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
54namespace ClarisWksParserInternal
55{
56struct State;
57class SubDocument;
58}
59
60class ClarisWksDocument;
61
67 class ClarisWksParser final : public MWAWTextParser
68{
69 friend class ClarisWksParserInternal::SubDocument;
70 friend class ClarisWksDocument;
71
72public:
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
84protected:
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
101protected:
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:
ClarisWksStruct.hxx
MWAWEntry.hxx
MWAWParser.hxx
MWAWPosition.hxx
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:74
ClarisWksParserInternal::SubDocument
Internal: the subdocument of a ClarisWksParser.
Definition: ClarisWksParser.cxx:85
ClarisWksParser
the main class to read a Claris Works file
Definition: ClarisWksParser.hxx:68
ClarisWksParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: ClarisWksParser.cxx:196
ClarisWksParser::m_state
std::shared_ptr< ClarisWksParserInternal::State > m_state
the state
Definition: ClarisWksParser.hxx:107
ClarisWksParser::newPage
void newPage(int number, bool softBreak)
adds a new page
Definition: ClarisWksParser.cxx:169
ClarisWksParser::~ClarisWksParser
~ClarisWksParser() final
destructor
Definition: ClarisWksParser.cxx:149
ClarisWksParser::ClarisWksParser
ClarisWksParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: ClarisWksParser.cxx:141
ClarisWksParser::m_document
std::shared_ptr< ClarisWksDocument > m_document
the main document manager
Definition: ClarisWksParser.hxx:110
ClarisWksParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: ClarisWksParser.cxx:257
ClarisWksParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: ClarisWksParser.cxx:208
ClarisWksParser::sendFootnote
void sendFootnote(int zoneId)
creates a document to send a footnote
Definition: ClarisWksParser.cxx:188
ClarisWksParser::init
void init()
inits all internal variables
Definition: ClarisWksParser.cxx:153
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:299
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
ClarisWksParserInternal
Internal: the structures of a ClarisWksParser.
Definition: ClarisWksParser.cxx:67
librevenge
Definition: MWAWDocument.hxx:57