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 <libwpd-stream/libwpd-stream.h>
70 
71 #include "libmwaw_internal.hxx"
72 #include "MWAWInputStream.hxx"
73 
74 #include "MWAWDebug.hxx"
75 
76 class WPXBinaryData;
77 class MWAWPosition;
78 
79 namespace MWAWOLEParserInternal
80 {
81 class CompObj;
82 }
83 
88 {
89 public:
92  MWAWOLEParser(std::string mainName);
93 
96 
99  bool parse(MWAWInputStreamPtr fileInput);
100 
102  std::vector<std::string> const &getNotParse() const {
103  return m_unknownOLEs;
104  }
105 
107  std::vector<int> const &getObjectsId() const {
108  return m_objectsId;
109  }
111  std::vector<MWAWPosition> const &getObjectsPosition() const {
112  return m_objectsPosition;
113  }
115  std::vector<WPXBinaryData> const &getObjects() const {
116  return m_objects;
117  }
119  std::vector<std::string> const &getObjectsType() const {
120  return m_objectsType;
121  }
122 
124  bool getObject(int id, WPXBinaryData &obj, MWAWPosition &pos, std::string &type) const;
125 
129  void setObject(int id, WPXBinaryData const &obj, MWAWPosition const &pos,
130  std::string const &type);
131 
132 protected:
133 
135  static bool readOle(MWAWInputStreamPtr ip, std::string const &oleName,
136  libmwaw::DebugFile &ascii);
138  static bool readMM(MWAWInputStreamPtr input, std::string const &oleName,
139  libmwaw::DebugFile &ascii);
141  static bool readObjInfo(MWAWInputStreamPtr input, std::string const &oleName,
142  libmwaw::DebugFile &ascii);
144  bool readCompObj(MWAWInputStreamPtr ip, std::string const &oleName,
145  libmwaw::DebugFile &ascii);
146 
148  static bool isOlePres(MWAWInputStreamPtr ip, std::string const &oleName);
150  static bool readOlePres(MWAWInputStreamPtr ip, WPXBinaryData &data, MWAWPosition &pos,
151  libmwaw::DebugFile &ascii);
152 
154  static bool isOle10Native(MWAWInputStreamPtr ip, std::string const &oleName);
156  static bool readOle10Native(MWAWInputStreamPtr ip, WPXBinaryData &data,
157  libmwaw::DebugFile &ascii);
158 
162  bool readContents(MWAWInputStreamPtr input, std::string const &oleName,
163  WPXBinaryData &pict, MWAWPosition &pos, libmwaw::DebugFile &ascii);
164 
170  bool readCONTENTS(MWAWInputStreamPtr input, std::string const &oleName,
171  WPXBinaryData &pict, MWAWPosition &pos, libmwaw::DebugFile &ascii);
172 
173 
175  std::string m_avoidOLE;
177  std::vector<std::string> m_unknownOLEs;
178 
180  std::vector<WPXBinaryData> m_objects;
182  std::vector<MWAWPosition> m_objectsPosition;
184  std::vector<int> m_objectsId;
186  std::vector<std::string> m_objectsType;
187 
189  shared_ptr<MWAWOLEParserInternal::CompObj> m_compObjIdName;
190 
191 };
192 
193 #endif
194 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
std::vector< WPXBinaryData > const & getObjects() const
returns the list of data which have been read
Definition: MWAWOLEParser.hxx:115
static bool readOlePres(MWAWInputStreamPtr ip, WPXBinaryData &data, MWAWPosition &pos, libmwaw::DebugFile &ascii)
extracts the picture of OlePres001 if it is possible
Definition: MWAWOLEParser.cxx:755
std::vector< std::string > m_objectsType
list of picture type
Definition: MWAWOLEParser.hxx:186
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
Definition: ACText.hxx:44
static bool readOle(MWAWInputStreamPtr ip, std::string const &oleName, libmwaw::DebugFile &ascii)
the &quot;Ole&quot; small structure : unknown contain
Definition: MWAWOLEParser.cxx:479
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:67
void setObject(int id, WPXBinaryData const &obj, MWAWPosition const &pos, std::string const &type)
sets an object just in case, the external parsing find another representation
Definition: MWAWOLEParser.cxx:258
std::vector< std::string > m_unknownOLEs
list of ole which can not be parsed
Definition: MWAWOLEParser.hxx:177
std::vector< WPXBinaryData > m_objects
list of pictures read
Definition: MWAWOLEParser.hxx:180
bool parse(MWAWInputStreamPtr fileInput)
tries to parse basic OLE (excepted mainName)
Definition: MWAWOLEParser.cxx:275
bool getObject(int id, WPXBinaryData &obj, MWAWPosition &pos, std::string &type) const
returns the picture corresponding to an id
Definition: MWAWOLEParser.cxx:245
std::vector< std::string > const & getNotParse() const
returns the list of unknown ole
Definition: MWAWOLEParser.hxx:102
bool readContents(MWAWInputStreamPtr input, std::string const &oleName, WPXBinaryData &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:911
static bool readMM(MWAWInputStreamPtr input, std::string const &oleName, libmwaw::DebugFile &ascii)
the &quot;MM&quot; small structure : seems to contain the file versions
Definition: MWAWOLEParser.cxx:533
~MWAWOLEParser()
destructor
Definition: MWAWOLEParser.cxx:241
std::vector< std::string > const & getObjectsType() const
returns the list of data type
Definition: MWAWOLEParser.hxx:119
static bool isOlePres(MWAWInputStreamPtr ip, std::string const &oleName)
the OlePres001 seems to contain standart picture file and size
Definition: MWAWOLEParser.cxx:710
a class used to parse some basic oles Tries to read the different ole parts and stores their contents...
Definition: MWAWOLEParser.hxx:87
std::vector< MWAWPosition > const & getObjectsPosition() const
returns the list of data positions which have been read
Definition: MWAWOLEParser.hxx:111
bool readCONTENTS(MWAWInputStreamPtr input, std::string const &oleName, WPXBinaryData &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:1010
std::string m_avoidOLE
if filled, does not parse content with this name
Definition: MWAWOLEParser.hxx:175
bool readCompObj(MWAWInputStreamPtr ip, std::string const &oleName, libmwaw::DebugFile &ascii)
the &quot;CompObj&quot; contains : UserType,ClipName,ProgIdName
Definition: MWAWOLEParser.cxx:590
std::vector< MWAWPosition > m_objectsPosition
list of picture size ( if known)
Definition: MWAWOLEParser.hxx:182
std::vector< int > const & getObjectsId() const
returns the list of id for which we have find a representation
Definition: MWAWOLEParser.hxx:107
std::vector< int > m_objectsId
list of pictures id
Definition: MWAWOLEParser.hxx:184
MWAWOLEParser(std::string mainName)
constructor
Definition: MWAWOLEParser.cxx:235
shared_ptr< MWAWOLEParserInternal::CompObj > m_compObjIdName
a smart ptr used to stored the list of compobj id-&gt;name
Definition: MWAWOLEParser.hxx:189
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
static bool readObjInfo(MWAWInputStreamPtr input, std::string const &oleName, libmwaw::DebugFile &ascii)
the &quot;ObjInfo&quot; small structure : seems to contain 3 ints=0,3,4
Definition: MWAWOLEParser.cxx:512
static bool readOle10Native(MWAWInputStreamPtr ip, WPXBinaryData &data, libmwaw::DebugFile &ascii)
extracts the picture if it is possible
Definition: MWAWOLEParser.cxx:873
static bool isOle10Native(MWAWInputStreamPtr ip, std::string const &oleName)
theOle10Native : basic Windows© picture, with no size
Definition: MWAWOLEParser.cxx:857

Generated for libmwaw by doxygen 1.8.5