-------------------------------------------------------------------------------
--
--  Copyright (C) 2009, 2010, 2013, 2014 Stephe Leake
--  Copyright (C) 1999 FlightSafety International and Ted Dennison
--
--  This file is part of the OpenToken package.
--
--  The OpenToken package is free software; you can redistribute it
--  and/or modify it under the terms of the GNU General Public License
--  as published by the Free Software Foundation; either version 3, or
--  (at your option) any later version. The OpenToken package 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. See the GNU General Public
--  License for more details. You should have received a copy of the
--  GNU General Public License distributed with the OpenToken package;
--  see file GPL.txt. If not, write to the Free Software Foundation,
--  59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
--
--  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.
--
--  This software was originally developed by the following company,
--  and was released as open-source software as a service to the
--  community:
--
--           FlightSafety International Simulation Systems Division
--                    Broken Arrow, OK  USA  918-259-4000
--
-------------------------------------------------------------------------------

with Ada.Characters.Latin_1;
with Ada.Strings.Bounded;

-------------------------------------------------------------------------------
--  This package hierarchy implements a mostly full-strength parser.
-------------------------------------------------------------------------------
package OpenToken is

   Syntax_Error : exception; -- no token matching current input could be found.

   Parse_Error : exception; -- Input does not conform to the grammar

   Grammar_Error : exception; -- Grammar is not consistent (ie unused tokens, missing productions)

   User_Error : exception; -- other user error (ie command line parameter)

   Programmer_Error : exception; --  a programming convention has been violated

   --  We use this regardless of OS, since we need a standard way of
   --  representing an end of line in a string buffer
   EOL_Character : constant Character := Ada.Characters.Latin_1.CR;

   --  Similarly, this is independent of OS
   EOF_Character : constant Character := Ada.Characters.Latin_1.EOT;

   --  The maximum length of some things.
   --  FIXME: currently only used in recognizers.string (directly), keyword, separator (via Buffers)
   --  Add independent lengths to those in Get, with more reasonable defaults
   Max_String_Length : constant := 1024;

   package Buffers is new Ada.Strings.Bounded.Generic_Bounded_Length (Max_String_Length);

   ----------------------------------------------------------------------
   --  If Trace_Parse > 0, Parse prints helpful messages; higher value
   --  prints more.
   ----------------------------------------------------------------------
   Trace_Parse : Integer := 0;

   --  Put Message, indented by 3 * Trace_Indent; no new_line
   procedure Trace_Put (Message : in String);

   function Int_Image (Item : in Integer) return String;
   --  No leading space

private
   Trace_Indent : Integer := 0;
end OpenToken;