ClarisWksParser.hxx Source File documentation

ClarisWksParser.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 Claris Works text document
36 *
37 */
38 #ifndef CLARIS_WKS_PARSER
39 # define CLARIS_WKS_PARSER
40
41 #include <set>
42 #include <string>
43 #include <vector>
44
45 #include <librevenge/librevenge.h>
46
47 #include "MWAWEntry.hxx"
48 #include "MWAWPosition.hxx"
49
50 #include "MWAWParser.hxx"
51
52 #include "ClarisWksStruct.hxx"
53
54 namespace ClarisWksParserInternal
55 {
56 struct State;
57 class SubDocument;
58 }
59
60 class ClarisWksDocument;
61
67 class ClarisWksParser final : public MWAWTextParser
68 {
69 friend class ClarisWksParserInternal::SubDocument;
70 friend class ClarisWksDocument;
71
72 public:
74 ClarisWksParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
76 ~ClarisWksParser() final;
77
79 bool checkHeader(MWAWHeader *header, bool strict=false) final;
80
81 // the main parse function
82 void parse(librevenge::RVNGTextInterface *documentInterface) final;
83
84 protected:
86 void init();
87
89 void createDocument(librevenge::RVNGTextInterface *documentInterface);
90
92 void newPage(int number, bool softBreak);
93
94 //
95 // interface with the text parser
96 //
97
99 void sendFootnote(int zoneId);
100
101 protected:
102
103 //
104 // data
105 //
107 std::shared_ptr<ClarisWksParserInternal::State> m_state;
108
110 std::shared_ptr<ClarisWksDocument> m_document;
111 };
112 #endif
113 // 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
ClarisWksParserInternal::SubDocument::operator!=
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: ClarisWksParser.cxx:96
ClarisWksParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: ClarisWksParser.cxx:79
ClarisWksParser::m_document
std::shared_ptr< ClarisWksDocument > m_document
the main document manager
Definition: ClarisWksParser.hxx:110
MWAWNote
a note
Definition: libmwaw_internal.hxx:445
ClarisWksParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: ClarisWksParser.cxx:79
ClarisWksDatabase.hxx
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
ClarisWksParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: ClarisWksParser.cxx:257
ClarisWksStruct.hxx
ClarisWksParser::newPage
void newPage(int number, bool softBreak)
adds a new page
Definition: ClarisWksParser.cxx:169
ClarisWksPresentation.hxx
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
libmwaw::DebugFile::open
bool open(std::string const &filename)
opens/creates a file to store a result
Definition: MWAWDebug.cxx:46
ClarisWksParserInternal::SubDocument::SubDocument
SubDocument(ClarisWksParser &pars, MWAWInputStreamPtr const &input, int zoneId, MWAWPosition const &pos=MWAWPosition())
Definition: ClarisWksParser.cxx:87
MWAWEntry.hxx
MWAWFontConverter.hxx
MWAWSubDocumentPtr
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
ClarisWksParser::ClarisWksDocument
friend class ClarisWksDocument
Definition: ClarisWksParser.hxx:70
MWAWPrinter.hxx
ClarisWksSpreadsheet.hxx
MWAWDocument::MWAW_K_DRAW
@ MWAW_K_DRAW
vectorized grphic
Definition: MWAWDocument.hxx:83
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:73
MWAWParser::getTextListener
MWAWTextListenerPtr & getTextListener()
returns the text listener
Definition: MWAWParser.hxx:145
MWAWSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:41
ClarisWksParserInternal::SubDocument::parse
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: ClarisWksParser.cxx:115
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
ClarisWksParserInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: ClarisWksParser.cxx:93
MWAWListener::SoftPageBreak
@ SoftPageBreak
Definition: MWAWListener.hxx:58
ClarisWksParser::sendFootnote
void sendFootnote(int zoneId)
creates a document to send a footnote
Definition: ClarisWksParser.cxx:188
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:188
ClarisWksParser::~ClarisWksParser
~ClarisWksParser() final
destructor
Definition: ClarisWksParser.cxx:149
libmwaw::DebugFile::reset
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:93
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
ClarisWksTable.hxx
ClarisWksStyleManager.hxx
MWAWParser::getPageSpan
const MWAWPageSpan & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
MWAWPosition.hxx
MWAWDocument::MWAW_K_TEXT
@ MWAW_K_TEXT
word processing file
Definition: MWAWDocument.hxx:82
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:47
ClarisWksParser.hxx
ClarisWksParserInternal::SubDocument::m_position
MWAWPosition m_position
the subdocument position if defined
Definition: ClarisWksParser.cxx:112
ClarisWksDocument::NewPage
void(MWAWParser::* NewPage)(int page, bool softBreak)
callback used to send a page break
Definition: ClarisWksDocument.hxx:268
ClarisWksDocument.hxx
ClarisWksParser::ClarisWksParser
ClarisWksParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: ClarisWksParser.cxx:141
MWAWParser::asciiName
const std::string & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:232
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
libmwaw::DebugFile::setStream
void setStream(MWAWInputStreamPtr const &ip)
resets the input
Definition: MWAWDebug.hxx:81
MWAWPictMac.hxx
libmwaw::ParseException
Definition: libmwaw_internal.hxx:143
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
ClarisWksGraph.hxx
ClarisWksParserInternal::SubDocument::m_id
int m_id
the subdocument id
Definition: ClarisWksParser.cxx:110
ClarisWksParserInternal::SubDocument
Internal: the subdocument of a ClarisWksParser.
Definition: ClarisWksParser.cxx:84
ClarisWksText.hxx
ClarisWksParser::init
void init()
inits all internal variables
Definition: ClarisWksParser.cxx:153
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWHeader.hxx
ClarisWksParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: ClarisWksParser.cxx:208
ClarisWksParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: ClarisWksParser.cxx:196
ClarisWksParser
the main class to read a Claris Works file
Definition: ClarisWksParser.hxx:67
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
ClarisWksParserInternal::State::State
State()
constructor
Definition: ClarisWksParser.cxx:73
ClarisWksDocument::SendFootnote
void(MWAWParser::* SendFootnote)(int zoneId)
callback used to send a footnote
Definition: ClarisWksDocument.hxx:270
MWAWTextListener.hxx
ClarisWksParser::m_state
std::shared_ptr< ClarisWksParserInternal::State > m_state
the state
Definition: ClarisWksParser.hxx:107
MWAWSubDocument::m_parser
MWAWParser * m_parser
the main zone parser
Definition: MWAWSubDocument.hxx:75
MWAWSection.hxx
ClarisWksParserInternal::State
Internal: the state of a ClarisWksParser.
Definition: ClarisWksParser.cxx:71
MWAWNote::FootNote
@ FootNote
Definition: libmwaw_internal.hxx:447
ClarisWksParserInternal
Internal: the structures of a ClarisWksParser.
Definition: ClarisWksParser.cxx:66
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
MWAWFont.hxx
librevenge
Definition: MWAWDocument.hxx:56
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
MWAWParser.hxx
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163