Package Name: ada.strings.bounded
------------------------------------------------------------------------------
-- --
-- GNAT RUNTIME COMPONENTS --
-- --
-- A D A . S T R I N G S . B O U N D E D --
-- --
-- S p e c --
-- --
-- $Revision: 1.9 $ --
-- --
-- This specification is adapted from the Ada Reference Manual for use with --
-- GNAT. In accordance with the copyright of that document, you can freely --
-- copy and modify this specification, provided that if you redistribute a --
-- modified version, any changes that you have made are clearly indicated. --
-- --
------------------------------------------------------------------------------
with Ada.Strings.Maps;
package Ada.Strings.Bounded is
pragma Preelaborate (Bounded);
generic
Max : Positive;
-- Maximum length of a Bounded_String
package Generic_Bounded_Length is
Max_Length : constant Positive := Max;
type Bounded_String is private;
Null_Bounded_String : constant Bounded_String;
subtype Length_Range is Natural range 0 .. Max_Length;
function Length (Source : in Bounded_String) return Length_Range;
--------------------------------------------------------
-- Conversion, Concatenation, and Selection Functions --
--------------------------------------------------------
function To_Bounded_String
(Source : in String;
Drop : in Truncation := Error)
return Bounded_String;
function To_String (Source : in Bounded_String) return String;
function Append
(Left, Right : in Bounded_String;
Drop : in Truncation := Error)
return Bounded_String;
function Append
(Left : in Bounded_String;
Right : in String;
Drop : in Truncation := Error)
return Bounded_String;
function Append
(Left : in String;
Right : in Bounded_String;
Drop : in Truncation := Error)
return Bounded_String;
function Append
(Left : in Bounded_String;
Right : in Character;
Drop : in Truncation := Error)
return Bounded_String;
function Append
(Left : in Character;
Right : in Bounded_String;
Drop : in Truncation := Error)
return Bounded_String;
procedure Append
(Source : in out Bounded_String;
New_Item : in Bounded_String;
Drop : in Truncation := Error);
procedure Append
(Source : in out Bounded_String;
New_Item : in String;
Drop : in Truncation := Error);
procedure Append
(Source : in out Bounded_String;
New_Item : in Character;
Drop : in Truncation := Error);
function "&"
(Left, Right : in Bounded_String)
return Bounded_String;
function "&"
(Left : in Bounded_String;
Right : in String)
return Bounded_String;
function "&"
(Left : in String;
Right : in Bounded_String)
return Bounded_String;
function "&"
(Left : in Bounded_String;
Right : in Character)
return Bounded_String;
function "&"
(Left : in Character;
Right : in Bounded_String)
return Bounded_String;
function Element
(Source : in Bounded_String;
Index : in Positive)
return Character;
procedure Replace_Element
(Source : in out Bounded_String;
Index : in Positive;
By : in Character);
function Slice
(Source : in Bounded_String;
Low : in Positive;
High : in Natural)
return String;
function "=" (Left, Right : in Bounded_String) return Boolean;
function "="
(Left : in Bounded_String;
Right : in String)
return Boolean;
function "="
(Left : in String;
Right : in Bounded_String)
return Boolean;
function "<" (Left, Right : in Bounded_String) return Boolean;
function "<"
(Left : in Bounded_String;
Right : in String)
return Boolean;
function "<"
(Left : in String;
Right : in Bounded_String)
return Boolean;
function "<=" (Left, Right : in Bounded_String) return Boolean;
function "<="
(Left : in Bounded_String;
Right : in String)
return Boolean;
function "<="
(Left : in String;
Right : in Bounded_String)
return Boolean;
function ">" (Left, Right : in Bounded_String) return Boolean;
function ">"
(Left : in Bounded_String;
Right : in String)
return Boolean;
function ">"
(Left : in String;
Right : in Bounded_String)
return Boolean;
function ">=" (Left, Right : in Bounded_String) return Boolean;
function ">="
(Left : in Bounded_String;
Right : in String)
return Boolean;
function ">="
(Left : in String;
Right : in Bounded_String)
return Boolean;
----------------------
-- Search Functions --
----------------------
function Index
(Source : in Bounded_String;
Pattern : in String;
Going : in Direction := Forward;
Mapping : in Maps.Character_Mapping := Maps.Identity)
return Natural;
function Index
(Source : in Bounded_String;
Pattern : in String;
Going : in Direction := Forward;
Mapping : in Maps.Character_Mapping_Function)
return Natural;
function Index
(Source : in Bounded_String;
Set : in Maps.Character_Set;
Test : in Membership := Inside;
Going : in Direction := Forward)
return Natural;
function Index_Non_Blank
(Source : in Bounded_String;
Going : in Direction := Forward)
return Natural;
function Count
(Source : in Bounded_String;
Pattern : in String;
Mapping : in Maps.Character_Mapping := Maps.Identity)
return Natural;
function Count
(Source : in Bounded_String;
Pattern : in String;
Mapping : in Maps.Character_Mapping_Function)
return Natural;
function Count
(Source : in Bounded_String;
Set : in Maps.Character_Set)
return Natural;
procedure Find_Token
(Source : in Bounded_String;
Set : in Maps.Character_Set;
Test : in Membership;
First : out Positive;
Last : out Natural);
------------------------------------
-- String Translation Subprograms --
------------------------------------
function Translate
(Source : in Bounded_String;
Mapping : in Maps.Character_Mapping)
return Bounded_String;
procedure Translate
(Source : in out Bounded_String;
Mapping : in Maps.Character_Mapping);
function Translate
(Source : in Bounded_String;
Mapping : in Maps.Character_Mapping_Function)
return Bounded_String;
procedure Translate
(Source : in out Bounded_String;
Mapping : in Maps.Character_Mapping_Function);
---------------------------------------
-- String Transformation Subprograms --
---------------------------------------
function Replace_Slice
(Source : in Bounded_String;
Low : in Positive;
High : in Natural;
By : in String;
Drop : in Truncation := Error)
return Bounded_String;
procedure Replace_Slice
(Source : in out Bounded_String;
Low : in Positive;
High : in Natural;
By : in String;
Drop : in Truncation := Error);
function Insert
(Source : in Bounded_String;
Before : in Positive;
New_Item : in String;
Drop : in Truncation := Error)
return Bounded_String;
procedure Insert
(Source : in out Bounded_String;
Before : in Positive;
New_Item : in String;
Drop : in Truncation := Error);
function Overwrite
(Source : in Bounded_String;
Position : in Positive;
New_Item : in String;
Drop : in Truncation := Error)
return Bounded_String;
procedure Overwrite
(Source : in out Bounded_String;
Position : in Positive;
New_Item : in String;
Drop : in Truncation := Error);
function Delete
(Source : in Bounded_String;
From : in Positive;
Through : in Natural)
return Bounded_String;
procedure Delete
(Source : in out Bounded_String;
From : in Positive;
Through : in Natural);
---------------------------------
-- String Selector Subprograms --
---------------------------------
function Trim
(Source : in Bounded_String;
Side : in Trim_End)
return Bounded_String;
procedure Trim
(Source : in out Bounded_String;
Side : in Trim_End);
function Trim
(Source : in Bounded_String;
Left : in Maps.Character_Set;
Right : in Maps.Character_Set)
return Bounded_String;
procedure Trim
(Source : in out Bounded_String;
Left : in Maps.Character_Set;
Right : in Maps.Character_Set);
function Head
(Source : in Bounded_String;
Count : in Natural;
Pad : in Character := Space;
Drop : in Truncation := Error)
return Bounded_String;
procedure Head
(Source : in out Bounded_String;
Count : in Natural;
Pad : in Character := Space;
Drop : in Truncation := Error);
function Tail
(Source : in Bounded_String;
Count : in Natural;
Pad : in Character := Space;
Drop : in Truncation := Error)
return Bounded_String;
procedure Tail
(Source : in out Bounded_String;
Count : in Natural;
Pad : in Character := Space;
Drop : in Truncation := Error);
------------------------------------
-- String Constructor Subprograms --
------------------------------------
function "*"
(Left : in Natural;
Right : in Character)
return Bounded_String;
function "*"
(Left : in Natural;
Right : in String)
return Bounded_String;
function "*"
(Left : in Natural;
Right : in Bounded_String)
return Bounded_String;
function Replicate
(Count : in Natural;
Item : in Character;
Drop : in Truncation := Error)
return Bounded_String;
function Replicate
(Count : in Natural;
Item : in String;
Drop : in Truncation := Error)
return Bounded_String;
function Replicate
(Count : in Natural;
Item : in Bounded_String;
Drop : in Truncation := Error)
return Bounded_String;
private
type Bounded_String is record
Length : Length_Range := 0;
Data : String (1 .. Max_Length);
end record;
Null_Bounded_String : constant Bounded_String :=
(Length => 0, Data => (1 .. Max_Length => Ascii.NUL));
-- Pragma Inline declarations (GNAT specific additions)
pragma Inline ("=");
pragma Inline ("<");
pragma Inline ("<=");
pragma Inline (">");
pragma Inline (">=");
pragma Inline ("&");
pragma Inline (Count);
pragma Inline (Element);
pragma Inline (Find_Token);
pragma Inline (Index);
pragma Inline (Index_Non_Blank);
pragma Inline (Length);
pragma Inline (Replace_Element);
pragma Inline (Slice);
pragma Inline (To_Bounded_String);
pragma Inline (To_String);
end Generic_Bounded_Length;
end Ada.Strings.Bounded;