tamlBinaryWriter.h

Engine/source/persistence/taml/binary/tamlBinaryWriter.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_BINARYWRITER_H_
25#define _TAML_BINARYWRITER_H_
26
27#ifndef _TAML_H_
28#include "persistence/taml/taml.h"
29#endif
30
31//-----------------------------------------------------------------------------
32
33/// @ingroup tamlGroup
34/// @see tamlGroup
35class TamlBinaryWriter
36{
37public:
38    TamlBinaryWriter( Taml* pTaml ) :
39        mpTaml( pTaml ),
40        mVersionId(2)
41    {
42    }
43    virtual ~TamlBinaryWriter() {}
44
45    /// Write.
46    bool write( FileStream& stream, const TamlWriteNode* pTamlWriteNode, const bool compressed );
47
48private:
49    Taml* mpTaml;
50    const U32 mVersionId;
51
52private:
53    void writeElement( Stream& stream, const TamlWriteNode* pTamlWriteNode );
54    void writeAttributes( Stream& stream, const TamlWriteNode* pTamlWriteNode );
55    void writeChildren( Stream& stream, const TamlWriteNode* pTamlWriteNode );
56    void writeCustomElements( Stream& stream, const TamlWriteNode* pTamlWriteNode );
57    void writeCustomNode( Stream& stream, const TamlCustomNode* pCustomNode );
58};
59
60#endif // _TAML_BINARYWRITER_H_
61