1/* Copyright (C) 1991-1993,1995-1999,2000,2001 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 Lesser General Public 6 License as published by the Free Software Foundation; either 7 version 2.1 of the 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 Lesser General Public License for more details. 13 14 You should have received a copy of the GNU Lesser General Public 15 License along with the GNU C Library; if not, write to the Free 16 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 17 02111-1307 USA. */ 18 19/* March 11, 2001 Manuel Novoa III 20 * 21 * Modified as appropriate for my new stdio lib. 22 */ 23 24#ifndef _PRINTF_H 25 26#define _PRINTF_H 1 27#include <features.h> 28 29__BEGIN_DECLS 30 31#define __need_FILE 32#include <stdio.h> 33#define __need_size_t 34#define __need_wchar_t 35#include <stddef.h> 36 37/* WARNING -- This is definitely nonportable... but it seems to work 38 * with gcc, which is currently the only "supported" compiler. 39 * The library code uses bitmasks for space-efficiency (you can't 40 * set/test multiple bitfields in one operation). Unfortunatly, we 41 * need to support bitfields since that's what glibc made visible to users. 42 * So, we take 43 * advantage of how gcc lays out bitfields to create an appropriate 44 * mapping. Inside uclibc (i.e. if _LIBC is defined) we access the 45 * bitfields using bitmasks in a single flag variable. 46 * 47 * WARNING -- This may very well fail if built with -fpack-struct!!! 48 * 49 * TODO -- Add a validation test. 50 * TODO -- Add an option to build in a shim translation function if 51 * the bitfield<->bitmask mapping fails. 52 */ 53#include <endian.h> 54 55struct printf_info { 56 int prec; /* Precision. */ 57 int width; /* Width. */ 58#ifdef __UCLIBC_HAS_WCHAR__ 59 wchar_t spec; /* Format letter. */ 60#else 61 int spec; 62#endif 63 64 65#if __BYTE_ORDER == __LITTLE_ENDIAN 66 unsigned int space:1; /* Space flag. */ 67 unsigned int showsign:1; /* + flag. */ 68 unsigned int extra:1; /* For special use. */ 69 unsigned int left:1; /* - flag. */ 70 unsigned int alt:1; /* # flag. */ 71 unsigned int group:1; /* ' flag. */ 72 unsigned int i18n:1; /* I flag. */ 73 unsigned int wide:1; /* Nonzero for wide character streams. */ 74 unsigned int is_char:1; /* hh flag. */ 75 unsigned int is_short:1; /* h flag. */ 76 unsigned int is_long:1; /* l flag. */ 77 unsigned int is_long_double:1;/* L flag. */ 78 unsigned int __padding:20; /* non-gnu: match _flags width of 32 bits */ 79#elif __BYTE_ORDER == __BIG_ENDIAN 80 unsigned int __padding:20; /* non-gnu: match _flags width of 32 bits */ 81 unsigned int is_long_double:1;/* L flag. */ 82 unsigned int is_long:1; /* l flag. */ 83 unsigned int is_short:1; /* h flag. */ 84 unsigned int is_char:1; /* hh flag. */ 85 unsigned int wide:1; /* Nonzero for wide character streams. */ 86 unsigned int i18n:1; /* I flag. */ 87 unsigned int group:1; /* ' flag. */ 88 unsigned int alt:1; /* # flag. */ 89 unsigned int left:1; /* - flag. */ 90 unsigned int extra:1; /* For special use. */ 91 unsigned int showsign:1; /* + flag. */ 92 unsigned int space:1; /* Space flag. */ 93#else 94#error unsupported byte order! 95#endif 96 97 98#ifdef __UCLIBC_HAS_WCHAR__ 99 wchar_t pad; /* Padding character. */ 100#else 101 int pad; 102#endif 103}; 104 105 106/* Type of a printf specifier-handler function. 107 STREAM is the FILE on which to write output. 108 INFO gives information about the format specification. 109 ARGS is a vector of pointers to the argument data; 110 the number of pointers will be the number returned 111 by the associated arginfo function for the same INFO. 112 113 The function should return the number of characters written, 114 or -1 for errors. */ 115 116#ifdef __UCLIBC_HAS_GLIBC_CUSTOM_PRINTF__ 117typedef int (*printf_function) (FILE *__stream, 118 __const struct printf_info *__info, 119 __const void *__const *__args); 120 121/* Type of a printf specifier-arginfo function. 122 INFO gives information about the format specification. 123 N, ARGTYPES, and return value are as for parse_printf_format. */ 124 125typedef int printf_arginfo_function (__const struct printf_info *__info, 126 size_t __n, int *__argtypes); 127 128 129/* Register FUNC to be called to format SPEC specifiers; ARGINFO must be 130 specified to determine how many arguments a SPEC conversion requires and 131 what their types are. */ 132 133extern int register_printf_function (int __spec, printf_function __func, 134 printf_arginfo_function __arginfo); 135#endif 136 137 138/* Parse FMT, and fill in N elements of ARGTYPES with the 139 types needed for the conversions FMT specifies. Returns 140 the number of arguments required by FMT. 141 142 The ARGINFO function registered with a user-defined format is passed a 143 `struct printf_info' describing the format spec being parsed. A width 144 or precision of INT_MIN means a `*' was used to indicate that the 145 width/precision will come from an arg. The function should fill in the 146 array it is passed with the types of the arguments it wants, and return 147 the number of arguments it wants. */ 148 149extern size_t parse_printf_format (__const char *__restrict __fmt, size_t __n, 150 int *__restrict __argtypes) __THROW; 151 152 153/* Codes returned by `parse_printf_format' for basic types. 154 155 These values cover all the standard format specifications. 156 Users can add new values after PA_LAST for their own types. */ 157 158/* WARNING -- The above is not entirely true, even for glibc. 159 * As far as the library code is concerned, such args are treated 160 * as 'your type' pointers if qualified by PA_FLAG_PTR. If they 161 * aren't qualified as pointers, I _think_ glibc just ignores them 162 * and carries on. I think it should be treated as an error. */ 163 164enum { /* C type: */ 165 PA_INT, /* int */ 166 PA_CHAR, /* int, cast to char */ 167 PA_WCHAR, /* wide char */ 168 PA_STRING, /* const char *, a '\0'-terminated string */ 169 PA_WSTRING, /* const wchar_t *, wide character string */ 170 PA_POINTER, /* void * */ 171 PA_FLOAT, /* float */ 172 PA_DOUBLE, /* double */ 173 __PA_NOARG, /* non-glibc -- signals non-arg width or prec */ 174 PA_LAST 175}; 176 177/* Flag bits that can be set in a type returned by `parse_printf_format'. */ 178/* WARNING -- These differ in value from what glibc uses. */ 179#define PA_FLAG_MASK (0xff00) 180#define __PA_FLAG_CHAR (0x0100) /* non-gnu -- to deal with hh */ 181#define PA_FLAG_SHORT (0x0200) 182#define PA_FLAG_LONG (0x0400) 183#define PA_FLAG_LONG_LONG (0x0800) 184#define PA_FLAG_LONG_DOUBLE PA_FLAG_LONG_LONG 185#define PA_FLAG_PTR (0x1000) /* TODO -- make dynamic??? */ 186 187#define __PA_INTMASK (0x0f00) /* non-gnu -- all int flags */ 188 189#if 0 190/* Function which can be registered as `printf'-handlers. */ 191 192/* Print floating point value using using abbreviations for the orders 193 of magnitude used for numbers ('k' for kilo, 'm' for mega etc). If 194 the format specifier is a uppercase character powers of 1000 are 195 used. Otherwise powers of 1024. */ 196extern int printf_size (FILE *__restrict __fp, 197 __const struct printf_info *__info, 198 __const void *__const *__restrict __args) __THROW; 199 200/* This is the appropriate argument information function for `printf_size'. */ 201extern int printf_size_info (__const struct printf_info *__restrict 202 __info, size_t __n, int *__restrict __argtypes) 203 __THROW; 204 205#endif 206 207__END_DECLS 208 209#endif /* printf.h */ 210