gcc/ada/libgnat/s-imagew.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                       S Y S T E M . I M A G E _ W                        --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 1992-2023, Free Software Foundation, Inc.         --
  10 --                                                                          --
  11 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  12 -- terms of the  GNU General Public License as published  by the Free Soft- --
  13 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  14 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  15 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  16 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  17 --                                                                          --
  18 -- As a special exception under Section 7 of GPL version 3, you are granted --
  19 -- additional permissions described in the GCC Runtime Library Exception,   --
  20 -- version 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 -- GNAT was originally developed  by the GNAT team at  New York University. --
  28 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  29 --                                                                          --
  30 ------------------------------------------------------------------------------
  31
  32 --  Contains the routine for computing the image  of signed and unsigned
  33 --  integers up to Integer for use by Text_IO.Integer_IO and
  34 --  Text_IO.Modular_IO.
  35
  36 generic
  37
  38    type Int is range <>;
  39
  40    type Uns is mod <>;
  41
  42 package System.Image_W is
  43    pragma Pure;
  44
  45    procedure Set_Image_Width_Integer
  46      (V : Int;
  47       W : Integer;
  48       S : out String;
  49       P : in out Natural);
  50    --  Sets the signed image of V in decimal format, starting at S (P + 1),
  51    --  updating P to point to the last character stored. The image includes
  52    --  a leading minus sign if necessary, but no leading spaces unless W is
  53    --  positive, in which case leading spaces are output if necessary to ensure
  54    --  that the output string is no less than W characters long. The caller
  55    --  promises that the buffer is large enough and no check is made for this.
  56    --  Constraint_Error will not necessarily be raised if this is violated,
  57    --  since it is perfectly valid to compile this unit with checks off.
  58
  59    procedure Set_Image_Width_Unsigned
  60      (V : Uns;
  61       W : Integer;
  62       S : out String;
  63       P : in out Natural);
  64    --  Sets the unsigned image of V in decimal format, starting at S (P + 1),
  65    --  updating P to point to the last character stored. The image includes no
  66    --  leading spaces unless W is positive, in which case leading spaces are
  67    --  output if necessary to ensure that the output string is no less than
  68    --  W characters long. The caller promises that the buffer is large enough
  69    --  and no check is made for this. Constraint_Error will not necessarily be
  70    --  raised if this is violated, since it is perfectly valid to compile this
  71    --  unit with checks off.
  72
  73 end System.Image_W;