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