MWAWOLEParser.hxx Source File documentation

MWAWOLEParser.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 * freely inspired from istorage :
36 * ------------------------------------------------------------
37 * Generic OLE Zones furnished with a copy of the file header
38 *
39 * Compound Storage (32 bit version)
40 * Storage implementation
41 *
42 * This file contains the compound file implementation
43 * of the storage interface.
44 *
45 * Copyright 1999 Francis Beaudet
46 * Copyright 1999 Sylvain St-Germain
47 * Copyright 1999 Thuy Nguyen
48 * Copyright 2005 Mike McCormack
49 *
50 * This library is free software; you can redistribute it and/or
51 * modify it under the terms of the GNU Lesser General Public
52 * License as published by the Free Software Foundation; either
53 * version 2.1 of the License, or (at your option) any later version.
54 *
55 * This library is distributed in the hope that it will be useful,
56 * but WITHOUT ANY WARRANTY; without even the implied warranty of
57 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
58 * Lesser General Public License for more details.
59 *
60 * ------------------------------------------------------------
61 */
62
63#ifndef MWAW_OLE_PARSER_H
64#define MWAW_OLE_PARSER_H
65
66#include <string>
67#include <vector>
68
69#include <librevenge-stream/librevenge-stream.h>
70
71#include "libmwaw_internal.hxx"
72#include "MWAWInputStream.hxx"
73
74#include "MWAWDebug.hxx"
75
76namespace MWAWOLEParserInternal
77{
78class CompObj;
79struct State;
80}
81
85 class MWAWOLEParser
86{
87public:
93 explicit MWAWOLEParser(std::string const &mainName, MWAWFontConverterPtr const &fontConverter, int fontId);
94
96 ~MWAWOLEParser();
97
100 bool parse(MWAWInputStreamPtr fileInput);
102 void updateMetaData(librevenge::RVNGPropertyList &metaData) const;
104 int getFontEncoding() const;
106 std::vector<std::string> const &getNotParse() const;
108 std::vector<int> const &getObjectsId() const;
110 std::vector<MWAWPosition> const &getObjectsPosition() const;
112 std::vector<librevenge::RVNGBinaryData> const &getObjects() const;
114 std::vector<std::string> const &getObjectsType() const;
115
117 bool getObject(int id, librevenge::RVNGBinaryData &obj, MWAWPosition &pos, std::string &type) const;
118
122 void setObject(int id, librevenge::RVNGBinaryData const &obj, MWAWPosition const &pos,
123 std::string const &type);
124
129 bool readSummaryInformation(MWAWInputStreamPtr input, std::string const &oleName,
130 int &encoding, librevenge::RVNGPropertyList &pList,
131 libmwaw::DebugFile &ascii,
132 long endPos=-1) const;
133
134protected:
136 bool readSummaryProperty(MWAWInputStreamPtr input, long endPos, int type,
137 libmwaw::DebugFile &ascii, libmwaw::DebugStream &f) const;
139 bool readSummaryPropertyString(MWAWInputStreamPtr input, long endPos, int type, librevenge::RVNGString &string,
140 libmwaw::DebugStream &f) const;
142 bool readSummaryPropertyLong(MWAWInputStreamPtr input, long endPos, int type, long &value,
143 libmwaw::DebugStream &f) const;
144
146 static bool readOle(MWAWInputStreamPtr ip, std::string const &oleName,
147 libmwaw::DebugFile &ascii);
149 static bool readMM(MWAWInputStreamPtr input, std::string const &oleName,
150 libmwaw::DebugFile &ascii);
152 static bool readObjInfo(MWAWInputStreamPtr input, std::string const &oleName,
153 libmwaw::DebugFile &ascii);
155 bool readCompObj(MWAWInputStreamPtr ip, std::string const &oleName,
156 libmwaw::DebugFile &ascii);
157
159 static bool isOlePres(MWAWInputStreamPtr ip, std::string const &oleName);
161 static bool readOlePres(MWAWInputStreamPtr ip, librevenge::RVNGBinaryData &data, MWAWPosition &pos,
162 libmwaw::DebugFile &ascii);
163
165 static bool isOle10Native(MWAWInputStreamPtr ip, std::string const &oleName);
167 static bool readOle10Native(MWAWInputStreamPtr ip, librevenge::RVNGBinaryData &data,
168 libmwaw::DebugFile &ascii);
169
173 bool readContents(MWAWInputStreamPtr input, std::string const &oleName,
174 librevenge::RVNGBinaryData &pict, MWAWPosition &pos, libmwaw::DebugFile &ascii);
175
181 bool readCONTENTS(MWAWInputStreamPtr input, std::string const &oleName,
182 librevenge::RVNGBinaryData &pict, MWAWPosition &pos, libmwaw::DebugFile &ascii);
183
184
186 std::string m_avoidOLE;
188 std::shared_ptr<MWAWOLEParserInternal::State> m_state;
189};
190
191#endif
192// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWOLEParser
a class used to parse some basic oles Tries to read the different ole parts and stores their contents...
Definition: MWAWOLEParser.hxx:86
MWAWOLEParser::getFontEncoding
int getFontEncoding() const
returns the font encoding find in SummaryInformation or -1
Definition: MWAWOLEParser.cxx:254
MWAWOLEParser::readCONTENTS
bool readCONTENTS(MWAWInputStreamPtr input, std::string const &oleName, librevenge::RVNGBinaryData &pict, MWAWPosition &pos, libmwaw::DebugFile &ascii)
the CONTENTS : seems to store a header size, the header and then a object in EMF (with the same heade...
Definition: MWAWOLEParser.cxx:1395
MWAWOLEParser::isOle10Native
static bool isOle10Native(MWAWInputStreamPtr ip, std::string const &oleName)
theOle10Native : basic Windows© picture, with no size
Definition: MWAWOLEParser.cxx:1244
MWAWOLEParser::readCompObj
bool readCompObj(MWAWInputStreamPtr ip, std::string const &oleName, libmwaw::DebugFile &ascii)
the "CompObj" contains : UserType,ClipName,ProgIdName
Definition: MWAWOLEParser.cxx:652
MWAWOLEParser::m_avoidOLE
std::string m_avoidOLE
if filled, does not parse content with this name
Definition: MWAWOLEParser.hxx:186
MWAWOLEParser::readOlePres
static bool readOlePres(MWAWInputStreamPtr ip, librevenge::RVNGBinaryData &data, MWAWPosition &pos, libmwaw::DebugFile &ascii)
extracts the picture of OlePres001 if it is possible
Definition: MWAWOLEParser.cxx:1143
MWAWOLEParser::readSummaryProperty
bool readSummaryProperty(MWAWInputStreamPtr input, long endPos, int type, libmwaw::DebugFile &ascii, libmwaw::DebugStream &f) const
try to read a summary property
Definition: MWAWOLEParser.cxx:979
MWAWOLEParser::getObjectsId
std::vector< int > const & getObjectsId() const
returns the list of id for which we have find a representation
Definition: MWAWOLEParser.cxx:273
MWAWOLEParser::getObjectsType
std::vector< std::string > const & getObjectsType() const
returns the list of data type
Definition: MWAWOLEParser.cxx:288
MWAWOLEParser::getObjectsPosition
std::vector< MWAWPosition > const & getObjectsPosition() const
returns the list of data positions which have been read
Definition: MWAWOLEParser.cxx:278
MWAWOLEParser::readOle
static bool readOle(MWAWInputStreamPtr ip, std::string const &oleName, libmwaw::DebugFile &ascii)
the "Ole" small structure : unknown contain
Definition: MWAWOLEParser.cxx:542
MWAWOLEParser::readMM
static bool readMM(MWAWInputStreamPtr input, std::string const &oleName, libmwaw::DebugFile &ascii)
the "MM" small structure : seems to contain the file versions
Definition: MWAWOLEParser.cxx:596
MWAWOLEParser::readSummaryInformation
bool readSummaryInformation(MWAWInputStreamPtr input, std::string const &oleName, int &encoding, librevenge::RVNGPropertyList &pList, libmwaw::DebugFile &ascii, long endPos=-1) const
the summary information and the doc summary information
Definition: MWAWOLEParser.cxx:772
MWAWOLEParser::readSummaryPropertyLong
bool readSummaryPropertyLong(MWAWInputStreamPtr input, long endPos, int type, long &value, libmwaw::DebugStream &f) const
try to read a summary property: type 2,3,9,12,
Definition: MWAWOLEParser.cxx:954
MWAWOLEParser::isOlePres
static bool isOlePres(MWAWInputStreamPtr ip, std::string const &oleName)
the OlePres001 seems to contain standart picture file and size
Definition: MWAWOLEParser.cxx:1098
MWAWOLEParser::readOle10Native
static bool readOle10Native(MWAWInputStreamPtr ip, librevenge::RVNGBinaryData &data, libmwaw::DebugFile &ascii)
extracts the picture if it is possible
Definition: MWAWOLEParser.cxx:1260
MWAWOLEParser::readObjInfo
static bool readObjInfo(MWAWInputStreamPtr input, std::string const &oleName, libmwaw::DebugFile &ascii)
the "ObjInfo" small structure : seems to contain 3 ints=0,3,4
Definition: MWAWOLEParser.cxx:575
MWAWOLEParser::getNotParse
std::vector< std::string > const & getNotParse() const
returns the list of unknown ole
Definition: MWAWOLEParser.cxx:268
MWAWOLEParser::parse
bool parse(MWAWInputStreamPtr fileInput)
tries to parse basic OLE (excepted mainName)
Definition: MWAWOLEParser.cxx:323
MWAWOLEParser::readSummaryPropertyString
bool readSummaryPropertyString(MWAWInputStreamPtr input, long endPos, int type, librevenge::RVNGString &string, libmwaw::DebugStream &f) const
try to read a summary property: type 1e
Definition: MWAWOLEParser.cxx:922
MWAWOLEParser::updateMetaData
void updateMetaData(librevenge::RVNGPropertyList &metaData) const
update the meta data, using information find in SummaryInformation
Definition: MWAWOLEParser.cxx:259
MWAWOLEParser::~MWAWOLEParser
~MWAWOLEParser()
destructor
Definition: MWAWOLEParser.cxx:250
MWAWOLEParser::readContents
bool readContents(MWAWInputStreamPtr input, std::string const &oleName, librevenge::RVNGBinaryData &pict, MWAWPosition &pos, libmwaw::DebugFile &ascii)
the Contents : in general a picture : a PNG, an JPEG, a basic metafile, I find also a Word art pictur...
Definition: MWAWOLEParser.cxx:1298
MWAWOLEParser::getObjects
std::vector< librevenge::RVNGBinaryData > const & getObjects() const
returns the list of data which have been read
Definition: MWAWOLEParser.cxx:283
MWAWOLEParser::setObject
void setObject(int id, librevenge::RVNGBinaryData const &obj, MWAWPosition const &pos, std::string const &type)
sets an object just in case, the external parsing find another representation
Definition: MWAWOLEParser.cxx:306
MWAWOLEParser::getObject
bool getObject(int id, librevenge::RVNGBinaryData &obj, MWAWPosition &pos, std::string &type) const
returns the picture corresponding to an id
Definition: MWAWOLEParser.cxx:293
MWAWOLEParser::m_state
std::shared_ptr< MWAWOLEParserInternal::State > m_state
the main state
Definition: MWAWOLEParser.hxx:188
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
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:66
libmwaw_internal.hxx
MWAWFontConverterPtr
std::shared_ptr< MWAWFontConverter > MWAWFontConverterPtr
a smart pointer of MWAWFontConverter
Definition: libmwaw_internal.hxx:545
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWOLEParserInternal
Low level: namespace used to define/store the data used by MWAWOLEParser.
Definition: MWAWOLEParser.cxx:53
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61