src/real/format-output/cl_format.h

   1 // Formatted output functions à la Common Lisp.
   2
   3 #ifndef _CL_FORMAT_H
   4 #define _CL_FORMAT_H
   5
   6 #include "cl_number.h"
   7 #include "cl_io.h"
   8 #include "cl_float.h"
   9
  10 // gibt arg als römische Zahl auf stream aus, z.B. 4 als IIII.
  11 extern void format_old_roman (cl_ostream stream, const cl_I& arg);
  12
  13 // gibt arg als römische Zahl auf stream aus, z.B. 4 als IV.
  14 extern void format_new_roman (cl_ostream stream, const cl_I& arg);
  15
  16 extern const char * const cl_format_tens [10];
  17
  18 // gibt die ganze Zahl arg im Klartext auf englisch auf den Stream aus.
  19 extern void format_cardinal (cl_ostream stream, const cl_I& arg);
  20
  21 // gibt eine ganze Zahl arg als Abzählnummer im Klartext auf englisch
  22 // auf den stream aus.
  23 extern void format_ordinal (cl_ostream stream, const cl_I& arg);
  24
  25 // gibt count (>=0) Zeichen ch auf stream aus.
  26 inline void format_padding (cl_ostream stream, sintL count, char ch)
  27 {
  28         for (; count >= 0; count--)
  29                 fprintchar(stream,ch);
  30 }
  31
  32 // gibt auf den Stream stream aus:
  33 // den String str, eventuell aufgefüllt mit Padding characters padchar.
  34 // Und zwar so, daß die Breite mindestens mincol ist. Um das zu erreichen,
  35 // werden mindestens minpad Zeichen eingefügt, eventuelle weitere dann in
  36 // Blöcken à colinc Zeichen. Falls padleftflag, werden sie links eingefügt,
  37 // sonst rechts vom String.
  38 extern void format_padded_string (cl_ostream stream, sintL mincol, sintL colinc, sintL minpad, char padchar, cl_boolean padleftflag, const char * str);
  39
  40 // gibt den Integer arg auf den Stream aus:
  41 // in Zahlenbasis base, mit Vorzeichen (+ nur falls >0 und positive-sign-flag),
  42 // bei commaflag alle drei Stellen unterbrochen durch ein Zeichen commachar.
  43 // Das Ganze links aufgefüllt mit padchar's, so daß die Gesamtbreite mindestens
  44 // mincol ist.
  45 extern void format_integer (cl_ostream stream, const cl_I& arg, unsigned int base, sintL mincol, char padchar, char commachar, uintL commainterval, cl_boolean commaflag, cl_boolean positive_sign_flag);
  46
  47 // format_scale_exponent(arg) liefert zur Floating-Point-Zahl arg
  48 // drei Werte: mantissa und n, mit
  49 // ganzem n und mantissa floating-point, 0.1 <= mantissa < 1,
  50 // arg = mantissa * 10^n * sign (also 10^(n-1) <= abs(arg) < 10^n ).
  51 // (Bei arg=0.0: 0.0 und n=0.)
  52 extern const cl_decoded_float format_scale_exponent (const cl_F& arg);
  53 CL_REQUIRE(cl_fmt_scaleexp)
  54
  55 // format_float_to_string(arg,width,d,k,dmin)
  56 // ergibt einen String zum Floating-point arg:
  57 // er hat den Wert von abs(arg)*expt(10,k), dabei mind. d Nachkommastellen
  58 // und höchstens die Länge width (width<=0 -> keine Einschränkung).
  59 // Trotzdem wird nicht auf weniger als dmin Stellen gerundet.
  60 struct digits_with_dot {
  61         char * string; // Mit cl_malloc_hook() alloziert, mit cl_free_hook() freizugeben.
  62         uintL length; // strlen(string)
  63         cl_boolean dot_comes_first; // string[0] == '.' ?
  64         cl_boolean dot_comes_last; // string[strlen(string)-1] == '.' ?
  65         uintL dot_position; // string[dot_position] is '.'
  66 // Constructor.
  67         digits_with_dot (char* s, uintL l, cl_boolean df, cl_boolean dl, uintL dp)
  68                 : string(s), length(l), dot_comes_first(df), dot_comes_last(dl), dot_position(dp) {}
  69 };
  70 extern const digits_with_dot format_float_to_string (const cl_F& arg, const sintL width, const sintL d, const sintL k, const sintL dmin);
  71 CL_REQUIRE(cl_fmt_floatstring)
  72
  73
  74 #endif /* _CL_FORMAT_H */