workbookhelper.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <memory>
#include <string_view>

#include <oox/helper/storagebase.hxx>
#include <address.hxx>

namespace oox::drawingml::chart { class ChartConverter; }
namespace rtl { template <class reference_type> class Reference; }

namespace com::sun::star {
    namespace container { class XNameContainer; }
    namespace sheet { class XDatabaseRange; }
    namespace sheet { class XSpreadsheet; }
    namespace sheet { class XSpreadsheetDocument; }
    namespace sheet { struct FormulaToken; }
    namespace style { class XStyle; }
    namespace table { class XCellRange; }
}

namespace oox {
    class SegmentProgressBar;
}

namespace oox::core {
    class FilterBase;
    class FragmentHandler;
    class XmlFilterBase;
    class FastParser;
}

class ScDocument;
class ScDocumentImport;
class ScEditEngineDefaulter;
class ScDBData;
class ScRangeData;

namespace oox::xls {

class ExcelFilter;

struct IgnoreCaseCompare
{
    bool operator()( const OUString& rName1, std::u16string_view rName2 ) const;
};

class AddressConverter;
class ConnectionsBuffer;
class DefinedNamesBuffer;
class ExternalLinkBuffer;
class FormulaParser;
class PageSettingsConverter;
class PivotCacheBuffer;
class PivotTableBuffer;
class ScenarioBuffer;
class SharedStringsBuffer;
class StylesBuffer;
class TableBuffer;
class ThemeBuffer;
class UnitConverter;
class ViewSettings;
class WorkbookSettings;
class WorksheetBuffer;
class FormulaBuffer;

class WorkbookGlobals;
typedef std::shared_ptr< WorkbookGlobals > WorkbookGlobalsRef;

class WorkbookHelper
{
public:
    /*implicit*/ WorkbookHelper( WorkbookGlobals& rBookGlob ) : mrBookGlob( rBookGlob ) {}
    virtual             ~WorkbookHelper();

    WorkbookHelper(WorkbookHelper const &) = default;
    WorkbookHelper(WorkbookHelper &&) = default;
    WorkbookHelper & operator =(WorkbookHelper const &) = delete; // due to mrBookGlob
    WorkbookHelper & operator =(WorkbookHelper &&) = delete; // due to mrBookGlob

    static WorkbookGlobalsRef constructGlobals( ExcelFilter& rFilter );

    // filter -----------------------------------------------------------------

    ::oox::core::FilterBase& getBaseFilter() const;
    SegmentProgressBar& getProgressBar() const;
    sal_Int16           getCurrentSheetIndex() const;
    bool                isGeneratorKnownGood() const;

    void                setVbaProjectStorage( const StorageRef& rxVbaPrjStrg );
    void                setCurrentSheetIndex( SCTAB nSheet );
    void                finalizeWorkbookImport();
    void                useInternalChartDataTable( bool bInternal );

    // document model ---------------------------------------------------------
    ScDocument& getScDocument();
    const ScDocument& getScDocument() const;

    ScDocumentImport& getDocImport();
    const ScDocumentImport& getDocImport() const;

    ScEditEngineDefaulter& getEditEngine() const;
    const css::uno::Reference< css::sheet::XSpreadsheetDocument >&
                        getDocument() const;

    css::uno::Reference< css::sheet::XSpreadsheet >
                        getSheetFromDoc( sal_Int32 nSheet ) const;
    css::uno::Reference< css::sheet::XSpreadsheet >
                        getSheetFromDoc( const OUString& rSheet ) const;

    css::uno::Reference< css::table::XCellRange >
                        getCellRangeFromDoc( const ScRange& rRange ) const;

    css::uno::Reference< css::container::XNameContainer >
                        getCellStyleFamily() const;
    css::uno::Reference< css::style::XStyle >
                        getStyleObject( const OUString& rStyleName, bool bPageStyle ) const;

    // second is true if ownership belongs to the caller
    typedef std::pair<ScRangeData*, bool> RangeDataRet;

    RangeDataRet createNamedRangeObject(
                            OUString& orName,
                            const css::uno::Sequence< css::sheet::FormulaToken>& rTokens,
                            sal_Int32 nIndex,
                            sal_Int32 nNameFlags, bool bHidden ) const;

    RangeDataRet createLocalNamedRangeObject(
                            OUString& orName,
                            const css::uno::Sequence< css::sheet::FormulaToken>& rTokens,
                            sal_Int32 nIndex,
                            sal_Int32 nNameFlags, sal_Int32 nTab, bool bHidden ) const;

    css::uno::Reference< css::sheet::XDatabaseRange >
                        createDatabaseRangeObject(
                            OUString& orName,
                            const ScRange& rRangeAddr ) const;

    css::uno::Reference< css::sheet::XDatabaseRange >
                        createUnnamedDatabaseRangeObject(
                            const ScRange& rRangeAddr ) const;

    ScDBData* findDatabaseRangeByIndex( sal_uInt16 nIndex ) const;

    css::uno::Reference< css::style::XStyle >
                        createStyleObject(
                            OUString& orStyleName,
                            bool bPageStyle ) const;

    // buffers ----------------------------------------------------------------

    FormulaBuffer&      getFormulaBuffer() const;
    WorkbookSettings&   getWorkbookSettings() const;
    ViewSettings&       getViewSettings() const;
    WorksheetBuffer&    getWorksheets() const;
    ThemeBuffer&        getTheme() const;
    StylesBuffer&       getStyles() const;
    SharedStringsBuffer& getSharedStrings() const;
    ExternalLinkBuffer& getExternalLinks() const;
    DefinedNamesBuffer& getDefinedNames() const;
    TableBuffer&        getTables() const;
    ScenarioBuffer&     getScenarios() const;
    ConnectionsBuffer&  getConnections() const;
    PivotCacheBuffer&   getPivotCaches() const;
    PivotTableBuffer&   getPivotTables() const;

    // converters -------------------------------------------------------------

    FormulaParser&      getFormulaParser() const;
    FormulaParser*      createFormulaParser() const;
    UnitConverter&      getUnitConverter() const;
    AddressConverter&   getAddressConverter() const;
    oox::drawingml::chart::ChartConverter* getChartConverter() const;
    PageSettingsConverter& getPageSettingsConverter() const;

    // OOXML/BIFF12 specific (MUST NOT be called in BIFF filter) --------------

    ::oox::core::XmlFilterBase& getOoxFilter() const;

    bool importOoxFragment( const rtl::Reference<oox::core::FragmentHandler>& rxHandler );

    bool importOoxFragment( const rtl::Reference<oox::core::FragmentHandler>& rxHandler, oox::core::FastParser& rParser );

    // BIFF2-BIFF8 specific (MUST NOT be called in OOXML/BIFF12 filter) -------

    rtl_TextEncoding    getTextEncoding() const;

private:
    WorkbookGlobals&    mrBookGlob;
};

} // namespace oox::xls

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */