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.hxx
MWAWParser.hxx
MWAWPosition.hxx
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:57
MWAWSpreadsheetParser
virtual class which defines the ancestor of all spreadsheet zone parser
Definition: MWAWParser.hxx:283
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:77
RagTime5SSParserInternal::SubDocument
Internal: the subdocument of a RagTime5SSParser.
Definition: RagTime5SSParser.cxx:74
RagTime5SSParser
the main class to parse a RagTime 5-6 file containing only a spreadsheet
Definition: RagTime5SSParser.hxx:66
RagTime5SSParser::~RagTime5SSParser
~RagTime5SSParser() final
destructor
Definition: RagTime5SSParser.cxx:139
RagTime5SSParser::parse
void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final
virtual function used to parse the input
Definition: RagTime5SSParser.cxx:176
RagTime5SSParser::RagTime5SSParser
RagTime5SSParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: RagTime5SSParser.cxx:131
RagTime5SSParser::sendFootnote
void sendFootnote(int zoneId)
creates a document to send a footnote
Definition: RagTime5SSParser.cxx:158
RagTime5SSParser::init
void init()
inits all internal variables
Definition: RagTime5SSParser.cxx:143
RagTime5SSParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: RagTime5SSParser.cxx:165
RagTime5SSParser::m_document
std::shared_ptr< RagTime5Document > m_document
the main document manager
Definition: RagTime5SSParser.hxx:105
RagTime5SSParser::createDocument
void createDocument(librevenge::RVNGSpreadsheetInterface *documentInterface)
creates the listener which will be associated to the document
Definition: RagTime5SSParser.cxx:208
RagTime5SSParser::m_state
std::shared_ptr< RagTime5SSParserInternal::State > m_state
the state
Definition: RagTime5SSParser.hxx:102
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
RagTime5SSParserInternal
Internal: the structures of a RagTime5SSParser.
Definition: RagTime5SSParser.cxx:56
librevenge
Definition: MWAWDocument.hxx:57