aboutsummaryrefslogtreecommitdiff
path: root/gcc/ada/libgnat/s-imgint.ads
blob: 55df149dcf4a30391606e918cd7eb44102bd8086 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
------------------------------------------------------------------------------
--                                                                          --
--                         GNAT RUN-TIME COMPONENTS                         --
--                                                                          --
--                       S Y S T E M . I M G _ I N T                        --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--          Copyright (C) 1992-2025, Free Software Foundation, Inc.         --
--                                                                          --
-- GNAT is free software;  you can  redistribute it  and/or modify it under --
-- terms of the  GNU General Public License as published  by the Free Soft- --
-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
-- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
--                                                                          --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception,   --
-- version 3.1, as published by the Free Software Foundation.               --
--                                                                          --
-- You should have received a copy of the GNU General Public License and    --
-- a copy of the GCC Runtime Library Exception along with this program;     --
-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
-- <http://www.gnu.org/licenses/>.                                          --
--                                                                          --
-- GNAT was originally developed  by the GNAT team at  New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc.      --
--                                                                          --
------------------------------------------------------------------------------

--  This package provides the subprograms supporting the ``Image`` attribute
--  and ``Ada.Text_IO.Integer_IO`` conversions routines for signed integer
--  types up to Size ``Integer'Size``.

with System.Image_I;

package System.Img_Int
  with SPARK_Mode
is
   package Impl is new Image_I (Integer);

   procedure Image_Integer
     (V : Integer;
      S : in out String;
      P : out Natural)
     renames Impl.Image_Integer;
   --  Computes Integer'Image (``V``) and stores the result in
   --  ``S`` (1 .. ``P``) setting the resulting value of ``P``.
   --  The caller guarantees that ``S`` is long enough to hold the result,
   --  and that ``S``'First is 1.
   --
   --  If ``V`` is not negative, the subprogram writes the leading blank in
   --  ``S``. It then calls *Set_Image_Integer* unconditionally.

   procedure Set_Image_Integer
     (V : Integer;
      S : in out String;
      P : in out Natural)
     renames Impl.Set_Image_Integer;
   --  Stores the image of ``V`` in ``S`` starting at ``S`` (``P`` + 1), ``P``
   --  is updated to point to the last character stored. The value stored is
   --  identical to the value of Integer'Image (``V``) except that no leading
   --  space is stored when ``V`` is non-negative. The caller guarantees that
   --  ``S`` is long enough to hold the result. ``S`` need not have a lower
   --  bound of 1.
   --
   --  If ``V`` is negative, the subprogram writes the leading '-' character,
   --  otherwise work with -``V`` (always work with negative value to avoid
   --  overflow: the largest negative number is not a special case).
   --
   --  This subprogram then uses recursion: if the value is equal or less than
   --  -10, recurse with the value divided by 10. Then add the digit for the
   --  remainder.

end System.Img_Int;