StarItemPool.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  * StarPool to read/parse some StarOffice pools
36  *
37  */
38 #ifndef STAR_ITEM_POOL_HXX
39 # define STAR_ITEM_POOL_HXX
40 
41 #include <map>
42 #include <set>
43 #include <vector>
44 
46 
47 #include "STOFFDebug.hxx"
48 #include "STOFFEntry.hxx"
49 #include "STOFFInputStream.hxx"
50 
51 class StarAttribute;
52 class StarItem;
53 class StarItemSet;
54 class StarItemStyle;
55 
56 namespace StarItemPoolInternal
57 {
58 struct State;
59 }
60 
61 class StarAttribute;
62 class StarObject;
63 class StarZone;
64 
71 {
72 public:
77  StarItemPool(StarObject &document, Type type);
79  virtual ~StarItemPool();
80 
82  void clean();
84  void addSecondaryPool(std::shared_ptr<StarItemPool> secondary);
86  bool isSecondaryPool() const;
88  bool read(StarZone &zone);
90  int getVersion() const;
92  Type getType() const;
94  bool isInside() const
95  {
96  return m_isInside;
97  }
99  bool readStyles(StarZone &zone, StarObject &doc);
103  void updateStyles();
105  void updateUsingStyles(StarItemSet &itemSet) const;
107  void defineGraphicStyle(STOFFListenerPtr &listener, librevenge::RVNGString const &styleName, StarObject &object) const
108  {
109  std::set<librevenge::RVNGString> done;
110  defineGraphicStyle(listener, styleName, object, done);
111  }
113  void defineParagraphStyle(STOFFListenerPtr &listener, librevenge::RVNGString const &styleName, StarObject &object) const
114  {
115  std::set<librevenge::RVNGString> done;
116  defineParagraphStyle(listener, styleName, object, done);
117  }
119  StarItemStyle const *findStyleWithFamily(librevenge::RVNGString const &style, int family) const;
121  std::shared_ptr<StarAttribute> readAttribute(StarZone &zone, int which, int vers, long endPos);
123  std::shared_ptr<StarItem> readItem(StarZone &zone, bool isDirect, long endPos);
125  std::shared_ptr<StarItem> loadSurrogate(StarZone &zone, uint16_t &nWhich, bool localId, libstoff::DebugStream &f);
127  bool loadSurrogate(StarItem &item);
129  void setRelativeUnit(double relUnit);
131  double getRelativeUnit() const;
132 protected:
134  void defineGraphicStyle(STOFFListenerPtr listener, librevenge::RVNGString const &styleName, StarObject &object, std::set<librevenge::RVNGString> &done) const;
136  void defineParagraphStyle(STOFFListenerPtr listener, librevenge::RVNGString const &styleName, StarObject &object, std::set<librevenge::RVNGString> &done) const;
138  bool readV1(StarZone &zone, StarItemPool *master);
140  bool readV2(StarZone &zone, StarItemPool *master);
141 
143  std::shared_ptr<StarItem> createItem(int which, int surrogateId, bool localId);
144 
145  //
146  // data
147  //
148 private:
152  std::shared_ptr<StarItemPoolInternal::State> m_state;
153 };
154 #endif
155 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
class to store an item: ie.
Definition: StarItem.hxx:53
std::shared_ptr< StarItem > loadSurrogate(StarZone &zone, uint16_t &nWhich, bool localId, libstoff::DebugStream &f)
try to load a surrogate
Definition: StarItemPool.cxx:1162
Definition: StarItemPool.hxx:75
Type
the known item pool
Definition: StarItemPool.hxx:75
bool readV2(StarZone &zone, StarItemPool *master)
try to read a "ItemPool" zone (version 2)
Definition: StarItemPool.cxx:1211
std::shared_ptr< StarItemPoolInternal::State > m_state
the state
Definition: StarItemPool.hxx:152
Definition: StarItemPool.hxx:75
Definition: StarItemPool.hxx:75
virtual ~StarItemPool()
destructor
Definition: StarItemPool.cxx:909
Definition: StarItemPool.hxx:75
bool m_isInside
true if the pool is open
Definition: StarItemPool.hxx:150
Definition: StarItemPool.hxx:75
bool readV1(StarZone &zone, StarItemPool *master)
try to read a "ItemPool" zone (version 1)
Definition: StarItemPool.cxx:1468
void defineGraphicStyle(STOFFListenerPtr &listener, librevenge::RVNGString const &styleName, StarObject &object) const
define a graphic style
Definition: StarItemPool.hxx:107
void defineParagraphStyle(STOFFListenerPtr &listener, librevenge::RVNGString const &styleName, StarObject &object) const
define a paragraph style
Definition: StarItemPool.hxx:113
void addSecondaryPool(std::shared_ptr< StarItemPool > secondary)
add a secondary pool
Definition: StarItemPool.cxx:934
bool readStyles(StarZone &zone, StarObject &doc)
try to read the styles, ie a "StyleItemPool" zone
Definition: StarItemPool.cxx:1795
std::shared_ptr< StarAttribute > readAttribute(StarZone &zone, int which, int vers, long endPos)
try to read an attribute
Definition: StarItemPool.cxx:966
StarItemStyle const * findStyleWithFamily(librevenge::RVNGString const &style, int family) const
try to find a style with a name and a family style
Definition: StarItemPool.cxx:2141
bool read(StarZone &zone)
try to read a "ItemPool" zone
Definition: StarItemPool.cxx:992
std::shared_ptr< StarItem > createItem(int which, int surrogateId, bool localId)
create an item for futher reading
Definition: StarItemPool.cxx:957
virtual class used to store the different attribute
Definition: StarAttribute.hxx:62
std::shared_ptr< StarItem > readItem(StarZone &zone, bool isDirect, long endPos)
read a item
Definition: StarItemPool.cxx:1041
void updateStyles()
try to update the style
Definition: StarItemPool.cxx:2069
void setRelativeUnit(double relUnit)
set the item pool relative unit (if this is different to the default one)
Definition: StarItemPool.cxx:913
int getVersion() const
returns the pool version
Definition: StarItemPool.cxx:947
class to store a list of item
Definition: StarItem.hxx:87
void clean()
clean the pool&#39;s list of attributes, ...
Definition: StarItemPool.cxx:924
brief class used to stored the style
Definition: StarItem.hxx:115
Type getType() const
returns the pool type
Definition: StarItemPool.cxx:952
bool isInside() const
returns true if we are reading the pool
Definition: StarItemPool.hxx:94
void updateUsingStyles(StarItemSet &itemSet) const
update a itemset by adding attribute corresponding to its styles
Definition: StarItemPool.cxx:2239
Internal: the structures of a StarItemPool.
Definition: StarItemPool.cxx:56
the main class to read/.
Definition: StarItemPool.hxx:70
Definition: STOFFDebug.hxx:194
StarItemPool(StarObject &document, Type type)
constructor
Definition: StarItemPool.cxx:903
std::shared_ptr< STOFFListener > STOFFListenerPtr
a smart pointer of STOFFListener
Definition: libstaroffice_internal.hxx:487
bool isSecondaryPool() const
returns true if a pool is a secondary pool
Definition: StarItemPool.cxx:929
double getRelativeUnit() const
returns the set relative unit if this is set, or the default unit corresponding to this pool ...
Definition: StarItemPool.cxx:918
an object corresponding to an OLE directory
Definition: StarObject.hxx:64
a zone in a StarOffice file
Definition: StarZone.hxx:56
Definition: StarItemPool.hxx:75
Definition: StarItemPool.hxx:75
Internal: the state of a StarItemPool.
Definition: StarItemPool.cxx:354

Generated on Sat May 29 2021 22:54:03 for libstaroffice by doxygen 1.8.14