RagTime5Text.hxx Source File documentation

RagTime5Text.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 ( text part )
36 *
37 */
38 #ifndef RAGTIME5_TEXT
39 # define RAGTIME5_TEXT
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 RagTime5TextInternal
58 {
59 struct ClusterText;
60 struct State;
61
62 class SubDocument;
63 }
64
65 class RagTime5Parser;
66 class RagTime5StructManager;
67 class RagTime5StyleManager;
68 class RagTime5Zone;
69
75 class RagTime5Text
76 {
77 friend class RagTime5TextInternal::SubDocument;
78 friend class RagTime5Parser;
79
80 public:
81
83 explicit RagTime5Text(RagTime5Parser &parser);
85 virtual ~RagTime5Text();
86
88 int version() const;
89
91 int numPages() const;
92
93 protected:
94
96 void flushExtra();
97
98 // interface with main parser
99
101 std::shared_ptr<RagTime5ClusterManager::Cluster> readTextCluster(RagTime5Zone &zone, int zoneType);
102
103 //
104 // Intermediate level
105 //
106
107 //
108 // basic text
109 //
110
112 bool readPLC(RagTime5TextInternal::ClusterText &cluster, int zoneId);
114 bool readPLCToCharStyle(RagTime5TextInternal::ClusterText &cluster);
115
117 bool readLinkZones(RagTime5ClusterManager::Cluster &cluster, RagTime5ClusterManager::Link const &link);
118
120 bool readFieldZones(RagTime5ClusterManager::Cluster &cluster, RagTime5ClusterManager::Link const &link, bool isDefinition);
122 bool readFieldDefinition(RagTime5Zone &zone, long endPos, int n);
124 bool readFieldPosition(RagTime5Zone &zone, long endPos, int n);
125
127 bool readTextSeparators(RagTime5Zone &zone, std::vector<int> &pos);
128
129 //
130 // low level
131 //
132
133 //
134 // send data
135 //
136
138 bool send(int zoneId, MWAWListenerPtr listener, int partId=0, int block2Id=0);
140 bool send(RagTime5TextInternal::ClusterText &cluster, MWAWListenerPtr listener, int partId=0, int block2Id=0);
141
142 private:
143 RagTime5Text(RagTime5Text const &orig) = delete;
144 RagTime5Text &operator=(RagTime5Text const &orig) = delete;
145
146 protected:
147 //
148 // data
149 //
151 RagTime5Parser &m_mainParser;
152
154 std::shared_ptr<RagTime5StructManager> m_structManager;
156 std::shared_ptr<RagTime5StyleManager> m_styleManager;
158 MWAWParserStatePtr m_parserState;
159
161 std::shared_ptr<RagTime5TextInternal::State> m_state;
162 };
163 #endif
164 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTime5Text::m_styleManager
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Text.hxx:156
RagTime5Text::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Text.cxx:848
RagTime5TextInternal::ClusterText
low level: the text cluster of a RagTime5Text
Definition: RagTime5Text.cxx:142
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
RagTime5Text::readPLCToCharStyle
bool readPLCToCharStyle(RagTime5TextInternal::ClusterText &cluster)
try to read a plc id to char style correspondance
Definition: RagTime5Text.cxx:766
RagTime5Text::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Text.cxx:236
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
RagTime5Text::readTextCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readTextCluster(RagTime5Zone &zone, int zoneType)
try to read a text cluster
Definition: RagTime5Text.cxx:2023
RagTime5Text::readFieldDefinition
bool readFieldDefinition(RagTime5Zone &zone, long endPos, int n)
try to read a field definition
Definition: RagTime5Text.cxx:378
RagTime5StructManager.hxx
RagTime5TextInternal
Internal: the structures of a RagTime5Text.
Definition: RagTime5Text.cxx:62
RagTime5StyleManager
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:60
RagTime5Text::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Text.hxx:154
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:48
RagTime5Text::send
bool send(int zoneId, MWAWListenerPtr listener, int partId=0, int block2Id=0)
try to send the cluster zone
Definition: RagTime5Text.cxx:243
RagTime5Text::readTextSeparators
bool readTextSeparators(RagTime5Zone &zone, std::vector< int > &pos)
try to read the text separators
Definition: RagTime5Text.cxx:262
RagTime5Text::readFieldPosition
bool readFieldPosition(RagTime5Zone &zone, long endPos, int n)
try to read a field position
Definition: RagTime5Text.cxx:511
RagTime5Text::readLinkZones
bool readLinkZones(RagTime5ClusterManager::Cluster &cluster, RagTime5ClusterManager::Link const &link)
try to read a list of link/list definition
Definition: RagTime5Text.cxx:549
RagTime5Text::SubDocument
friend class RagTime5TextInternal::SubDocument
Definition: RagTime5Text.hxx:77
RagTime5Text::RagTime5Text
RagTime5Text(RagTime5Parser &parser)
constructor
Definition: RagTime5Text.cxx:219
RagTime5Text::~RagTime5Text
virtual ~RagTime5Text()
destructor
Definition: RagTime5Text.cxx:228
RagTime5Parser
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:73
RagTime5Text
the main class to read the text part of RagTime 56 file
Definition: RagTime5Text.hxx:75
RagTime5Text::m_state
std::shared_ptr< RagTime5TextInternal::State > m_state
the state
Definition: RagTime5Text.hxx:161
MWAWInputStream.hxx
MWAWDebug.hxx
RagTime5Text::operator=
RagTime5Text & operator=(RagTime5Text const &orig)=delete
RagTime5Text::version
int version() const
returns the file version
Definition: RagTime5Text.cxx:231
MWAWPosition.hxx
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:170
RagTime5Text::readFieldZones
bool readFieldZones(RagTime5ClusterManager::Cluster &cluster, RagTime5ClusterManager::Link const &link, bool isDefinition)
try to read a list of field definition
Definition: RagTime5Text.cxx:307
RagTime5ClusterManager.hxx
RagTime5Text::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Text.hxx:158
RagTime5Text::readPLC
bool readPLC(RagTime5TextInternal::ClusterText &cluster, int zoneId)
try to read a list of PLC
Definition: RagTime5Text.cxx:687
RagTime5Text::m_mainParser
RagTime5Parser & m_mainParser
the parser
Definition: RagTime5Text.hxx:151
RagTime5ClusterManager::Link
a link to a small zone (or set of zones) in RagTime 5/6 documents
Definition: RagTime5ClusterManager.hxx:105
RagTime5ClusterManager::Cluster
the cluster data
Definition: RagTime5ClusterManager.hxx:221