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 
56 
57 namespace RagTime5TextInternal
58 {
59 struct ClusterText;
60 struct State;
61 
62 class SubDocument;
63 }
64 
65 class RagTime5Document;
68 class RagTime5Zone;
69 
76 {
78  friend class RagTime5Document;
79 
80 public:
81 
83  explicit RagTime5Text(RagTime5Document &doc);
85  virtual ~RagTime5Text();
86 
88  int version() const;
89 
91  int numPages() const;
92 
93 protected:
94 
96  void flushExtra(bool onlyCheck=false);
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);
115 
118 
120  bool readTextSeparators(RagTime5Zone &zone, std::vector<int> &pos);
121 
122  //
123  // low level
124  //
125 
126  //
127  // send data
128  //
129 
131  bool send(int zoneId, MWAWListenerPtr listener, int partId=0, int cellId=0, double totalWidth=-1);
133  bool send(RagTime5TextInternal::ClusterText &cluster, MWAWListenerPtr listener, int partId=0, int cellId=0, double totalWidth=-1);
135  bool send(RagTime5TextInternal::ClusterText &cluster, RagTime5Zone &dataZone, MWAWListenerPtr listener, size_t firstChar, size_t lastChar,
136  bool isLastZone, double totalWidth);
137 
138 public:
140  static std::string printType(unsigned long fileType)
141  {
142  return RagTime5StructManager::printType(fileType);
143  }
144 
145 private:
146  RagTime5Text(RagTime5Text const &orig) = delete;
147  RagTime5Text &operator=(RagTime5Text const &orig) = delete;
148 
149 protected:
150  //
151  // data
152  //
155 
157  std::shared_ptr<RagTime5StructManager> m_structManager;
159  std::shared_ptr<RagTime5StyleManager> m_styleManager;
162 
164  std::shared_ptr<RagTime5TextInternal::State> m_state;
165 };
166 #endif
167 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5StructManager.cxx:94
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Text.hxx:159
low level: the text cluster of a RagTime5Text
Definition: RagTime5Text.cxx:183
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
bool readPLCToCharStyle(RagTime5TextInternal::ClusterText &cluster)
try to read a plc id to char style correspondance
Definition: RagTime5Text.cxx:742
int numPages() const
returns the number of pages
Definition: RagTime5Text.cxx:365
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
std::shared_ptr< RagTime5ClusterManager::Cluster > readTextCluster(RagTime5Zone &zone, int zoneType)
try to read a text cluster
Definition: RagTime5Text.cxx:2436
Internal: the subdocument of a RagTime5Text.
Definition: RagTime5Text.cxx:281
Internal: the structures of a RagTime5Text.
Definition: RagTime5Text.cxx:67
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:60
bool send(int zoneId, MWAWListenerPtr listener, int partId=0, int cellId=0, double totalWidth=-1)
try to send the cluster zone
Definition: RagTime5Text.cxx:372
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Text.hxx:157
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:50
bool readLinkZones(RagTime5TextInternal::ClusterText &cluster, RagTime5ClusterManager::Link const &link, int what)
try to read a list of link/list definition with what=0:attachment, 1:item, 3:index, 4:field, 5:footnote
Definition: RagTime5Text.cxx:436
bool readTextSeparators(RagTime5Zone &zone, std::vector< int > &pos)
try to read the text separators
Definition: RagTime5Text.cxx:391
RagTime5Text(RagTime5Document &doc)
constructor
Definition: RagTime5Text.cxx:348
virtual ~RagTime5Text()
destructor
Definition: RagTime5Text.cxx:357
the main class to read the text part of RagTime 56 file
Definition: RagTime5Text.hxx:75
std::shared_ptr< RagTime5TextInternal::State > m_state
the state
Definition: RagTime5Text.hxx:164
RagTime5Text & operator=(RagTime5Text const &orig)=delete
int version() const
returns the file version
Definition: RagTime5Text.cxx:360
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:76
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:174
RagTime5Document & m_document
the parser
Definition: RagTime5Text.hxx:154
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Text.hxx:161
void flushExtra(bool onlyCheck=false)
sends the data which have not yet been sent to the listener
Definition: RagTime5Text.cxx:824
bool readPLC(RagTime5TextInternal::ClusterText &cluster, int zoneId)
try to read a list of PLC
Definition: RagTime5Text.cxx:663
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5Text.hxx:140

Generated for libmwaw by doxygen 1.8.14