Package: Ada.Strings.Bounded

Package: Ada.Strings.Bounded

Dependencies

with Ada.Strings.Maps;

Description

GNAT RUN-TIME COMPONENTS

A D A . S T R I N G S . B O U N D E D

S p e c

$Revision: 1.12 $

Copyright (C) 1992-2000 Free Software Foundation, Inc.

This specification is derived from the Ada Reference Manual for use with GNAT. The copyright notice above, and the license provisions that follow apply solely to the contents of the part following the private keyword.

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 2, 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. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License distributed with GNAT; see file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

As a special exception, if other files instantiate generics from this unit, or you link this unit with other files to produce an executable, this unit does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Public License.

GNAT was originally developed by the GNAT team at New York University. It is now maintained by Ada Core Technologies Inc (http://www.gnat.com).

Header

package Ada.Strings.Bounded is

pragma Preelaborate (Bounded);

Other Items:

generic
   Max : Positive;
   --  Maximum length of a Bounded_String

package Generic_Bounded_Length is

Type Summary

Bounded_String

Primitive Operations: "&", "&", "&", "&", "&", "*", "*", "*", "<", "<", "<", "<=", "<=", "<=", "=", "=", "=", ">", ">", ">", ">=", ">=", ">=", Append, Append, Append, Append, Append, Append, Append, Append, Count, Count, Count, Delete, Delete, Element, Find_Token, Head, Head, Index, Index, Index, Index_Non_Blank, Insert, Insert, Length, Overwrite, Overwrite, Replace_Element, Replace_Slice, Replace_Slice, Replicate, Replicate, Replicate, Slice, Tail, Tail, To_Bounded_String, To_String, Translate, Translate, Translate, Translate, Trim, Trim, Trim, Trim

Constants and Named Numbers

Max_Length : constant Positive := Max;

Null_Bounded_String : constant Bounded_String;

Other Items:

type Bounded_String is private;

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

   --  Implementation-defined ...

end Generic_Bounded_Length;

end Ada.Strings.Bounded;