RagTime5Formula.hxx Source File documentation

RagTime5Formula.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 ( formula part )
36 *
37 */
38 #ifndef RAGTIME5_FORMULA
39 # define RAGTIME5_FORMULA
40
41 #include <set>
42 #include <string>
43 #include <map>
44 #include <vector>
45
46 #include <librevenge/librevenge.h>
47
48 #include "libmwaw_internal.hxx"
49
50 #include "MWAWCell.hxx"
51 #include "MWAWDebug.hxx"
52 #include "MWAWInputStream.hxx"
53 #include "MWAWPosition.hxx"
54
55 #include "RagTime5StructManager.hxx"
56 #include "RagTime5ClusterManager.hxx"
57
58 namespace RagTime5FormulaInternal
59 {
60 struct ClusterFormula;
61 struct State;
62 }
63
64 class RagTime5Document;
65 class RagTime5StructManager;
66 class RagTime5Zone;
67
73 class RagTime5Formula
74 {
75 friend class RagTime5Document;
76
77 public:
78
80 explicit RagTime5Formula(RagTime5Document &doc);
82 virtual ~RagTime5Formula();
83
85 int version() const;
86
87 // interface with main parser
88
90 bool readFormulaClusters(RagTime5ClusterManager::Link const &link, int sheetId);
92 std::set<unsigned long> const &getFunctionsId() const;
93 protected:
94
95
96 //
97 // Intermediate level
98 //
99
101 bool readFunctionNames(RagTime5ClusterManager::Link const &link);
102
104 bool readFormulaZones(RagTime5ClusterManager::Cluster &cluster, RagTime5ClusterManager::Link const &link, int sheetId, bool isDefinition);
106 bool readFormulaDefinition(RagTime5Zone &zone, long endPos, int sheetId, int n, std::vector<MWAWCellContent::FormulaInstruction> &formula);
108 bool readFormulaPosition(RagTime5Zone &zone, long endPos, int n);
109
110 //
111 // low level
112 //
113
115 bool readFormula(MWAWInputStreamPtr &input, std::vector<MWAWCellContent::FormulaInstruction> &formula,
116 long const(&limitPos)[5], std::vector<std::string> const &functions, std::vector<MWAWCellContent::FormulaInstruction> const &cells, libmwaw::DebugStream &f) const;
118 bool readFormula2(MWAWInputStreamPtr &input, long const(&limitPos)[5], std::vector<std::string> const &functions, std::vector<MWAWCellContent::FormulaInstruction> const &cells, libmwaw::DebugStream &f) const;
119
120
121 //
122 // send data
123 //
124
125 public:
127 static std::string printType(unsigned long fileType)
128 {
129 return RagTime5StructManager::printType(fileType);
130 }
131
132 private:
133 RagTime5Formula(RagTime5Formula const &orig) = delete;
134 RagTime5Formula &operator=(RagTime5Formula const &orig) = delete;
135
136 protected:
137 //
138 // data
139 //
141 RagTime5Document &m_document;
142
144 std::shared_ptr<RagTime5StructManager> m_structManager;
146 MWAWParserStatePtr m_parserState;
147
149 std::shared_ptr<RagTime5FormulaInternal::State> m_state;
150 };
151 #endif
152 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
RagTime5ClusterManager::Link::m_ids
std::vector< int > m_ids
the data ids
Definition: RagTime5ClusterManager.hxx:210
MWAWCellContent::FormulaInstruction::F_CellList
@ F_CellList
Definition: MWAWCell.hxx:398
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
RagTime5Document::readPositions
bool readPositions(int posId, std::vector< long > &listPosition)
try to read a positions zone in data
Definition: RagTime5Document.cxx:923
RagTime5Formula::~RagTime5Formula
virtual ~RagTime5Formula()
destructor
Definition: RagTime5Formula.cxx:364
RagTime5Formula::readFormulaZones
bool readFormulaZones(RagTime5ClusterManager::Cluster &cluster, RagTime5ClusterManager::Link const &link, int sheetId, bool isDefinition)
try to read a list of formula definition
Definition: RagTime5Formula.cxx:423
RagTime5StructManager::Field::T_Unicode
@ T_Unicode
Definition: RagTime5StructManager.hxx:245
RagTime5Formula::readFormulaDefinition
bool readFormulaDefinition(RagTime5Zone &zone, long endPos, int sheetId, int n, std::vector< MWAWCellContent::FormulaInstruction > &formula)
try to read a formula definition
Definition: RagTime5Formula.cxx:1009
RagTime5FormulaInternal::Functions
Definition: RagTime5Formula.cxx:501
RagTime5FormulaInternal::Functions::m_name
const char * m_name
Definition: RagTime5Formula.cxx:502
RagTime5FormulaInternal::State::m_idFunctionMap
std::map< unsigned long, char const * > m_idFunctionMap
map id to function name
Definition: RagTime5Formula.cxx:285
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
libmwaw::DebugFile::addDelimiter
void addDelimiter(long pos, char c)
adds a not breaking delimiter in position pos
Definition: MWAWDebug.cxx:73
RagTime5FormulaInternal::State::m_documentFunctionNames
std::vector< std::string > m_documentFunctionNames
the document fonction names
Definition: RagTime5Formula.cxx:289
RagTime5FormulaInternal::State::State
State()
constructor
Definition: RagTime5Formula.cxx:69
RagTime5Formula::RagTime5Formula
RagTime5Formula(RagTime5Document &doc)
constructor
Definition: RagTime5Formula.cxx:356
MWAWCellContent::FormulaInstruction::F_Operator
@ F_Operator
Definition: MWAWCell.hxx:398
RagTime5StructManager.hxx
RagTime5Spreadsheet.hxx
RagTime5Zone::ascii
libmwaw::DebugFile & ascii()
returns the current ascii file
Definition: RagTime5StructManager.hxx:109
MWAWCellContent::FormulaInstruction
small class use to define a formula instruction
Definition: MWAWCell.hxx:397
RagTime5FormulaInternal::FunctionNameParser::parseField
bool parseField(RagTime5StructManager::Field &field, RagTime5Zone &, int n, libmwaw::DebugStream &f) final
parse a field
Definition: RagTime5Formula.cxx:307
MWAWFontConverter.hxx
libmwaw::appendUnicode
void appendUnicode(uint32_t val, librevenge::RVNGString &buffer)
adds an unicode character to a string
Definition: libmwaw_internal.cxx:63
RagTime5Document::checkClusterList
bool checkClusterList(std::vector< RagTime5StructManager::ZoneLink > const &list)
check a cluster list
Definition: RagTime5Document.cxx:1117
RagTime5FormulaInternal
Internal: the structures of a RagTime5Formula.
Definition: RagTime5Formula.cxx:63
RagTime5FormulaInternal::State::m_idFunctionSet
std::set< unsigned long > m_idFunctionSet
the set of function id
Definition: RagTime5Formula.cxx:287
RagTime5Document.hxx
RagTime5FormulaInternal::s_listFunctions
static const Functions s_listFunctions[]
Definition: RagTime5Formula.cxx:506
RagTime5FormulaInternal::FunctionNameParser
Internal: the helper to read function name.
Definition: RagTime5Formula.cxx:296
MWAWCellContent::FormulaInstruction::F_Function
@ F_Function
Definition: MWAWCell.hxx:398
RagTime5Formula::m_state
std::shared_ptr< RagTime5FormulaInternal::State > m_state
the state
Definition: RagTime5Formula.hxx:149
RagTime5Formula::getFunctionsId
const std::set< unsigned long > & getFunctionsId() const
returns the set of function id in fields
Definition: RagTime5Formula.cxx:373
libmwaw::DebugFile::addNote
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
MWAWCellContent::FormulaInstruction::m_content
std::string m_content
the content ( if type == F_Operator or type = F_Function or type==F_Text)
Definition: MWAWCell.hxx:417
RagTime5StructManager::Field::T_FieldList
@ T_FieldList
Definition: RagTime5StructManager.hxx:244
RagTime5Formula::version
int version() const
returns the file version
Definition: RagTime5Formula.cxx:368
MWAWCell.hxx
MWAWSubDocument.hxx
RagTime5ClusterManager.hxx
RagTime5Formula::readFormula2
bool readFormula2(MWAWInputStreamPtr &input, long const(&limitPos)[5], std::vector< std::string > const &functions, std::vector< MWAWCellContent::FormulaInstruction > const &cells, libmwaw::DebugStream &f) const
try to read a formula (second zone)
Definition: RagTime5Formula.cxx:874
MWAWCellContent::FormulaInstruction::F_Text
@ F_Text
Definition: MWAWCell.hxx:398
RagTime5StructManager::FieldParser
virtual class use to parse the field data
Definition: RagTime5StructManager.hxx:353
RagTime5Formula::operator=
RagTime5Formula & operator=(RagTime5Formula const &orig)=delete
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:76
MWAWParagraph.hxx
RagTime5ClusterManager::Link::empty
bool empty() const
returns true if all link are empty
Definition: RagTime5ClusterManager.hxx:133
RagTime5Formula::readFunctionNames
bool readFunctionNames(RagTime5ClusterManager::Link const &link)
try to read the functions name
Definition: RagTime5Formula.cxx:378
libmwaw_internal.hxx
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5StructManager.cxx:94
MWAWPosition.hxx
MWAWCellContent::FormulaInstruction::m_type
Type m_type
the type
Definition: MWAWCell.hxx:415
RagTime5FormulaInternal::s_numFunctions
static const size_t s_numFunctions
Definition: RagTime5Formula.cxx:528
RagTime5Document::readStructZone
bool readStructZone(RagTime5ClusterManager::Link const &link, RagTime5StructManager::FieldParser &parser, int headerSz, RagTime5ClusterManager::NameLink *nameLink=nullptr)
try to read a structured zone
Definition: RagTime5Document.cxx:1722
RagTime5FormulaInternal::FunctionNameParser::FunctionNameParser
FunctionNameParser(std::map< unsigned long, char const * > const &idFunctionMap, std::vector< std::string > &functionNames)
constructor
Definition: RagTime5Formula.cxx:298
RagTime5FormulaInternal::FunctionNameParser::m_functionNames
std::vector< std::string > & m_functionNames
the fonction names
Definition: RagTime5Formula.cxx:344
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:50
RagTime5Formula::readFormulaClusters
bool readFormulaClusters(RagTime5ClusterManager::Link const &link, int sheetId)
try to read some formula cluster
Definition: RagTime5Formula.cxx:386
RagTime5Zone::getInput
MWAWInputStreamPtr getInput()
returns the current input
Definition: RagTime5StructManager.hxx:94
RagTime5StructManager::FieldParser::FieldParser
FieldParser(std::string const &zoneName)
constructor
Definition: RagTime5StructManager.hxx:355
MWAWDebug.hxx
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
RagTime5ClusterManager::Link::m_longList
std::vector< long > m_longList
a list of long used to store decal
Definition: RagTime5ClusterManager.hxx:218
RagTime5Formula::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5Formula.hxx:127
MWAWCellContent::FormulaInstruction::m_longValue
double m_longValue
value ( if type==F_Long )
Definition: MWAWCell.hxx:419
RagTime5StyleManager.hxx
RagTime5FormulaInternal::s_listFunctions2
static const char * s_listFunctions2[]
Definition: RagTime5Formula.cxx:530
RagTime5Document::getDataZone
std::shared_ptr< RagTime5Zone > getDataZone(int dataId) const
returns the zone corresponding to a data id (or 0)
Definition: RagTime5Document.cxx:465
MWAWCellContent::FormulaInstruction::m_doubleValue
double m_doubleValue
value ( if type==F_Double )
Definition: MWAWCell.hxx:421
RagTime5FormulaInternal::FunctionNameParser::m_idFunctionMap
const std::map< unsigned long, char const * > & m_idFunctionMap
map id to function name
Definition: RagTime5Formula.cxx:342
MWAWCellContent::FormulaInstruction::F_Long
@ F_Long
Definition: MWAWCell.hxx:398
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
RagTime5Formula
the main class to read the formula part of RagTime 56 file
Definition: RagTime5Formula.hxx:73
RagTime5FormulaInternal::Functions::m_arity
int m_arity
Definition: RagTime5Formula.cxx:503
RagTime5FormulaInternal::FunctionNameParser::~FunctionNameParser
~FunctionNameParser() final
destructor
Definition: RagTime5Formula.cxx:347
RagTime5Formula::readFormula
bool readFormula(MWAWInputStreamPtr &input, std::vector< MWAWCellContent::FormulaInstruction > &formula, long const(&limitPos)[5], std::vector< std::string > const &functions, std::vector< MWAWCellContent::FormulaInstruction > const &cells, libmwaw::DebugStream &f) const
try to read a formula
Definition: RagTime5Formula.cxx:537
MWAWCellContent::FormulaInstruction::F_Double
@ F_Double
Definition: MWAWCell.hxx:398
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
MWAWCellContent::FormulaInstruction::m_position
MWAWVec2i m_position[2]
cell position ( if type==F_Cell or F_CellList )
Definition: MWAWCell.hxx:423
libmwaw::DebugFile::addPos
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
RagTime5Document::getClusterManager
std::shared_ptr< RagTime5ClusterManager > getClusterManager()
returns the cluster manager
Definition: RagTime5Document.cxx:395
MWAW_N_ELEMENTS
#define MWAW_N_ELEMENTS(m)
Definition: libmwaw_internal.hxx:111
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:174
MWAWListener.hxx
RagTime5ClusterManager::Link
a link to a small zone (or set of zones) in RagTime 5/6 documents
Definition: RagTime5ClusterManager.hxx:113
RagTime5Formula::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Formula.hxx:144
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
RagTime5FormulaInternal::State
Internal: the state of a RagTime5Formula.
Definition: RagTime5Formula.cxx:67
RagTime5Formula::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Formula.hxx:146
RagTime5ClusterManager::Cluster
the cluster data
Definition: RagTime5ClusterManager.hxx:261
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:50
MWAWInputStream.hxx
RagTime5FormulaInternal::State::m_idFormulaMap
std::map< int, std::shared_ptr< ClusterFormula > > m_idFormulaMap
map data id to text zone
Definition: RagTime5Formula.cxx:292
MWAWFont.hxx
RagTime5Document::readFixedSizeZone
bool readFixedSizeZone(RagTime5ClusterManager::Link const &link, std::string const &name)
try to read a fixed size zone
Definition: RagTime5Document.cxx:1658
RagTime5Formula::readFormulaPosition
bool readFormulaPosition(RagTime5Zone &zone, long endPos, int n)
try to read a formula position
Definition: RagTime5Formula.cxx:1246
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
RagTime5Document::getSpreadsheetParser
std::shared_ptr< RagTime5Spreadsheet > getSpreadsheetParser()
returns the spreadsheet parser
Definition: RagTime5Document.cxx:420
RagTime5Formula.hxx
RagTime5Formula::m_document
RagTime5Document & m_document
the parser
Definition: RagTime5Formula.hxx:141