RagTime5Layout.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 /* libmwaw
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  * Parser to RagTime 5-6 document ( layout part )
36  *
37  */
38 #ifndef RAGTIME5_LAYOUT
39 # define RAGTIME5_LAYOUT
40 
41 #include <set>
42 #include <string>
43 #include <map>
44 #include <vector>
45 
46 #include <librevenge/librevenge.h>
47 
48 #include "libmwaw_internal.hxx"
49 
50 #include "MWAWDebug.hxx"
51 #include "MWAWInputStream.hxx"
52 #include "MWAWPosition.hxx"
53 
56 
57 namespace RagTime5LayoutInternal
58 {
59 struct ClusterLayout;
60 struct State;
61 }
62 
63 class RagTime5Parser;
65 class RagTime5Zone;
66 
73 {
74  friend class RagTime5Parser;
75 
76 public:
77 
79  explicit RagTime5Layout(RagTime5Parser &parser);
81  virtual ~RagTime5Layout();
82 
84  int version() const;
85 
87  int numPages() const;
88 
89 protected:
90 
92  void flushExtra();
93 
94  // interface with main parser
95 
97  std::shared_ptr<RagTime5ClusterManager::Cluster> readLayoutCluster(RagTime5Zone &zone, int zoneType);
98 
99  //
100  // Intermediate level
101  //
102 
104  void updateLayouts();
105 
108  //
109  // low level
110  //
111 
112  //
113  // send data
114  //
115 
117  bool sendPageContents();
119  bool send(RagTime5LayoutInternal::ClusterLayout &cluster, MWAWListenerPtr listener, int page);
120 
121 private:
122  RagTime5Layout(RagTime5Layout const &orig) = delete;
123  RagTime5Layout &operator=(RagTime5Layout const &orig) = delete;
124 
125 protected:
126  //
127  // data
128  //
131 
133  std::shared_ptr<RagTime5StructManager> m_structManager;
136 
138  std::shared_ptr<RagTime5LayoutInternal::State> m_state;
139 };
140 #endif
141 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:549
RagTime5LayoutInternal
Internal: the structures of a RagTime5Layout.
Definition: RagTime5Layout.cxx:62
RagTime5Parser::getClusterManager
std::shared_ptr< RagTime5ClusterManager > getClusterManager()
returns the cluster manager
Definition: RagTime5Parser.cxx:326
RagTime5LayoutInternal::ClustListParser::ClustListParser
ClustListParser(RagTime5ClusterManager &clusterManager, int fieldSize, std::string const &zoneName)
constructor
Definition: RagTime5Layout.cxx:299
RagTime5LayoutInternal::LayoutCParser::m_linkId
int m_linkId
the link id : 0: listItem, 1: pipeline, 2: settinglinks, 3: namelink,
Definition: RagTime5Layout.cxx:949
RagTime5Layout::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Layout.cxx:158
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:840
RagTime5Layout::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Layout.hxx:133
RagTime5Layout::send
bool send(RagTime5LayoutInternal::ClusterLayout &cluster, MWAWListenerPtr listener, int page)
try to send the cluster zone
Definition: RagTime5Layout.cxx:274
RagTime5LayoutInternal::LayoutCParser::~LayoutCParser
~LayoutCParser() final
destructor
Definition: RagTime5Layout.cxx:957
RagTime5LayoutInternal::LayoutCParser
low level: parser of layout cluster
Definition: RagTime5Layout.cxx:371
RagTime5LayoutInternal::LayoutCParser::parseField
bool parseField(RagTime5StructManager::Field const &field, int, libmwaw::DebugStream &f) final
parse a field
Definition: RagTime5Layout.cxx:642
RagTime5Parser::readUnicodeStringList
bool readUnicodeStringList(RagTime5ClusterManager::Link const &link, std::map< int, librevenge::RVNGString > &idToStringMap)
try to read a list of unicode string zone
Definition: RagTime5Parser.cxx:864
RagTime5LayoutInternal::ClusterLayout::~ClusterLayout
~ClusterLayout() final
destructor
Definition: RagTime5Layout.cxx:111
RagTime5ClusterManager::Cluster::Cluster
Cluster(Type type)
constructor
Definition: RagTime5ClusterManager.hxx:237
RagTime5Layout::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Layout.hxx:135
RagTime5LayoutInternal::LayoutCParser::m_actualZoneId
int m_actualZoneId
the actual zone id
Definition: RagTime5Layout.cxx:943
MWAWPosition::setPage
void setPage(int pg) const
sets the page
Definition: MWAWPosition.hxx:204
RagTime5LayoutInternal::ClusterLayout::Zone::m_dimension
MWAWVec2f m_dimension
the dimension
Definition: RagTime5Layout.cxx:94
RagTime5ClusterManager::ClusterParser::m_link
Link m_link
the actual link
Definition: RagTime5ClusterManager.hxx:428
RagTime5LayoutInternal::ClusterLayout::m_zoneList
std::vector< Zone > m_zoneList
list of zone's
Definition: RagTime5Layout.cxx:98
RagTime5StructManager.hxx
RagTime5StructManager::Field::T_Unstructured
@ T_Unstructured
Definition: RagTime5StructManager.hxx:238
RagTime5Parser
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:73
RagTime5Layout::~RagTime5Layout
virtual ~RagTime5Layout()
destructor
Definition: RagTime5Layout.cxx:149
RagTime5LayoutInternal::LayoutCParser::getCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > getCluster() final
return the current cluster
Definition: RagTime5Layout.cxx:386
RagTime5LayoutInternal::State::State
State()
constructor
Definition: RagTime5Layout.cxx:119
RagTime5Parser::readListZone
bool readListZone(RagTime5ClusterManager::Link const &link)
try to read a list zone
Definition: RagTime5Parser.cxx:1608
MWAWFontConverter.hxx
RagTime5LayoutInternal::ClusterLayout::m_pipelineLink
RagTime5ClusterManager::Link m_pipelineLink
link to a pipeline cluster list
Definition: RagTime5Layout.cxx:100
RagTime5StructManager::Field
a field of RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:235
RagTime5LayoutInternal::LayoutCParser::parseHeaderZone
bool parseHeaderZone(MWAWInputStreamPtr &input, long fSz, int N, int flag, libmwaw::DebugStream &f)
parse the header zone
Definition: RagTime5Layout.cxx:841
RagTime5ClusterManager::ClusterParser::readLinkHeader
bool readLinkHeader(MWAWInputStreamPtr &input, long fSz, Link &link, long(&values)[4], std::string &message)
try to read a link header
Definition: RagTime5ClusterManager.cxx:552
RagTime5ClusterManager::getClusterName
std::string getClusterName(int id)
returns "data"+id+"A" ( followed by the cluster type and name if know)
Definition: RagTime5ClusterManager.cxx:223
RagTime5ClusterManager::ClusterParser
virtual class use to parse the cluster data
Definition: RagTime5ClusterManager.hxx:350
RagTime5LayoutInternal::LayoutCParser::parseZoneBlock
bool parseZoneBlock(MWAWInputStreamPtr &input, long fSz, int N, int flag, libmwaw::DebugStream &f)
parse a zone block
Definition: RagTime5Layout.cxx:747
RagTime5Layout
the main class to read the text part of RagTime 56 file
Definition: RagTime5Layout.hxx:72
RagTime5LayoutInternal::ClusterLayout::Zone
a zone of in a layout
Definition: RagTime5Layout.cxx:81
RagTime5LayoutInternal::ClusterLayout::m_numMasterChild
int m_numMasterChild
the number of master child
Definition: RagTime5Layout.cxx:108
RagTime5LayoutInternal::State::m_numPages
int m_numPages
the number of pages
Definition: RagTime5Layout.cxx:127
RagTime5StructManager::DataParser
virtual class use to parse the unstructured data
Definition: RagTime5StructManager.hxx:384
RagTime5ClusterManager::ClusterParser::getClusterName
std::string getClusterName(int id)
returns "data"+id+"A" ( followed by the cluster type and name if know)
Definition: RagTime5ClusterManager.cxx:547
RagTime5StructManager::DataParser::DataParser
DataParser(std::string const &zoneName)
constructor
Definition: RagTime5StructManager.hxx:386
RagTime5Parser::readFixedSizeZone
bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, std::string const &name)
try to read a fixed size zone
Definition: RagTime5Parser.cxx:1681
RagTime5StructManager::Field::T_FieldList
@ T_FieldList
Definition: RagTime5StructManager.hxx:237
RagTime5LayoutInternal::ClusterLayout
the layout cluster ( 4001 zone)
Definition: RagTime5Layout.cxx:65
RagTime5LayoutInternal::ClustListParser::m_fieldSize
int m_fieldSize
the field size
Definition: RagTime5Layout.cxx:352
RagTime5Layout::readLayoutCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readLayoutCluster(RagTime5Zone &zone, int zoneType)
try to read a layout cluster
Definition: RagTime5Layout.cxx:963
RagTime5LayoutInternal::ClusterLayout::m_numChild
int m_numChild
the number of classic child
Definition: RagTime5Layout.cxx:106
RagTime5LayoutInternal::ClusterLayout::ClusterLayout
ClusterLayout()
constructor
Definition: RagTime5Layout.cxx:67
RagTime5ClusterManager
basic class used to manage RagTime 5/6 zones
Definition: RagTime5ClusterManager.hxx:58
RagTime5LayoutInternal::ClustListParser::operator=
ClustListParser & operator=(ClustListParser &orig)=delete
copy operator, not implemented
RagTime5Parser::send
bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, int part2Id=0)
try to send a cluster zone (mainly unimplemented)
Definition: RagTime5Parser.cxx:2448
RagTime5LayoutInternal::LayoutCParser::getLayoutCluster
std::shared_ptr< ClusterLayout > getLayoutCluster()
return the current layout cluster
Definition: RagTime5Layout.cxx:391
RagTime5Parser::checkClusterList
bool checkClusterList(std::vector< RagTime5StructManager::ZoneLink > const &list)
check a cluster list
Definition: RagTime5Parser.cxx:1093
RagTime5Layout::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Layout.cxx:269
RagTime5Layout::operator=
RagTime5Layout & operator=(RagTime5Layout const &orig)=delete
RagTime5LayoutInternal::ClusterLayout::m_listItemLink
RagTime5ClusterManager::Link m_listItemLink
link to a zone of fieldSize 8(unknown)
Definition: RagTime5Layout.cxx:102
MWAWSubDocument.hxx
RagTime5ClusterManager.hxx
RagTime5StructManager::FieldParser
virtual class use to parse the field data
Definition: RagTime5StructManager.hxx:341
RagTime5Layout::updateLayouts
void updateLayouts()
update all internal data: list of master layout, ...
Definition: RagTime5Layout.cxx:208
RagTime5LayoutInternal::State::m_layoutIdToSendList
std::vector< int > m_layoutIdToSendList
the list of layout to send
Definition: RagTime5Layout.cxx:133
RagTime5LayoutInternal::ClustListParser::getClusterName
std::string getClusterName(int id) const
return the cluster name
Definition: RagTime5Layout.cxx:323
RagTime5Layout::m_mainParser
RagTime5Parser & m_mainParser
the parser
Definition: RagTime5Layout.hxx:130
RagTime5LayoutInternal::ClusterLayout::Zone::Zone
Zone()
constructor
Definition: RagTime5Layout.cxx:83
RagTime5Layout::sendPageContents
bool sendPageContents()
try to send the page content corresponding to the layout
Definition: RagTime5Layout.cxx:165
MWAWParagraph.hxx
RagTime5LayoutInternal::ClustListParser::m_linkList
std::vector< RagTime5StructManager::ZoneLink > m_linkList
the list of read cluster
Definition: RagTime5Layout.cxx:354
RagTime5LayoutInternal::LayoutCParser::parseZone
bool parseZone(MWAWInputStreamPtr &input, long fSz, int N, int flag, libmwaw::DebugStream &f) final
parse a zone
Definition: RagTime5Layout.cxx:437
RagTime5LayoutInternal::ClusterLayout::Zone::m_mainId
int m_mainId
the main zone id
Definition: RagTime5Layout.cxx:90
libmwaw_internal.hxx
MWAWPosition.hxx
RagTime5LayoutInternal::State
Internal: the state of a RagTime5Layout.
Definition: RagTime5Layout.cxx:117
RagTime5LayoutInternal::State::m_idLayoutMap
std::map< int, std::shared_ptr< ClusterLayout > > m_idLayoutMap
map data id to text zone
Definition: RagTime5Layout.cxx:129
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:47
RagTime5StructManager::Field::T_Long
@ T_Long
Definition: RagTime5StructManager.hxx:237
RagTime5ClusterManager::Cluster::C_GraphicZone
@ C_GraphicZone
Definition: RagTime5ClusterManager.hxx:228
RagTime5LayoutInternal::ClustListParser::~ClustListParser
~ClustListParser() final
destructor
Definition: RagTime5Layout.cxx:364
RagTime5LayoutInternal::ClustListParser::getIdList
std::vector< int > getIdList() const
returns the not null list dataId list
Definition: RagTime5Layout.cxx:313
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:48
RagTime5LayoutInternal::LayoutCParser::m_fieldName
std::string m_fieldName
the actual field name
Definition: RagTime5Layout.cxx:951
RagTime5LayoutInternal::ClusterLayout::m_childIdSet
std::set< int > m_childIdSet
list of child id
Definition: RagTime5Layout.cxx:104
MWAWVec2< float >
MWAWDebug.hxx
RagTime5LayoutInternal::LayoutCParser::endZone
void endZone() final
end of a start zone call
Definition: RagTime5Layout.cxx:407
MWAWBox2f
MWAWBox2< float > MWAWBox2f
MWAWBox2 of float.
Definition: libmwaw_internal.hxx:1191
RagTime5StyleManager.hxx
RagTime5LayoutInternal::ClustListParser
Internal: the helper to read a clustList.
Definition: RagTime5Layout.cxx:297
RagTime5Layout::m_state
std::shared_ptr< RagTime5LayoutInternal::State > m_state
the state
Definition: RagTime5Layout.hxx:138
RagTime5LayoutInternal::State::m_masterIdSet
std::set< int > m_masterIdSet
the list of master id
Definition: RagTime5Layout.cxx:131
RagTime5LayoutInternal::ClustListParser::m_clusterManager
RagTime5ClusterManager & m_clusterManager
the main zone manager
Definition: RagTime5Layout.cxx:357
RagTime5ClusterManager::Cluster::m_dataLink
Link m_dataLink
the main data link
Definition: RagTime5ClusterManager.hxx:263
RagTime5LayoutInternal::LayoutCParser::m_what
int m_what
a index to know which field is parsed : 0: main, 1:list of zones, 2: unknown, 3:data0,...
Definition: RagTime5Layout.cxx:947
RagTime5Layout.hxx
RagTime5LayoutInternal::LayoutCParser::m_numZones
int m_numZones
the number of zones
Definition: RagTime5Layout.cxx:945
RagTime5Parser::getClusterType
RagTime5ClusterManager::Cluster::Type getClusterType(int zId) const
returns the cluster type corresponding to zone id or C_Unknown (if the zone is not a cluster or was n...
Definition: RagTime5Parser.cxx:383
RagTime5LayoutInternal::LayoutCParser::m_actualZone
ClusterLayout::Zone m_actualZone
the actual zone
Definition: RagTime5Layout.cxx:954
RagTime5LayoutInternal::LayoutCParser::startZone
void startZone() final
start a new zone
Definition: RagTime5Layout.cxx:396
RagTime5Layout::RagTime5Layout
RagTime5Layout(RagTime5Parser &parser)
constructor
Definition: RagTime5Layout.cxx:141
MWAWPosition::Page
@ Page
Definition: MWAWPosition.hxx:51
RagTime5LayoutInternal::LayoutCParser::m_cluster
std::shared_ptr< ClusterLayout > m_cluster
the current cluster
Definition: RagTime5Layout.cxx:941
RagTime5StructManager::Field::T_LongList
@ T_LongList
Definition: RagTime5StructManager.hxx:237
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:555
RagTime5LayoutInternal::LayoutCParser::LayoutCParser
LayoutCParser(RagTime5ClusterManager &parser, int zoneType)
constructor
Definition: RagTime5Layout.cxx:373
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:170
RagTime5Zone::m_ids
int m_ids[3]
the zone id
Definition: RagTime5StructManager.hxx:138
MWAWListener.hxx
RagTime5LayoutInternal::ClusterLayout::Zone::m_masterId
int m_masterId
the master zone id or 0
Definition: RagTime5Layout.cxx:92
RagTime5LayoutInternal::ClustListParser::parseData
bool parseData(MWAWInputStreamPtr &input, long endPos, RagTime5Zone &, int, libmwaw::DebugStream &f) final
try to parse a data
Definition: RagTime5Layout.cxx:329
RagTime5Layout::version
int version() const
returns the file version
Definition: RagTime5Layout.cxx:153
RagTime5ClusterManager::Cluster
the cluster data
Definition: RagTime5ClusterManager.hxx:221
RagTime5ClusterManager::ClusterParser::m_type
int m_type
the cluster type
Definition: RagTime5ClusterManager.hxx:420
MWAWInputStream.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:551
MWAWFont.hxx
MWAWPosition::m_anchorTo
AnchorTo m_anchorTo
anchor position
Definition: MWAWPosition.hxx:269
RagTime5Parser::readStructZone
bool readStructZone(RagTime5ClusterManager::Cluster &cluster, RagTime5StructManager::FieldParser &parser, int headerSz)
try to read a structured zone
Definition: RagTime5Parser.cxx:1745
RagTime5ClusterManager::Cluster::C_Layout
@ C_Layout
Definition: RagTime5ClusterManager.hxx:224
RagTime5StructManager::readDataIdList
static bool readDataIdList(MWAWInputStreamPtr input, int n, std::vector< int > &listIds)
try to read n data id
Definition: RagTime5StructManager.cxx:269
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
RagTime5Layout::updateLayout
void updateLayout(RagTime5LayoutInternal::ClusterLayout &layout)
check that a layout is valid, ...
Definition: RagTime5Layout.cxx:232
RagTime5Parser.hxx
RagTime5ClusterManager::ClusterParser::ClusterParser
ClusterParser(RagTime5ClusterManager &parser, int type, std::string const &zoneName)
constructor
Definition: RagTime5ClusterManager.hxx:352
RagTime5ClusterManager::Cluster::C_Unknown
@ C_Unknown
Definition: RagTime5ClusterManager.hxx:234

Generated on Mon Apr 25 2022 14:03:04 for libmwaw by doxygen 1.8.17