printf.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  1. /* Copyright (C) 1991-2016 Free Software Foundation, Inc.
  2. This file is part of the GNU C Library.
  3. The GNU C Library is free software; you can redistribute it and/or
  4. modify it under the terms of the GNU Lesser General Public
  5. License as published by the Free Software Foundation; either
  6. version 2.1 of the License, or (at your option) any later version.
  7. The GNU C Library is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. Lesser General Public License for more details.
  11. You should have received a copy of the GNU Lesser General Public
  12. License along with the GNU C Library; if not, see
  13. <http://www.gnu.org/licenses/>. */
  14. #ifndef _PRINTF_H
  15. #define _PRINTF_H 1
  16. #include <features.h>
  17. __BEGIN_DECLS
  18. #define __need_FILE
  19. #include <stdio.h>
  20. #define __need_size_t
  21. #define __need_wchar_t
  22. #include <stddef.h>
  23. #include <stdarg.h>
  24. struct printf_info
  25. {
  26. int prec; /* Precision. */
  27. int width; /* Width. */
  28. wchar_t spec; /* Format letter. */
  29. unsigned int is_long_double:1;/* L flag. */
  30. unsigned int is_short:1; /* h flag. */
  31. unsigned int is_long:1; /* l flag. */
  32. unsigned int alt:1; /* # flag. */
  33. unsigned int space:1; /* Space flag. */
  34. unsigned int left:1; /* - flag. */
  35. unsigned int showsign:1; /* + flag. */
  36. unsigned int group:1; /* ' flag. */
  37. unsigned int extra:1; /* For special use. */
  38. unsigned int is_char:1; /* hh flag. */
  39. unsigned int wide:1; /* Nonzero for wide character streams. */
  40. unsigned int i18n:1; /* I flag. */
  41. unsigned int __pad:4; /* Unused so far. */
  42. unsigned short int user; /* Bits for user-installed modifiers. */
  43. wchar_t pad; /* Padding character. */
  44. };
  45. /* Type of a printf specifier-handler function.
  46. STREAM is the FILE on which to write output.
  47. INFO gives information about the format specification.
  48. ARGS is a vector of pointers to the argument data;
  49. the number of pointers will be the number returned
  50. by the associated arginfo function for the same INFO.
  51. The function should return the number of characters written,
  52. or -1 for errors. */
  53. typedef int printf_function (FILE *__stream,
  54. const struct printf_info *__info,
  55. const void *const *__args);
  56. /* Type of a printf specifier-arginfo function.
  57. INFO gives information about the format specification.
  58. N, ARGTYPES, *SIZE has to contain the size of the parameter for
  59. user-defined types, and return value are as for parse_printf_format
  60. except that -1 should be returned if the handler cannot handle
  61. this case. This allows to partially overwrite the functionality
  62. of existing format specifiers. */
  63. typedef int printf_arginfo_size_function (const struct printf_info *__info,
  64. size_t __n, int *__argtypes,
  65. int *__size);
  66. /* Old version of 'printf_arginfo_function' without a SIZE parameter. */
  67. typedef int printf_arginfo_function (const struct printf_info *__info,
  68. size_t __n, int *__argtypes);
  69. /* Type of a function to get a value of a user-defined from the
  70. variable argument list. */
  71. typedef void printf_va_arg_function (void *__mem, va_list *__ap);
  72. /* Register FUNC to be called to format SPEC specifiers; ARGINFO must be
  73. specified to determine how many arguments a SPEC conversion requires and
  74. what their types are. */
  75. extern int register_printf_specifier (int __spec, printf_function __func,
  76. printf_arginfo_size_function __arginfo)
  77. __THROW;
  78. /* Obsolete interface similar to register_printf_specifier. It can only
  79. handle basic data types because the ARGINFO callback does not return
  80. information on the size of the user-defined type. */
  81. extern int register_printf_function (int __spec, printf_function __func,
  82. printf_arginfo_function __arginfo)
  83. __THROW __attribute_deprecated__;
  84. /* Register a new modifier character sequence. If the call succeeds
  85. it returns a positive value representing the bit set in the USER
  86. field in 'struct printf_info'. */
  87. extern int register_printf_modifier (const wchar_t *__str) __wur __THROW;
  88. /* Register variable argument handler for user type. The return value
  89. is to be used in ARGINFO functions to signal the use of the
  90. type. */
  91. extern int register_printf_type (printf_va_arg_function __fct) __wur __THROW;
  92. /* Parse FMT, and fill in N elements of ARGTYPES with the
  93. types needed for the conversions FMT specifies. Returns
  94. the number of arguments required by FMT.
  95. The ARGINFO function registered with a user-defined format is passed a
  96. `struct printf_info' describing the format spec being parsed. A width
  97. or precision of INT_MIN means a `*' was used to indicate that the
  98. width/precision will come from an arg. The function should fill in the
  99. array it is passed with the types of the arguments it wants, and return
  100. the number of arguments it wants. */
  101. extern size_t parse_printf_format (const char *__restrict __fmt, size_t __n,
  102. int *__restrict __argtypes) __THROW;
  103. /* Codes returned by `parse_printf_format' for basic types.
  104. These values cover all the standard format specifications.
  105. Users can reserve new values after PA_LAST for their own types
  106. using 'register_printf_type'. */
  107. enum
  108. { /* C type: */
  109. PA_INT, /* int */
  110. PA_CHAR, /* int, cast to char */
  111. PA_WCHAR, /* wide char */
  112. PA_STRING, /* const char *, a '\0'-terminated string */
  113. PA_WSTRING, /* const wchar_t *, wide character string */
  114. PA_POINTER, /* void * */
  115. PA_FLOAT, /* float */
  116. PA_DOUBLE, /* double */
  117. PA_LAST
  118. };
  119. /* Flag bits that can be set in a type returned by `parse_printf_format'. */
  120. #define PA_FLAG_MASK 0xff00
  121. #define PA_FLAG_LONG_LONG (1 << 8)
  122. #define PA_FLAG_LONG_DOUBLE PA_FLAG_LONG_LONG
  123. #define PA_FLAG_LONG (1 << 9)
  124. #define PA_FLAG_SHORT (1 << 10)
  125. #define PA_FLAG_PTR (1 << 11)
  126. /* Function which can be registered as `printf'-handlers. */
  127. /* Print floating point value using using abbreviations for the orders
  128. of magnitude used for numbers ('k' for kilo, 'm' for mega etc). If
  129. the format specifier is a uppercase character powers of 1000 are
  130. used. Otherwise powers of 1024. */
  131. extern int printf_size (FILE *__restrict __fp,
  132. const struct printf_info *__info,
  133. const void *const *__restrict __args) __THROW;
  134. /* This is the appropriate argument information function for `printf_size'. */
  135. extern int printf_size_info (const struct printf_info *__restrict
  136. __info, size_t __n, int *__restrict __argtypes)
  137. __THROW;
  138. #ifdef __LDBL_COMPAT
  139. # include <bits/printf-ldbl.h>
  140. #endif
  141. __END_DECLS
  142. #endif /* printf.h */