Wed Mar 20 11:28:49 1996 Andreas Schwab <schwab@issan.informatik.uni-dortmund.de>
[kopensolaris-gnu/glibc.git] / stdio-common / printf.h
1 /* Copyright (C) 1991, 1992, 1993, 1995 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
8
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 Library General Public License for more details.
13
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB.  If
16 not, write to the, 1992 Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 #ifndef _PRINTF_H
20
21 #define _PRINTF_H       1
22 #include <features.h>
23
24 __BEGIN_DECLS
25
26 #define __need_FILE
27 #include <stdio.h>
28 #define __need_size_t
29 #include <stddef.h>
30
31
32 struct printf_info
33 {
34   int prec;                     /* Precision.  */
35   int width;                    /* Width.  */
36   unsigned char spec;           /* Format letter.  */
37   unsigned int is_long_double:1;/* L flag.  */
38   unsigned int is_short:1;      /* h flag.  */
39   unsigned int is_long:1;       /* l flag.  */
40   unsigned int alt:1;           /* # flag.  */
41   unsigned int space:1;         /* Space flag.  */
42   unsigned int left:1;          /* - flag.  */
43   unsigned int showsign:1;      /* + flag.  */
44   unsigned int group:1;         /* ' flag.  */
45   char pad;                     /* Padding character.  */
46 };
47
48
49 /* Type of a printf specifier-handler function.
50    STREAM is the FILE on which to write output.
51    INFO gives information about the format specification.
52    ARGS is a vector of pointers to the argument data;
53    the number of pointers will be the number returned
54    by the associated arginfo function for the same INFO.
55
56    The function should return the number of characters written,
57    or -1 for errors.  */
58
59 typedef int printf_function __P ((FILE *__stream,
60                                   __const struct printf_info *__info,
61                                   __const void *__const *__args));
62
63 /* Type of a printf specifier-arginfo function.
64    INFO gives information about the format specification.
65    N, ARGTYPES, and return value are as for printf_parse_format.  */
66
67 typedef int printf_arginfo_function __P ((__const struct printf_info * __info,
68                                           size_t __n,
69                                           int *__argtypes));
70
71
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, even if your program never calls
75    `parse_printf_format'.  */
76
77 extern int register_printf_function __P ((int __spec, printf_function __func,
78                                           printf_arginfo_function __arginfo));
79
80
81 /* Parse FMT, and fill in N elements of ARGTYPES with the
82    types needed for the conversions FMT specifies.  Returns
83    the number of arguments required by FMT.
84
85    The ARGINFO function registered with a user-defined format is passed a
86    `struct printf_info' describing the format spec being parsed.  A width
87    or precision of INT_MIN means a `*' was used to indicate that the
88    width/precision will come from an arg.  The function should fill in the
89    array it is passed with the types of the arguments it wants, and return
90    the number of arguments it wants.  */
91
92 extern size_t parse_printf_format __P ((__const char *__fmt,
93                                         size_t __n,
94                                         int *__argtypes));
95
96
97 /* Codes returned by `parse_printf_format' for basic types.
98
99    These values cover all the standard format specifications.
100    Users can add new values after PA_LAST for their own types.  */
101
102 enum
103 {                               /* C type: */
104   PA_INT,                       /* int */
105   PA_CHAR,                      /* int, cast to char */
106   PA_STRING,                    /* const char *, a '\0'-terminated string */
107   PA_POINTER,                   /* void * */
108   PA_FLOAT,                     /* float */
109   PA_DOUBLE,                    /* double */
110   PA_LAST
111 };
112
113 /* Flag bits that can be set in a type returned by `parse_printf_format'.  */
114 #define PA_FLAG_MASK            0xff00
115 #define PA_FLAG_LONG_LONG       (1 << 8)
116 #define PA_FLAG_LONG_DOUBLE     PA_FLAG_LONG_LONG
117 #define PA_FLAG_LONG            (1 << 9)
118 #define PA_FLAG_SHORT           (1 << 10)
119 #define PA_FLAG_PTR             (1 << 11)
120
121
122 __END_DECLS
123
124 #endif /* printf.h  */