STOFFEntry.hxx
Go to the documentation of this file.
/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
/* libstaroffice
* Version: MPL 2.0 / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 2.0 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
* Copyright (C) 2006, 2007 Andrew Ziem
* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
*
*
* All Rights Reserved.
*
* For minor contributions see the git repository.
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
* in which case the provisions of the LGPLv2+ are applicable
* instead of those above.
*/
#ifndef STOFF_ENTRY_H
#define STOFF_ENTRY_H
#include <ostream>
#include <string>
class STOFFEntry
{
public:
STOFFEntry()
: m_begin(-1)
, m_length(-1)
, m_type("")
, m_name("")
, m_id(-1)
, m_parsed(false)
, m_extra("") {}
virtual ~STOFFEntry();
void setBegin(long off)
{
m_begin = off;
}
void setLength(long l)
{
m_length = l;
}
void setEnd(long off)
{
m_length = off-m_begin;
}
long begin() const
{
return m_begin;
}
long end() const
{
return m_begin+m_length;
}
long length() const
{
return m_length;
}
bool valid() const
{
return m_begin >= 0 && m_length > 0;
}
bool operator==(const STOFFEntry &a) const
{
if (m_begin != a.m_begin) return false;
if (m_length != a.m_length) return false;
if (m_id != a. m_id) return false;
if (m_type != a.m_type) return false;
if (m_name != a.m_name) return false;
return true;
}
bool operator!=(const STOFFEntry &a) const
{
return !operator==(a);
}
bool isParsed() const
{
return m_parsed;
}
void setParsed(bool ok=true) const
{
m_parsed = ok;
}
void setType(std::string const &newType)
{
m_type=newType;
}
std::string const &type() const
{
return m_type;
}
bool hasType(std::string const &typ) const
{
return m_type == typ;
}
void setName(std::string const &nam)
{
m_name=nam;
}
std::string const &name() const
{
return m_name;
}
bool hasName(std::string const &nam) const
{
return m_name == nam;
}
int id() const
{
return m_id;
}
void setId(int newId)
{
m_id = newId;
}
std::string const &extra() const
{
return m_extra;
}
void setExtra(std::string const &s)
{
m_extra = s;
}
friend std::ostream &operator<< (std::ostream &o, STOFFEntry const &ent)
{
o << ent.m_type;
if (ent.m_name.length()) o << "|" << ent.m_name;
if (ent.m_id >= 0) o << "[" << ent.m_id << "]";
if (ent.m_extra.length()) o << "[" << ent.m_extra << "]";
return o;
}
protected:
long m_begin , m_length ;
std::string m_type;
std::string m_name;
int m_id;
mutable bool m_parsed;
std::string m_extra;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFEntry::begin
long begin() const
returns the begin offset
Definition STOFFEntry.hxx:78
STOFFEntry::m_extra
std::string m_extra
an extra string
Definition STOFFEntry.hxx:201
STOFFEntry::setName
void setName(std::string const &nam)
sets the name of the entry
Definition STOFFEntry.hxx:143
STOFFEntry::hasType
bool hasType(std::string const &typ) const
returns true if the type entry == type
Definition STOFFEntry.hxx:137
STOFFEntry::id
int id() const
returns the id
Definition STOFFEntry.hxx:159
STOFFEntry::name
std::string const & name() const
name of the entry
Definition STOFFEntry.hxx:148
STOFFEntry::STOFFEntry
STOFFEntry()
constructor
Definition STOFFEntry.hxx:50
STOFFEntry::operator==
bool operator==(const STOFFEntry &a) const
basic operator==
Definition STOFFEntry.hxx:100
STOFFEntry::m_type
std::string m_type
the entry type
Definition STOFFEntry.hxx:193
STOFFEntry::isParsed
bool isParsed() const
a flag to know if the entry was parsed or not
Definition STOFFEntry.hxx:116
STOFFEntry::operator<<
friend std::ostream & operator<<(std::ostream &o, STOFFEntry const &ent)
Definition STOFFEntry.hxx:180
STOFFEntry::setType
void setType(std::string const &newType)
sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ...
Definition STOFFEntry.hxx:127
STOFFEntry::setBegin
void setBegin(long off)
sets the begin offset
Definition STOFFEntry.hxx:62
STOFFEntry::operator!=
bool operator!=(const STOFFEntry &a) const
basic operator!=
Definition STOFFEntry.hxx:110
STOFFEntry::setExtra
void setExtra(std::string const &s)
sets the extra string
Definition STOFFEntry.hxx:175
STOFFEntry::m_id
int m_id
an identificator
Definition STOFFEntry.hxx:197
STOFFEntry::m_name
std::string m_name
the name
Definition STOFFEntry.hxx:195
STOFFEntry::length
long length() const
returns the length of the zone
Definition STOFFEntry.hxx:88
STOFFEntry::extra
std::string const & extra() const
retrieves the extra string
Definition STOFFEntry.hxx:170
STOFFEntry::hasName
bool hasName(std::string const &nam) const
checks if the entry name is equal to name
Definition STOFFEntry.hxx:153
STOFFEntry::setId
void setId(int newId)
sets the id
Definition STOFFEntry.hxx:164
STOFFEntry::setParsed
void setParsed(bool ok=true) const
sets the flag m_parsed to true or false
Definition STOFFEntry.hxx:121
STOFFEntry::setEnd
void setEnd(long off)
sets the end offset
Definition STOFFEntry.hxx:72
STOFFEntry::setLength
void setLength(long l)
sets the zone size
Definition STOFFEntry.hxx:67
STOFFEntry::m_parsed
bool m_parsed
a bool to store if the entry is or not parsed
Definition STOFFEntry.hxx:199
STOFFEntry::type
std::string const & type() const
returns the type of the entry
Definition STOFFEntry.hxx:132
STOFFEntry::valid
bool valid() const
returns true if the zone length is positive
Definition STOFFEntry.hxx:94
STOFFEntry::end
long end() const
returns the end offset
Definition STOFFEntry.hxx:83
STOFFEntry::~STOFFEntry
virtual ~STOFFEntry()
Definition STOFFEntry.cxx:36
STOFFEntry::m_begin
long m_begin
the begin of the entry.
Definition STOFFEntry.hxx:190
STOFFEntry::m_length
long m_length
the size of the entry
Definition STOFFEntry.hxx:190