gnoga_2.1.2_5f127c56/src/gnoga.ads

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
------------------------------------------------------------------------------
--                                                                          --
--                   GNOGA - The GNU Omnificent GUI for Ada                 --
--                                                                          --
--                                G N O G A                                 --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--                                                                          --
--                     Copyright (C) 2014 David Botton                      --
--                                                                          --
--  This library is free software;  you can redistribute it and/or modify   --
--  it under terms of the  GNU General Public License  as published by the  --
--  Free Software  Foundation;  either version 3,  or (at your  option) any --
--  later version. This library is distributed in the hope that it will be  --
--  useful, but WITHOUT 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/>.                                         --
--                                                                          --
--  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.                                     --
--                                                                          --
--  For more information please go to http://www.gnoga.com                  --
------------------------------------------------------------------------------

with Ada.Exceptions;
with Ada.Task_Identification;
with UXStrings;
with UXStrings.Conversions;

package Gnoga is
   use UXStrings;

   subtype String is UXString;

   Version        : constant String := "2.1a";
   Version_High   : constant        := 2;
   Version_Low    : constant        := 1;
   Version_Status : constant String := "a";

   HTTP_Server_Name : constant String := "gnoga/" & Version;

   function Escape_Quotes
     (S : String)
      return String;
   --  Escape quotes for JavaScript.

   function Unescape_Quotes
     (S : String)
      return String;
   --  Unescape a string quoted for JavaScript

   function URL_Encode
     (S        : String;
      Encoding : String := "")
      return String;
   function URL_Decode
     (S        : String;
      Encoding : String := "")
      return String;
   --  Encode and decode form URL Supported encodings are ISO-8859-1 (default)
   --  and UTF-8 (typically from Input_Encoding function)

   function Left_Trim
     (S : String)
      return String;
   function Right_Trim
     (S : String)
      return String;
   --  Remove extra spaces and tabs

   function Left_Trim_Slashes
     (S : String)
      return String;
   function Right_Trim_Slashes
     (S : String)
      return String;
   --  Remove extra spaces, tabs and '/'s

   procedure String_Replace
     (Source      : in out String;
      Pattern     : in     String;
      Replacement : in     String);
   --  Replace all instances of Pattern with Replacement in Source

   procedure Write_To_Console (Message : in String);
   --  Output message to console

   procedure Log_To_File
     (File_Name  : in String;
      Flush_Auto : in Boolean := False);
   --  Redirect logging to File_Name instead of console with flushing if
   --  specified

   procedure Log (Message : in String);
   --  Output message to log

   procedure Log (Occurrence : in Ada.Exceptions.Exception_Occurrence);
   --  Output exception occurence to log

   procedure Log
     (Message    : in String;
      Occurrence : in Ada.Exceptions.Exception_Occurrence);
   --  Output message with exception occurence to log

   procedure Flush_Log;
   --  Manual flush log file

   procedure Activate_Exception_Handler (Id : Ada.Task_Identification.Task_Id);
   --  Activate exception log for the designated task

   --  Convenient string conversions of usual types
   function Value is new UXStrings.Conversions.Integer_Value (Integer);
   function Value is new UXStrings.Conversions.Floating_Point_Value (Float);
   function Image is new UXStrings.Conversions.Scalar_Image (Boolean);
   function Image is new UXStrings.Conversions.Integer_Image (Integer);
   function Image is new UXStrings.Conversions.Floating_Point_Image (Float);

end Gnoga;