MWAWEntry.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2 
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33 
34 #ifndef MWAW_ENTRY_H
35 #define MWAW_ENTRY_H
36 
37 #include <ostream>
38 #include <string>
39 
46 class MWAWEntry
47 {
48 public:
51  : m_begin(-1)
52  , m_length(-1)
53  , m_type("")
54  , m_name("")
55  , m_extra("")
56  , m_id(-1)
57  , m_parsed(false)
58  {
59  }
60  MWAWEntry(MWAWEntry const &)=default;
61  MWAWEntry &operator=(MWAWEntry const &)=default;
63  virtual ~MWAWEntry();
64 
66  void setBegin(long off)
67  {
68  m_begin = off;
69  }
71  void setLength(long l)
72  {
73  m_length = l;
74  }
76  void setEnd(long off)
77  {
78  m_length = off-m_begin;
79  }
80 
82  long begin() const
83  {
84  return m_begin;
85  }
87  long end() const
88  {
89  return m_begin+m_length;
90  }
92  long length() const
93  {
94  return m_length;
95  }
96 
98  bool valid() const
99  {
100  return m_begin >= 0 && m_length > 0;
101  }
102 
104  bool operator==(const MWAWEntry &a) const
105  {
106  if (m_begin != a.m_begin) return false;
107  if (m_length != a.m_length) return false;
108  if (m_id != a. m_id) return false;
109  if (m_type != a.m_type) return false;
110  if (m_name != a.m_name) return false;
111  return true;
112  }
114  bool operator!=(const MWAWEntry &a) const
115  {
116  return !operator==(a);
117  }
118 
120  bool isParsed() const
121  {
122  return m_parsed;
123  }
125  void setParsed(bool ok=true) const
126  {
127  m_parsed = ok;
128  }
129 
131  void setType(std::string const &newType)
132  {
133  m_type=newType;
134  }
136  std::string const &type() const
137  {
138  return m_type;
139  }
141  bool hasType(std::string const &typ) const
142  {
143  return m_type == typ;
144  }
145 
147  void setName(std::string const &nam)
148  {
149  m_name=nam;
150  }
152  std::string const &name() const
153  {
154  return m_name;
155  }
157  bool hasName(std::string const &nam) const
158  {
159  return m_name == nam;
160  }
161 
163  int id() const
164  {
165  return m_id;
166  }
168  void setId(int newId)
169  {
170  m_id = newId;
171  }
172 
174  std::string const &extra() const
175  {
176  return m_extra;
177  }
179  void setExtra(std::string const &s)
180  {
181  m_extra = s;
182  }
183 
184  friend std::ostream &operator<< (std::ostream &o, MWAWEntry const &ent)
185  {
186  o << ent.m_type;
187  if (ent.m_name.length()) o << "|" << ent.m_name;
188  if (ent.m_id >= 0) o << "[" << ent.m_id << "]";
189  if (ent.m_extra.length()) o << "[" << ent.m_extra << "]";
190  return o;
191  }
192 
193 protected:
194  long m_begin , m_length ;
195 
197  std::string m_type;
199  std::string m_name;
201  std::string m_extra;
203  int m_id;
205  mutable bool m_parsed;
206 };
207 
208 #endif
209 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWEntry::operator=
MWAWEntry & operator=(MWAWEntry const &)=default
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWEntry::setName
void setName(std::string const &nam)
sets the name of the entry
Definition: MWAWEntry.hxx:147
MWAWEntry::isParsed
bool isParsed() const
a flag to know if the entry was parsed or not
Definition: MWAWEntry.hxx:120
MWAWEntry::setExtra
void setExtra(std::string const &s)
sets the extra string
Definition: MWAWEntry.hxx:179
MWAWEntry::id
int id() const
returns the id
Definition: MWAWEntry.hxx:163
MWAWEntry.hxx
MWAWEntry::m_name
std::string m_name
the name
Definition: MWAWEntry.hxx:199
MWAWEntry::type
std::string const & type() const
returns the type of the entry
Definition: MWAWEntry.hxx:136
MWAWEntry::MWAWEntry
MWAWEntry(MWAWEntry const &)=default
MWAWEntry::setParsed
void setParsed(bool ok=true) const
sets the flag m_parsed to true or false
Definition: MWAWEntry.hxx:125
MWAWEntry::operator!=
bool operator!=(const MWAWEntry &a) const
basic operator!=
Definition: MWAWEntry.hxx:114
MWAWEntry::operator==
bool operator==(const MWAWEntry &a) const
basic operator==
Definition: MWAWEntry.hxx:104
MWAWEntry::hasType
bool hasType(std::string const &typ) const
returns true if the type entry == type
Definition: MWAWEntry.hxx:141
MWAWEntry::MWAWEntry
MWAWEntry()
constructor
Definition: MWAWEntry.hxx:50
MWAWEntry::m_id
int m_id
an identificator
Definition: MWAWEntry.hxx:203
MWAWEntry::setType
void setType(std::string const &newType)
sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ...
Definition: MWAWEntry.hxx:131
MWAWEntry::setEnd
void setEnd(long off)
sets the end offset
Definition: MWAWEntry.hxx:76
MWAWEntry::m_parsed
bool m_parsed
a bool to store if the entry is or not parsed
Definition: MWAWEntry.hxx:205
MWAWEntry::name
std::string const & name() const
name of the entry
Definition: MWAWEntry.hxx:152
MWAWEntry::setBegin
void setBegin(long off)
sets the begin offset
Definition: MWAWEntry.hxx:66
MWAWEntry::length
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:92
MWAWEntry::m_length
long m_length
the size of the entry
Definition: MWAWEntry.hxx:194
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:82
MWAWEntry::setLength
void setLength(long l)
sets the zone size
Definition: MWAWEntry.hxx:71
MWAWEntry::m_begin
long m_begin
the begin of the entry.
Definition: MWAWEntry.hxx:194
MWAWEntry::setId
void setId(int newId)
sets the id
Definition: MWAWEntry.hxx:168
MWAWEntry::m_type
std::string m_type
the entry type
Definition: MWAWEntry.hxx:197
MWAWEntry::operator<<
friend std::ostream & operator<<(std::ostream &o, MWAWEntry const &ent)
Definition: MWAWEntry.hxx:184
MWAWEntry::m_extra
std::string m_extra
an extra string
Definition: MWAWEntry.hxx:201
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:87
MWAWEntry::valid
bool valid() const
returns true if the zone length is positive
Definition: MWAWEntry.hxx:98
MWAWEntry::extra
std::string const & extra() const
retrieves the extra string
Definition: MWAWEntry.hxx:174
MWAWEntry::hasName
bool hasName(std::string const &nam) const
checks if the entry name is equal to name
Definition: MWAWEntry.hxx:157
MWAWEntry::~MWAWEntry
virtual ~MWAWEntry()
destructor
Definition: MWAWEntry.cxx:36

Generated on Tue Nov 14 2023 07:47:35 for libmwaw by doxygen 1.8.20