HanMacWrdJText.hxx Source File documentation

HanMacWrdJText.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 HanMac Word-J text document
36 *
37 */
38#ifndef HAN_MAC_WRD_J_TEXT
39# define HAN_MAC_WRD_J_TEXT
40
41#include <map>
42#include <vector>
43
44#include "libmwaw_internal.hxx"
45#include "MWAWDebug.hxx"
46
47namespace HanMacWrdJTextInternal
48{
49struct Paragraph;
50class SubDocument;
51struct TextZone;
52struct State;
53}
54
55class HanMacWrdJParser;
56
62 class HanMacWrdJText
63{
64 friend class HanMacWrdJTextInternal::SubDocument;
65 friend class HanMacWrdJParser;
66public:
68 explicit HanMacWrdJText(HanMacWrdJParser &parser);
70 virtual ~HanMacWrdJText();
71
73 int version() const;
74
76 int numPages() const;
77
78protected:
80 bool sendMainText();
82 bool sendText(long id, long cPos, MWAWListenerPtr listener=MWAWListenerPtr());
84 bool canSendTextAsGraphic(long id, long cPos);
86 bool sendText(HanMacWrdJTextInternal::TextZone const &zone, long cPos, MWAWListenerPtr listener=MWAWListenerPtr());
88 bool canSendTextAsGraphic(HanMacWrdJTextInternal::TextZone const &zone, long cPos);
90 void flushExtra();
91
93 int computeNumPages(HanMacWrdJTextInternal::TextZone const &zone);
95 std::vector<long> getTokenIdList() const;
97 void updateTextZoneTypes(std::map<long,int> const &idTypeMap);
99 void updateFootnoteInformations(long const &textZId, std::vector<long> const &fPosList);
100
101 //
102 // intermediate level
103 //
104
106 bool readFontNames(MWAWEntry const &entry);
108 bool readFonts(MWAWEntry const &entry);
110 bool readFont(MWAWFont &font, long endPos=-1);
112 bool readParagraphs(MWAWEntry const &entry);
114 bool readParagraph(HanMacWrdJTextInternal::Paragraph &para, long endPos=-1);
116 bool readStyles(MWAWEntry const &entry);
118 bool readTextZonesList(MWAWEntry const &entry);
120 bool readTextZone(MWAWEntry const &entry, int actZone);
122 bool readTextToken(long endPos, HanMacWrdJTextInternal::TextZone &zone);
124 bool readSections(MWAWEntry const &entry);
126 bool readFtnPos(MWAWEntry const &entry);
127
128 //
129 // low level
130 //
131
132private:
133 HanMacWrdJText(HanMacWrdJText const &orig) = delete;
134 HanMacWrdJText &operator=(HanMacWrdJText const &orig) = delete;
135
136protected:
137 //
138 // data
139 //
141 MWAWParserStatePtr m_parserState;
142
144 std::shared_ptr<HanMacWrdJTextInternal::State> m_state;
145
147 HanMacWrdJParser *m_mainParser;
148};
149#endif
150// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
HanMacWrdJParser
the main class to read a HanMac Word-J file
Definition HanMacWrdJParser.hxx:110
HanMacWrdJTextInternal::SubDocument
Internal: the subdocument of a HanMacWrdJText.
Definition HanMacWrdJText.cxx:349
HanMacWrdJText::updateTextZoneTypes
void updateTextZoneTypes(std::map< long, int > const &idTypeMap)
update the text zone type with map id->type
Definition HanMacWrdJText.cxx:900
HanMacWrdJText::numPages
int numPages() const
returns the number of pages
Definition HanMacWrdJText.cxx:453
HanMacWrdJText::sendText
bool sendText(long id, long cPos, MWAWListenerPtr listener=MWAWListenerPtr())
send a text zone
Definition HanMacWrdJText.cxx:524
HanMacWrdJText::HanMacWrdJText
HanMacWrdJText(HanMacWrdJText const &orig)=delete
HanMacWrdJText::~HanMacWrdJText
virtual ~HanMacWrdJText()
destructor
Definition HanMacWrdJText.cxx:442
HanMacWrdJText::readFontNames
bool readFontNames(MWAWEntry const &entry)
try to read the fonts name zone (type 15)
Definition HanMacWrdJText.cxx:1651
HanMacWrdJText::HanMacWrdJParser
friend class HanMacWrdJParser
Definition HanMacWrdJText.hxx:65
HanMacWrdJText::readFonts
bool readFonts(MWAWEntry const &entry)
try to read the fonts zone (type 0)
Definition HanMacWrdJText.cxx:1568
HanMacWrdJText::canSendTextAsGraphic
bool canSendTextAsGraphic(long id, long cPos)
check if we can send a textzone as graphic
Definition HanMacWrdJText.cxx:486
HanMacWrdJText::readTextZonesList
bool readTextZonesList(MWAWEntry const &entry)
try to read the list of textzones ( type 4)
Definition HanMacWrdJText.cxx:922
HanMacWrdJText::readParagraphs
bool readParagraphs(MWAWEntry const &entry)
try to read the paragraphs zone (type 1)
Definition HanMacWrdJText.cxx:2093
HanMacWrdJText::version
int version() const
returns the file version
Definition HanMacWrdJText.cxx:446
HanMacWrdJText::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition HanMacWrdJText.cxx:2378
HanMacWrdJText::readFont
bool readFont(MWAWFont &font, long endPos=-1)
try to read the font ( reading up to endPos if endPos is defined )
Definition HanMacWrdJText.cxx:1439
HanMacWrdJText::updateFootnoteInformations
void updateFootnoteInformations(long const &textZId, std::vector< long > const &fPosList)
update the footnote text zone id and the list of first char position
Definition HanMacWrdJText.cxx:916
HanMacWrdJText::m_mainParser
HanMacWrdJParser * m_mainParser
the main parser;
Definition HanMacWrdJText.hxx:147
HanMacWrdJText::HanMacWrdJText
HanMacWrdJText(HanMacWrdJParser &parser)
constructor
Definition HanMacWrdJText.cxx:435
HanMacWrdJText::readStyles
bool readStyles(MWAWEntry const &entry)
try to read the style zone (type 2)
Definition HanMacWrdJText.cxx:1731
HanMacWrdJText::m_state
std::shared_ptr< HanMacWrdJTextInternal::State > m_state
the state
Definition HanMacWrdJText.hxx:144
HanMacWrdJText::readFtnPos
bool readFtnPos(MWAWEntry const &entry)
try to read the footnote position
Definition HanMacWrdJText.cxx:2285
HanMacWrdJText::readSections
bool readSections(MWAWEntry const &entry)
try to read the different sections
Definition HanMacWrdJText.cxx:2174
HanMacWrdJText::getTokenIdList
std::vector< long > getTokenIdList() const
returns the list of zoneId which corresponds to the token
Definition HanMacWrdJText.cxx:467
HanMacWrdJText::readTextZone
bool readTextZone(MWAWEntry const &entry, int actZone)
try to read a text zone ( type 5 )
Definition HanMacWrdJText.cxx:1070
HanMacWrdJText::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition HanMacWrdJText.hxx:141
HanMacWrdJText::readParagraph
bool readParagraph(HanMacWrdJTextInternal::Paragraph &para, long endPos=-1)
try to read a paragraph ( reading up to endPos if endPos is defined )
Definition HanMacWrdJText.cxx:1876
HanMacWrdJText::readTextToken
bool readTextToken(long endPos, HanMacWrdJTextInternal::TextZone &zone)
try to read the token in the text zone
Definition HanMacWrdJText.cxx:1330
HanMacWrdJText::computeNumPages
int computeNumPages(HanMacWrdJTextInternal::TextZone const &zone)
compute the number of pages present in a zone
Definition HanMacWrdJText.cxx:848
HanMacWrdJText::operator=
HanMacWrdJText & operator=(HanMacWrdJText const &orig)=delete
HanMacWrdJText::sendMainText
bool sendMainText()
send the main text zone
Definition HanMacWrdJText.cxx:536
MWAWEntry
basic class to store an entry in a file This contained :
Definition MWAWEntry.hxx:47
MWAWFont
Class to store font.
Definition MWAWFont.hxx:44
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
HanMacWrdJTextInternal
Internal: the structures of a HanMacWrdJText.
Definition HanMacWrdJText.cxx:59
HanMacWrdJTextInternal::Paragraph
Internal: class to store the paragraph properties of a HanMacWrdJText.
Definition HanMacWrdJText.cxx:264
HanMacWrdJTextInternal::State
Internal: the state of a HanMacWrdJText.
Definition HanMacWrdJText.cxx:312
HanMacWrdJTextInternal::TextZone
Internal: a struct used to store a text zone.
Definition HanMacWrdJText.cxx:231