OpenASIP  2.0
DebugElement.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 DebugElement.hh
26  *
27  * Declaration of DebugElement class.
28  *
29  * @author Mikael Lepistö 2006 (tmlepist-no.spam-cs.tut.fi)
30  *
31  * @note rating: yellow
32  */
33 
34 #ifndef TTA_DEBUG_ELEMENT_HH
35 #define TTA_DEBUG_ELEMENT_HH
36 
37 #include <vector>
38 
39 #include "TPEFBaseType.hh"
40 #include "SectionElement.hh"
41 #include "Exception.hh"
42 
43 namespace TPEF {
44 namespace ReferenceManager {
45  class SafePointer;
46 }
47 
48  class Chunk;
49 /**
50  * Base class for all kinds of TPEF elements that belong to debug sections.
51  *
52  * Allows representing data of any debug element. All types of TPEF debug
53  * elements share a common property: a string that defines (part of) the
54  * information stored in the element.
55  */
56 class DebugElement : public SectionElement {
57 public:
58  enum ElementType {
59  DE_STAB = 0x1
60  };
61 
62  DebugElement();
63  virtual ~DebugElement();
64 
65  virtual ElementType type() const = 0;
66 
67  Chunk* debugString() const;
68  void setDebugString(const ReferenceManager::SafePointer* aString);
69  void setDebugString(Chunk* aString);
70 
71  /// Returns one byte of additional data.
72  virtual Byte byte(Word index) const = 0;
73  /// Returns the length of additional data of debug element.
74  virtual Word length() const = 0;
75 
76 protected:
77  /// String of debug element.
79 };
80 
81 }
82 
83 #endif
TPEF::DebugElement::DebugElement
DebugElement()
Definition: DebugElement.cc:43
Exception.hh
TPEF::DebugElement::byte
virtual Byte byte(Word index) const =0
Returns one byte of additional data.
Byte
unsigned char Byte
Definition: BaseType.hh:116
TPEF::DebugElement::DE_STAB
@ DE_STAB
Definition: DebugElement.hh:59
TPEF::DebugElement::~DebugElement
virtual ~DebugElement()
Definition: DebugElement.cc:49
TPEF::ReferenceManager::SafePointer
Definition: SafePointer.hh:188
TPEF::DebugElement::type
virtual ElementType type() const =0
TPEF::SectionElement
Definition: SectionElement.hh:44
TPEF::DebugElement::debugString_
const ReferenceManager::SafePointer * debugString_
String of debug element.
Definition: DebugElement.hh:78
TPEF::DebugElement::length
virtual Word length() const =0
Returns the length of additional data of debug element.
SectionElement.hh
TPEF::DebugElement
Definition: DebugElement.hh:56
TPEF::DebugElement::debugString
Chunk * debugString() const
Definition: DebugElement.cc:58
TPEF::DebugElement::ElementType
ElementType
Definition: DebugElement.hh:58
TPEFBaseType.hh
TPEF::Chunk
Definition: Chunk.hh:45
TPEF
Definition: Assembler.hh:43
TPEF::DebugElement::setDebugString
void setDebugString(const ReferenceManager::SafePointer *aString)
Definition: DebugElement.cc:68