TeachTxtParser.hxx Source File documentation

TeachTxtParser.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 #ifndef TEACH_TXT_PARSER
35 # define TEACH_TXT_PARSER
36
37 #include <string>
38 #include <vector>
39
40 #include <librevenge/librevenge.h>
41
42 #include "MWAWDebug.hxx"
43 #include "MWAWInputStream.hxx"
44
45 #include "MWAWParser.hxx"
46
47 namespace TeachTxtParserInternal
48 {
49 struct State;
50 }
51
54 class TeachTxtParser final : public MWAWTextParser
55 {
56 public:
58 TeachTxtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
60 ~TeachTxtParser() final;
61
63 bool checkHeader(MWAWHeader *header, bool strict=false) final;
64
65 // the main parse function
66 void parse(librevenge::RVNGTextInterface *documentInterface) final;
67
68 protected:
70 void init();
71
73 void createDocument(librevenge::RVNGTextInterface *documentInterface);
74
76 void newPage(int number);
77
78 protected:
80 bool createZones();
82 bool readStyles(MWAWEntry const &entry);
83
85 bool readWRCT(MWAWEntry const &entry);
86
87 // Intermediate level
88
90 int computeNumPages() const;
91
93 bool sendText();
95 bool sendPicture(int id);
97 void flushExtra();
98
100 MWAWInputStreamPtr rsrcInput();
102 libmwaw::DebugFile &rsrcAscii();
103
104 //
105 // data
106 //
108 std::shared_ptr<TeachTxtParserInternal::State> m_state;
109 };
110 #endif
111 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:567
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
TeachTxtParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: TeachTxtParser.cxx:79
TeachTxtParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: TeachTxtParser.cxx:485
MWAWParser::getFontConverter
MWAWFontConverterPtr & getFontConverter()
returns the font converter
Definition: MWAWParser.hxx:150
MWAWInputStream::get
static std::shared_ptr< MWAWInputStream > get(librevenge::RVNGBinaryData const &data, bool inverted)
returns a new input stream corresponding to a librevenge::RVNGBinaryData
Definition: MWAWInputStream.cxx:102
TeachTxtParser::m_state
std::shared_ptr< TeachTxtParserInternal::State > m_state
the state
Definition: TeachTxtParser.hxx:108
TeachTxtParser::newPage
void newPage(int number)
adds a new page
Definition: TeachTxtParser.cxx:120
MWAWPageSpan::setPageSpan
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
TeachTxtParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: TeachTxtParser.cxx:167
TeachTxtParser::init
void init()
inits all internal variables
Definition: TeachTxtParser.cxx:97
MWAWDocument::Type
Type
an enum to define the different type of document
Definition: MWAWDocument.hxx:99
MWAWDocument::MWAW_T_TEACHTEXT
@ MWAW_T_TEACHTEXT
TeachText/SimpleText.
Definition: MWAWDocument.hxx:152
MWAWPosition::setRelativePosition
void setRelativePosition(AnchorTo anchor, XPos X=XLeft, YPos Y=YTop)
sets the relative position
Definition: MWAWPosition.hxx:237
TeachTxtParserInternal::State::m_posFontMap
std::map< long, MWAWFont > m_posFontMap
the map of id -> font
Definition: TeachTxtParser.cxx:74
TeachTxtParser
the main class to read a SimpleText/TeachText/Tex-Edit file
Definition: TeachTxtParser.hxx:54
MWAWEntry::isParsed
bool isParsed() const
a flag to know if the entry was parsed or not
Definition: MWAWEntry.hxx:121
MWAWFont::boldBit
@ boldBit
Definition: MWAWFont.hxx:190
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
MWAWFont::setColor
void setColor(MWAWColor color)
sets the font color
Definition: MWAWFont.hxx:341
libmwaw::DebugFile::open
bool open(std::string const &filename)
opens/creates a file to store a result
Definition: MWAWDebug.cxx:46
TeachTxtParserInternal::State::State
State()
constructor
Definition: TeachTxtParser.cxx:62
MWAWEntry::id
int id() const
returns the id
Definition: MWAWEntry.hxx:164
MWAWFontConverter.hxx
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
MWAWEmbeddedObject
small class use to define a embedded object
Definition: libmwaw_internal.hxx:467
MWAWParser::version
int version() const
returns the works version
Definition: MWAWParser.hxx:108
MWAWPrinter.hxx
TeachTxtParserInternal
Internal: the structures of a TeachTxtParser.
Definition: TeachTxtParser.cxx:56
TeachTxtParser::createZones
bool createZones()
finds the different objects zones
Definition: TeachTxtParser.cxx:195
MWAWFont::Line::Simple
@ Simple
Definition: MWAWFont.hxx:49
MWAWPictData::get
static MWAWPictData * get(MWAWInputStreamPtr const &input, int size)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:108
MWAWEntry::setParsed
void setParsed(bool ok=true) const
sets the flag m_parsed to true or false
Definition: MWAWEntry.hxx:126
MWAWParser::getTextListener
MWAWTextListenerPtr & getTextListener()
returns the text listener
Definition: MWAWParser.hxx:145
libmwaw::DebugFile::addNote
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
MWAWFont::setDeltaLetterSpacing
void setDeltaLetterSpacing(float d, librevenge::RVNGUnit unit=librevenge::RVNG_POINT)
sets the letter spacing ( delta value in point )
Definition: MWAWFont.hxx:292
MWAWEntry::type
const std::string & type() const
returns the type of the entry
Definition: MWAWEntry.hxx:137
MWAWPosition::XCenter
@ XCenter
Definition: MWAWPosition.hxx:55
TeachTxtParser::sendPicture
bool sendPicture(int id)
try to send a picture knowing the id
Definition: TeachTxtParser.cxx:436
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
MWAWFont::embossBit
@ embossBit
Definition: MWAWFont.hxx:190
TeachTxtParser::~TeachTxtParser
~TeachTxtParser() final
destructor
Definition: TeachTxtParser.cxx:93
TeachTxtParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: TeachTxtParser.cxx:107
MWAWSubDocument.hxx
libmwaw::DebugFile::reset
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:93
MWAWFont::m_extra
std::string m_extra
extra data
Definition: MWAWFont.hxx:573
MWAWFont::shadowBit
@ shadowBit
Definition: MWAWFont.hxx:191
MWAWParser::setTextListener
void setTextListener(MWAWTextListenerPtr &listener)
sets the text listener
Definition: MWAWParser.cxx:158
MWAWParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:227
MWAWParagraph.hxx
MWAWRSRCParser.hxx
MWAWParser::getRSRCParser
MWAWRSRCParserPtr & getRSRCParser()
returns the rsrc parser
Definition: MWAWParser.hxx:190
MWAWParser::getPageSpan
const MWAWPageSpan & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
MWAWPosition.hxx
MWAWDocument
This class provides all the functions needed by applications to parse many pre-MacOSX documents.
Definition: MWAWDocument.hxx:69
MWAWDocument::MWAW_T_UNKNOWN
@ MWAW_T_UNKNOWN
Unrecognised file type.
Definition: MWAWDocument.hxx:100
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:47
TeachTxtParserInternal::State::m_idPictEntryMap
std::map< int, MWAWEntry > m_idPictEntryMap
a map id->pictEntry
Definition: TeachTxtParser.cxx:76
MWAWParser::asciiName
const std::string & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:232
MWAWParser::setVersion
void setVersion(int vers)
sets the document's version
Definition: MWAWParser.hxx:206
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWPosition::m_wrapping
Wrapping m_wrapping
Wrapping.
Definition: MWAWPosition.hxx:278
MWAWEntry::length
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:93
MWAWPictData.hxx
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
libmwaw::DebugFile::setStream
void setStream(MWAWInputStreamPtr const &ip)
resets the input
Definition: MWAWDebug.hxx:81
MWAWDocument::MWAW_T_TEXEDIT
@ MWAW_T_TEXEDIT
Tex-Edit (v2)
Definition: MWAWDocument.hxx:153
MWAWPict::MWAW_R_BAD
@ MWAW_R_BAD
Definition: MWAWPict.hxx:73
libmwaw::ParseException
Definition: libmwaw_internal.hxx:143
MWAWDebug.hxx
MWAWFont::getDebugString
std::string getDebugString(std::shared_ptr< MWAWFontConverter > &converter) const
returns a string which can be used for debugging
Definition: MWAWFont.cxx:181
TeachTxtParserInternal::State::m_numberSpacesForTab
int m_numberSpacesForTab
number of space to used to replace tab (0: means keep tabs )
Definition: TeachTxtParser.cxx:78
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
TeachTxtParser::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: TeachTxtParser.cxx:230
MWAWFont::setId
void setId(int newId)
sets the font id
Definition: MWAWFont.hxx:264
TeachTxtParser::computeNumPages
int computeNumPages() const
compute the number of page of a zone
Definition: TeachTxtParser.cxx:242
TeachTxtParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: TeachTxtParser.cxx:79
TeachTxtParserInternal::State
Internal: the state of a TeachTxtParser.
Definition: TeachTxtParser.cxx:60
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWHeader.hxx
MWAWPictData::check
static ReadResult check(MWAWInputStreamPtr const &input, int size, MWAWBox2f &box)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:100
MWAWFont::setSize
void setSize(float sz, bool isRelative=false)
sets the font size
Definition: MWAWFont.hxx:275
TeachTxtParser::readStyles
bool readStyles(MWAWEntry const &entry)
try to read the styles ( resource styl : SimpleText,id=128, Tex-Edit,id=1000 )
Definition: TeachTxtParser.cxx:345
TeachTxtParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: TeachTxtParser.cxx:112
TeachTxtParser.hxx
MWAWFont::italicBit
@ italicBit
Definition: MWAWFont.hxx:190
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
TeachTxtParser::sendText
bool sendText()
try to send the main text
Definition: TeachTxtParser.cxx:256
MWAWTextListener.hxx
TeachTxtParser::readWRCT
bool readWRCT(MWAWEntry const &entry)
try to read the unknown wrct structure ( only in TexEdit,id=1000 )
Definition: TeachTxtParser.cxx:412
libmwaw::DebugFile::addPos
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
MWAWEntry::valid
bool valid() const
returns true if the zone length is positive
Definition: MWAWEntry.hxx:99
MWAWBox2::size
MWAWVec2< T > size() const
the box size
Definition: libmwaw_internal.hxx:1067
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
MWAWPosition::WRunThrough
@ WRunThrough
Definition: MWAWPosition.hxx:53
MWAWPosition::Paragraph
@ Paragraph
Definition: MWAWPosition.hxx:51
MWAWInputStream.hxx
MWAWHeader::reset
void reset(MWAWDocument::Type type, int vers, Kind kind=MWAWDocument::MWAW_K_TEXT)
resets the data
Definition: MWAWHeader.hxx:84
MWAWFont.hxx
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
TeachTxtParserInternal::State::m_type
MWAWDocument::Type m_type
the file type
Definition: TeachTxtParser.cxx:72
MWAWBox2< float >
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
TeachTxtParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: TeachTxtParser.cxx:136
TeachTxtParser::TeachTxtParser
TeachTxtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: TeachTxtParser.cxx:87
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
MWAWParser.hxx
MWAWFont::setUnderlineStyle
void setUnderlineStyle(Line::Style style=Line::None, bool doReset=true)
sets the underline style ( by default, we also reset the style)
Definition: MWAWFont.hxx:466
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:98
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163
MWAWFont::setFlags
void setFlags(uint32_t fl)
sets the font attributes bold, ...
Definition: MWAWFont.hxx:325