gcc/ada/a-zchhan.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --    A D A . W I D E _ W I D E _ C H A R A C T E R S . H A N D L I N G     --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 -- This specification is derived from the Ada Reference Manual for use with --
  10 -- GNAT.  In accordance with the copyright of that document, you can freely --
  11 -- copy and modify this specification,  provided that if you redistribute a --
  12 -- modified version,  any changes that you have made are clearly indicated. --
  13 --                                                                          --
  14 ------------------------------------------------------------------------------
  15
  16 package Ada.Wide_Wide_Characters.Handling is
  17
  18    function Is_Control (Item : Wide_Wide_Character) return Boolean;
  19    pragma Inline (Is_Control);
  20    --  Returns True if the Wide_Wide_Character designated by Item is
  21    --  categorized as other_control, otherwise returns false.
  22
  23    function Is_Letter (Item : Wide_Wide_Character) return Boolean;
  24    pragma Inline (Is_Letter);
  25    --  Returns True if the Wide_Wide_Character designated by Item is
  26    --  categorized as letter_uppercase, letter_lowercase, letter_titlecase,
  27    --  letter_modifier, letter_other, or number_letter. Otherwise returns
  28    --  false.
  29
  30    function Is_Lower (Item : Wide_Wide_Character) return Boolean;
  31    pragma Inline (Is_Lower);
  32    --  Returns True if the Wide_Wide_Character designated by Item is
  33    --  categorized as letter_lowercase, otherwise returns false.
  34
  35    function Is_Upper (Item : Wide_Wide_Character) return Boolean;
  36    pragma Inline (Is_Upper);
  37    --  Returns True if the Wide_Wide_Character designated by Item is
  38    --  categorized as letter_uppercase, otherwise returns false.
  39
  40    function Is_Digit (Item : Wide_Wide_Character) return Boolean;
  41    pragma Inline (Is_Digit);
  42    --  Returns True if the Wide_Wide_Character designated by Item is
  43    --  categorized as number_decimal, otherwise returns false.
  44
  45    function Is_Decimal_Digit (Item : Wide_Wide_Character) return Boolean
  46      renames Is_Digit;
  47
  48    function Is_Hexadecimal_Digit (Item : Wide_Wide_Character) return Boolean;
  49    --  Returns True if the Wide_Wide_Character designated by Item is
  50    --  categorized as number_decimal, or is in the range 'A' .. 'F' or
  51    --  'a' .. 'f', otherwise returns false.
  52
  53    function Is_Alphanumeric (Item : Wide_Wide_Character) return Boolean;
  54    pragma Inline (Is_Alphanumeric);
  55    --  Returns True if the Wide_Wide_Character designated by Item is
  56    --  categorized as letter_uppercase, letter_lowercase, letter_titlecase,
  57    --  letter_modifier, letter_other, number_letter, or number_decimal.
  58    --  Otherwise returns false.
  59
  60    function Is_Special (Item : Wide_Wide_Character) return Boolean;
  61    pragma Inline (Is_Special);
  62    --  Returns True if the Wide_Wide_Character designated by Item
  63    --  is categorized as graphic_character, but not categorized as
  64    --  letter_uppercase, letter_lowercase, letter_titlecase, letter_modifier,
  65    --  letter_other, number_letter, or number_decimal. Otherwise returns false.
  66
  67    function Is_Line_Terminator (Item : Wide_Wide_Character) return Boolean;
  68    pragma Inline (Is_Line_Terminator);
  69    --  Returns True if the Wide_Wide_Character designated by Item is
  70    --  categorized as separator_line or separator_paragraph, or if Item is a
  71    --  conventional line terminator character (CR, LF, VT, or FF). Otherwise
  72    --  returns false.
  73
  74    function Is_Mark (Item : Wide_Wide_Character) return Boolean;
  75    pragma Inline (Is_Mark);
  76    --  Returns True if the Wide_Wide_Character designated by Item is
  77    --  categorized as mark_non_spacing or mark_spacing_combining, otherwise
  78    --  returns false.
  79
  80    function Is_Other (Item : Wide_Wide_Character) return Boolean;
  81    pragma Inline (Is_Other);
  82    --  Returns True if the Wide_Wide_Character designated by Item is
  83    --  categorized as other_format, otherwise returns false.
  84
  85    function Is_Punctuation (Item : Wide_Wide_Character) return Boolean;
  86    pragma Inline (Is_Punctuation);
  87    --  Returns True if the Wide_Wide_Character designated by Item is
  88    --  categorized as punctuation_connector, otherwise returns false.
  89
  90    function Is_Space (Item : Wide_Wide_Character) return Boolean;
  91    pragma Inline (Is_Space);
  92    --  Returns True if the Wide_Wide_Character designated by Item is
  93    --  categorized as separator_space, otherwise returns false.
  94
  95    function Is_Graphic (Item : Wide_Wide_Character) return Boolean;
  96    pragma Inline (Is_Graphic);
  97    --  Returns True if the Wide_Wide_Character designated by Item is
  98    --  categorized as graphic_character, otherwise returns false.
  99
 100    function To_Lower (Item : Wide_Wide_Character) return Wide_Wide_Character;
 101    pragma Inline (To_Lower);
 102    --  Returns the Simple Lowercase Mapping of the Wide_Wide_Character
 103    --  designated by Item. If the Simple Lowercase Mapping does not exist for
 104    --  the Wide_Wide_Character designated by Item, then the value of Item is
 105    --  returned.
 106
 107    function To_Lower (Item : Wide_Wide_String) return Wide_Wide_String;
 108    --  Returns the result of applying the To_Lower Wide_Wide_Character to
 109    --  Wide_Wide_Character conversion to each element of the Wide_Wide_String
 110    --  designated by Item. The result is the null Wide_Wide_String if the value
 111    --  of the formal parameter is the null Wide_Wide_String.
 112
 113    function To_Upper (Item : Wide_Wide_Character) return Wide_Wide_Character;
 114    pragma Inline (To_Upper);
 115    --  Returns the Simple Uppercase Mapping of the Wide_Wide_Character
 116    --  designated by Item. If the Simple Uppercase Mapping does not exist for
 117    --  the Wide_Wide_Character designated by Item, then the value of Item is
 118    --  returned.
 119
 120    function To_Upper (Item : Wide_Wide_String) return Wide_Wide_String;
 121    --  Returns the result of applying the To_Upper Wide_Wide_Character to
 122    --  Wide_Wide_Character conversion to each element of the Wide_Wide_String
 123    --  designated by Item. The result is the null Wide_Wide_String if the value
 124    --  of the formal parameter is the null Wide_Wide_String.
 125
 126 end Ada.Wide_Wide_Characters.Handling;