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
56namespace RagTime5ChartInternal
57{
58struct State;
59
60class SubDocument;
61}
62
63class RagTime5Document;
64class RagTime5StructManager;
65class RagTime5StyleManager;
66class RagTime5Zone;
67
73 class RagTime5Chart
74{
75 friend class RagTime5ChartInternal::SubDocument;
76 friend class RagTime5Document;
77
78public:
80 explicit RagTime5Chart(RagTime5Document &doc);
82 virtual ~RagTime5Chart();
83
85 int version() const;
86
88 int numPages() const;
89
90protected:
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
113 static std::string printType(unsigned long fileType)
114 {
115 return RagTime5StructManager::printType(fileType);
116 }
117
118
119private:
120 RagTime5Chart(RagTime5Chart const &orig) = delete;
121 RagTime5Chart &operator=(RagTime5Chart const &orig) = delete;
122
123protected:
124 //
125 // data
126 //
128 RagTime5Document &m_document;
129
131 std::shared_ptr<RagTime5StructManager> m_structManager;
133 std::shared_ptr<RagTime5StyleManager> m_styleManager;
135 MWAWParserStatePtr m_parserState;
136
138 std::shared_ptr<RagTime5ChartInternal::State> m_state;
139};
140#endif
141// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWPosition.hxx
RagTime5ClusterManager.hxx
RagTime5StructManager.hxx
RagTime5Chart
the main class to read the chart part of RagTime 56 file
Definition RagTime5Chart.hxx:74
RagTime5Chart::m_state
std::shared_ptr< RagTime5ChartInternal::State > m_state
the state
Definition RagTime5Chart.hxx:138
RagTime5Chart::RagTime5Chart
RagTime5Chart(RagTime5Chart const &orig)=delete
RagTime5Chart::RagTime5Chart
RagTime5Chart(RagTime5Document &doc)
constructor
Definition RagTime5Chart.cxx:404
RagTime5Chart::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition RagTime5Chart.cxx:444
RagTime5Chart::~RagTime5Chart
virtual ~RagTime5Chart()
destructor
Definition RagTime5Chart.cxx:413
RagTime5Chart::version
int version() const
returns the file version
Definition RagTime5Chart.cxx:416
RagTime5Chart::m_document
RagTime5Document & m_document
the document
Definition RagTime5Chart.hxx:128
RagTime5Chart::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition RagTime5Chart.hxx:113
RagTime5Chart::numPages
int numPages() const
returns the number of pages
Definition RagTime5Chart.cxx:421
RagTime5Chart::readChartCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readChartCluster(RagTime5Zone &zone, int zoneType)
try to read a chart cluster
Definition RagTime5Chart.cxx:2063
RagTime5Chart::operator=
RagTime5Chart & operator=(RagTime5Chart const &orig)=delete
RagTime5Chart::m_styleManager
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition RagTime5Chart.hxx:133
RagTime5Chart::SubDocument
friend class RagTime5ChartInternal::SubDocument
Definition RagTime5Chart.hxx:75
RagTime5Chart::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition RagTime5Chart.hxx:131
RagTime5Chart::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition RagTime5Chart.hxx:135
RagTime5Document
the main class to read a RagTime v5 file
Definition RagTime5Document.hxx:77
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition RagTime5StructManager.hxx:175
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition RagTime5StructManager.cxx:94
RagTime5StyleManager
basic class used to read/store RagTime 5/6 styles
Definition RagTime5StyleManager.hxx:63
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition RagTime5StructManager.hxx:51
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition libmwaw_internal.hxx:557
RagTime5ChartInternal
Internal: the structures of a RagTime5Chart.
Definition RagTime5Chart.cxx:59