RagTime5Pipeline.hxx Source File documentation

RagTime5Pipeline.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 ( pipeline part )
36 *
37 */
38 #ifndef RAGTIME5_PIPELINE
39 # define RAGTIME5_PIPELINE
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
54 #include "RagTime5StructManager.hxx"
55 #include "RagTime5ClusterManager.hxx"
56
57 namespace RagTime5PipelineInternal
58 {
59 struct ClusterPipeline;
60 struct State;
61 }
62
63 class RagTime5Document;
64 class RagTime5StructManager;
65 class RagTime5Zone;
66
72 class RagTime5Pipeline
73 {
74 friend class RagTime5Document;
75
76 public:
77
79 explicit RagTime5Pipeline(RagTime5Document &doc);
81 virtual ~RagTime5Pipeline();
82
84 int version() const;
85
86 protected:
87
89 void flushExtra();
90
91 // interface with main parser
92
94 std::shared_ptr<RagTime5ClusterManager::Cluster> readPipelineCluster(RagTime5Zone &zone, int zoneType);
96 RagTime5ClusterManager::Cluster::Type getContainerType(int pipelineId) const;
98 bool send(int pipelineId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, double totalWidth=-1);
99
100 //
101 // Intermediate level
102 //
103
104 //
105 // low level
106 //
107
108 //
109 // send data
110 //
111
112 public:
114 static std::string printType(unsigned long fileType)
115 {
116 return RagTime5StructManager::printType(fileType);
117 }
118
119 private:
120 RagTime5Pipeline(RagTime5Pipeline const &orig) = delete;
121 RagTime5Pipeline &operator=(RagTime5Pipeline const &orig) = delete;
122
123 protected:
124 //
125 // data
126 //
128 RagTime5Document &m_document;
129
131 std::shared_ptr<RagTime5StructManager> m_structManager;
133 MWAWParserStatePtr m_parserState;
134
136 std::shared_ptr<RagTime5PipelineInternal::State> m_state;
137 };
138 #endif
139 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTime5ClusterManager::Link::m_ids
std::vector< int > m_ids
the data ids
Definition: RagTime5ClusterManager.hxx:210
RagTime5PipelineInternal::PipelineCParser::getCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > getCluster() final
return the current cluster
Definition: RagTime5Pipeline.cxx:321
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
RagTime5Pipeline::getContainerType
RagTime5ClusterManager::Cluster::Type getContainerType(int pipelineId) const
try to return the container's type corresponding to an id
Definition: RagTime5Pipeline.cxx:138
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
RagTime5Pipeline::m_document
RagTime5Document & m_document
the parser
Definition: RagTime5Pipeline.hxx:128
RagTime5PipelineInternal::ClusterPipeline
the pipeline cluster ( 4001 zone)
Definition: RagTime5Pipeline.cxx:65
RagTime5ClusterManager::Cluster::Cluster
Cluster(Type type)
constructor
Definition: RagTime5ClusterManager.hxx:279
RagTime5ClusterManager::Cluster::C_Pipeline
@ C_Pipeline
Definition: RagTime5ClusterManager.hxx:264
RagTime5Pipeline::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5Pipeline.hxx:114
RagTime5PipelineInternal::UnknownParser
Internal: the helper to read a unknown.
Definition: RagTime5Pipeline.cxx:266
RagTime5ClusterManager::ClusterParser::m_link
Link m_link
the actual link
Definition: RagTime5ClusterManager.hxx:459
RagTime5StructManager.hxx
RagTime5StructManager::Field::T_Unstructured
@ T_Unstructured
Definition: RagTime5StructManager.hxx:245
RagTime5Pipeline::send
bool send(int pipelineId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, double totalWidth=-1)
try to send the container corresponding to pipelineId (mainly unimplemented)
Definition: RagTime5Pipeline.cxx:125
RagTime5PipelineInternal::ClusterPipeline::~ClusterPipeline
~ClusterPipeline() final
destructor
Definition: RagTime5Pipeline.cxx:87
RagTime5ClusterManager::ClusterParser::getClusterDebugName
std::string getClusterDebugName(int id)
returns "data"+id+"A" ( followed by the cluster type and name if know)
Definition: RagTime5ClusterManager.cxx:555
MWAWFontConverter.hxx
RagTime5PipelineInternal::ClustListParser::parseData
bool parseData(MWAWInputStreamPtr &input, long endPos, RagTime5Zone &, int, libmwaw::DebugStream &f) final
try to parse a data
Definition: RagTime5Pipeline.cxx:209
RagTime5StructManager::Field
a field of RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:242
RagTime5Document::checkClusterList
bool checkClusterList(std::vector< RagTime5StructManager::ZoneLink > const &list)
check a cluster list
Definition: RagTime5Document.cxx:1117
RagTime5PipelineInternal::ClustListParser::m_clusterManager
RagTime5ClusterManager & m_clusterManager
the main zone manager
Definition: RagTime5Pipeline.cxx:254
RagTime5PipelineInternal::State::State
State()
constructor
Definition: RagTime5Pipeline.cxx:95
RagTime5Document.hxx
RagTime5ClusterManager::ClusterParser
virtual class use to parse the cluster data
Definition: RagTime5ClusterManager.hxx:381
RagTime5Pipeline::version
int version() const
returns the file version
Definition: RagTime5Pipeline.cxx:120
RagTime5PipelineInternal::ClustListParser::getClusterDebugName
std::string getClusterDebugName(int id) const
return the cluster name
Definition: RagTime5Pipeline.cxx:194
RagTime5PipelineInternal::ClusterPipeline::m_dataId
int m_dataId
the data id
Definition: RagTime5Pipeline.cxx:78
RagTime5Pipeline::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Pipeline.hxx:131
RagTime5PipelineInternal::PipelineCParser::m_cluster
std::shared_ptr< ClusterPipeline > m_cluster
the current cluster
Definition: RagTime5Pipeline.cxx:462
RagTime5PipelineInternal::ClustListParser::ClustListParser
ClustListParser(RagTime5ClusterManager &clusterManager, int fieldSize, std::string const &zoneName)
constructor
Definition: RagTime5Pipeline.cxx:180
RagTime5StructManager::DataParser
virtual class use to parse the unstructured data
Definition: RagTime5StructManager.hxx:396
RagTime5StructManager::DataParser::DataParser
DataParser(std::string const &zoneName)
constructor
Definition: RagTime5StructManager.cxx:61
RagTime5StructManager::Field::T_FieldList
@ T_FieldList
Definition: RagTime5StructManager.hxx:244
RagTime5ClusterManager
basic class used to manage RagTime 5/6 zones
Definition: RagTime5ClusterManager.hxx:59
RagTime5PipelineInternal::ClustListParser::~ClustListParser
~ClustListParser() final
destructor
Definition: RagTime5Pipeline.cxx:261
MWAWSubDocument.hxx
RagTime5ClusterManager.hxx
RagTime5Pipeline::operator=
RagTime5Pipeline & operator=(RagTime5Pipeline const &orig)=delete
RagTime5StructManager::ZoneLink::m_dataId
int m_dataId
the data id (or 0)
Definition: RagTime5StructManager.hxx:344
RagTime5ClusterManager::Link::m_N
int m_N
the number of data ( or some flag if m_N & 0x8020)
Definition: RagTime5ClusterManager.hxx:212
RagTime5PipelineInternal::UnknownParser::UnknownParser
UnknownParser(UnknownParser &orig)=delete
copy constructor, not implemented
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:77
RagTime5PipelineInternal::State
Internal: the state of a RagTime5Pipeline.
Definition: RagTime5Pipeline.cxx:93
MWAWParagraph.hxx
libmwaw_internal.hxx
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5StructManager.cxx:94
MWAWPosition.hxx
RagTime5PipelineInternal::PipelineCParser::getPipelineCluster
std::shared_ptr< ClusterPipeline > getPipelineCluster()
return the pipeline cluster
Definition: RagTime5Pipeline.cxx:326
RagTime5PipelineInternal::UnknownParser::m_fieldSize
int m_fieldSize
the field size
Definition: RagTime5Pipeline.cxx:296
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
RagTime5ClusterManager::ClusterParser::m_dataId
int m_dataId
the actual zone id
Definition: RagTime5ClusterManager.hxx:457
RagTime5Pipeline::~RagTime5Pipeline
virtual ~RagTime5Pipeline()
destructor
Definition: RagTime5Pipeline.cxx:116
RagTime5PipelineInternal::ClusterPipeline::ClusterPipeline
ClusterPipeline()
constructor
Definition: RagTime5Pipeline.cxx:67
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:51
RagTime5Pipeline::RagTime5Pipeline
RagTime5Pipeline(RagTime5Pipeline const &orig)=delete
RagTime5PipelineInternal::PipelineCParser::parseZone
bool parseZone(MWAWInputStreamPtr &input, long fSz, int N, int flag, libmwaw::DebugStream &f) final
parse a zone
Definition: RagTime5Pipeline.cxx:352
RagTime5PipelineInternal
Internal: the structures of a RagTime5Pipeline.
Definition: RagTime5Pipeline.cxx:63
MWAWDebug.hxx
RagTime5PipelineInternal::UnknownParser::UnknownParser
UnknownParser(int fieldSize, std::string const &zoneName)
constructor
Definition: RagTime5Pipeline.cxx:268
RagTime5Document::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: RagTime5Document.cxx:472
RagTime5StyleManager.hxx
RagTime5PipelineInternal::PipelineCParser
try to read a pipeline cluster: 104,204,4104, 4204
Definition: RagTime5Pipeline.cxx:311
RagTime5PipelineInternal::ClustListParser::m_linkList
std::vector< RagTime5StructManager::ZoneLink > m_linkList
the list of read cluster
Definition: RagTime5Pipeline.cxx:251
RagTime5Pipeline
the main class to read the text part of RagTime 56 file
Definition: RagTime5Pipeline.hxx:73
RagTime5PipelineInternal::UnknownParser::parseData
bool parseData(MWAWInputStreamPtr &input, long endPos, RagTime5Zone &, int, libmwaw::DebugStream &f) final
try to parse a data
Definition: RagTime5Pipeline.cxx:280
RagTime5ClusterManager::Cluster::Type
Type
the cluster type
Definition: RagTime5ClusterManager.hxx:263
RagTime5Pipeline::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Pipeline.hxx:133
RagTime5PipelineInternal::ClusterPipeline::m_layoutId
int m_layoutId
the layout id
Definition: RagTime5Pipeline.cxx:82
RagTime5PipelineInternal::UnknownParser::operator=
UnknownParser & operator=(UnknownParser &orig)=delete
copy operator, not implemented
RagTime5Pipeline::readPipelineCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readPipelineCluster(RagTime5Zone &zone, int zoneType)
try to read a pipeline cluster
Definition: RagTime5Pipeline.cxx:471
RagTime5PipelineInternal::ClusterPipeline::m_masterId
int m_masterId
the master id
Definition: RagTime5Pipeline.cxx:80
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
RagTime5PipelineInternal::State::m_idPipelineMap
std::map< int, std::shared_ptr< ClusterPipeline > > m_idPipelineMap
map data id to text zone
Definition: RagTime5Pipeline.cxx:100
RagTime5PipelineInternal::PipelineCParser::PipelineCParser
PipelineCParser(RagTime5ClusterManager &parser, int type)
constructor
Definition: RagTime5Pipeline.cxx:313
RagTime5ClusterManager::getClusterDebugName
std::string getClusterDebugName(int id)
returns "data"+id+"A" ( followed by the cluster type and name if know)
Definition: RagTime5ClusterManager.cxx:230
RagTime5Document::getClusterManager
std::shared_ptr< RagTime5ClusterManager > getClusterManager()
returns the cluster manager
Definition: RagTime5Document.cxx:395
RagTime5ClusterManager::Link::m_fileType
unsigned long m_fileType[2]
the zone type in file
Definition: RagTime5ClusterManager.hxx:216
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:175
RagTime5PipelineInternal::ClustListParser::ClustListParser
ClustListParser(ClustListParser &orig)=delete
copy constructor, not implemented
RagTime5Zone::m_ids
int m_ids[3]
the zone id
Definition: RagTime5StructManager.hxx:140
MWAWListener.hxx
RagTime5Pipeline::m_state
std::shared_ptr< RagTime5PipelineInternal::State > m_state
the state
Definition: RagTime5Pipeline.hxx:136
RagTime5PipelineInternal::PipelineCParser::~PipelineCParser
~PipelineCParser() final
destructor
Definition: RagTime5Pipeline.cxx:465
RagTime5PipelineInternal::ClustListParser::operator=
ClustListParser & operator=(ClustListParser &orig)=delete
copy operator, not implemented
RagTime5ClusterManager::Cluster
the cluster data
Definition: RagTime5ClusterManager.hxx:261
RagTime5PipelineInternal::ClustListParser::getIdList
std::vector< int > getIdList() const
returns the not null list dataId list
Definition: RagTime5Pipeline.cxx:199
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:51
RagTime5ClusterManager::ClusterParser::m_type
int m_type
the cluster type
Definition: RagTime5ClusterManager.hxx:451
MWAWInputStream.hxx
RagTime5Pipeline::RagTime5Pipeline
RagTime5Pipeline(RagTime5Document &doc)
constructor
Definition: RagTime5Pipeline.cxx:108
RagTime5Pipeline.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
MWAWFont.hxx
RagTime5PipelineInternal::ClustListParser
Internal: the helper to read a clustList.
Definition: RagTime5Pipeline.cxx:178
RagTime5PipelineInternal::ClusterPipeline::m_data2Link
RagTime5ClusterManager::Link m_data2Link
the second data link(rare)
Definition: RagTime5Pipeline.cxx:84
RagTime5PipelineInternal::ClustListParser::m_fieldSize
int m_fieldSize
the field size
Definition: RagTime5Pipeline.cxx:249
RagTime5StructManager::ZoneLink::m_subZoneId
long m_subZoneId[2]
the sub id zones
Definition: RagTime5StructManager.hxx:346
RagTime5PipelineInternal::PipelineCParser::parseField
bool parseField(RagTime5StructManager::Field const &field, int, libmwaw::DebugStream &f) final
parse a field
Definition: RagTime5Pipeline.cxx:331
RagTime5Document::readFixedSizeZone
bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, std::string const &name)
try to read a fixed size zone
Definition: RagTime5Document.cxx:1658
RagTime5Document::send
bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0, int cellId=0, double totalWidth=-1)
try to send a cluster zone (mainly unimplemented)
Definition: RagTime5Document.cxx:2609
RagTime5Pipeline::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Pipeline.cxx:166
RagTime5StructManager::ZoneLink
a zone link in RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:303
RagTime5StructManager::readDataIdList
static bool readDataIdList(MWAWInputStreamPtr input, int n, std::vector< int > &listIds)
try to read n data id
Definition: RagTime5StructManager.cxx:332
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
RagTime5ClusterManager::ClusterParser::ClusterParser
ClusterParser(RagTime5ClusterManager &parser, int type, std::string const &zoneName)
constructor
Definition: RagTime5ClusterManager.hxx:383
RagTime5ClusterManager::Cluster::C_Unknown
@ C_Unknown
Definition: RagTime5ClusterManager.hxx:276
RagTime5ClusterManager::Link::m_fieldSize
int m_fieldSize
the field size
Definition: RagTime5ClusterManager.hxx:214
RagTime5PipelineInternal::UnknownParser::~UnknownParser
~UnknownParser() final
destructor
Definition: RagTime5Pipeline.cxx:304