source: trunk/src/engine.h @ 180

Last change on this file since 180 was 180, checked in by cameron, 11 years ago

Adding boolean more parameter to Text_Action.

File size: 7.0 KB
Line 
1/*  engine.h - parabix parsing engine
2    Copyright (c) 2007, 2008 Robert D. Cameron and Dan Lin
3    Licensed to the public under the Open Software License 3.0.
4    Licensed to International Characters, Inc., under the Academic
5    Free License 3.0.
6
7*/
8#ifndef ENGINE_H
9#define ENGINE_H
10
11#include "xmlmodel.h"
12#include "xmldecl.h"
13#include "byteplex.h"
14#include "bitlex.h"
15#include "xml_error.h"
16#include "contentmodel.h"
17#include "symtab.h"
18
19#define min(x,y) ((x) <(y) ?(x) :(y) )
20/* A ParsingEngine is the principal class for parsing XML
21data.  */
22
23class Parser_Interface {
24public:
25        ~Parser_Interface();
26        static Parser_Interface * ParserFactory(char * filename);
27        static Parser_Interface * ParserFactory(char * filename, Model_Info * m);
28        // Constructor for a subsidiary parser for internal entities.
29        static Parser_Interface * ParserFactory(char * byte_buffer, int byte_count, Entity_Info * e, Model_Info * m);
30        virtual void ParseContent() = 0;
31        virtual void Parse_DocumentContent() = 0;
32        virtual void Parse_WF_Content() = 0;
33        virtual void Parse_AnyContent() = 0;
34        virtual void Parse_MixedContent(symbol_set_t elems) = 0;
35        virtual void Parse_ValidContent(CM_RegExp * cre, int & cur_state) = 0;
36        virtual bool at_EOF() const = 0;
37        virtual void Parse_ExtSubsetDecl() = 0;
38        virtual void Parse_Prolog() = 0;
39        unsigned char * GetCodeUnitPtr(int pos);
40        bool has_ByteOrderMark();
41        XML_version get_version();
42        XML_standalone standalone_status();
43        bool has_EncodingDecl();
44        unsigned char * get_Encoding();
45        Model_Info * model_info;
46        Entity_Info * entity_Info;
47protected:
48        /* Co-classes */
49
50        Byteplex * byteplex;   
51        Bitplex * bitplex;
52        Lexer_Interface * lexer;
53        /* Parallel data streams for current buffer full of XML data. */
54        BytePack * x8data;
55        LexicalStreamSet * buf;
56               
57        int buffer_base_pos;
58        int buffer_rel_pos;
59        int buffer_limit_pos;
60       
61};
62
63template <class B>
64class ParsingEngine : public Parser_Interface {
65public:
66        ParsingEngine(Entity_Info * e, Model_Info * m, Byteplex * b, bool is_external);
67        ~ParsingEngine();
68        void ParseContent();
69protected:
70        bool StrictWellFormedness;
71
72        vector<int> LastAttOccurrence;
73        XML_Decl_Parser<B::Base> * decl_parser;
74       
75        int text_or_markup_start;
76        /* Getters for current point/position information. */
77        int AbsPos() const;
78        int LengthFrom(int start_pos) const;
79        int BufferRelPos() const;
80        unsigned char * cur() const;
81        unsigned char * GetCodeUnitPtr(int pos);
82
83        bool at_EOF () const;
84        /*Internal helper for text action*/
85        void text_if_nonnull_action(bool more);
86        /* Mutators that advance the input. */
87        void Advance(int n);
88        void ScanTo(int lex_item);
89        void ScanToMarkupStart();  // Specialized version.
90        void ScanToCD_End_check(); // Specialized version.
91        void AdjustBufferEndForIncompleteSequences();
92        void AdvanceBuffers();
93        /* Parsing routines. */
94
95        void WF_Error (XML_Constraint errCode);
96        void Validity_Error (XML_Constraint errCode);
97        void Syntax_Error (XML_NonTerminal errNT);
98       
99        void Parse_Comment ();
100        void Parse_StartTag ();
101        void Parse_EndTag ();
102        void Parse_CDATA ();
103        void Parse_PI ();
104        void Parse_CharRef (); 
105        void Parse_EntityRef ();
106        void Parse_EntityRef_inMixed(symbol_set_t elems);
107        void Parse_EntityRef_inAnyContent();
108       
109        /* Parsing routine for Document Type*/
110        void Parse_DocType ();
111        void Parse_ExternalID (char *& SystemLiteral, char *& PubidLiteral);
112        void Parse_SystemLiteral ();
113        void Parse_PubidLiteral ();
114        void Parse_IntSubset ();
115        void Parse_PEReference ();
116        void Parse_Elementdecl ();
117        ContentModel * Parse_RemainingMixed ();
118        Content_RE * Parse_RemainingChildren ();
119        Content_RE * Parse_Cp();
120        void Parse_AttlistDecl ();
121        void Parse_Notation (ATT_info * this_info);
122        void Parse_Enumeration (ATT_info * this_info);
123        void Parse_DefaultDecl (ATT_info * this_info);
124        void Parse_Entitydecl ();
125        void Parse_Notationdecl ();
126        void requireWS ();
127        void Parse_AttValue ();
128        void Parse_GEntityValue(GEntity_info * this_info);
129        void Parse_PEntityValue(PEntity_info * this_info);
130        char * Replace_EntityRef(bool& is_simple);
131        char * Replace_CharRef();
132        void Parse_Prolog();
133        void Parse_DocumentContent();
134       
135        void Parse_WF_Element();
136        void Parse_WF_Content();
137        int Parse_WF_StartTag(bool& is_empty);
138        void Parse_WF_EndTag(int nameID);
139
140        void Parse_ValidEntityRef(CM_RegExp * cre, int & cur_state);
141        int Parse_ValidElement();
142        void Parse_ValidContent(CM_RegExp * cre, int & cur_state);
143        void Parse_AnyContent();
144        void Parse_MixedContent(symbol_set_t elems);
145       
146        int Parse_ValidStartTag(bool& is_empty);
147       
148        int Parse_Nmtoken();
149        int Parse_Name(); 
150       
151        /*Parsing routine for external entities*/
152        void Parse_ExtSubsetDecl ();
153       
154        /* Action routine for document start. */
155        void DocumentStart_action();   
156       
157        /* Action routine for document end. */
158        void DocumentEnd_action();
159       
160        /* Action routine for an XML comment in "<!--"  "-->" brackets. */
161        void Comment_action(unsigned char * item, int lgth);
162       
163        /* Action routine called upon recognizing "<![CDATA[" to start a CDATA section. */
164        void CDATA_start_action(unsigned char * CDATA_ptr);
165
166        /* Action routine called upon recognizing "]]>" to end a CDATA section. */
167        void CDATA_end_action(unsigned char * CDATA_end_ptr);
168       
169        /* Action routine for an XML processing instruction enclosed in "<?" and "?>" brackets. */
170        void PI_action(unsigned char * item, int lgth);
171       
172        /* Action routine for an empty element enclosed in "<" and "/>" brackets. */
173        void EmptyElement_action(unsigned char * item, int lgth);
174       
175        /* Action routine for a start tag enclosed in "<" and ">" brackets. */
176        void StartTag_action(unsigned char * item, int lgth);
177       
178        /* Action routine for an end tag enclosed in "</" and ">" brackets. */
179        void EndTag_action(unsigned char * item, int lgth);
180       
181        /* Action routine for an error item */
182        void Error_action(unsigned char * item, int lgth);
183       
184        /* Action routine for a text item */
185        void Text_action(unsigned char * item, int lgth, bool more);
186       
187        /* Action routine for a character or entity reference.*/
188        void Reference_action(unsigned char * item, int lgth);
189       
190        /* Action routine for an element name occurring immediately after the
191        opening "<" of a start tag or empty element tag. */
192        void ElementName_action(unsigned char * item, int lgth);
193       
194        /* Action routine for a processing instruction target name occurring immediately
195        after the opening "<?" of a processing instruction. */
196        void PI_Target_action(unsigned char * item, int lgth);
197       
198        /* Action routine for an individual attribute/value pair occurring in
199        a element start tag or an empty element tag. */
200        void AttributeValue_action(unsigned char * name, int name_lgth, 
201                                   unsigned char * val, int val_lgth);
202       
203        /* Action routine for an individual namespace binding occurring in
204        a element start tag or an empty element tag. */
205        void Namespace_action(unsigned char * name, int name_end, 
206                              unsigned char * URI, int URI_end);
207       
208        /*Action routine for end of buffer events. */
209        void FinalizeBuffer_action();
210       
211        /*Document Type actions.*/
212        void Doctype_action(unsigned char * item, int lgth);
213        void PEReference_action(unsigned char * item, int lgth);
214       
215        void Prolog_action(unsigned char * item, int lgth);
216       
217        void ExtSubsetDecl_action(unsigned char * item, int lgth);
218};
219
220
221#endif
Note: See TracBrowser for help on using the repository browser.