source: icXML/icXML-devel/src/icxercesc/internal/ReaderMgr.hpp @ 2720

Last change on this file since 2720 was 2720, checked in by cameron, 6 years ago

Initial check-in of icXML 0.8 source files

File size: 14.6 KB
Line 
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements.  See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License.  You may obtain a copy of the License at
8 *
9 *      http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id: ReaderMgr.hpp 833045 2009-11-05 13:21:27Z borisk $
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_READERMGR_HPP)
23#define XERCESC_INCLUDE_GUARD_READERMGR_HPP
24
25#include <xercesc/util/PlatformUtils.hpp>
26#include <xercesc/util/RefStackOf.hpp>
27#include <xercesc/sax/Locator.hpp>
28#include <xercesc/framework/XMLBuffer.hpp>
29#include <xercesc/internal/XMLReader.hpp>
30
31XERCES_CPP_NAMESPACE_BEGIN
32
33#if 1
34
35class XMLEntityDecl;
36class XMLEntityHandler;
37class XMLDocumentHandler;
38class IGXMLScanner;
39#if !defined(XERCESC_INCLUDE_GUARD_XMLSCANNER_HPP)
40class XMLScanner;
41#endif
42
43// ---------------------------------------------------------------------------
44//  This class is used by the scanner. The scanner must deal with expansion
45//  of entities, some of which are totally different files (external parsed
46//  entities.) It does so by pushing readers onto a stack. The top reader is
47//  the one it wants to read out of, but that one must be popped when it is
48//  empty. To keep that logic from being all over the place, the scanner
49//  talks to the reader manager, which handles the stack and popping off
50//  used up readers.
51// ---------------------------------------------------------------------------
52class XMLPARSER_EXPORT ReaderMgr :   public XMemory
53                                                                   , public Locator
54{
55        template<class XMLScanner> friend class XMLParserImpl;
56        friend class XMLScanner;
57        friend class IGXMLScanner;
58
59public :
60        // -----------------------------------------------------------------------
61        //  Class specific types
62        // -----------------------------------------------------------------------
63        struct LastExtEntityInfo : public XMemory
64        {
65                const   XMLCh*          systemId;
66                const   XMLCh*          publicId;
67                                XMLFileLoc      lineNumber;
68                                XMLFileLoc      colNumber;
69        };
70
71
72        // -----------------------------------------------------------------------
73        //  Constructors and Destructor
74        // -----------------------------------------------------------------------
75        ReaderMgr(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
76        ~ReaderMgr();
77
78
79        // -----------------------------------------------------------------------
80        //  Convenience scanning methods
81        //
82        //  This are all convenience methods that work in terms of the core
83        //  character spooling methods.
84        // -----------------------------------------------------------------------
85        bool atEOF() const;
86        bool getName(XMLBuffer& toFill);
87        bool getQName(XMLBuffer& toFill, int* colonPosition);
88        bool getNameToken(XMLBuffer& toFill);
89        XMLCh getNextChar();
90        bool getNextCharIfNot(const XMLCh chNotToGet, XMLCh& chGotten);
91        void movePlainContentChars(XMLBuffer &dest);
92        void getSpaces(XMLBuffer& toFill);
93        void getUpToCharOrWS(XMLBuffer& toFill, const XMLCh toCheck);
94        bool isEmpty() const;
95        bool lookingAtChar(const XMLCh toCheck);
96        bool lookingAtSpace();
97        XMLCh peekNextChar();
98        bool skipIfQuote(XMLCh& chGotten);
99        void skipPastChar(const XMLCh toSkip);
100        void skipPastSpaces(bool& skippedSomething, bool inDecl = false);
101        void skipPastSpaces();
102        void skipToChar(const XMLCh toSkipTo);
103        bool skippedChar(const XMLCh toSkip);
104        bool skippedSpace();
105        bool skippedString(const XMLCh* const toSkip);
106        bool skippedStringLong(const XMLCh* const toSkip);
107        void skipQuotedString(const XMLCh quoteCh);
108        XMLCh skipUntilIn(const XMLCh* const listToSkip);
109        XMLCh skipUntilInOrWS(const XMLCh* const listToSkip);
110        bool peekString(const XMLCh* const toPeek);
111
112
113        // -----------------------------------------------------------------------
114        //  Control methods
115        // -----------------------------------------------------------------------
116        void cleanStackBackTo(const XMLSize_t readerNum);
117        XMLReader* createReader
118        (
119                const   InputSource&        src
120                , const bool                xmlDecl
121                , const XMLReader::RefFrom  refFrom
122                , const XMLReader::Types    type
123                , const XMLReader::Sources  source
124                , const bool                calcSrsOfs = true
125                ,       XMLSize_t           lowWaterMark = 100
126        );
127        XMLReader* createReader
128        (
129                const   XMLCh* const        sysId
130                , const XMLCh* const        pubId
131                , const bool                xmlDecl
132                , const XMLReader::RefFrom  refFrom
133                , const XMLReader::Types    type
134                , const XMLReader::Sources  source
135                ,       InputSource*&       srcToFill
136                , const bool                calcSrcOfs = true
137                ,       XMLSize_t           lowWaterMark = 100
138                , const bool                disableDefaultEntityResolution = false
139        );
140        XMLReader* createReader
141        (
142                const   XMLCh* const        baseURI
143                , const XMLCh* const        sysId
144                , const XMLCh* const        pubId
145                , const bool                xmlDecl
146                , const XMLReader::RefFrom  refFrom
147                , const XMLReader::Types    type
148                , const XMLReader::Sources  source
149                ,       InputSource*&       srcToFill
150                , const bool                calcSrcOfs = true
151                ,       XMLSize_t           lowWaterMark = 100
152                , const bool                disableDefaultEntityResolution = false
153        );
154        XMLReader* createIntEntReader
155        (
156                const   XMLCh* const        sysId
157                , const XMLReader::RefFrom  refFrom
158                , const XMLReader::Types    type
159                , const XMLCh* const        dataBuf
160                , const XMLSize_t           dataLen
161                , const bool                copyBuf
162                , const bool                calcSrcOfs = true
163                ,       XMLSize_t           lowWaterMark = 100
164        );
165        bool isScanningPERefOutOfLiteral() const;
166        bool pushReader
167        (
168                                XMLReader* const        reader
169                ,       XMLEntityDecl* const    entity
170        );
171        void reset();
172
173
174        // -----------------------------------------------------------------------
175        //  Getter methods
176        // -----------------------------------------------------------------------
177        const XMLCh* getCurrentEncodingStr() const;
178        const XMLEntityDecl* getCurrentEntity() const;
179        XMLEntityDecl* getCurrentEntity();
180        const XMLReader* getCurrentReader() const;
181        XMLReader* getCurrentReader();
182        XMLSize_t getCurrentReaderNum() const;
183        XMLSize_t getReaderDepth() const;
184        void getLastExtEntityInfo(LastExtEntityInfo& lastInfo) const;
185        XMLFilePos getSrcOffset() const;
186        bool getThrowEOE() const;
187        inline bool getNextCharOfCurrentReader(XMLCh & chRet);
188
189        // -----------------------------------------------------------------------
190        //  Setter methods
191        // -----------------------------------------------------------------------
192        void setEntityHandler(XMLEntityHandler* const newHandler);
193        void setThrowEOE(const bool newValue);
194        void setXMLVersion(const XMLReader::XMLVersion version);
195        void setStandardUriConformant(const bool newValue);
196
197        // -----------------------------------------------------------------------
198        //  Implement the SAX Locator interface
199        // -----------------------------------------------------------------------
200        virtual const XMLCh* getPublicId() const;
201        virtual const XMLCh* getSystemId() const;
202        virtual XMLFileLoc getLineNumber() const;
203        virtual XMLFileLoc getColumnNumber() const;
204
205
206private :
207        // -----------------------------------------------------------------------
208        //  Private helper methods
209        // -----------------------------------------------------------------------
210        const XMLReader* getLastExtEntity(const XMLEntityDecl*& itsEntity) const;
211        bool popReader();
212
213        // -----------------------------------------------------------------------
214        //  Unimplemented constructors and operators
215        // -----------------------------------------------------------------------
216        ReaderMgr(const ReaderMgr&);
217        ReaderMgr& operator=(const ReaderMgr&);
218
219        // -----------------------------------------------------------------------
220        //  Private data members
221        //
222        //  fCurEntity
223        //      This is the current top of stack entity. We pull it off the stack
224        //      and store it here for efficiency.
225        //
226        //  fCurReader
227        //      This is the current top of stack reader. We pull it off the
228        //      stack and store it here for efficiency.
229        //
230        //  fEntityHandler
231        //      This is the installed entity handler. Its installed via the
232        //      scanner but he passes it on to us since we need it the most, in
233        //      process of creating external entity readers.
234        //
235        //  fEntityStack
236        //      We need to keep up with which of the pushed readers are pushed
237        //      entity values that are being spooled. This is done to avoid the
238        //      problem of recursive definitions. This stack consists of refs to
239        //      EntityDecl objects for the pushed entities.
240        //
241        //  fNextReaderNum
242        //      This is the reader serial number value. Each new reader that is
243        //      created from this reader is given a successive number. This lets
244        //      us catch things like partial markup errors and such.
245        //
246        //  fReaderStack
247        //      This is the stack of reader references. We own all the readers
248        //      and destroy them when they are used up.
249        //
250        //  fThrowEOE
251        //      This flag controls whether we throw an exception when we hit an
252        //      end of entity. The scanner doesn't really need to know about ends
253        //      of entities in the int/ext subsets, so it will turn this flag off
254        //      until it gets into the content usually.
255        //
256        //  fXMLVersion
257        //      Enum to indicate if each Reader should be created as XML 1.1 or
258        //      XML 1.0 conformant
259        //
260        //  fStandardUriConformant
261        //      This flag controls whether we force conformant URI
262        // -----------------------------------------------------------------------
263        XMLEntityDecl*              fCurEntity;
264        XMLReader*                  fCurReader;
265        XMLEntityHandler*           fEntityHandler;
266        RefStackOf<XMLEntityDecl>*  fEntityStack;
267        unsigned int                fNextReaderNum;
268        RefStackOf<XMLReader>*      fReaderStack;
269        bool                        fThrowEOE;
270        XMLReader::XMLVersion       fXMLVersion;
271        bool                        fStandardUriConformant;
272        MemoryManager*              fMemoryManager;
273};
274
275inline bool ReaderMgr::getNextCharOfCurrentReader(XMLCh & chRet)
276{
277        if (fCurReader->getNextChar(chRet))
278                return 1;
279
280        popReader();
281
282        return 0;
283}
284
285// ---------------------------------------------------------------------------
286//  ReaderMgr: Inlined methods
287//
288//  NOTE: We cannot put these in alphabetical and type order as we usually
289//  do because some of the compilers we have to support are too stupid to
290//  understand out of order inlines!
291// ---------------------------------------------------------------------------
292inline XMLSize_t ReaderMgr::getCurrentReaderNum() const
293{
294        return fCurReader->getReaderNum();
295}
296
297inline const XMLReader* ReaderMgr::getCurrentReader() const
298{
299        assert (fCurReader != NULL);
300        return fCurReader;
301}
302
303inline XMLReader* ReaderMgr::getCurrentReader()
304{
305        assert (fCurReader != NULL);
306        return fCurReader;
307}
308
309inline bool ReaderMgr::getName(XMLBuffer& toFill)
310{
311        toFill.reset();
312        return fCurReader->getName(toFill, false);
313}
314
315inline bool ReaderMgr::getQName(XMLBuffer& toFill, int *colonPosition)
316{
317        toFill.reset();
318        return fCurReader->getQName(toFill, colonPosition);
319}
320
321inline bool ReaderMgr::getNameToken(XMLBuffer& toFill)
322{
323        toFill.reset();
324        return fCurReader->getName(toFill, true);
325}
326
327inline bool ReaderMgr::getNextCharIfNot(const XMLCh chNotToGet, XMLCh& chGotten)
328{
329        return fCurReader->getNextCharIfNot(chNotToGet, chGotten);
330}
331
332inline void ReaderMgr::movePlainContentChars(XMLBuffer &dest)
333{
334        fCurReader->movePlainContentChars(dest);
335}
336
337inline bool ReaderMgr::getThrowEOE() const
338{
339        return fThrowEOE;
340}
341
342inline XMLFilePos ReaderMgr::getSrcOffset() const
343{
344        return fCurReader? fCurReader->getSrcOffset() : 0;
345}
346
347inline bool ReaderMgr::lookingAtChar(const XMLCh chToCheck)
348{
349        return (chToCheck == peekNextChar());
350}
351
352inline bool ReaderMgr::lookingAtSpace()
353{
354        XMLCh c = peekNextChar();
355        return fCurReader->isWhitespace(c);
356}
357
358inline void ReaderMgr::setThrowEOE(const bool newValue)
359{
360        fThrowEOE = newValue;
361}
362
363inline void ReaderMgr::setStandardUriConformant(const bool newValue)
364{
365        fStandardUriConformant = newValue;
366}
367
368inline bool ReaderMgr::skippedString(const XMLCh* const toSkip)
369{
370        return fCurReader->skippedString(toSkip);
371}
372
373inline bool ReaderMgr::skippedStringLong(const XMLCh* const toSkip)
374{
375        return fCurReader->skippedStringLong(toSkip);
376}
377
378inline void ReaderMgr::skipToChar(const XMLCh toSkipTo)
379{
380                XMLCh nextCh = 0;
381        do
382        {
383                // Get chars until we find the one to skip
384                nextCh = getNextChar();
385                }
386        // Break out at end of input or the char to skip
387                while((nextCh != toSkipTo) && nextCh!=0);
388}
389
390inline void ReaderMgr::skipPastChar(const XMLCh toSkipPast)
391{
392                XMLCh nextCh = 0;
393        do
394        {
395                // Get chars until we find the one to skip
396                nextCh = getNextChar();
397                }
398                while((nextCh != toSkipPast) && nextCh!=0);
399}
400
401inline bool ReaderMgr::peekString(const XMLCh* const toPeek)
402{
403        return fCurReader->peekString(toPeek);
404}
405
406inline void ReaderMgr::setEntityHandler(XMLEntityHandler* const newHandler)
407{
408        fEntityHandler = newHandler;
409}
410
411inline void ReaderMgr::setXMLVersion(const XMLReader::XMLVersion version)
412{
413        fXMLVersion = version;
414        fCurReader->setXMLVersion(version);
415}
416
417#endif
418
419//
420//  This is a simple class to temporarily change the 'throw at end of entity'
421//  flag of the reader manager. There are some places where we need to
422//  turn this on and off on a scoped basis.
423//
424class XMLPARSER_EXPORT ThrowEOEJanitor
425{
426public :
427        // -----------------------------------------------------------------------
428        //  Constructors and destructor
429        // -----------------------------------------------------------------------
430        ThrowEOEJanitor(ReaderMgr* mgrTarget, const bool newValue) :
431
432                fOld(mgrTarget->getThrowEOE())
433                , fMgr(mgrTarget)
434        {
435                mgrTarget->setThrowEOE(newValue);
436        }
437
438        ~ThrowEOEJanitor()
439        {
440                fMgr->setThrowEOE(fOld);
441        };
442
443private :
444        // -----------------------------------------------------------------------
445        //  Unimplemented constructors and operators
446        // -----------------------------------------------------------------------
447        ThrowEOEJanitor(const ThrowEOEJanitor&);
448        ThrowEOEJanitor& operator=(const ThrowEOEJanitor&);
449
450        // -----------------------------------------------------------------------
451        //  Private data members
452        //
453        //  fOld
454        //      The previous value of the flag, which we replaced during ctor,
455        //      and will replace during dtor.
456        //
457        //  fMgr
458        //      A pointer to the reader manager we are going to set/reset the
459        //      flag on.
460        // -----------------------------------------------------------------------
461        bool        fOld;
462        ReaderMgr*  fMgr;
463};
464
465
466
467XERCES_CPP_NAMESPACE_END
468
469#endif
Note: See TracBrowser for help on using the repository browser.