RagTime5SSParser.hxx Source File documentation

RagTime5SSParser.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 * Main parser of RagTime 5-6 document containing only a spreadsheet
36 *
37 */
38 #ifndef RAGTIME_5_SS_PARSER
39 # define RAGTIME_5_SS_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 namespace RagTime5SSParserInternal
53 {
54 struct State;
55 class SubDocument;
56 }
57
58 class RagTime5Document;
59
65 class RagTime5SSParser final : public MWAWSpreadsheetParser
66 {
67 friend class RagTime5SSParserInternal::SubDocument;
68 friend class RagTime5Document;
69
70 public:
72 RagTime5SSParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
74 ~RagTime5SSParser() final;
75
77 bool checkHeader(MWAWHeader *header, bool strict=false) final;
78
79 // the main parse function
80 void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final;
81
82 protected:
84 void init();
85
87 void createDocument(librevenge::RVNGSpreadsheetInterface *documentInterface);
88
89 //
90 // interface with the text parser
91 //
92
94 void sendFootnote(int zoneId);
95
96 protected:
97
98 //
99 // data
100 //
102 std::shared_ptr<RagTime5SSParserInternal::State> m_state;
103
105 std::shared_ptr<RagTime5Document> m_document;
106 };
107 #endif
108 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:47
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWSpreadsheetParser
virtual class which defines the ancestor of all spreadsheet zone parser
Definition: MWAWParser.hxx:283
MWAWNote
a note
Definition: libmwaw_internal.hxx:445
RagTime5SSParser.hxx
MWAWDocument::MWAW_K_SPREADSHEET
@ MWAW_K_SPREADSHEET
spreadsheet
Definition: MWAWDocument.hxx:86
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
RagTime5SSParser::sendFootnote
void sendFootnote(int zoneId)
creates a document to send a footnote
Definition: RagTime5SSParser.cxx:158
RagTime5StructManager.hxx
RagTime5SSParserInternal::SubDocument::parse
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: RagTime5SSParser.cxx:104
libmwaw::DebugFile::open
bool open(std::string const &filename)
opens/creates a file to store a result
Definition: MWAWDebug.cxx:46
RagTime5SSParserInternal::SubDocument::m_id
int m_id
the subdocument id
Definition: RagTime5SSParser.cxx:99
RagTime5SSParserInternal
Internal: the structures of a RagTime5SSParser.
Definition: RagTime5SSParser.cxx:56
MWAWEntry.hxx
MWAWSubDocumentPtr
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
RagTime5Document.hxx
MWAWParser::resetSpreadsheetListener
void resetSpreadsheetListener()
resets the listener
Definition: MWAWParser.cxx:152
MWAWSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:42
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
MWAWParser::asciiName
std::string const & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:232
RagTime5SSParser::RagTime5SSParser
RagTime5SSParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: RagTime5SSParser.cxx:131
MWAWSubDocument.hxx
MWAWParser::getSpreadsheetListener
MWAWSpreadsheetListenerPtr & getSpreadsheetListener()
returns the spreadsheet listener
Definition: MWAWParser.hxx:140
RagTime5SSParser::parse
void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final
virtual function used to parse the input
Definition: RagTime5SSParser.cxx:176
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:77
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:188
libmwaw::DebugFile::reset
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:93
MWAWParser::getMainListener
MWAWListenerPtr getMainListener()
returns the main listener
Definition: MWAWParser.cxx:120
MWAWSpreadsheetListenerPtr
std::shared_ptr< MWAWSpreadsheetListener > MWAWSpreadsheetListenerPtr
a smart pointer of MWAWSpreadsheetListener
Definition: libmwaw_internal.hxx:563
MWAWSpreadsheetListener
This class contents the main functions needed to create a spreadsheet processing Document.
Definition: MWAWSpreadsheetListener.hxx:66
MWAWParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:227
RagTime5Document::SendFootnote
void(MWAWParser::* SendFootnote)(int zoneId)
callback used to send a footnote
Definition: RagTime5Document.hxx:309
RagTime5SSParser::~RagTime5SSParser
~RagTime5SSParser() final
destructor
Definition: RagTime5SSParser.cxx:139
RagTime5SSParser
the main class to parse a RagTime 5-6 file containing only a spreadsheet
Definition: RagTime5SSParser.hxx:66
RagTime5SSParserInternal::State::State
State()
constructor
Definition: RagTime5SSParser.cxx:62
MWAWPosition.hxx
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
RagTime5SSParserInternal::SubDocument::SubDocument
SubDocument(RagTime5SSParser &pars, MWAWInputStreamPtr const &input, int zoneId, MWAWPosition const &pos=MWAWPosition())
Definition: RagTime5SSParser.cxx:76
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
libmwaw::DebugFile::setStream
void setStream(MWAWInputStreamPtr const &ip)
resets the input
Definition: MWAWDebug.hxx:81
libmwaw::ParseException
Definition: libmwaw_internal.hxx:144
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
MWAWParser::getPageSpan
MWAWPageSpan const & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
RagTime5SSParserInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: RagTime5SSParser.cxx:82
RagTime5SSParser::init
void init()
inits all internal variables
Definition: RagTime5SSParser.cxx:143
RagTime5SSParser::RagTime5Document
friend class RagTime5Document
Definition: RagTime5SSParser.hxx:68
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWParser::setSpreadsheetListener
void setSpreadsheetListener(MWAWSpreadsheetListenerPtr &listener)
sets the spreadsheet listener
Definition: MWAWParser.cxx:147
MWAWHeader.hxx
Defines MWAWHeader (document's type, version, kind)
RagTime5SSParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: RagTime5SSParser.cxx:68
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
RagTime5SSParserInternal::SubDocument::m_position
MWAWPosition m_position
the subdocument position if defined
Definition: RagTime5SSParser.cxx:101
MWAWSubDocument::m_parser
MWAWParser * m_parser
the main zone parser
Definition: MWAWSubDocument.hxx:75
RagTime5SSParser::m_state
std::shared_ptr< RagTime5SSParserInternal::State > m_state
the state
Definition: RagTime5SSParser.hxx:102
RagTime5SSParserInternal::SubDocument
Internal: the subdocument of a RagTime5SSParser.
Definition: RagTime5SSParser.cxx:74
MWAWSpreadsheetListener.hxx
Defines MWAWSpreadsheetListener: the libmwaw spreadsheet processor listener.
RagTime5SSParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: RagTime5SSParser.cxx:165
RagTime5SSParserInternal::SubDocument::operator!=
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: RagTime5SSParser.cxx:85
MWAWNote::FootNote
@ FootNote
Definition: libmwaw_internal.hxx:447
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
RagTime5SSParserInternal::State
Internal: the state of a RagTime5SSParser.
Definition: RagTime5SSParser.cxx:60
librevenge
Definition: MWAWDocument.hxx:57
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
RagTime5SSParser::createDocument
void createDocument(librevenge::RVNGSpreadsheetInterface *documentInterface)
creates the listener which will be associated to the document
Definition: RagTime5SSParser.cxx:208
RagTime5SSParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: RagTime5SSParser.cxx:68
MWAWParser.hxx
RagTime5SSParser::m_document
std::shared_ptr< RagTime5Document > m_document
the main document manager
Definition: RagTime5SSParser.hxx:105