| ------------------------------------------------------------------------------ |
| -- -- |
| -- GNAT RUN-TIME COMPONENTS -- |
| -- -- |
| -- A D A . S T R I N G S . S U P E R B O U N D E D -- |
| -- -- |
| -- S p e c -- |
| -- -- |
| -- Copyright (C) 2003-2012, 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 non generic package contains most of the implementation of the |
| -- generic package Ada.Strings.Bounded.Generic_Bounded_Length. |
| |
| -- It defines type Super_String as a discriminated record with the maximum |
| -- length as the discriminant. Individual instantiations of Strings.Bounded |
| -- use this type with an appropriate discriminant value set. |
| |
| with Ada.Strings.Maps; |
| |
| package Ada.Strings.Superbounded is |
| pragma Preelaborate; |
| |
| -- Type Bounded_String in Ada.Strings.Bounded.Generic_Bounded_Length is |
| -- derived from Super_String, with the constraint of the maximum length. |
| |
| type Super_String (Max_Length : Positive) is record |
| Current_Length : Natural := 0; |
| Data : String (1 .. Max_Length); |
| -- A previous version had a default initial value for Data, which is |
| -- no longer necessary, because we now special-case this type in the |
| -- compiler, so "=" composes properly for descendants of this type. |
| -- Leaving it out is more efficient. |
| end record; |
| |
| -- The subprograms defined for Super_String are similar to those |
| -- defined for Bounded_String, except that they have different names, so |
| -- that they can be renamed in Ada.Strings.Bounded.Generic_Bounded_Length. |
| |
| function Super_Length (Source : Super_String) return Natural; |
| |
| -------------------------------------------------------- |
| -- Conversion, Concatenation, and Selection Functions -- |
| -------------------------------------------------------- |
| |
| function To_Super_String |
| (Source : String; |
| Max_Length : Natural; |
| Drop : Truncation := Error) return Super_String; |
| -- Note the additional parameter Max_Length, which specifies the maximum |
| -- length setting of the resulting Super_String value. |
| |
| -- The following procedures have declarations (and semantics) that are |
| -- exactly analogous to those declared in Ada.Strings.Bounded. |
| |
| function Super_To_String (Source : Super_String) return String; |
| |
| procedure Set_Super_String |
| (Target : out Super_String; |
| Source : String; |
| Drop : Truncation := Error); |
| |
| function Super_Append |
| (Left : Super_String; |
| Right : Super_String; |
| Drop : Truncation := Error) return Super_String; |
| |
| function Super_Append |
| (Left : Super_String; |
| Right : String; |
| Drop : Truncation := Error) return Super_String; |
| |
| function Super_Append |
| (Left : String; |
| Right : Super_String; |
| Drop : Truncation := Error) return Super_String; |
| |
| function Super_Append |
| (Left : Super_String; |
| Right : Character; |
| Drop : Truncation := Error) return Super_String; |
| |
| function Super_Append |
| (Left : Character; |
| Right : Super_String; |
| Drop : Truncation := Error) return Super_String; |
| |
| procedure Super_Append |
| (Source : in out Super_String; |
| New_Item : Super_String; |
| Drop : Truncation := Error); |
| |
| procedure Super_Append |
| (Source : in out Super_String; |
| New_Item : String; |
| Drop : Truncation := Error); |
| |
| procedure Super_Append |
| (Source : in out Super_String; |
| New_Item : Character; |
| Drop : Truncation := Error); |
| |
| function Concat |
| (Left : Super_String; |
| Right : Super_String) return Super_String; |
| |
| function Concat |
| (Left : Super_String; |
| Right : String) return Super_String; |
| |
| function Concat |
| (Left : String; |
| Right : Super_String) return Super_String; |
| |
| function Concat |
| (Left : Super_String; |
| Right : Character) return Super_String; |
| |
| function Concat |
| (Left : Character; |
| Right : Super_String) return Super_String; |
| |
| function Super_Element |
| (Source : Super_String; |
| Index : Positive) return Character; |
| |
| procedure Super_Replace_Element |
| (Source : in out Super_String; |
| Index : Positive; |
| By : Character); |
| |
| function Super_Slice |
| (Source : Super_String; |
| Low : Positive; |
| High : Natural) return String; |
| |
| function Super_Slice |
| (Source : Super_String; |
| Low : Positive; |
| High : Natural) return Super_String; |
| |
| procedure Super_Slice |
| (Source : Super_String; |
| Target : out Super_String; |
| Low : Positive; |
| High : Natural); |
| |
| function "=" |
| (Left : Super_String; |
| Right : Super_String) return Boolean; |
| |
| function Equal |
| (Left : Super_String; |
| Right : Super_String) return Boolean renames "="; |
| |
| function Equal |
| (Left : Super_String; |
| Right : String) return Boolean; |
| |
| function Equal |
| (Left : String; |
| Right : Super_String) return Boolean; |
| |
| function Less |
| (Left : Super_String; |
| Right : Super_String) return Boolean; |
| |
| function Less |
| (Left : Super_String; |
| Right : String) return Boolean; |
| |
| function Less |
| (Left : String; |
| Right : Super_String) return Boolean; |
| |
| function Less_Or_Equal |
| (Left : Super_String; |
| Right : Super_String) return Boolean; |
| |
| function Less_Or_Equal |
| (Left : Super_String; |
| Right : String) return Boolean; |
| |
| function Less_Or_Equal |
| (Left : String; |
| Right : Super_String) return Boolean; |
| |
| function Greater |
| (Left : Super_String; |
| Right : Super_String) return Boolean; |
| |
| function Greater |
| (Left : Super_String; |
| Right : String) return Boolean; |
| |
| function Greater |
| (Left : String; |
| Right : Super_String) return Boolean; |
| |
| function Greater_Or_Equal |
| (Left : Super_String; |
| Right : Super_String) return Boolean; |
| |
| function Greater_Or_Equal |
| (Left : Super_String; |
| Right : String) return Boolean; |
| |
| function Greater_Or_Equal |
| (Left : String; |
| Right : Super_String) return Boolean; |
| |
| ---------------------- |
| -- Search Functions -- |
| ---------------------- |
| |
| function Super_Index |
| (Source : Super_String; |
| Pattern : String; |
| Going : Direction := Forward; |
| Mapping : Maps.Character_Mapping := Maps.Identity) return Natural; |
| |
| function Super_Index |
| (Source : Super_String; |
| Pattern : String; |
| Going : Direction := Forward; |
| Mapping : Maps.Character_Mapping_Function) return Natural; |
| |
| function Super_Index |
| (Source : Super_String; |
| Set : Maps.Character_Set; |
| Test : Membership := Inside; |
| Going : Direction := Forward) return Natural; |
| |
| function Super_Index |
| (Source : Super_String; |
| Pattern : String; |
| From : Positive; |
| Going : Direction := Forward; |
| Mapping : Maps.Character_Mapping := Maps.Identity) return Natural; |
| |
| function Super_Index |
| (Source : Super_String; |
| Pattern : String; |
| From : Positive; |
| Going : Direction := Forward; |
| Mapping : Maps.Character_Mapping_Function) return Natural; |
| |
| function Super_Index |
| (Source : Super_String; |
| Set : Maps.Character_Set; |
| From : Positive; |
| Test : Membership := Inside; |
| Going : Direction := Forward) return Natural; |
| |
| function Super_Index_Non_Blank |
| (Source : Super_String; |
| Going : Direction := Forward) return Natural; |
| |
| function Super_Index_Non_Blank |
| (Source : Super_String; |
| From : Positive; |
| Going : Direction := Forward) return Natural; |
| |
| function Super_Count |
| (Source : Super_String; |
| Pattern : String; |
| Mapping : Maps.Character_Mapping := Maps.Identity) return Natural; |
| |
| function Super_Count |
| (Source : Super_String; |
| Pattern : String; |
| Mapping : Maps.Character_Mapping_Function) return Natural; |
| |
| function Super_Count |
| (Source : Super_String; |
| Set : Maps.Character_Set) return Natural; |
| |
| procedure Super_Find_Token |
| (Source : Super_String; |
| Set : Maps.Character_Set; |
| From : Positive; |
| Test : Membership; |
| First : out Positive; |
| Last : out Natural); |
| |
| procedure Super_Find_Token |
| (Source : Super_String; |
| Set : Maps.Character_Set; |
| Test : Membership; |
| First : out Positive; |
| Last : out Natural); |
| |
| ------------------------------------ |
| -- String Translation Subprograms -- |
| ------------------------------------ |
| |
| function Super_Translate |
| (Source : Super_String; |
| Mapping : Maps.Character_Mapping) return Super_String; |
| |
| procedure Super_Translate |
| (Source : in out Super_String; |
| Mapping : Maps.Character_Mapping); |
| |
| function Super_Translate |
| (Source : Super_String; |
| Mapping : Maps.Character_Mapping_Function) return Super_String; |
| |
| procedure Super_Translate |
| (Source : in out Super_String; |
| Mapping : Maps.Character_Mapping_Function); |
| |
| --------------------------------------- |
| -- String Transformation Subprograms -- |
| --------------------------------------- |
| |
| function Super_Replace_Slice |
| (Source : Super_String; |
| Low : Positive; |
| High : Natural; |
| By : String; |
| Drop : Truncation := Error) return Super_String; |
| |
| procedure Super_Replace_Slice |
| (Source : in out Super_String; |
| Low : Positive; |
| High : Natural; |
| By : String; |
| Drop : Truncation := Error); |
| |
| function Super_Insert |
| (Source : Super_String; |
| Before : Positive; |
| New_Item : String; |
| Drop : Truncation := Error) return Super_String; |
| |
| procedure Super_Insert |
| (Source : in out Super_String; |
| Before : Positive; |
| New_Item : String; |
| Drop : Truncation := Error); |
| |
| function Super_Overwrite |
| (Source : Super_String; |
| Position : Positive; |
| New_Item : String; |
| Drop : Truncation := Error) return Super_String; |
| |
| procedure Super_Overwrite |
| (Source : in out Super_String; |
| Position : Positive; |
| New_Item : String; |
| Drop : Truncation := Error); |
| |
| function Super_Delete |
| (Source : Super_String; |
| From : Positive; |
| Through : Natural) return Super_String; |
| |
| procedure Super_Delete |
| (Source : in out Super_String; |
| From : Positive; |
| Through : Natural); |
| |
| --------------------------------- |
| -- String Selector Subprograms -- |
| --------------------------------- |
| |
| function Super_Trim |
| (Source : Super_String; |
| Side : Trim_End) return Super_String; |
| |
| procedure Super_Trim |
| (Source : in out Super_String; |
| Side : Trim_End); |
| |
| function Super_Trim |
| (Source : Super_String; |
| Left : Maps.Character_Set; |
| Right : Maps.Character_Set) return Super_String; |
| |
| procedure Super_Trim |
| (Source : in out Super_String; |
| Left : Maps.Character_Set; |
| Right : Maps.Character_Set); |
| |
| function Super_Head |
| (Source : Super_String; |
| Count : Natural; |
| Pad : Character := Space; |
| Drop : Truncation := Error) return Super_String; |
| |
| procedure Super_Head |
| (Source : in out Super_String; |
| Count : Natural; |
| Pad : Character := Space; |
| Drop : Truncation := Error); |
| |
| function Super_Tail |
| (Source : Super_String; |
| Count : Natural; |
| Pad : Character := Space; |
| Drop : Truncation := Error) return Super_String; |
| |
| procedure Super_Tail |
| (Source : in out Super_String; |
| Count : Natural; |
| Pad : Character := Space; |
| Drop : Truncation := Error); |
| |
| ------------------------------------ |
| -- String Constructor Subprograms -- |
| ------------------------------------ |
| |
| -- Note: in some of the following routines, there is an extra parameter |
| -- Max_Length which specifies the value of the maximum length for the |
| -- resulting Super_String value. |
| |
| function Times |
| (Left : Natural; |
| Right : Character; |
| Max_Length : Positive) return Super_String; |
| -- Note the additional parameter Max_Length |
| |
| function Times |
| (Left : Natural; |
| Right : String; |
| Max_Length : Positive) return Super_String; |
| -- Note the additional parameter Max_Length |
| |
| function Times |
| (Left : Natural; |
| Right : Super_String) return Super_String; |
| |
| function Super_Replicate |
| (Count : Natural; |
| Item : Character; |
| Drop : Truncation := Error; |
| Max_Length : Positive) return Super_String; |
| -- Note the additional parameter Max_Length |
| |
| function Super_Replicate |
| (Count : Natural; |
| Item : String; |
| Drop : Truncation := Error; |
| Max_Length : Positive) return Super_String; |
| -- Note the additional parameter Max_Length |
| |
| function Super_Replicate |
| (Count : Natural; |
| Item : Super_String; |
| Drop : Truncation := Error) return Super_String; |
| |
| private |
| -- Pragma Inline declarations |
| |
| pragma Inline ("="); |
| pragma Inline (Less); |
| pragma Inline (Less_Or_Equal); |
| pragma Inline (Greater); |
| pragma Inline (Greater_Or_Equal); |
| pragma Inline (Concat); |
| pragma Inline (Super_Count); |
| pragma Inline (Super_Element); |
| pragma Inline (Super_Find_Token); |
| pragma Inline (Super_Index); |
| pragma Inline (Super_Index_Non_Blank); |
| pragma Inline (Super_Length); |
| pragma Inline (Super_Replace_Element); |
| pragma Inline (Super_Slice); |
| pragma Inline (Super_To_String); |
| |
| end Ada.Strings.Superbounded; |
