gcc/m2/gm2-libs/FormatStrings.def

   1 (* FormatStrings.def provides a pseudo printf capability.
   2
   3 Copyright (C) 2005-2024 Free Software Foundation, Inc.
   4 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
   5
   6 This file is part of GNU Modula-2.
   7
   8 GNU Modula-2 is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3, or (at your option)
  11 any later version.
  12
  13 GNU Modula-2 is distributed in the hope that it will be useful, but
  14 WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 General Public License for more details.
  17
  18 Under Section 7 of GPL version 3, you are granted additional
  19 permissions described in the GCC Runtime Library Exception, version
  20 3.1, as published by the Free Software Foundation.
  21
  22 You should have received a copy of the GNU General Public License and
  23 a copy of the GCC Runtime Library Exception along with this program;
  24 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  25 <http://www.gnu.org/licenses/>.  *)
  26
  27 DEFINITION MODULE FormatStrings ;
  28
  29 FROM SYSTEM IMPORT BYTE ;
  30 FROM DynamicStrings IMPORT String ;
  31 EXPORT QUALIFIED Sprintf0, Sprintf1, Sprintf2, Sprintf3, Sprintf4,
  32                  HandleEscape ;
  33
  34
  35 (*
  36    Sprintf0 - returns a String containing, fmt, after it has had its
  37               escape sequences translated.
  38 *)
  39
  40 PROCEDURE Sprintf0 (fmt: String) : String ;
  41
  42
  43 (*
  44    Sprintf1 - returns a String containing, fmt, together with
  45               encapsulated entity, w. It only formats the
  46               first %s or %d with n.
  47 *)
  48
  49 PROCEDURE Sprintf1 (fmt: String; w: ARRAY OF BYTE) : String ;
  50
  51
  52 (*
  53    Sprintf2 - returns a string, fmt, which has been formatted.
  54 *)
  55
  56 PROCEDURE Sprintf2 (fmt: String; w1, w2: ARRAY OF BYTE) : String ;
  57
  58
  59 (*
  60    Sprintf3 - returns a string, fmt, which has been formatted.
  61 *)
  62
  63 PROCEDURE Sprintf3 (fmt: String; w1, w2, w3: ARRAY OF BYTE) : String ;
  64
  65
  66 (*
  67    Sprintf4 - returns a string, fmt, which has been formatted.
  68 *)
  69
  70 PROCEDURE Sprintf4 (fmt: String;
  71                     w1, w2, w3, w4: ARRAY OF BYTE) : String ;
  72
  73
  74 (*
  75    HandleEscape - translates \a, \b, \e, \f, \n, \r, \x[hex] \[octal]
  76                   into their respective ascii codes.  It also converts
  77                   \[any] into a single [any] character.
  78 *)
  79
  80 PROCEDURE HandleEscape (s: String) : String ;
  81
  82
  83 END FormatStrings.