gcc/ada/s-boustr.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                S Y S T E M . B O U N D E D _ S T R I N G S               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                       Copyright (C) 2016, AdaCore                        --
  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 --  A very simple implentation of bounded strings, used by tracebacks
  33
  34 package System.Bounded_Strings is
  35    type Bounded_String (Max_Length : Natural) is limited private;
  36    --  A string whose length is bounded by Max_Length. The bounded string is
  37    --  empty at initialization.
  38
  39    procedure Append (X : in out Bounded_String; C : Character);
  40    procedure Append (X : in out Bounded_String; S : String);
  41    --  Append a character or a string to X. If the bounded string is full,
  42    --  extra characters are simply dropped.
  43
  44    function To_String (X : Bounded_String) return String;
  45    function "+" (X : Bounded_String) return String renames To_String;
  46    --  Convert to a normal string
  47
  48    procedure Append_Address (X : in out Bounded_String; A : Address);
  49    --  Append an address to X
  50
  51    function Is_Full (X : Bounded_String) return Boolean;
  52    --  Return True iff X is full and any character or string will be dropped
  53    --  if appended.
  54 private
  55    type Bounded_String (Max_Length : Natural) is limited record
  56       Length : Natural := 0;
  57       --  Current length of the string
  58
  59       Chars  : String (1 .. Max_Length);
  60       --  String content
  61    end record;
  62 end System.Bounded_Strings;