--  Copyright (2008-2011) Cédric Coussinet (cedric.coussinet@nomoseed.net)
--
--  This program is free software: you can redistribute it and/or modify
--  it under the terms of the GNU Affero General Public License as published
--  by the Free Software Foundation, either version 3 of the License, or
--  (at your option) any later version.
--
--  This program 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 Affero General Public License for more details.

--  You should have received a copy of the GNU Affero General Public License
--  along with this program. If not, see <http://www.gnu.org/licenses/>

--  Ce composant permet d'analyser un fichier xml avec différent type
--  d'analyseur ou d'en analyser qu'une partie seulement.
--  Cette souplesse implique l'utilisation de flots de donnée ("Stream") de
--  sorte que ce composant ne gère ni l'ouverture ni la fermeture du fichier.

with Ada.Streams;

package Basic_Sax.Stream_Parser is

   type Reader (Stream : access Ada.Streams.Root_Stream_Type'Class) is tagged limited null record;

   procedure Start_Element (Handler : in out Reader;
                            Name    : in String;
                            A       : in Attributes) is null;
   --  Procédure à surcharger.
   --  Appellée à chaque balise ouvrante rencontrée
   --  ainsi que pour chaque balise singluière.

   procedure End_Element (Handler : in out Reader;
                          Name    : in String) is null;
   --  Procédure à surcharger.
   --  Appellée à chaque balise fermante rencontrée.

   procedure Characters (Handler : in out Reader;
                         Data    : in String) is null;
   --  Procédure à surcharger.
   --  Appellée lorque des charactères entre balises sont rencontrées.

   procedure Parse (Handler    : in out Reader'Class;
                    End_Marker : in String);
   --  Analyse le "Stream" jusqu'à ce que la balise "End_Marker"
   --  soit identifiée.

   procedure Move_At (Handler : in out Reader'Class;
                      Begin_Marker : in String);
   --  Place le "Reader" sur la première balise "Begin_Marker".

end Basic_Sax.Stream_Parser;
