WP6VariableLengthGroup.h Source File documentation

WP6VariableLengthGroup.h
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2/* libwpd
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) 2002 William Lachance (wrlach@gmail.com)
11 * Copyright (C) 2002 Marc Maurer (uwog@uwog.net)
12 * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
13 *
14 * For minor contributions see the git repository.
15 *
16 * Alternatively, the contents of this file may be used under the terms
17 * of the GNU Lesser General Public License Version 2.1 or later
18 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19 * applicable instead of those above.
20 *
21 * For further information visit http://libwpd.sourceforge.net
22 */
23
24/* "This product is not manufactured, approved, or supported by
25 * Corel Corporation or Corel Corporation Limited."
26 */
27
28#ifndef WP6VARIABLELENGTHGROUP_H
29#define WP6VARIABLELENGTHGROUP_H
30
31#include <vector>
32
33#include "WP6Part.h"
34
35 class WP6VariableLengthGroup_SubGroup
36{
37public:
38 virtual ~WP6VariableLengthGroup_SubGroup() {}
39 virtual void parse(WP6Listener *listener, const unsigned char numPrefixIDs, unsigned short const *prefixIDs) const = 0;
40};
41
42 class WP6VariableLengthGroup : public WP6Part
43{
44public:
45 WP6VariableLengthGroup(); // WP6VariableLengthGroup should _never_ be constructed, only its inherited classes
46 ~WP6VariableLengthGroup() override;
47
48 static WP6VariableLengthGroup *constructVariableLengthGroup(librevenge::RVNGInputStream *input, WPXEncryption *encryption, const unsigned char groupID);
49
50 static bool isGroupConsistent(librevenge::RVNGInputStream *input, WPXEncryption *encryption, const unsigned char groupID);
51
52protected:
53 void _read(librevenge::RVNGInputStream *input, WPXEncryption *encryption);
54 virtual void _readContents(librevenge::RVNGInputStream * /* input */, WPXEncryption * /* encryption */) {} // we don't always need more information than that provided generically
55
56 unsigned char getSubGroup() const
57 {
58 return m_subGroup;
59 }
60 unsigned short getSize() const
61 {
62 return m_size;
63 }
64 unsigned char getFlags() const
65 {
66 return m_flags;
67 }
68 unsigned char getNumPrefixIDs() const
69 {
70 return m_prefixIDs.size();;
71 }
72 const unsigned short *getPrefixIDs() const
73 {
74 return m_prefixIDs.data();
75 }
76 unsigned short getSizeNonDeletable() const
77 {
78 return m_sizeNonDeletable;
79 }
80 unsigned short getSizeDeletable() const
81 {
82 return m_sizeDeletable;
83 }
84
85private:
86 WP6VariableLengthGroup(const WP6VariableLengthGroup &);
87 WP6VariableLengthGroup &operator=(const WP6VariableLengthGroup &);
88 unsigned char m_subGroup;
89 unsigned short m_size;
90 unsigned char m_flags;
91 std::vector<unsigned short> m_prefixIDs;
92 unsigned short m_sizeNonDeletable;
93 unsigned short m_sizeDeletable;
94};
95
96#endif /* WP6VARIABLELENGTHGROUP_H */
97/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
WP6Part.h
WP6Listener
Definition WP6Listener.h:41
WP6Part
Definition WP6Part.h:37
WP6VariableLengthGroup_SubGroup
Definition WP6VariableLengthGroup.h:36
WP6VariableLengthGroup_SubGroup::parse
virtual void parse(WP6Listener *listener, const unsigned char numPrefixIDs, unsigned short const *prefixIDs) const =0
WP6VariableLengthGroup_SubGroup::~WP6VariableLengthGroup_SubGroup
virtual ~WP6VariableLengthGroup_SubGroup()
Definition WP6VariableLengthGroup.h:38
WP6VariableLengthGroup::m_flags
unsigned char m_flags
Definition WP6VariableLengthGroup.h:90
WP6VariableLengthGroup::getSize
unsigned short getSize() const
Definition WP6VariableLengthGroup.h:60
WP6VariableLengthGroup::m_subGroup
unsigned char m_subGroup
Definition WP6VariableLengthGroup.h:88
WP6VariableLengthGroup::_readContents
virtual void _readContents(librevenge::RVNGInputStream *, WPXEncryption *)
Definition WP6VariableLengthGroup.h:54
WP6VariableLengthGroup::m_sizeDeletable
unsigned short m_sizeDeletable
Definition WP6VariableLengthGroup.h:93
WP6VariableLengthGroup::m_sizeNonDeletable
unsigned short m_sizeNonDeletable
Definition WP6VariableLengthGroup.h:92
WP6VariableLengthGroup::isGroupConsistent
static bool isGroupConsistent(librevenge::RVNGInputStream *input, WPXEncryption *encryption, const unsigned char groupID)
Definition WP6VariableLengthGroup.cpp:97
WP6VariableLengthGroup::WP6VariableLengthGroup
WP6VariableLengthGroup()
Definition WP6VariableLengthGroup.cpp:47
WP6VariableLengthGroup::_read
void _read(librevenge::RVNGInputStream *input, WPXEncryption *encryption)
Definition WP6VariableLengthGroup.cpp:132
WP6VariableLengthGroup::m_size
unsigned short m_size
Definition WP6VariableLengthGroup.h:89
WP6VariableLengthGroup::getSizeNonDeletable
unsigned short getSizeNonDeletable() const
Definition WP6VariableLengthGroup.h:76
WP6VariableLengthGroup::constructVariableLengthGroup
static WP6VariableLengthGroup * constructVariableLengthGroup(librevenge::RVNGInputStream *input, WPXEncryption *encryption, const unsigned char groupID)
Definition WP6VariableLengthGroup.cpp:61
WP6VariableLengthGroup::m_prefixIDs
std::vector< unsigned short > m_prefixIDs
Definition WP6VariableLengthGroup.h:91
WP6VariableLengthGroup::~WP6VariableLengthGroup
~WP6VariableLengthGroup() override
Definition WP6VariableLengthGroup.cpp:57
WP6VariableLengthGroup::getSizeDeletable
unsigned short getSizeDeletable() const
Definition WP6VariableLengthGroup.h:80
WP6VariableLengthGroup::getFlags
unsigned char getFlags() const
Definition WP6VariableLengthGroup.h:64
WP6VariableLengthGroup::WP6VariableLengthGroup
WP6VariableLengthGroup(const WP6VariableLengthGroup &)
WP6VariableLengthGroup::getPrefixIDs
const unsigned short * getPrefixIDs() const
Definition WP6VariableLengthGroup.h:72
WP6VariableLengthGroup::getNumPrefixIDs
unsigned char getNumPrefixIDs() const
Definition WP6VariableLengthGroup.h:68
WP6VariableLengthGroup::operator=
WP6VariableLengthGroup & operator=(const WP6VariableLengthGroup &)
WP6VariableLengthGroup::getSubGroup
unsigned char getSubGroup() const
Definition WP6VariableLengthGroup.h:56
WPXEncryption
Definition WPXEncryption.h:36