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
57namespace RagTime5PipelineInternal
58{
59struct ClusterPipeline;
60struct State;
61}
62
63class RagTime5Document;
64class RagTime5StructManager;
65class RagTime5Zone;
66
72 class RagTime5Pipeline
73{
74 friend class RagTime5Document;
75
76public:
77
79 explicit RagTime5Pipeline(RagTime5Document &doc);
81 virtual ~RagTime5Pipeline();
82
84 int version() const;
85
86protected:
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
112public:
114 static std::string printType(unsigned long fileType)
115 {
116 return RagTime5StructManager::printType(fileType);
117 }
118
119private:
120 RagTime5Pipeline(RagTime5Pipeline const &orig) = delete;
121 RagTime5Pipeline &operator=(RagTime5Pipeline const &orig) = delete;
122
123protected:
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:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWPosition.hxx
RagTime5ClusterManager.hxx
RagTime5StructManager.hxx
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition MWAWPosition.hxx:48
RagTime5Document
the main class to read a RagTime v5 file
Definition RagTime5Document.hxx:77
RagTime5Pipeline::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition RagTime5Pipeline.hxx:114
RagTime5Pipeline::version
int version() const
returns the file version
Definition RagTime5Pipeline.cxx:120
RagTime5Pipeline::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition RagTime5Pipeline.hxx:133
RagTime5Pipeline::~RagTime5Pipeline
virtual ~RagTime5Pipeline()
destructor
Definition RagTime5Pipeline.cxx:116
RagTime5Pipeline::m_state
std::shared_ptr< RagTime5PipelineInternal::State > m_state
the state
Definition RagTime5Pipeline.hxx:136
RagTime5Pipeline::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition RagTime5Pipeline.cxx:166
RagTime5Pipeline::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition RagTime5Pipeline.hxx:131
RagTime5Pipeline::RagTime5Pipeline
RagTime5Pipeline(RagTime5Pipeline const &orig)=delete
RagTime5Pipeline::RagTime5Document
friend class RagTime5Document
Definition RagTime5Pipeline.hxx:74
RagTime5Pipeline::getContainerType
RagTime5ClusterManager::Cluster::Type getContainerType(int pipelineId) const
try to return the container's type corresponding to an id
Definition RagTime5Pipeline.cxx:138
RagTime5Pipeline::m_document
RagTime5Document & m_document
the parser
Definition RagTime5Pipeline.hxx:128
RagTime5Pipeline::RagTime5Pipeline
RagTime5Pipeline(RagTime5Document &doc)
constructor
Definition RagTime5Pipeline.cxx:108
RagTime5Pipeline::operator=
RagTime5Pipeline & operator=(RagTime5Pipeline const &orig)=delete
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
RagTime5Pipeline::readPipelineCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readPipelineCluster(RagTime5Zone &zone, int zoneType)
try to read a pipeline cluster
Definition RagTime5Pipeline.cxx:471
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition RagTime5StructManager.hxx:175
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition RagTime5StructManager.cxx:100
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition RagTime5StructManager.hxx:51
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition libmwaw_internal.hxx:557
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition libmwaw_internal.hxx:553
RagTime5PipelineInternal
Internal: the structures of a RagTime5Pipeline.
Definition RagTime5Pipeline.cxx:63
RagTime5ClusterManager::Cluster::Type
Type
the cluster type
Definition RagTime5ClusterManager.hxx:263
RagTime5PipelineInternal::ClusterPipeline
the pipeline cluster ( 4001 zone)
Definition RagTime5Pipeline.cxx:65
RagTime5PipelineInternal::State
Internal: the state of a RagTime5Pipeline.
Definition RagTime5Pipeline.cxx:93