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 RagTime5Parser;
64 class RagTime5StructManager;
65 class RagTime5Zone;
66
72 class RagTime5Pipeline
73 {
74 friend class RagTime5Parser;
75
76 public:
77
79 explicit RagTime5Pipeline(RagTime5Parser &parser);
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);
99
100 //
101 // Intermediate level
102 //
103
104 //
105 // low level
106 //
107
108 //
109 // send data
110 //
111
112 private:
113 RagTime5Pipeline(RagTime5Pipeline const &orig) = delete;
114 RagTime5Pipeline &operator=(RagTime5Pipeline const &orig) = delete;
115
116 protected:
117 //
118 // data
119 //
121 RagTime5Parser &m_mainParser;
122
124 std::shared_ptr<RagTime5StructManager> m_structManager;
126 MWAWParserStatePtr m_parserState;
127
129 std::shared_ptr<RagTime5PipelineInternal::State> m_state;
130 };
131 #endif
132 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTime5Pipeline
the main class to read the text part of RagTime 56 file
Definition: RagTime5Pipeline.hxx:72
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
RagTime5Pipeline::operator=
RagTime5Pipeline & operator=(RagTime5Pipeline const &orig)=delete
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
RagTime5Pipeline::version
int version() const
returns the file version
Definition: RagTime5Pipeline.cxx:120
RagTime5Pipeline::~RagTime5Pipeline
virtual ~RagTime5Pipeline()
destructor
Definition: RagTime5Pipeline.cxx:116
RagTime5Pipeline::RagTime5Pipeline
RagTime5Pipeline(RagTime5Parser &parser)
constructor
Definition: RagTime5Pipeline.cxx:108
RagTime5StructManager.hxx
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:48
RagTime5Pipeline::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Pipeline.hxx:124
RagTime5Pipeline::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Pipeline.hxx:126
RagTime5Pipeline::m_mainParser
RagTime5Parser & m_mainParser
the parser
Definition: RagTime5Pipeline.hxx:121
RagTime5Pipeline::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Pipeline.cxx:166
RagTime5Parser
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:73
RagTime5Pipeline::send
bool send(int pipelineId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0)
try to send the container corresponding to pipelineId (mainly unimplemented)
Definition: RagTime5Pipeline.cxx:125
MWAWInputStream.hxx
MWAWDebug.hxx
RagTime5ClusterManager::Cluster::Type
Type
the cluster type
Definition: RagTime5ClusterManager.hxx:223
MWAWPosition.hxx
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:170
RagTime5Pipeline::m_state
std::shared_ptr< RagTime5PipelineInternal::State > m_state
the state
Definition: RagTime5Pipeline.hxx:129
RagTime5ClusterManager.hxx
RagTime5Pipeline::readPipelineCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readPipelineCluster(RagTime5Zone &zone, int zoneType)
try to read a pipeline cluster
Definition: RagTime5Pipeline.cxx:470
RagTime5Pipeline::getContainerType
RagTime5ClusterManager::Cluster::Type getContainerType(int pipelineId) const
try to return the container&#39;s type corresponding to an id
Definition: RagTime5Pipeline.cxx:138
RagTime5PipelineInternal
Internal: the structures of a RagTime5Pipeline.
Definition: RagTime5Pipeline.cxx:62