source: trunk/src/engine.h @ 174

Last change on this file since 174 was 174, checked in by lindanl, 11 years ago

Nmtokens.

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