Lotus.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* libwps
 * Version: MPL 2.0 / LGPLv2.1+
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Major Contributor(s):
 * Copyright (C) 2006, 2007 Andrew Ziem
 * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)
 * Copyright (C) 2003 Marc Maurer (uwog@uwog.net)
 *
 * For minor contributions see the git repository.
 *
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU Lesser General Public License Version 2.1 or later
 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
 * applicable instead of those above.
 */
 
#ifndef LOTUS_H
#define LOTUS_H
 
#include <vector>
 
#include <librevenge-stream/librevenge-stream.h>
#include "libwps_internal.h"
#include "libwps_tools_win.h"
#include "WPSDebug.h"
 
#include "WKSParser.h"
 
namespace LotusParserInternal
{
class SubDocument;
struct State;
}
 
class LotusGraph;
class LotusChart;
class LotusSpreadsheet;
class LotusStyleManager;
class WPSGraphicStyle;
class WPSOLE1Parser;
 
/* .wk3: a spreadsheet is composed in two files
       + a wk3 file which contains the spreadsheet data
       + a fm3 file which contains the different formatings
 
   .wk4: the file contains three parts:
       + the wk3 previous file
           + the fm3 file
           + an unknown part, which may code the file structure,
 
           Normally the wk3 and the fm3 are a sequence of small zones,
           but picture seems to be appeared at random position inside the
           fm3 part (and even inside some structure fm3 structures...)
 
           search for .ole and OLE1
 
        .123: the file contains at least two parts:
           + the 123 storing the spreadsheet's data and format
           + the last part containing the file's structure
           + some optional part containing chart, picture, ...
 */

class LotusParser final : public WKSParser
{
        friend class LotusParserInternal::SubDocument;
        friend class LotusChart;
        friend class LotusGraph;
        friend class LotusSpreadsheet;
        friend class LotusStyleManager;
public:
        LotusParser(RVNGInputStreamPtr &input, WPSHeaderPtr &header,
                    char const *password=nullptr);
        ~LotusParser() final;
        void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final;
        bool checkHeader(WPSHeader *header, bool strict=false);

        struct Link
        {
                Link() : m_linkName()
                {
                }

                WPSVec3i m_cells[2];
                std::string m_linkName;
        };
protected:
        int version() const;
 
        //
        // interface
        //

        bool getFont(int id, WPSFont &font) const;
        Link const *getLink(std::string const &lId) const;

        librevenge::RVNGString getStringForLMBCS(std::string const &text) const;
        std::vector<uint32_t> getUnicodeVectorForLMBCS(std::string const &text) const;
        std::string getDebugStringForLMBCS(std::string const &text) const;

        void sendText(RVNGInputStreamPtr &input, WPSEntry const &entry) const;
 
        //
        // interface with LotusChart
        //

        bool sendChart(int cId, WPSPosition const &pos, WPSGraphicStyle const &style);
 
        //
        // interface with LotusGraph
        //

        bool hasGraphics(int sheetId) const;
        void sendGraphics(int sheetId);
 
        //
        // interface with LotusSpreadsheet
        //

        bool getLeftTopPosition(Vec2i const &cell, int spreadsheet, Vec2f &pos) const;
        librevenge::RVNGString getSheetName(int id) const;
 
        //
        // interface with WPSOLE1Parser
        //

        bool updateEmbeddedObject(int id, WPSEmbeddedObject &object) const;

        bool createZones();
        bool createListener(librevenge::RVNGSpreadsheetInterface *interface);
 
        //
        // low level
        //

        bool parseFormatStream();

        bool checkHeader(std::shared_ptr<WPSStream> stream, bool mainStream, bool strict);
        bool readZones(std::shared_ptr<WPSStream> stream);
        bool readExtFormats(std::shared_ptr<WPSStream> stream);
        bool readZone(std::shared_ptr<WPSStream> &stream);
        bool readZone1(std::shared_ptr<WPSStream> stream);
        bool readSheetZone(std::shared_ptr<WPSStream> stream);
        bool readZone4(std::shared_ptr<WPSStream> stream);
        bool readChartZone(std::shared_ptr<WPSStream> stream);
        bool readRefZone(std::shared_ptr<WPSStream> stream);
        static bool readZone7(std::shared_ptr<WPSStream> stream);
        bool readZone8(std::shared_ptr<WPSStream> stream);
        static bool readVersionZone(std::shared_ptr<WPSStream> stream);
        static bool readZoneV3(std::shared_ptr<WPSStream> stream);

        bool readSheetSize(std::shared_ptr<WPSStream> stream, long endPos, int &row, int &col, int &sheet);
        bool readMacFontName(std::shared_ptr<WPSStream> stream, long endPos);
        bool readFMTStyleName(std::shared_ptr<WPSStream> stream);
        bool readLinkZone(std::shared_ptr<WPSStream> stream);
        bool readDocumentInfoMac(std::shared_ptr<WPSStream> stream, long endPos);

        static RVNGInputStreamPtr decodeStream(RVNGInputStreamPtr input, long endPos, std::vector<uint8_t> const &key);
        static std::vector<uint8_t> retrievePasswordKeys(std::vector<uint8_t> const &fileKeys);
 
        std::shared_ptr<WKSContentListener> m_listener; 
        std::shared_ptr<LotusParserInternal::State> m_state;
        std::shared_ptr<LotusStyleManager> m_styleManager;
        std::shared_ptr<LotusChart> m_chartParser;
        std::shared_ptr<LotusGraph> m_graphParser;
        std::shared_ptr<LotusSpreadsheet> m_spreadsheetParser;
        std::shared_ptr<WPSOLE1Parser> m_ole1Parser;
};
 
#endif /* LOTUS_H */
/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */