home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / gnat-2.06-src.tgz / tar.out / fsf / gnat / ada / a-stwiun.ads < prev    next >
Text File  |  1996-09-28  |  11KB  |  371 lines
  1. ------------------------------------------------------------------------------
  2. --                                                                          --
  3. --                         GNAT RUNTIME COMPONENTS                          --
  4. --                                                                          --
  5. --           A D A . S T R I N G S . W I D E _ U N B O U N D E D            --
  6. --                                                                          --
  7. --                                 S p e c                                  --
  8. --                                                                          --
  9. --                            $Revision: 1.5 $                              --
  10. --                                                                          --
  11. --           Copyright (c) 1992,1993,1994 NYU, All Rights Reserved          --
  12. --                                                                          --
  13. -- This specification is adapted from the Ada Reference Manual for use with --
  14. -- GNAT.  In accordance with the copyright of that document, you can freely --
  15. -- copy and modify this specification,  provided that if you redistribute a --
  16. -- modified version,  any changes that you have made are clearly indicated. --
  17. --                                                                          --
  18. ------------------------------------------------------------------------------
  19.  
  20. with Ada.Strings.Wide_Maps;
  21.  
  22. package Ada.Strings.Wide_Unbounded is
  23. pragma Preelaborate (Wide_Unbounded);
  24.  
  25.    type Unbounded_Wide_String is private;
  26.  
  27.    Null_Unbounded_Wide_String : constant Unbounded_Wide_String;
  28.  
  29.    function Length (Source : Unbounded_Wide_String) return Natural;
  30.  
  31.    type Wide_String_Access is access all Wide_String;
  32.  
  33.    procedure Free (X : in out Wide_String_Access);
  34.  
  35.    --------------------------------------------------------
  36.    -- Conversion, Concatenation, and Selection Functions --
  37.    --------------------------------------------------------
  38.  
  39.    function To_Unbounded_Wide_String
  40.      (Source : Wide_String)
  41.       return   Unbounded_Wide_String;
  42.  
  43.    function To_Unbounded_Wide_String
  44.      (Length : in Natural)
  45.       return   Unbounded_Wide_String;
  46.  
  47.    function To_Wide_String
  48.      (Source : Unbounded_Wide_String)
  49.       return   Wide_String;
  50.  
  51.    procedure Append
  52.      (Source   : in out Unbounded_Wide_String;
  53.       New_Item : in Unbounded_Wide_String);
  54.  
  55.    procedure Append
  56.      (Source   : in out Unbounded_Wide_String;
  57.       New_Item : in Wide_String);
  58.  
  59.    procedure Append
  60.      (Source   : in out Unbounded_Wide_String;
  61.       New_Item : in Wide_Character);
  62.  
  63.    function "&"
  64.      (Left, Right : Unbounded_Wide_String)
  65.       return        Unbounded_Wide_String;
  66.  
  67.    function "&"
  68.      (Left  : in Unbounded_Wide_String;
  69.       Right : in Wide_String)
  70.       return  Unbounded_Wide_String;
  71.  
  72.    function "&"
  73.      (Left  : in Wide_String;
  74.       Right : in Unbounded_Wide_String)
  75.       return  Unbounded_Wide_String;
  76.  
  77.    function "&"
  78.      (Left  : in Unbounded_Wide_String;
  79.       Right : in Wide_Character)
  80.       return  Unbounded_Wide_String;
  81.  
  82.    function "&"
  83.      (Left  : in Wide_Character;
  84.       Right : in Unbounded_Wide_String)
  85.       return  Unbounded_Wide_String;
  86.  
  87.    function Element
  88.      (Source : in Unbounded_Wide_String;
  89.       Index  : in Positive)
  90.       return   Wide_Character;
  91.  
  92.    procedure Replace_Element
  93.      (Source : in out Unbounded_Wide_String;
  94.       Index  : in Positive;
  95.       By     : Wide_Character);
  96.  
  97.    function Slice
  98.      (Source : in Unbounded_Wide_String;
  99.       Low    : in Positive;
  100.       High   : in Natural)
  101.       return   Wide_String;
  102.  
  103.    function "="
  104.      (Left  : in Unbounded_Wide_String;
  105.       Right : in Unbounded_Wide_String)
  106.       return  Boolean;
  107.  
  108.    function "="
  109.      (Left  : in Unbounded_Wide_String;
  110.       Right : in Wide_String)
  111.       return  Boolean;
  112.  
  113.    function "="
  114.      (Left  : in Wide_String;
  115.       Right : in Unbounded_Wide_String)
  116.       return  Boolean;
  117.  
  118.    function "<"
  119.      (Left  : in Unbounded_Wide_String;
  120.       Right : in Unbounded_Wide_String)
  121.       return  Boolean;
  122.  
  123.    function "<"
  124.      (Left  : in Unbounded_Wide_String;
  125.       Right : in Wide_String)
  126.       return  Boolean;
  127.  
  128.    function "<"
  129.      (Left  : in Wide_String;
  130.       Right : in Unbounded_Wide_String)
  131.       return  Boolean;
  132.  
  133.    function "<="
  134.      (Left  : in Unbounded_Wide_String;
  135.       Right : in Unbounded_Wide_String)
  136.       return  Boolean;
  137.  
  138.    function "<="
  139.      (Left  : in Unbounded_Wide_String;
  140.       Right : in Wide_String)
  141.       return  Boolean;
  142.  
  143.    function "<="
  144.      (Left  : in Wide_String;
  145.       Right : in Unbounded_Wide_String)
  146.       return  Boolean;
  147.  
  148.    function ">"
  149.      (Left  : in Unbounded_Wide_String;
  150.       Right : in Unbounded_Wide_String)
  151.       return  Boolean;
  152.  
  153.    function ">"
  154.      (Left  : in Unbounded_Wide_String;
  155.       Right : in Wide_String)
  156.       return  Boolean;
  157.  
  158.    function ">"
  159.      (Left  : in Wide_String;
  160.       Right : in Unbounded_Wide_String)
  161.       return  Boolean;
  162.  
  163.    function ">="
  164.      (Left  : in Unbounded_Wide_String;
  165.       Right : in Unbounded_Wide_String)
  166.       return  Boolean;
  167.  
  168.    function ">="
  169.      (Left  : in Unbounded_Wide_String;
  170.       Right : in Wide_String)
  171.       return  Boolean;
  172.  
  173.    function ">="
  174.      (Left  : in Wide_String;
  175.       Right : in Unbounded_Wide_String)
  176.       return  Boolean;
  177.  
  178.    ------------------------
  179.    -- Search Subprograms --
  180.    ------------------------
  181.  
  182.    function Index
  183.      (Source   : in Unbounded_Wide_String;
  184.       Pattern  : in Wide_String;
  185.       Going    : in Direction := Forward;
  186.       Mapping  : in Wide_Maps.Wide_Character_Mapping := Wide_Maps.Identity)
  187.       return     Natural;
  188.  
  189.    function Index
  190.      (Source   : in Unbounded_Wide_String;
  191.       Pattern  : in Wide_String;
  192.       Going    : in Direction := Forward;
  193.       Mapping  : in Wide_Maps.Wide_Character_Mapping_Function)
  194.       return     Natural;
  195.  
  196.    function Index
  197.      (Source : in Unbounded_Wide_String;
  198.       Set    : in Wide_Maps.Wide_Character_Set;
  199.       Test   : in Membership := Inside;
  200.       Going  : in Direction  := Forward)
  201.       return   Natural;
  202.  
  203.    function Index_Non_Blank
  204.      (Source : in Unbounded_Wide_String;
  205.       Going  : in Direction := Forward)
  206.       return   Natural;
  207.  
  208.    function Count
  209.      (Source  : in Unbounded_Wide_String;
  210.       Pattern : in Wide_String;
  211.       Mapping : in Wide_Maps.Wide_Character_Mapping := Wide_Maps.Identity)
  212.       return    Natural;
  213.  
  214.    function Count
  215.      (Source   : in Unbounded_Wide_String;
  216.       Pattern  : in Wide_String;
  217.       Mapping  : in Wide_Maps.Wide_Character_Mapping_Function)
  218.       return     Natural;
  219.  
  220.    function Count
  221.      (Source : in Unbounded_Wide_String;
  222.       Set    : in Wide_Maps.Wide_Character_Set)
  223.       return   Natural;
  224.  
  225.    procedure Find_Token
  226.      (Source : in Unbounded_Wide_String;
  227.       Set    : in Wide_Maps.Wide_Character_Set;
  228.       Test   : in Membership;
  229.       First  : out Positive;
  230.       Last   : out Natural);
  231.  
  232.    ------------------------------------
  233.    -- Wide_String Translation Subprograms --
  234.    ------------------------------------
  235.  
  236.    function Translate
  237.      (Source  : in Unbounded_Wide_String;
  238.       Mapping : in Wide_Maps.Wide_Character_Mapping)
  239.       return    Unbounded_Wide_String;
  240.  
  241.    procedure Translate
  242.      (Source  : in out Unbounded_Wide_String;
  243.       Mapping : Wide_Maps.Wide_Character_Mapping);
  244.  
  245.    function Translate
  246.      (Source  : in Unbounded_Wide_String;
  247.       Mapping : in Wide_Maps.Wide_Character_Mapping_Function)
  248.       return    Unbounded_Wide_String;
  249.  
  250.    procedure Translate
  251.      (Source  : in out Unbounded_Wide_String;
  252.       Mapping : in Wide_Maps.Wide_Character_Mapping_Function);
  253.  
  254.    ---------------------------------------
  255.    -- Wide_String Transformation Subprograms --
  256.    ---------------------------------------
  257.  
  258.    function Replace_Slice
  259.      (Source : in Unbounded_Wide_String;
  260.       Low    : in Positive;
  261.       High   : in Natural;
  262.       By     : in Wide_String)
  263.       return   Unbounded_Wide_String;
  264.  
  265.    procedure Replace_Slice
  266.      (Source   : in out Unbounded_Wide_String;
  267.       Low      : in Positive;
  268.       High     : in Natural;
  269.       By       : in Wide_String);
  270.  
  271.    function Insert
  272.      (Source   : in Unbounded_Wide_String;
  273.       Before   : in Positive;
  274.       New_Item : in Wide_String)
  275.       return     Unbounded_Wide_String;
  276.  
  277.    procedure Insert
  278.      (Source   : in out Unbounded_Wide_String;
  279.       Before   : in Positive;
  280.       New_Item : in Wide_String);
  281.  
  282.    function Overwrite
  283.      (Source   : in Unbounded_Wide_String;
  284.       Position : in Positive;
  285.       New_Item : in Wide_String)
  286.       return     Unbounded_Wide_String;
  287.  
  288.    procedure Overwrite
  289.      (Source    : in out Unbounded_Wide_String;
  290.       Position  : in Positive;
  291.       New_Item  : in Wide_String);
  292.  
  293.    function Delete
  294.      (Source  : in Unbounded_Wide_String;
  295.       From    : in Positive;
  296.       Through : in Natural)
  297.       return    Unbounded_Wide_String;
  298.  
  299.    procedure Delete
  300.      (Source  : in out Unbounded_Wide_String;
  301.       From    : in Positive;
  302.       Through : in Natural);
  303.  
  304.    function Trim
  305.      (Source : in Unbounded_Wide_String;
  306.       Side   : in Trim_End)
  307.       return   Unbounded_Wide_String;
  308.  
  309.    procedure Trim
  310.      (Source : in out Unbounded_Wide_String;
  311.       Side   : in Trim_End);
  312.  
  313.    function Trim
  314.      (Source : in Unbounded_Wide_String;
  315.       Left   : in Wide_Maps.Wide_Character_Set;
  316.       Right  : in Wide_Maps.Wide_Character_Set)
  317.       return   Unbounded_Wide_String;
  318.  
  319.    procedure Trim
  320.      (Source : in out Unbounded_Wide_String;
  321.       Left   : in Wide_Maps.Wide_Character_Set;
  322.       Right  : in Wide_Maps.Wide_Character_Set);
  323.  
  324.    function Head
  325.      (Source : in Unbounded_Wide_String;
  326.       Count  : in Natural;
  327.       Pad    : in Wide_Character := Wide_Space)
  328.       return   Unbounded_Wide_String;
  329.  
  330.    procedure Head
  331.      (Source : in out Unbounded_Wide_String;
  332.       Count  : in Natural;
  333.       Pad    : in Wide_Character := Wide_Space);
  334.  
  335.    function Tail
  336.      (Source : in Unbounded_Wide_String;
  337.       Count  : in Natural;
  338.       Pad    : in Wide_Character := Wide_Space)
  339.       return   Unbounded_Wide_String;
  340.  
  341.    procedure Tail
  342.      (Source : in out Unbounded_Wide_String;
  343.       Count  : in Natural;
  344.       Pad    : in Wide_Character := Wide_Space);
  345.  
  346.    function "*"
  347.      (Left  : in Natural;
  348.       Right : in Wide_Character)
  349.       return  Unbounded_Wide_String;
  350.  
  351.    function "*"
  352.      (Left  : in Natural;
  353.       Right : in Wide_String)
  354.       return  Unbounded_Wide_String;
  355.  
  356.    function "*"
  357.      (Left  : in Natural;
  358.       Right : in Unbounded_Wide_String)
  359.       return  Unbounded_Wide_String;
  360.  
  361. private
  362.  
  363.    type Unbounded_Wide_String is record
  364.       Reference : Wide_String_Access := new Wide_String'("");
  365.    end record;
  366.  
  367.    Null_Unbounded_Wide_String : constant Unbounded_Wide_String :=
  368.                              (Reference => new Wide_String'(""));
  369.  
  370. end Ada.Strings.Wide_Unbounded;
  371.