argp-fmtstream.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. /* Word-wrapping and line-truncating streams.
  2. Copyright (C) 1997-2019 Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. Written by Miles Bader <miles@gnu.ai.mit.edu>.
  5. The GNU C Library is free software; you can redistribute it and/or
  6. modify it under the terms of the GNU Lesser General Public
  7. License as published by the Free Software Foundation; either
  8. version 2.1 of the License, or (at your option) any later version.
  9. The GNU C Library is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12. Lesser General Public License for more details.
  13. You should have received a copy of the GNU Lesser General Public
  14. License along with the GNU C Library; if not, see
  15. <http://www.gnu.org/licenses/>. */
  16. /* This package emulates glibc `line_wrap_stream' semantics for systems that
  17. don't have that. If the system does have it, it is just a wrapper for
  18. that. This header file is only used internally while compiling argp, and
  19. shouldn't be installed. */
  20. #ifndef _ARGP_FMTSTREAM_H
  21. #define _ARGP_FMTSTREAM_H
  22. #include <stdio.h>
  23. #include <string.h>
  24. #include <unistd.h>
  25. #if defined (__GNU_LIBRARY__) && defined (HAVE_LINEWRAP_H)
  26. /* line_wrap_stream is available, so use that. */
  27. #define ARGP_FMTSTREAM_USE_LINEWRAP
  28. #endif
  29. #ifdef ARGP_FMTSTREAM_USE_LINEWRAP
  30. /* Just be a simple wrapper for line_wrap_stream; the semantics are
  31. *slightly* different, as line_wrap_stream doesn't actually make a new
  32. object, it just modifies the given stream (reversibly) to do
  33. line-wrapping. Since we control who uses this code, it doesn't matter. */
  34. #include <linewrap.h>
  35. typedef FILE *argp_fmtstream_t;
  36. #define argp_make_fmtstream line_wrap_stream
  37. #define __argp_make_fmtstream line_wrap_stream
  38. #define argp_fmtstream_free line_unwrap_stream
  39. #define __argp_fmtstream_free line_unwrap_stream
  40. #define __argp_fmtstream_putc(fs,ch) putc(ch,fs)
  41. #define argp_fmtstream_putc(fs,ch) putc(ch,fs)
  42. #define __argp_fmtstream_puts(fs,str) fputs(str,fs)
  43. #define argp_fmtstream_puts(fs,str) fputs(str,fs)
  44. #define __argp_fmtstream_write(fs,str,len) fwrite(str,1,len,fs)
  45. #define argp_fmtstream_write(fs,str,len) fwrite(str,1,len,fs)
  46. #define __argp_fmtstream_printf fprintf
  47. #define argp_fmtstream_printf fprintf
  48. #define __argp_fmtstream_lmargin line_wrap_lmargin
  49. #define argp_fmtstream_lmargin line_wrap_lmargin
  50. #define __argp_fmtstream_set_lmargin line_wrap_set_lmargin
  51. #define argp_fmtstream_set_lmargin line_wrap_set_lmargin
  52. #define __argp_fmtstream_rmargin line_wrap_rmargin
  53. #define argp_fmtstream_rmargin line_wrap_rmargin
  54. #define __argp_fmtstream_set_rmargin line_wrap_set_rmargin
  55. #define argp_fmtstream_set_rmargin line_wrap_set_rmargin
  56. #define __argp_fmtstream_wmargin line_wrap_wmargin
  57. #define argp_fmtstream_wmargin line_wrap_wmargin
  58. #define __argp_fmtstream_set_wmargin line_wrap_set_wmargin
  59. #define argp_fmtstream_set_wmargin line_wrap_set_wmargin
  60. #define __argp_fmtstream_point line_wrap_point
  61. #define argp_fmtstream_point line_wrap_point
  62. #else /* !ARGP_FMTSTREAM_USE_LINEWRAP */
  63. /* Guess we have to define our own version. */
  64. struct argp_fmtstream
  65. {
  66. FILE *stream; /* The stream we're outputting to. */
  67. size_t lmargin, rmargin; /* Left and right margins. */
  68. ssize_t wmargin; /* Margin to wrap to, or -1 to truncate. */
  69. /* Point in buffer to which we've processed for wrapping, but not output. */
  70. size_t point_offs;
  71. /* Output column at POINT_OFFS, or -1 meaning 0 but don't add lmargin. */
  72. ssize_t point_col;
  73. char *buf; /* Output buffer. */
  74. char *p; /* Current end of text in BUF. */
  75. char *end; /* Absolute end of BUF. */
  76. };
  77. typedef struct argp_fmtstream *argp_fmtstream_t;
  78. __BEGIN_DECLS
  79. /* Return an argp_fmtstream that outputs to STREAM, and which prefixes lines
  80. written on it with LMARGIN spaces and limits them to RMARGIN columns
  81. total. If WMARGIN >= 0, words that extend past RMARGIN are wrapped by
  82. replacing the whitespace before them with a newline and WMARGIN spaces.
  83. Otherwise, chars beyond RMARGIN are simply dropped until a newline.
  84. Returns NULL if there was an error. */
  85. extern argp_fmtstream_t __argp_make_fmtstream (FILE *__stream,
  86. size_t __lmargin,
  87. size_t __rmargin,
  88. ssize_t __wmargin);
  89. extern argp_fmtstream_t argp_make_fmtstream (FILE *__stream,
  90. size_t __lmargin,
  91. size_t __rmargin,
  92. ssize_t __wmargin);
  93. /* Flush __FS to its stream, and free it (but don't close the stream). */
  94. extern void __argp_fmtstream_free (argp_fmtstream_t __fs);
  95. extern void argp_fmtstream_free (argp_fmtstream_t __fs);
  96. extern ssize_t __argp_fmtstream_printf (argp_fmtstream_t __fs,
  97. const char *__fmt, ...)
  98. __attribute__ ((__format__ (printf, 2, 3)));
  99. extern ssize_t argp_fmtstream_printf (argp_fmtstream_t __fs,
  100. const char *__fmt, ...)
  101. __attribute__ ((__format__ (printf, 2, 3)));
  102. extern int __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
  103. extern int argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch);
  104. extern int __argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str);
  105. extern int argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str);
  106. extern size_t __argp_fmtstream_write (argp_fmtstream_t __fs,
  107. const char *__str, size_t __len);
  108. extern size_t argp_fmtstream_write (argp_fmtstream_t __fs,
  109. const char *__str, size_t __len);
  110. /* Access macros for various bits of state. */
  111. #define argp_fmtstream_lmargin(__fs) ((__fs)->lmargin)
  112. #define argp_fmtstream_rmargin(__fs) ((__fs)->rmargin)
  113. #define argp_fmtstream_wmargin(__fs) ((__fs)->wmargin)
  114. #define __argp_fmtstream_lmargin argp_fmtstream_lmargin
  115. #define __argp_fmtstream_rmargin argp_fmtstream_rmargin
  116. #define __argp_fmtstream_wmargin argp_fmtstream_wmargin
  117. /* Set __FS's left margin to LMARGIN and return the old value. */
  118. extern size_t argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
  119. size_t __lmargin);
  120. extern size_t __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs,
  121. size_t __lmargin);
  122. /* Set __FS's right margin to __RMARGIN and return the old value. */
  123. extern size_t argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
  124. size_t __rmargin);
  125. extern size_t __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs,
  126. size_t __rmargin);
  127. /* Set __FS's wrap margin to __WMARGIN and return the old value. */
  128. extern size_t argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
  129. size_t __wmargin);
  130. extern size_t __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs,
  131. size_t __wmargin);
  132. /* Return the column number of the current output point in __FS. */
  133. extern size_t argp_fmtstream_point (argp_fmtstream_t __fs);
  134. extern size_t __argp_fmtstream_point (argp_fmtstream_t __fs);
  135. /* Internal routines. */
  136. extern void _argp_fmtstream_update (argp_fmtstream_t __fs);
  137. extern void __argp_fmtstream_update (argp_fmtstream_t __fs);
  138. extern int _argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
  139. extern int __argp_fmtstream_ensure (argp_fmtstream_t __fs, size_t __amount);
  140. #ifdef __OPTIMIZE__
  141. /* Inline versions of above routines. */
  142. #if !_LIBC
  143. #define __argp_fmtstream_putc argp_fmtstream_putc
  144. #define __argp_fmtstream_puts argp_fmtstream_puts
  145. #define __argp_fmtstream_write argp_fmtstream_write
  146. #define __argp_fmtstream_set_lmargin argp_fmtstream_set_lmargin
  147. #define __argp_fmtstream_set_rmargin argp_fmtstream_set_rmargin
  148. #define __argp_fmtstream_set_wmargin argp_fmtstream_set_wmargin
  149. #define __argp_fmtstream_point argp_fmtstream_point
  150. #define __argp_fmtstream_update _argp_fmtstream_update
  151. #define __argp_fmtstream_ensure _argp_fmtstream_ensure
  152. #endif
  153. #ifndef ARGP_FS_EI
  154. #define ARGP_FS_EI extern inline
  155. #endif
  156. ARGP_FS_EI size_t
  157. __argp_fmtstream_write (argp_fmtstream_t __fs, const char *__str, size_t __len)
  158. {
  159. if (__fs->p + __len <= __fs->end || __argp_fmtstream_ensure (__fs, __len))
  160. {
  161. memcpy (__fs->p, __str, __len);
  162. __fs->p += __len;
  163. return __len;
  164. }
  165. else
  166. return 0;
  167. }
  168. ARGP_FS_EI int
  169. __argp_fmtstream_puts (argp_fmtstream_t __fs, const char *__str)
  170. {
  171. size_t __len = strlen (__str);
  172. if (__len)
  173. {
  174. size_t __wrote = __argp_fmtstream_write (__fs, __str, __len);
  175. return __wrote == __len ? 0 : -1;
  176. }
  177. else
  178. return 0;
  179. }
  180. ARGP_FS_EI int
  181. __argp_fmtstream_putc (argp_fmtstream_t __fs, int __ch)
  182. {
  183. if (__fs->p < __fs->end || __argp_fmtstream_ensure (__fs, 1))
  184. return *__fs->p++ = __ch;
  185. else
  186. return EOF;
  187. }
  188. /* Set __FS's left margin to __LMARGIN and return the old value. */
  189. ARGP_FS_EI size_t
  190. __argp_fmtstream_set_lmargin (argp_fmtstream_t __fs, size_t __lmargin)
  191. {
  192. size_t __old;
  193. if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
  194. __argp_fmtstream_update (__fs);
  195. __old = __fs->lmargin;
  196. __fs->lmargin = __lmargin;
  197. return __old;
  198. }
  199. /* Set __FS's right margin to __RMARGIN and return the old value. */
  200. ARGP_FS_EI size_t
  201. __argp_fmtstream_set_rmargin (argp_fmtstream_t __fs, size_t __rmargin)
  202. {
  203. size_t __old;
  204. if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
  205. __argp_fmtstream_update (__fs);
  206. __old = __fs->rmargin;
  207. __fs->rmargin = __rmargin;
  208. return __old;
  209. }
  210. /* Set FS's wrap margin to __WMARGIN and return the old value. */
  211. ARGP_FS_EI size_t
  212. __argp_fmtstream_set_wmargin (argp_fmtstream_t __fs, size_t __wmargin)
  213. {
  214. size_t __old;
  215. if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
  216. __argp_fmtstream_update (__fs);
  217. __old = __fs->wmargin;
  218. __fs->wmargin = __wmargin;
  219. return __old;
  220. }
  221. /* Return the column number of the current output point in __FS. */
  222. ARGP_FS_EI size_t
  223. __argp_fmtstream_point (argp_fmtstream_t __fs)
  224. {
  225. if ((size_t) (__fs->p - __fs->buf) > __fs->point_offs)
  226. __argp_fmtstream_update (__fs);
  227. return __fs->point_col >= 0 ? __fs->point_col : 0;
  228. }
  229. #if !_LIBC
  230. #undef __argp_fmtstream_putc
  231. #undef __argp_fmtstream_puts
  232. #undef __argp_fmtstream_write
  233. #undef __argp_fmtstream_set_lmargin
  234. #undef __argp_fmtstream_set_rmargin
  235. #undef __argp_fmtstream_set_wmargin
  236. #undef __argp_fmtstream_point
  237. #undef __argp_fmtstream_update
  238. #undef __argp_fmtstream_ensure
  239. #endif
  240. #endif /* __OPTIMIZE__ */
  241. __END_DECLS
  242. #endif /* ARGP_FMTSTREAM_USE_LINEWRAP */
  243. #endif /* argp-fmtstream.h */