RagTime5Chart.hxx Source File documentation

RagTime5Chart.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 RagTime 5-6 document ( chart part )
36 *
37 */
38 #ifndef RAGTIME5_CHART
39 # define RAGTIME5_CHART
40
41 #include <string>
42 #include <map>
43 #include <vector>
44
45 #include <librevenge/librevenge.h>
46
47 #include "libmwaw_internal.hxx"
48
49 #include "MWAWDebug.hxx"
50 #include "MWAWInputStream.hxx"
51 #include "MWAWPosition.hxx"
52
53 #include "RagTime5StructManager.hxx"
54 #include "RagTime5ClusterManager.hxx"
55
56 namespace RagTime5ChartInternal
57 {
58 struct State;
59
60 class SubDocument;
61 }
62
63 class RagTime5Parser;
64 class RagTime5StructManager;
65 class RagTime5StyleManager;
66 class RagTime5Zone;
67
73 class RagTime5Chart
74 {
75 friend class RagTime5ChartInternal::SubDocument;
76 friend class RagTime5Parser;
77
78 public:
80 explicit RagTime5Chart(RagTime5Parser &parser);
82 virtual ~RagTime5Chart();
83
85 int version() const;
86
88 int numPages() const;
89
90 protected:
91
93 void flushExtra();
94
95 // interface with main parser
96
98 std::shared_ptr<RagTime5ClusterManager::Cluster> readChartCluster(RagTime5Zone &zone, int zoneType);
99
100 //
101 // Intermediate level
102 //
103
104 //
105 // basic
106 //
107
108 //
109 // low level
110 //
111
112
113 private:
114 RagTime5Chart(RagTime5Chart const &orig) = delete;
115 RagTime5Chart &operator=(RagTime5Chart const &orig) = delete;
116
117 protected:
118 //
119 // data
120 //
122 RagTime5Parser &m_mainParser;
123
125 std::shared_ptr<RagTime5StructManager> m_structManager;
127 std::shared_ptr<RagTime5StyleManager> m_styleManager;
129 MWAWParserStatePtr m_parserState;
130
132 std::shared_ptr<RagTime5ChartInternal::State> m_state;
133 };
134 #endif
135 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTime5Chart::RagTime5Chart
RagTime5Chart(RagTime5Parser &parser)
constructor
Definition: RagTime5Chart.cxx:404
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
RagTime5Chart::~RagTime5Chart
virtual ~RagTime5Chart()
destructor
Definition: RagTime5Chart.cxx:413
libmwaw_internal.hxx
RagTime5Chart::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Chart.hxx:129
RagTime5StructManager.hxx
RagTime5Chart::version
int version() const
returns the file version
Definition: RagTime5Chart.cxx:416
RagTime5StyleManager
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:60
RagTime5Chart::m_styleManager
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Chart.hxx:127
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:48
RagTime5Chart::operator=
RagTime5Chart & operator=(RagTime5Chart const &orig)=delete
RagTime5Chart::m_mainParser
RagTime5Parser & m_mainParser
the parser
Definition: RagTime5Chart.hxx:122
RagTime5Chart::SubDocument
friend class RagTime5ChartInternal::SubDocument
Definition: RagTime5Chart.hxx:75
RagTime5Chart::readChartCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readChartCluster(RagTime5Zone &zone, int zoneType)
try to read a chart cluster
Definition: RagTime5Chart.cxx:1999
RagTime5ChartInternal
Internal: the structures of a RagTime5Chart.
Definition: RagTime5Chart.cxx:58
RagTime5Chart::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Chart.cxx:444
RagTime5Parser
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:73
RagTime5Chart
the main class to read the chart part of RagTime 56 file
Definition: RagTime5Chart.hxx:73
MWAWInputStream.hxx
MWAWDebug.hxx
RagTime5Chart::m_state
std::shared_ptr< RagTime5ChartInternal::State > m_state
the state
Definition: RagTime5Chart.hxx:132
MWAWPosition.hxx
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:170
RagTime5Chart::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Chart.hxx:125
RagTime5ClusterManager.hxx
RagTime5Chart::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Chart.cxx:421