StarObject.hxx Source File documentation

StarObject.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/* libstaroffice
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/*
35 * class to parse/store an object corresponding to an OLE directory
36 *
37 */
38#ifndef STAR_OBJECT
39# define STAR_OBJECT
40
41#include <vector>
42#include <stack>
43#include <libstaroffice/STOFFDocument.hxx>
44
45#include "STOFFDebug.hxx"
46#include "STOFFOLEParser.hxx"
47
48#include "StarItemPool.hxx"
49
50namespace StarObjectInternal
51{
52struct State;
53}
54
55class StarAttributeManager;
56class StarFormatManager;
57class StarItemSet;
58
64 class StarObject
65{
66public:
68 StarObject(char const *passwd, std::shared_ptr<STOFFOLEParser> &oleParser, std::shared_ptr<STOFFOLEParser::OleDirectory> &directory);
70 virtual ~StarObject();
71
72 //
73 // basic
74 //
75
77 bool parse();
79 STOFFDocument::Kind getDocumentKind() const;
81 char const *getPassword() const
82 {
83 return m_password;
84 }
85
86 std::shared_ptr<STOFFOLEParser::OleDirectory> getOLEDirectory()
87 {
88 return m_directory;
89 }
90
91 std::shared_ptr<StarAttributeManager> getAttributeManager();
93 std::shared_ptr<StarFormatManager> getFormatManager();
95 librevenge::RVNGPropertyList const &getMetaData() const
96 {
97 return m_metaData;
98 }
99
100 librevenge::RVNGString getUserNameMetaData(int i) const;
101 // the document pool
103 void cleanPools();
105 std::shared_ptr<StarItemPool> getNewItemPool(StarItemPool::Type type);
109 std::shared_ptr<StarItemPool> findItemPool(StarItemPool::Type type, bool isInside);
111 std::shared_ptr<StarItemPool> getCurrentPool(bool onlyInside=true);
112
114 bool readPersistData(StarZone &zone, long endPos);
116 bool readSfxStyleSheets(STOFFInputStreamPtr input, std::string const &name);
118 bool readItemSet(StarZone &zone, std::vector<STOFFVec2i> const &limits, long endPos,
119 StarItemSet &itemSet, StarItemPool *pool=nullptr, bool isDirect=false);
120protected:
122 bool readPersistElements(STOFFInputStreamPtr input, std::string const &name);
124 bool readSfxDocumentInformation(STOFFInputStreamPtr input, std::string const &name);
126 bool readSfxPreview(STOFFInputStreamPtr input, std::string const &name);
128 bool readSfxWindows(STOFFInputStreamPtr input, libstoff::DebugFile &ascii);
130 bool readStarFrameworkConfigFile(STOFFInputStreamPtr input, libstoff::DebugFile &ascii);
132 bool readStarFrameworkConfigItem(STOFFEntry &entry, STOFFInputStreamPtr input, libstoff::DebugFile &ascii);
133
134 //
135 // data
136 //
137protected:
139 StarObject(StarObject const &orig, bool duplicateState);
141 char const *m_password;
143 std::shared_ptr<STOFFOLEParser> m_oleParser;
145 std::shared_ptr<STOFFOLEParser::OleDirectory> m_directory;
146
148 std::shared_ptr<StarObjectInternal::State> m_state;
150 librevenge::RVNGPropertyList m_metaData;
151
152private:
153 StarObject(StarObject const &orig) = delete;
154 StarObject &operator=(StarObject const &orig) = delete;
155};
156
157#endif
158// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
STOFFDebug.hxx
STOFFDocument.hxx
STOFFOLEParser.hxx
StarItemPool.hxx
STOFFDocument::Kind
Kind
an enum to define the kind of document
Definition STOFFDocument.hxx:66
STOFFEntry
basic class to store an entry in a file This contained :
Definition STOFFEntry.hxx:47
StarAttributeManager
the main class to read/.
Definition StarAttribute.hxx:1081
StarFormatManager
the main class to read/.
Definition StarFormatManager.hxx:91
StarItemPool
the main class to read/.
Definition StarItemPool.hxx:71
StarItemPool::Type
Type
the known item pool
Definition StarItemPool.hxx:75
StarItemSet
class to store a list of item
Definition StarItem.hxx:88
StarObject
an object corresponding to an OLE directory
Definition StarObject.hxx:65
StarObject::readSfxStyleSheets
bool readSfxStyleSheets(STOFFInputStreamPtr input, std::string const &name)
try to read a spreadshet style zone: SfxStyleSheets
Definition StarObject.cxx:638
StarObject::m_state
std::shared_ptr< StarObjectInternal::State > m_state
the state
Definition StarObject.hxx:148
StarObject::findItemPool
std::shared_ptr< StarItemPool > findItemPool(StarItemPool::Type type, bool isInside)
check if a pool corresponding to a given type is opened if so returned it.
Definition StarObject.cxx:159
StarObject::getDocumentKind
STOFFDocument::Kind getDocumentKind() const
returns the document kind
Definition StarObject.cxx:115
StarObject::m_password
char const * m_password
the document password
Definition StarObject.hxx:141
StarObject::getOLEDirectory
std::shared_ptr< STOFFOLEParser::OleDirectory > getOLEDirectory()
returns the object directory
Definition StarObject.hxx:86
StarObject::readStarFrameworkConfigFile
bool readStarFrameworkConfigFile(STOFFInputStreamPtr input, libstoff::DebugFile &ascii)
try to read the "Star Framework Config File"
Definition StarObject.cxx:687
StarObject::readPersistData
bool readPersistData(StarZone &zone, long endPos)
try to read persist data
Definition StarObject.cxx:363
StarObject::readStarFrameworkConfigItem
bool readStarFrameworkConfigItem(STOFFEntry &entry, STOFFInputStreamPtr input, libstoff::DebugFile &ascii)
try to read an item in a "Star Framework Config File"
Definition StarObject.cxx:764
StarObject::readPersistElements
bool readPersistElements(STOFFInputStreamPtr input, std::string const &name)
the "persist elements" small ole: the list of object
Definition StarObject.cxx:287
StarObject::readItemSet
bool readItemSet(StarZone &zone, std::vector< STOFFVec2i > const &limits, long endPos, StarItemSet &itemSet, StarItemPool *pool=nullptr, bool isDirect=false)
try to read a list of item
Definition StarObject.cxx:229
StarObject::~StarObject
virtual ~StarObject()
destructor
Definition StarObject.cxx:102
StarObject::StarObject
StarObject(StarObject const &orig)=delete
StarObject::readSfxWindows
bool readSfxWindows(STOFFInputStreamPtr input, libstoff::DebugFile &ascii)
try to read the windows information : "SfxWindows"
Definition StarObject.cxx:824
StarObject::m_oleParser
std::shared_ptr< STOFFOLEParser > m_oleParser
the ole parser
Definition StarObject.hxx:143
StarObject::StarObject
StarObject(char const *passwd, std::shared_ptr< STOFFOLEParser > &oleParser, std::shared_ptr< STOFFOLEParser::OleDirectory > &directory)
constructor
Definition StarObject.cxx:80
StarObject::readSfxDocumentInformation
bool readSfxDocumentInformation(STOFFInputStreamPtr input, std::string const &name)
try to read the document information : "SfxDocumentInformation"
Definition StarObject.cxx:488
StarObject::getUserNameMetaData
librevenge::RVNGString getUserNameMetaData(int i) const
returns the ith user meta data
Definition StarObject.cxx:130
StarObject::operator=
StarObject & operator=(StarObject const &orig)=delete
StarObject::getMetaData
librevenge::RVNGPropertyList const & getMetaData() const
returns the meta data (filled by readSfxDocumentInformation)
Definition StarObject.hxx:95
StarObject::getNewItemPool
std::shared_ptr< StarItemPool > getNewItemPool(StarItemPool::Type type)
returns a new item pool for this document
Definition StarObject.cxx:142
StarObject::m_metaData
librevenge::RVNGPropertyList m_metaData
the meta data
Definition StarObject.hxx:150
StarObject::getFormatManager
std::shared_ptr< StarFormatManager > getFormatManager()
returns the format manager
Definition StarObject.cxx:125
StarObject::getAttributeManager
std::shared_ptr< StarAttributeManager > getAttributeManager()
returns the attribute manager
Definition StarObject.cxx:120
StarObject::cleanPools
void cleanPools()
clean each pool
Definition StarObject.cxx:106
StarObject::m_directory
std::shared_ptr< STOFFOLEParser::OleDirectory > m_directory
the directory
Definition StarObject.hxx:145
StarObject::readSfxPreview
bool readSfxPreview(STOFFInputStreamPtr input, std::string const &name)
try to read the preview : "SfxPreview"
Definition StarObject.cxx:800
StarObject::parse
bool parse()
try to parse data
Definition StarObject.cxx:170
StarObject::getPassword
char const * getPassword() const
returns the document password (the password given by the user)
Definition StarObject.hxx:81
StarObject::getCurrentPool
std::shared_ptr< StarItemPool > getCurrentPool(bool onlyInside=true)
returns the current all/inside pool
Definition StarObject.cxx:149
StarZone
a zone in a StarOffice file
Definition StarZone.hxx:57
libstoff::DebugFile
Definition STOFFDebug.hxx:211
STOFFInputStreamPtr
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition libstaroffice_internal.hxx:489
StarObjectInternal
Internal: the structures of a StarObject.
Definition StarObject.cxx:52
StarObjectInternal::State
the state of a StarObject
Definition StarObject.cxx:54