gcc/ada/a-stzsup.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --  A D A . S T R I N G S .  W I D E _ W I D E _ S U P E R B O U N D E D    --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2003-2009, Free Software Foundation, Inc.         --
  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 --  This non generic package contains most of the implementation of the
  33 --  generic package Ada.Strings.Wide_Wide_Bounded.Generic_Bounded_Length.
  34
  35 --  It defines type Super_String as a discriminated record with the maximum
  36 --  length as the discriminant. Individual instantiations of the package
  37 --  Strings.Wide_Wide_Bounded.Generic_Bounded_Length use this type with
  38 --  an appropriate discriminant value set.
  39
  40 with Ada.Strings.Wide_Wide_Maps;
  41
  42 package Ada.Strings.Wide_Wide_Superbounded is
  43    pragma Preelaborate;
  44
  45    Wide_Wide_NUL : constant Wide_Wide_Character :=
  46                      Wide_Wide_Character'Val (0);
  47
  48    type Super_String (Max_Length : Positive) is record
  49       Current_Length : Natural := 0;
  50       Data           : Wide_Wide_String (1 .. Max_Length) :=
  51                          (others => Wide_Wide_NUL);
  52    end record;
  53    --  Wide_Wide_Bounded.Generic_Bounded_Length.Wide_Wide_Bounded_String is
  54    --  derived from this type, with the constraint of the maximum length.
  55
  56    --  The subprograms defined for Super_String are similar to those defined
  57    --  for Bounded_Wide_Wide_String, except that they have different names, so
  58    --  that they can be renamed in Wide_Wide_Bounded.Generic_Bounded_Length.
  59
  60    function Super_Length (Source : Super_String) return Natural;
  61
  62    --------------------------------------------------------
  63    -- Conversion, Concatenation, and Selection Functions --
  64    --------------------------------------------------------
  65
  66    function To_Super_String
  67      (Source     : Wide_Wide_String;
  68       Max_Length : Natural;
  69       Drop       : Truncation := Error) return Super_String;
  70    --  Note the additional parameter Max_Length, which specifies the maximum
  71    --  length setting of the resulting Super_String value.
  72
  73    --  The following procedures have declarations (and semantics) that are
  74    --  exactly analogous to those declared in Ada.Strings.Wide_Wide_Bounded.
  75
  76    function Super_To_String (Source : Super_String) return Wide_Wide_String;
  77
  78    procedure Set_Super_String
  79      (Target : out Super_String;
  80       Source : Wide_Wide_String;
  81       Drop   : Truncation := Error);
  82
  83    function Super_Append
  84      (Left  : Super_String;
  85       Right : Super_String;
  86       Drop  : Truncation := Error) return Super_String;
  87
  88    function Super_Append
  89      (Left  : Super_String;
  90       Right : Wide_Wide_String;
  91       Drop  : Truncation := Error) return Super_String;
  92
  93    function Super_Append
  94      (Left  : Wide_Wide_String;
  95       Right : Super_String;
  96       Drop  : Truncation := Error) return Super_String;
  97
  98    function Super_Append
  99      (Left  : Super_String;
 100       Right : Wide_Wide_Character;
 101       Drop  : Truncation := Error) return Super_String;
 102
 103    function Super_Append
 104      (Left  : Wide_Wide_Character;
 105       Right : Super_String;
 106       Drop  : Truncation := Error) return Super_String;
 107
 108    procedure Super_Append
 109      (Source   : in out Super_String;
 110       New_Item : Super_String;
 111       Drop     : Truncation := Error);
 112
 113    procedure Super_Append
 114      (Source   : in out Super_String;
 115       New_Item : Wide_Wide_String;
 116       Drop     : Truncation := Error);
 117
 118    procedure Super_Append
 119      (Source   : in out Super_String;
 120       New_Item : Wide_Wide_Character;
 121       Drop     : Truncation := Error);
 122
 123    function Concat
 124      (Left  : Super_String;
 125       Right : Super_String) return Super_String;
 126
 127    function Concat
 128      (Left  : Super_String;
 129       Right : Wide_Wide_String) return Super_String;
 130
 131    function Concat
 132      (Left  : Wide_Wide_String;
 133       Right : Super_String) return Super_String;
 134
 135    function Concat
 136      (Left  : Super_String;
 137       Right : Wide_Wide_Character) return Super_String;
 138
 139    function Concat
 140      (Left  : Wide_Wide_Character;
 141       Right : Super_String) return Super_String;
 142
 143    function Super_Element
 144      (Source : Super_String;
 145       Index  : Positive) return Wide_Wide_Character;
 146
 147    procedure Super_Replace_Element
 148      (Source : in out Super_String;
 149       Index  : Positive;
 150       By     : Wide_Wide_Character);
 151
 152    function Super_Slice
 153      (Source : Super_String;
 154       Low    : Positive;
 155       High   : Natural) return Wide_Wide_String;
 156
 157    function Super_Slice
 158      (Source : Super_String;
 159       Low    : Positive;
 160       High   : Natural) return Super_String;
 161
 162    procedure Super_Slice
 163      (Source : Super_String;
 164       Target : out Super_String;
 165       Low    : Positive;
 166       High   : Natural);
 167
 168    function "="
 169      (Left  : Super_String;
 170       Right : Super_String) return Boolean;
 171
 172    function Equal
 173      (Left  : Super_String;
 174       Right : Super_String) return Boolean renames "=";
 175
 176    function Equal
 177      (Left  : Super_String;
 178       Right : Wide_Wide_String) return Boolean;
 179
 180    function Equal
 181      (Left  : Wide_Wide_String;
 182       Right : Super_String) return Boolean;
 183
 184    function Less
 185      (Left  : Super_String;
 186       Right : Super_String) return Boolean;
 187
 188    function Less
 189      (Left  : Super_String;
 190       Right : Wide_Wide_String) return Boolean;
 191
 192    function Less
 193      (Left  : Wide_Wide_String;
 194       Right : Super_String) return Boolean;
 195
 196    function Less_Or_Equal
 197      (Left  : Super_String;
 198       Right : Super_String) return Boolean;
 199
 200    function Less_Or_Equal
 201      (Left  : Super_String;
 202       Right : Wide_Wide_String) return Boolean;
 203
 204    function Less_Or_Equal
 205      (Left  : Wide_Wide_String;
 206       Right : Super_String) return Boolean;
 207
 208    function Greater
 209      (Left  : Super_String;
 210       Right : Super_String) return Boolean;
 211
 212    function Greater
 213      (Left  : Super_String;
 214       Right : Wide_Wide_String) return Boolean;
 215
 216    function Greater
 217      (Left  : Wide_Wide_String;
 218       Right : Super_String) return Boolean;
 219
 220    function Greater_Or_Equal
 221      (Left  : Super_String;
 222       Right : Super_String) return Boolean;
 223
 224    function Greater_Or_Equal
 225      (Left  : Super_String;
 226       Right : Wide_Wide_String) return Boolean;
 227
 228    function Greater_Or_Equal
 229      (Left  : Wide_Wide_String;
 230       Right : Super_String) return Boolean;
 231
 232    ----------------------
 233    -- Search Functions --
 234    ----------------------
 235
 236    function Super_Index
 237      (Source  : Super_String;
 238       Pattern : Wide_Wide_String;
 239       Going   : Direction := Forward;
 240       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping :=
 241                   Wide_Wide_Maps.Identity)
 242       return Natural;
 243
 244    function Super_Index
 245      (Source  : Super_String;
 246       Pattern : Wide_Wide_String;
 247       Going   : Direction := Forward;
 248       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping_Function)
 249       return Natural;
 250
 251    function Super_Index
 252      (Source : Super_String;
 253       Set    : Wide_Wide_Maps.Wide_Wide_Character_Set;
 254       Test   : Membership := Inside;
 255       Going  : Direction  := Forward) return Natural;
 256
 257    function Super_Index
 258      (Source  : Super_String;
 259       Pattern : Wide_Wide_String;
 260       From    : Positive;
 261       Going   : Direction := Forward;
 262       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping :=
 263                   Wide_Wide_Maps.Identity)
 264       return Natural;
 265
 266    function Super_Index
 267      (Source  : Super_String;
 268       Pattern : Wide_Wide_String;
 269       From    : Positive;
 270       Going   : Direction := Forward;
 271       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping_Function)
 272       return Natural;
 273
 274    function Super_Index
 275      (Source : Super_String;
 276       Set    : Wide_Wide_Maps.Wide_Wide_Character_Set;
 277       From   : Positive;
 278       Test   : Membership := Inside;
 279       Going  : Direction := Forward) return Natural;
 280
 281    function Super_Index_Non_Blank
 282      (Source : Super_String;
 283       Going  : Direction := Forward) return Natural;
 284
 285    function Super_Index_Non_Blank
 286      (Source : Super_String;
 287       From   : Positive;
 288       Going  : Direction := Forward) return Natural;
 289
 290    function Super_Count
 291      (Source  : Super_String;
 292       Pattern : Wide_Wide_String;
 293       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping :=
 294                   Wide_Wide_Maps.Identity)
 295       return Natural;
 296
 297    function Super_Count
 298      (Source  : Super_String;
 299       Pattern : Wide_Wide_String;
 300       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping_Function)
 301       return Natural;
 302
 303    function Super_Count
 304      (Source : Super_String;
 305       Set    : Wide_Wide_Maps.Wide_Wide_Character_Set) return Natural;
 306
 307    procedure Super_Find_Token
 308      (Source : Super_String;
 309       Set    : Wide_Wide_Maps.Wide_Wide_Character_Set;
 310       Test   : Membership;
 311       First  : out Positive;
 312       Last   : out Natural);
 313
 314    ------------------------------------
 315    -- String Translation Subprograms --
 316    ------------------------------------
 317
 318    function Super_Translate
 319      (Source  : Super_String;
 320       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping)
 321       return Super_String;
 322
 323    procedure Super_Translate
 324      (Source   : in out Super_String;
 325       Mapping  : Wide_Wide_Maps.Wide_Wide_Character_Mapping);
 326
 327    function Super_Translate
 328      (Source  : Super_String;
 329       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping_Function)
 330       return Super_String;
 331
 332    procedure Super_Translate
 333      (Source  : in out Super_String;
 334       Mapping : Wide_Wide_Maps.Wide_Wide_Character_Mapping_Function);
 335
 336    ---------------------------------------
 337    -- String Transformation Subprograms --
 338    ---------------------------------------
 339
 340    function Super_Replace_Slice
 341      (Source : Super_String;
 342       Low    : Positive;
 343       High   : Natural;
 344       By     : Wide_Wide_String;
 345       Drop   : Truncation := Error) return Super_String;
 346
 347    procedure Super_Replace_Slice
 348      (Source  : in out Super_String;
 349       Low     : Positive;
 350       High    : Natural;
 351       By      : Wide_Wide_String;
 352       Drop    : Truncation := Error);
 353
 354    function Super_Insert
 355      (Source   : Super_String;
 356       Before   : Positive;
 357       New_Item : Wide_Wide_String;
 358       Drop     : Truncation := Error) return Super_String;
 359
 360    procedure Super_Insert
 361      (Source   : in out Super_String;
 362       Before   : Positive;
 363       New_Item : Wide_Wide_String;
 364       Drop     : Truncation := Error);
 365
 366    function Super_Overwrite
 367      (Source   : Super_String;
 368       Position : Positive;
 369       New_Item : Wide_Wide_String;
 370       Drop     : Truncation := Error) return Super_String;
 371
 372    procedure Super_Overwrite
 373      (Source    : in out Super_String;
 374       Position  : Positive;
 375       New_Item  : Wide_Wide_String;
 376       Drop      : Truncation := Error);
 377
 378    function Super_Delete
 379      (Source  : Super_String;
 380       From    : Positive;
 381       Through : Natural) return Super_String;
 382
 383    procedure Super_Delete
 384      (Source  : in out Super_String;
 385       From    : Positive;
 386       Through : Natural);
 387
 388    ---------------------------------
 389    -- String Selector Subprograms --
 390    ---------------------------------
 391
 392    function Super_Trim
 393      (Source : Super_String;
 394       Side   : Trim_End) return Super_String;
 395
 396    procedure Super_Trim
 397      (Source : in out Super_String;
 398       Side   : Trim_End);
 399
 400    function Super_Trim
 401      (Source : Super_String;
 402       Left   : Wide_Wide_Maps.Wide_Wide_Character_Set;
 403       Right  : Wide_Wide_Maps.Wide_Wide_Character_Set) return Super_String;
 404
 405    procedure Super_Trim
 406      (Source : in out Super_String;
 407       Left   : Wide_Wide_Maps.Wide_Wide_Character_Set;
 408       Right  : Wide_Wide_Maps.Wide_Wide_Character_Set);
 409
 410    function Super_Head
 411      (Source : Super_String;
 412       Count  : Natural;
 413       Pad    : Wide_Wide_Character := Wide_Wide_Space;
 414       Drop   : Truncation := Error) return Super_String;
 415
 416    procedure Super_Head
 417      (Source : in out Super_String;
 418       Count  : Natural;
 419       Pad    : Wide_Wide_Character := Wide_Wide_Space;
 420       Drop   : Truncation := Error);
 421
 422    function Super_Tail
 423      (Source : Super_String;
 424       Count  : Natural;
 425       Pad    : Wide_Wide_Character := Wide_Wide_Space;
 426       Drop   : Truncation := Error) return Super_String;
 427
 428    procedure Super_Tail
 429      (Source : in out Super_String;
 430       Count  : Natural;
 431       Pad    : Wide_Wide_Character := Wide_Wide_Space;
 432       Drop   : Truncation := Error);
 433
 434    ------------------------------------
 435    -- String Constructor Subprograms --
 436    ------------------------------------
 437
 438    --  Note: in some of the following routines, there is an extra parameter
 439    --  Max_Length which specifies the value of the maximum length for the
 440    --  resulting Super_String value.
 441
 442    function Times
 443      (Left       : Natural;
 444       Right      : Wide_Wide_Character;
 445       Max_Length : Positive) return Super_String;
 446    --  Note the additional parameter Max_Length
 447
 448    function Times
 449      (Left       : Natural;
 450       Right      : Wide_Wide_String;
 451       Max_Length : Positive) return Super_String;
 452    --  Note the additional parameter Max_Length
 453
 454    function Times
 455      (Left  : Natural;
 456       Right : Super_String) return Super_String;
 457
 458    function Super_Replicate
 459      (Count      : Natural;
 460       Item       : Wide_Wide_Character;
 461       Drop       : Truncation := Error;
 462       Max_Length : Positive) return Super_String;
 463    --  Note the additional parameter Max_Length
 464
 465    function Super_Replicate
 466      (Count      : Natural;
 467       Item       : Wide_Wide_String;
 468       Drop       : Truncation := Error;
 469       Max_Length : Positive) return Super_String;
 470    --  Note the additional parameter Max_Length
 471
 472    function Super_Replicate
 473      (Count : Natural;
 474       Item  : Super_String;
 475       Drop  : Truncation := Error) return Super_String;
 476
 477 private
 478       --  Pragma Inline declarations
 479
 480       pragma Inline ("=");
 481       pragma Inline (Less);
 482       pragma Inline (Less_Or_Equal);
 483       pragma Inline (Greater);
 484       pragma Inline (Greater_Or_Equal);
 485       pragma Inline (Concat);
 486       pragma Inline (Super_Count);
 487       pragma Inline (Super_Element);
 488       pragma Inline (Super_Find_Token);
 489       pragma Inline (Super_Index);
 490       pragma Inline (Super_Index_Non_Blank);
 491       pragma Inline (Super_Length);
 492       pragma Inline (Super_Replace_Element);
 493       pragma Inline (Super_Slice);
 494       pragma Inline (Super_To_String);
 495
 496 end Ada.Strings.Wide_Wide_Superbounded;