source: trunk/src/engine.h @ 1932

Last change on this file since 1932 was 386, checked in by ksherdy, 9 years ago

Add commented out interface method to support GML2SVG demo.

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