Mirror of :pserver:cvs@cvs.fefe.de:/cvs libowfat https://www.fefe.de/libowfat/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

234 lines
10 KiB

  1. /* this header file comes from libowfat, http://www.fefe.de/libowfat/ */
  2. #ifndef FMT_H
  3. #define FMT_H
  4. /* for size_t: */
  5. #include <stddef.h>
  6. /* for uint32_t */
  7. #include <stdint.h>
  8. /* for time_t: */
  9. #ifdef _WIN32
  10. #include <time.h>
  11. #else
  12. #include <sys/types.h>
  13. #endif
  14. /* for byte_copy */
  15. #include "byte.h"
  16. #ifdef __cplusplus
  17. extern "C" {
  18. #endif
  19. #ifndef __pure__
  20. #define __pure__
  21. #endif
  22. #define FMT_LONG 41 /* enough space to hold -2^127 in decimal, plus \0 */
  23. #define FMT_ULONG 40 /* enough space to hold 2^128 - 1 in decimal, plus \0 */
  24. #define FMT_8LONG 44 /* enough space to hold 2^128 - 1 in octal, plus \0 */
  25. #define FMT_XLONG 33 /* enough space to hold 2^128 - 1 in hexadecimal, plus \0 */
  26. #define FMT_LEN ((char *) 0) /* convenient abbreviation */
  27. /* This file declares routines for formatting strings and numbers in
  28. * various forms or encodings, either binary or text based.
  29. *
  30. * The first argument is always the destination buffer, the second
  31. * argument is always the value to be formatted/encoded. The return
  32. * value is always the number of bytes written in the output buffer.
  33. *
  34. * If you don't know how large the output will be, call the function
  35. * first with NULL as destination buffer and use the length it returns
  36. * to allocate the destination buffer.
  37. *
  38. * Note that none of these routines append a 0 terminator. If you need
  39. * 0 termination, call the functions like this:
  40. buf[fmt_ulong(buf,number)]=0;
  41. */
  42. /* convert signed src integer -23 to ASCII '-','2','3', return number of
  43. * bytes of value in output format (3 in this example).
  44. * If dest is not NULL, write result to dest */
  45. size_t fmt_long(char *dest,signed long src) __pure__;
  46. /* convert unsigned src integer 23 to ASCII '2','3', return number of
  47. * bytes of value in output format (2 in this example).
  48. * If dest is not NULL, write result to dest */
  49. size_t fmt_ulong(char *dest,unsigned long src) __pure__;
  50. /* convert unsigned src integer 0x23 to ASCII '2','3', return number of
  51. * bytes of value in output format (2 in this example).
  52. * If dest is not NULL, write result to dest */
  53. size_t fmt_xlong(char *dest,unsigned long src) __pure__;
  54. /* convert unsigned src integer 023 to ASCII '2','3', return number of
  55. * bytes of value in output format (2 in this example).
  56. * If dest is not NULL, write result to dest */
  57. size_t fmt_8long(char *dest,unsigned long src) __pure__;
  58. /* like fmt_long but for long long */
  59. size_t fmt_longlong(char *dest,signed long long src) __pure__;
  60. /* like fmt_ulong but for unsigned long long */
  61. size_t fmt_ulonglong(char *dest,unsigned long long src) __pure__;
  62. /* like fmt_xlong but for unsigned long long */
  63. size_t fmt_xlonglong(char *dest,unsigned long long src) __pure__;
  64. #define fmt_uint(dest,src) fmt_ulong(dest,src)
  65. #define fmt_int(dest,src) fmt_long(dest,src)
  66. #define fmt_xint(dest,src) fmt_xlong(dest,src)
  67. #define fmt_8int(dest,src) fmt_8long(dest,src)
  68. /* Like fmt_ulong, but prepend '0' while length is smaller than padto.
  69. * Does not truncate! */
  70. /* fmt_ulong0(buf,23,4) -> '0','0','2','3' return 4 */
  71. /* fmt_ulong0(buf,234,2) -> '2','3','4', return 3 */
  72. size_t fmt_ulong0(char *,unsigned long src,size_t padto) __pure__;
  73. #define fmt_uint0(buf,src,padto) fmt_ulong0(buf,src,padto)
  74. /* convert src double 1.7 to ASCII '1','.','7', return length.
  75. * If dest is not NULL, write result to dest */
  76. size_t fmt_double(char *dest, double d,int max,int prec) __pure__;
  77. /* if src is negative, write '-' and return 1.
  78. * if src is positive, write '+' and return 1.
  79. * otherwise return 0 */
  80. size_t fmt_plusminus(char *dest,int src) __pure__;
  81. /* if src is negative, write '-' and return 1.
  82. * otherwise return 0. */
  83. size_t fmt_minus(char *dest,int src) __pure__;
  84. /* copy str to dest until \0 byte, return number of copied bytes. */
  85. /* fmt_str(NULL,str) == strlen(str) */
  86. /* fmt_str(buf,str) == strcpy(buf,str), return strlen(str) */
  87. /* strcat(strcpy(buf,"foo"),"bar") can be written as
  88. * i=fmt_str(buf,"foo");
  89. * i+=fmt_str(buf+i,"bar");
  90. * buf[i]=0;
  91. * This is more efficient because strcat needs to scan the string to
  92. * find the end and append.
  93. */
  94. size_t fmt_str(char *dest,const char *src) __pure__;
  95. /* copy str to dest until \0 byte or limit bytes copied.
  96. * return number of copied bytes. */
  97. size_t fmt_strn(char *dest,const char *src,size_t limit) __pure__;
  98. /* copy n bytes from src to dest, return n */
  99. static inline size_t fmt_copybytes(char* dest,const char* src,size_t n) {
  100. if (dest) byte_copy(dest,n,src);
  101. return n;
  102. }
  103. /* copy sizeof(src)-1 bytes from src to dest, return sizeof(src)-1 */
  104. /* this is for
  105. * fmt_copybytes_sizeof_minus1(dest, "\x01\x02\x03\x04");
  106. * since we are technically passing a string, sizeof will include the
  107. * finishing 0 byte which we neither need nor want */
  108. #define fmt_copybytes_sizeof_minus1(dest,src) fmt_copybytes(dest,src,sizeof(src)-1)
  109. /* "foo" -> " foo"
  110. * write padlen-srclen spaces, if that is >= 0. Then copy srclen
  111. * characters from src. Truncate only if total length is larger than
  112. * maxlen. Return number of characters written. */
  113. size_t fmt_pad(char* dest,const char* src,size_t srclen,size_t padlen,size_t maxlen) __pure__;
  114. /* "foo" -> "foo "
  115. * append padlen-srclen spaces after dest, if that is >= 0. Truncate
  116. * only if total length is larger than maxlen. Return number of
  117. * characters written. */
  118. size_t fmt_fill(char* dest,size_t srclen,size_t padlen,size_t maxlen) __pure__;
  119. /* 1 -> "1", 4900 -> "4.9k", 2300000 -> "2.3M" */
  120. size_t fmt_human(char* dest,unsigned long long l) __pure__;
  121. /* 1 -> "1", 4900 -> "4.8k", 2300000 -> "2.2M" */
  122. size_t fmt_humank(char* dest,unsigned long long l) __pure__;
  123. /* "Sun, 06 Nov 1994 08:49:37 GMT" */
  124. size_t fmt_httpdate(char* dest,time_t t); /* not marked pure because it calls gmtime */
  125. /* "2014-05-27T19:22:16.247Z" */
  126. size_t fmt_iso8601(char* dest,time_t t) __pure__;
  127. #define FMT_UTF8 5
  128. #define FMT_ASN1LENGTH 17 /* enough space to hold 2^128-1 */
  129. #define FMT_ASN1TAG 19 /* enough space to hold 2^128-1 */
  130. /* some variable length encodings for integers */
  131. size_t fmt_utf8(char* dest,uint32_t n) __pure__; /* can store 0-0x7fffffff */
  132. size_t fmt_utf8_scratch(char* dest,uint32_t n) __pure__; /* same, but is allowed to overwrite up to 7 additional bytes */
  133. size_t fmt_asn1derlength(char* dest,unsigned long long l) __pure__; /* 0-0x7f: 1 byte, above that 1+bytes_needed bytes */
  134. size_t fmt_asn1derlength_scratch(char* dest,unsigned long long l) __pure__; /* same, but is allowed to overwrite up to 7 additional bytes */
  135. size_t fmt_asn1dertag(char* dest,unsigned long long l) __pure__; /* 1 byte for each 7 bits; upper bit = more bytes coming */
  136. size_t fmt_asn1dertag_scratch(char* dest,unsigned long long l) __pure__;/* same, but is allowed to overwrite up to 7 additional bytes */
  137. /* Google Protocol Buffers, https://developers.google.com/protocol-buffers/docs/encoding */
  138. size_t fmt_varint(char* dest,unsigned long long l) __pure__; /* protocol buffers encoding; like asn1dertag but little endian */
  139. size_t fmt_pb_tag(char* dest,size_t fieldno,unsigned char type) __pure__; /* protocol buffer tag */
  140. size_t fmt_pb_type0_int(char* dest,unsigned long long l) __pure__; /* protocol buffers encoding: type 0 bool/enum/int32/uint32/int64/uint64 */
  141. size_t fmt_pb_type0_sint(char* dest,signed long long l) __pure__;/* protocol buffers encoding: type 0 sint32/sint64 */
  142. size_t fmt_pb_type1_double(char* dest,double d) __pure__; /* protocol buffers encoding: double (64-bit little endian blob) */
  143. size_t fmt_pb_type1_fixed64(char* dest,uint64_t l) __pure__; /* protocol buffers encoding: 64-bit little endian blob */
  144. /* fmt_pb_type2_string can return 0 if (s,l) is clearly invalid */
  145. size_t fmt_pb_type2_string(char* dest,const char* s,size_t l) __pure__; /* protocol buffers encoding: varint length + blob */
  146. size_t fmt_pb_type5_float(char* dest,float f) __pure__; /* protocol buffers encoding: float (32-bit little endian blob) */
  147. size_t fmt_pb_type5_fixed32(char* dest,uint32_t l) __pure__; /* protocol buffers encoding: 32-bit little endian blob */
  148. size_t fmt_pb_int(char* dest,size_t fieldno,unsigned long long l) __pure__;
  149. size_t fmt_pb_sint(char* dest,size_t fieldno,signed long long l) __pure__;
  150. size_t fmt_pb_double(char* dest,size_t fieldno,double d) __pure__;
  151. size_t fmt_pb_float(char* dest,size_t fieldno,float f) __pure__;
  152. size_t fmt_pb_string(char* dest,size_t fieldno,const char* s,size_t l) __pure__;
  153. /* fmt_netstring can return 0 if (src,len) is clearly invalid */
  154. size_t fmt_netstring(char* dest,const char* src,size_t len) __pure__;
  155. /* Marshaling helper functions.
  156. * Escape one character, no matter if it needs escaping or not.
  157. * The functions will reject characters that cannot be represented but
  158. * not characters that the standard says should never occur. The idea
  159. * is to make these functions useful for creating bad encoding for
  160. * penetration testing.
  161. * Depending on the escaping method, the input character (uint32_t, a
  162. * unicode codepoint) may be limited to 0x7f, 0xff or 0x10ffff. */
  163. /* XML escaping: '&' -> '&amp;', '<' -> '&lt;', 'ö' -> '&#xf6;' */
  164. size_t fmt_escapecharxml(char* dest,uint32_t ch) __pure__;
  165. /* HTML escaping is the same as XML escaping. */
  166. size_t fmt_escapecharhtml(char* dest,uint32_t ch) __pure__;
  167. /* JSON escaping: '\' -> '\\', '"' -> '\"', 'ö' -> '\u00f6' */
  168. size_t fmt_escapecharjson(char* dest,uint32_t ch) __pure__;
  169. /* MIME quoted-printable escaping: 'ö' -> '=f6', characters > 0xff not supported */
  170. size_t fmt_escapecharquotedprintable(char* dest,uint32_t ch) __pure__;
  171. /* MIME quoted-printable escaping with UTF-8: 'ö' -> '=c3=b6', characters > 0x7fffffff not supported */
  172. size_t fmt_escapecharquotedprintableutf8(char* dest,uint32_t ch) __pure__;
  173. /* C99 style escaping: '\' -> '\\', newline -> '\n', 0xc2 -> '\302' */
  174. size_t fmt_escapecharc(char* dest,uint32_t ch) __pure__;
  175. /* internal functions, may be independently useful */
  176. char fmt_tohex(char c) __attribute__((__const__));
  177. #define fmt_strm(b,...) fmt_strm_internal(b,__VA_ARGS__,(char*)0)
  178. size_t fmt_strm_internal(char* dest,...) __pure__;
  179. #ifndef MAX_ALLOCA
  180. #define MAX_ALLOCA 100000
  181. #endif
  182. #define fmt_strm_alloca(a,...) ({ size_t len=fmt_strm((char*)0,a,__VA_ARGS__)+1; char* c=(len<MAX_ALLOCA?alloca(len):0); if (c) c[fmt_strm(c,a,__VA_ARGS__)]=0; c;})
  183. #ifdef __cplusplus
  184. }
  185. #endif
  186. #endif