tamlParser.h

Engine/source/persistence/taml/tamlParser.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2013 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _TAML_PARSER_H_
25#define _TAML_PARSER_H_
26
27#include "core/stringTable.h"
28
29//-----------------------------------------------------------------------------
30
31class TamlVisitor;
32
33//-----------------------------------------------------------------------------
34
35/// @ingroup tamlGroup
36/// @see tamlGroup
37class TamlParser
38{
39public:
40    TamlParser() :
41        mParsingFilename(StringTable->EmptyString())
42    {}
43    virtual ~TamlParser() {}
44
45    /// Whether the parser can change a property or not.
46    virtual bool canChangeProperty( void ) = 0;
47
48    /// Accept visitor.
49    virtual bool accept( const char* pFilename, TamlVisitor& visitor ) = 0;
50
51    /// Filename.
52    inline void setParsingFilename( const char* pFilename ) { mParsingFilename = StringTable->insert(pFilename); }
53    inline StringTableEntry getParsingFilename( void ) const { return mParsingFilename; }
54
55private:
56    StringTableEntry mParsingFilename;
57};
58
59#endif // _TAML_PARSER_H_
60