WPSEntry.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* libwps
3  * Version: MPL 2.0 / LGPLv2.1+
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * Major Contributor(s):
10  * Copyright (C) 2009, 2011 Alonso Laurent (alonso@loria.fr)
11  * Copyright (C) 2006, 2007 Andrew Ziem
12  * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13  * Copyright (C) 2004 Marc Maurer (uwog@uwog.net)
14  * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)
15  *
16  * For minor contributions see the git repository.
17  *
18  * Alternatively, the contents of this file may be used under the terms
19  * of the GNU Lesser General Public License Version 2.1 or later
20  * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
21  * applicable instead of those above.
22  *
23  * For further information visit http://libwps.sourceforge.net
24  */
25 
26 #ifndef WPS_ENTRY_H
27 #define WPS_ENTRY_H
28 
29 #include <ostream>
30 #include <string>
31 
38 class WPSEntry
39 {
40 public:
43  : m_begin(-1)
44  , m_length(-1)
45  , m_type("")
46  , m_name("")
47  , m_id(-1)
48  , m_parsed(false)
49  , m_extra("") {}
51  virtual ~WPSEntry() {}
53  void setBegin(long off)
54  {
55  m_begin = off;
56  }
58  void setLength(long l)
59  {
60  m_length = l;
61  }
63  void setEnd(long e)
64  {
65  m_length = e-m_begin;
66  }
67 
69  long begin() const
70  {
71  return m_begin;
72  }
74  long end() const
75  {
76  return m_begin+m_length;
77  }
79  long length() const
80  {
81  return m_length;
82  }
83 
85  bool valid(bool checkId = false) const
86  {
87  if (m_begin < 0 || m_length <= 0)
88  return false;
89  if (checkId && m_id < 0)
90  return false;
91  return true;
92  }
93 
95  bool operator==(const WPSEntry &a) const
96  {
97  if (m_begin != a.m_begin) return false;
98  if (m_length != a.m_length) return false;
99  if (m_id != a. m_id) return false;
100  if (m_type != a.m_type) return false;
101  if (m_name != a.m_name) return false;
102  return true;
103  }
105  bool operator!=(const WPSEntry &a) const
106  {
107  return !operator==(a);
108  }
109 
111  bool isParsed() const
112  {
113  return m_parsed;
114  }
116  void setParsed(bool ok=true) const
117  {
118  m_parsed = ok;
119  }
120 
122  void setType(std::string const &tp)
123  {
124  m_type=tp;
125  }
127  std::string const &type() const
128  {
129  return m_type;
130  }
132  bool hasType(std::string const &tp) const
133  {
134  return m_type == tp;
135  }
136 
138  void setName(std::string const &nam)
139  {
140  m_name=nam;
141  }
143  std::string const &name() const
144  {
145  return m_name;
146  }
148  bool hasName(std::string const &nam) const
149  {
150  return m_name == nam;
151  }
152 
154  int id() const
155  {
156  return m_id;
157  }
159  void setId(int i)
160  {
161  m_id = i;
162  }
163 
165  std::string const &extra() const
166  {
167  return m_extra;
168  }
170  void setExtra(std::string const &s)
171  {
172  m_extra = s;
173  }
174  friend std::ostream &operator<< (std::ostream &o, WPSEntry const &ent)
175  {
176  o << ent.m_type;
177  if (ent.m_name.length()) o << "|" << ent.m_name;
178  if (ent.m_id >= 0) o << "[" << ent.m_id << "]";
179  if (ent.m_extra.length()) o << "[" << ent.m_extra << "]";
180  return o;
181  }
182 protected:
183  long m_begin , m_length ;
184 
186  std::string m_type;
188  std::string m_name;
190  int m_id;
192  mutable bool m_parsed;
194  std::string m_extra;
195 };
196 
197 #endif
198 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
bool valid(bool checkId=false) const
returns true if the zone length is positive
Definition: WPSEntry.h:85
friend std::ostream & operator<<(std::ostream &o, WPSEntry const &ent)
Definition: WPSEntry.h:174
long length() const
returns the length of the zone
Definition: WPSEntry.h:79
void setParsed(bool ok=true) const
sets the flag m_parsed to true or false
Definition: WPSEntry.h:116
bool m_parsed
a bool to store if the entry is or not parsed
Definition: WPSEntry.h:192
void setBegin(long off)
sets the begin offset
Definition: WPSEntry.h:53
int id() const
returns the entry id
Definition: WPSEntry.h:154
long begin() const
returns the begin offset
Definition: WPSEntry.h:69
std::string const & extra() const
retrieves the extra string
Definition: WPSEntry.h:165
bool hasName(std::string const &nam) const
checks if the entry name is equal to name
Definition: WPSEntry.h:148
bool isParsed() const
a flag to know if the entry was parsed or not
Definition: WPSEntry.h:111
bool operator!=(const WPSEntry &a) const
basic operator!=
Definition: WPSEntry.h:105
std::string m_type
the entry type
Definition: WPSEntry.h:186
void setType(std::string const &tp)
sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ...
Definition: WPSEntry.h:122
void setId(int i)
sets the id
Definition: WPSEntry.h:159
long m_length
the size of the entry
Definition: WPSEntry.h:183
std::string m_name
the name
Definition: WPSEntry.h:188
std::string m_extra
an extra string
Definition: WPSEntry.h:194
WPSEntry()
constructor
Definition: WPSEntry.h:42
void setExtra(std::string const &s)
sets the extra string
Definition: WPSEntry.h:170
long end() const
returns the end offset
Definition: WPSEntry.h:74
long m_begin
the begin of the entry.
Definition: WPSEntry.h:183
basic class to store an entry in a file This contained :
Definition: WPSEntry.h:38
int m_id
the identificator
Definition: WPSEntry.h:190
void setName(std::string const &nam)
sets the name of the entry
Definition: WPSEntry.h:138
std::string const & type() const
returns the type of the entry
Definition: WPSEntry.h:127
bool hasType(std::string const &tp) const
returns true if the type entry == type
Definition: WPSEntry.h:132
void setEnd(long e)
sets the end offset
Definition: WPSEntry.h:63
std::string const & name() const
name of the entry
Definition: WPSEntry.h:143
bool operator==(const WPSEntry &a) const
basic operator==
Definition: WPSEntry.h:95
void setLength(long l)
sets the zone size
Definition: WPSEntry.h:58
virtual ~WPSEntry()
destructor
Definition: WPSEntry.h:51

Generated on Fri May 27 2022 03:07:00 for libwps by doxygen 1.8.14