OpenASIP  2.0
Serializer.hh
Go to the documentation of this file.
1 /*
2  Copyright (c) 2002-2009 Tampere University.
3 
4  This file is part of TTA-Based Codesign Environment (TCE).
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23  */
24 /**
25  * @file Serializer.hh
26  *
27  * Declaration of Serializer interface.
28  *
29  * @author Lasse Laasonen 2004 (lasse.laasonen-no.spam-tut.fi)
30  */
31 
32 #ifndef TTA_SERIALIZER_HH
33 #define TTA_SERIALIZER_HH
34 
35 #include "Serializable.hh"
36 #include "Exception.hh"
37 
38 class ObjectState;
39 
40 namespace TCETools { // had to wrap this to a namespace due to llvm::Serializer
41 
42 /**
43  * All serializers must implement this interface.
44  */
45 class Serializer {
46 public:
47  /**
48  * Serializes the given ObjectState tree.
49  *
50  * @param state Root of the ObjectState tree.
51  * @exception SerializerException If an error occurs while serializing.
52  */
53  virtual void writeState(const ObjectState* state) = 0;
54 
55  /**
56  * Creates an ObjectState tree according to the input.
57  *
58  * @return The created ObjectState tree.
59  * @exception SerializerException If an error occurs while reading input.
60  */
61  virtual ObjectState* readState() = 0;
62 
63  virtual ~Serializer() {}
64 };
65 
66 }
67 
68 using namespace TCETools;
69 
70 
71 #endif
TCETools
Definition: CIStringSet.hh:40
Exception.hh
ObjectState
Definition: ObjectState.hh:59
TCETools::Serializer
Definition: Serializer.hh:45
Serializable.hh
TCETools::Serializer::readState
virtual ObjectState * readState()=0
TCETools::Serializer::writeState
virtual void writeState(const ObjectState *state)=0
TCETools::Serializer::~Serializer
virtual ~Serializer()
Definition: Serializer.hh:63