DocMkrText.hxx Source File documentation

DocMkrText.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 Nisus text document
36 *
37 */
38#ifndef DOC_MKR_TEXT
39# define DOC_MKR_TEXT
40
41#include "libmwaw_internal.hxx"
42#include "MWAWDebug.hxx"
43
44namespace DocMkrTextInternal
45{
46struct Zone;
47
48class SubDocument;
49struct State;
50}
51
52class DocMkrParser;
53
59 class DocMkrText
60{
61 friend class DocMkrTextInternal::SubDocument;
62 friend class DocMkrParser;
63public:
65 explicit DocMkrText(DocMkrParser &parser);
67 virtual ~DocMkrText();
68
70 int version() const;
71
73 int numPages() const;
74
76 int numChapters() const;
77
79 void sendComment(std::string const &str);
80
81protected:
82
84 bool createZones();
85
87 bool sendMainText();
88
90 void flushExtra();
91
92 //
93 // intermediate level
94 //
95
97 void computeNumPages(DocMkrTextInternal::Zone const &zone) const;
98
100 void updatePageSpanList(std::vector<MWAWPageSpan> &spanList);
101
103 bool sendText(DocMkrTextInternal::Zone const &zone);
104
106 bool readFontNames(MWAWEntry const &entry);
107
109 bool readStyles(MWAWEntry const &entry);
110
112 bool readTOC(MWAWEntry const &entry);
113
115 bool sendTOC();
116
118 bool readWindows(MWAWEntry const &entry);
119
121 bool readFooter(MWAWEntry const &entry);
122
124 bool sendFooter(int zId);
125
126 //
127 // low level
128 //
129
131 void sendString(std::string const &str) const;
132private:
133 DocMkrText(DocMkrText const &orig) = delete;
134 DocMkrText &operator=(DocMkrText const &orig) = delete;
135
136protected:
137 //
138 // data
139 //
141 MWAWParserStatePtr m_parserState;
142
144 std::shared_ptr<DocMkrTextInternal::State> m_state;
145
147 DocMkrParser *m_mainParser;
148
149};
150#endif
151// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
DocMkrParser
the main class to read a DocMake file
Definition DocMkrParser.hxx:57
DocMkrTextInternal::SubDocument
Internal: the subdocument of a DocMkrText.
Definition DocMkrText.cxx:205
DocMkrText::readFooter
bool readFooter(MWAWEntry const &entry)
try to read the footer zone ( resource foot )
Definition DocMkrText.cxx:968
DocMkrText::sendTOC
bool sendTOC()
try to send a TOC zone
Definition DocMkrText.cxx:717
DocMkrText::createZones
bool createZones()
finds the different text zones
Definition DocMkrText.cxx:406
DocMkrText::version
int version() const
returns the file version
Definition DocMkrText.cxx:296
DocMkrText::sendFooter
bool sendFooter(int zId)
try to send a footer corresponding to a zone id
Definition DocMkrText.cxx:894
DocMkrText::computeNumPages
void computeNumPages(DocMkrTextInternal::Zone const &zone) const
compute the number of page of a zone
Definition DocMkrText.cxx:340
DocMkrText::m_state
std::shared_ptr< DocMkrTextInternal::State > m_state
the state
Definition DocMkrText.hxx:144
DocMkrText::DocMkrText
DocMkrText(DocMkrParser &parser)
constructor
Definition DocMkrText.cxx:285
DocMkrText::sendMainText
bool sendMainText()
send a main zone
Definition DocMkrText.cxx:1038
DocMkrText::readTOC
bool readTOC(MWAWEntry const &entry)
try to read a TOC zone? ( resource cnt# )
Definition DocMkrText.cxx:771
DocMkrText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition DocMkrText.hxx:141
DocMkrText::sendString
void sendString(std::string const &str) const
send a string to the listener
Definition DocMkrText.cxx:1029
DocMkrText::numChapters
int numChapters() const
returns the number of chapter
Definition DocMkrText.cxx:320
DocMkrText::updatePageSpanList
void updatePageSpanList(std::vector< MWAWPageSpan > &spanList)
update the page span list
Definition DocMkrText.cxx:357
DocMkrText::operator=
DocMkrText & operator=(DocMkrText const &orig)=delete
DocMkrText::readFontNames
bool readFontNames(MWAWEntry const &entry)
try to read the font name ( resource rQDF )
Definition DocMkrText.cxx:576
DocMkrText::readStyles
bool readStyles(MWAWEntry const &entry)
try to read the styles ( resource styl )
Definition DocMkrText.cxx:648
DocMkrText::m_mainParser
DocMkrParser * m_mainParser
the main parser;
Definition DocMkrText.hxx:147
DocMkrText::~DocMkrText
virtual ~DocMkrText()
destructor
Definition DocMkrText.cxx:292
DocMkrText::numPages
int numPages() const
returns the number of pages
Definition DocMkrText.cxx:303
DocMkrText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition DocMkrText.cxx:1053
DocMkrText::sendComment
void sendComment(std::string const &str)
send a string as comment
Definition DocMkrText.cxx:325
DocMkrText::sendText
bool sendText(DocMkrTextInternal::Zone const &zone)
try to send the text corresponding to a zone
Definition DocMkrText.cxx:505
DocMkrText::readWindows
bool readWindows(MWAWEntry const &entry)
try to read the windows information zone? ( resource Wndo )
Definition DocMkrText.cxx:833
DocMkrText::DocMkrParser
friend class DocMkrParser
Definition DocMkrText.hxx:62
DocMkrText::DocMkrText
DocMkrText(DocMkrText const &orig)=delete
MWAWEntry
basic class to store an entry in a file This contained :
Definition MWAWEntry.hxx:47
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition libmwaw_internal.hxx:557
DocMkrTextInternal
Internal: the structures of a DocMkrText.
Definition DocMkrText.cxx:58
DocMkrTextInternal::State
Internal: the state of a DocMkrText.
Definition DocMkrText.cxx:168
DocMkrTextInternal::Zone
Internal: structure to store a the data of a DocMkrText Zone.
Definition DocMkrText.cxx:133