Xerces-C++: XMLGrammarDescription.hpp Source File

Xerces-C++ 3.3.0

XMLGrammarDescription.hpp
Go to the documentation of this file.
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$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_XMLGRAMMARDESCRIPTION_HPP)
23#define XERCESC_INCLUDE_GUARD_XMLGRAMMARDESCRIPTION_HPP
24
25#include <xercesc/util/XMemory.hpp>
26#include <xercesc/validators/common/Grammar.hpp>
27
28#include <xercesc/internal/XSerializable.hpp>
29
30 XERCES_CPP_NAMESPACE_BEGIN
31
32 class XMLPARSER_EXPORT XMLGrammarDescription : public XSerializable, public XMemory
33{
34public :
35 // -----------------------------------------------------------------------
37 // -----------------------------------------------------------------------
39
43 virtual ~XMLGrammarDescription();
45
46 // -----------------------------------------------------------------------
48 // -----------------------------------------------------------------------
50
54 virtual Grammar::GrammarType getGrammarType() const = 0;
55
60 virtual const XMLCh* getGrammarKey() const = 0;
62
63 inline MemoryManager* getMemoryManager() const;
64
65 /***
66 * Support for Serialization/De-serialization
67 ***/
68 DECL_XSERIALIZABLE(XMLGrammarDescription)
69
70protected :
71 // -----------------------------------------------------------------------
73 // -----------------------------------------------------------------------
75 XMLGrammarDescription(MemoryManager* const memMgr = XMLPlatformUtils::fgMemoryManager);
77
78private :
79 // -----------------------------------------------------------------------
81 // -----------------------------------------------------------------------
83 XMLGrammarDescription(const XMLGrammarDescription& );
84 XMLGrammarDescription& operator=(const XMLGrammarDescription& );
86
87 // -----------------------------------------------------------------------
88 //
89 // fMemMgr: plugged-in (or defaulted-in) memory manager,
90 // not owned
91 // no reset after initialization
92 // allow derivatives to access directly
93 //
94 // -----------------------------------------------------------------------
95 MemoryManager* const fMemMgr;
96};
97
98 inline MemoryManager* XMLGrammarDescription::getMemoryManager() const
99{
100 return fMemMgr;
101}
102
103 XERCES_CPP_NAMESPACE_END
104
105#endif
XMemory.hpp
XMLPARSER_EXPORT
#define XMLPARSER_EXPORT
Definition XercesDefs.hpp:163
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
MemoryManager
Configurable memory manager.
Definition MemoryManager.hpp:40
XMLGrammarDescription
Definition XMLGrammarDescription.hpp:33
XMLGrammarDescription::getGrammarKey
virtual const XMLCh * getGrammarKey() const =0
getGrammarKey
XMLGrammarDescription::getGrammarType
virtual Grammar::GrammarType getGrammarType() const =0
getGrammarType
XMLGrammarDescription::~XMLGrammarDescription
virtual ~XMLGrammarDescription()
virtual destructor
XMLGrammarDescription::getMemoryManager
MemoryManager * getMemoryManager() const
Definition XMLGrammarDescription.hpp:98
XMLGrammarDescription::XMLGrammarDescription
XMLGrammarDescription(MemoryManager *const memMgr=XMLPlatformUtils::fgMemoryManager)
Hidden Constructors.
XMLPlatformUtils::fgMemoryManager
static MemoryManager * fgMemoryManager
The configurable memory manager.
Definition PlatformUtils.hpp:121
XMemory
This class makes it possible to override the C++ memory management by adding new/delete operators to ...
Definition XMemory.hpp:41