blob: c793703b39a768d7434a2063de07e3626e61a6fe [file] [log] [blame]
------------------------------------------------------------------------------
-- --
-- GNAT RUN-TIME COMPONENTS --
-- --
-- S Y S T E M . C A S E _ U T I L --
-- --
-- S p e c --
-- --
-- Copyright (C) 1995-2023, Free Software Foundation, Inc. --
-- --
-- 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 3, 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. --
-- --
-- As a special exception under Section 7 of GPL version 3, you are granted --
-- additional permissions described in the GCC Runtime Library Exception, --
-- version 3.1, as published by the Free Software Foundation. --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
-- Simple casing functions
-- This package provides simple casing functions that do not require the
-- overhead of the full casing tables found in Ada.Characters.Handling.
-- Preconditions in this unit are meant for analysis only, not for run-time
-- checking, so that the expected exceptions are raised. This is enforced by
-- setting the corresponding assertion policy to Ignore. Postconditions and
-- contract cases should not be executed at runtime as well, in order not to
-- slow down the execution of these functions.
pragma Assertion_Policy (Pre => Ignore,
Post => Ignore,
Contract_Cases => Ignore,
Ghost => Ignore);
package System.Case_Util
with Pure, SPARK_Mode
is
-- Note: all the following functions handle the full Latin-1 set
function To_Upper (A : Character) return Character
with
Post => (declare
A_Val : constant Natural := Character'Pos (A);
begin
(if A in 'a' .. 'z'
or else A_Val in 16#E0# .. 16#F6#
or else A_Val in 16#F8# .. 16#FE#
then
To_Upper'Result = Character'Val (A_Val - 16#20#)
else
To_Upper'Result = A));
-- Converts A to upper case if it is a lower case letter, otherwise
-- returns the input argument unchanged.
procedure To_Upper (A : in out String)
with
Post => (for all J in A'Range => A (J) = To_Upper (A'Old (J)));
function To_Upper (A : String) return String
with
Post => To_Upper'Result'First = A'First
and then To_Upper'Result'Last = A'Last
and then (for all J in A'Range =>
To_Upper'Result (J) = To_Upper (A (J)));
-- Folds all characters of string A to upper case
function To_Lower (A : Character) return Character
with
Post => (declare
A_Val : constant Natural := Character'Pos (A);
begin
(if A in 'A' .. 'Z'
or else A_Val in 16#C0# .. 16#D6#
or else A_Val in 16#D8# .. 16#DE#
then
To_Lower'Result = Character'Val (A_Val + 16#20#)
else
To_Lower'Result = A));
-- Converts A to lower case if it is an upper case letter, otherwise
-- returns the input argument unchanged.
procedure To_Lower (A : in out String)
with
Post => (for all J in A'Range => A (J) = To_Lower (A'Old (J)));
function To_Lower (A : String) return String
with
Post => To_Lower'Result'First = A'First
and then To_Lower'Result'Last = A'Last
and then (for all J in A'Range =>
To_Lower'Result (J) = To_Lower (A (J)));
-- Folds all characters of string A to lower case
procedure To_Mixed (A : in out String)
with
Post =>
(for all J in A'Range =>
(if J = A'First
or else A'Old (J - 1) = '_'
then
A (J) = To_Upper (A'Old (J))
else
A (J) = To_Lower (A'Old (J))));
function To_Mixed (A : String) return String
with
Post => To_Mixed'Result'First = A'First
and then To_Mixed'Result'Last = A'Last
and then (for all J in A'Range =>
(if J = A'First
or else A (J - 1) = '_'
then
To_Mixed'Result (J) = To_Upper (A (J))
else
To_Mixed'Result (J) = To_Lower (A (J))));
-- Converts A to mixed case (i.e. lower case, except for initial
-- character and any character after an underscore, which are
-- converted to upper case.
end System.Case_Util;