xlroot.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 <i18nlangtag/lang.h>
#include <tools/ref.hxx>
#include <tools/long.hxx>
#include "xlconst.hxx"
#include <memory>

namespace com::sun::star::beans { struct NamedValue; }
namespace comphelper { class IDocPasswordVerifier; }

// Forward declarations of objects in public use ==============================

class DateTime;
class SotStorage;
class SotStorageStream;

// Global data ================================================================

#ifdef DBG_UTIL

struct XclDebugObjCounter
{
    sal_Int32           mnObjCnt;
    explicit     XclDebugObjCounter() : mnObjCnt( 0 ) {}
                        ~XclDebugObjCounter();
};
#endif

class SfxMedium;
class ScEditEngineDefaulter;
class ScHeaderEditEngine;
class EditEngine;
class ScExtDocOptions;
class XclFontPropSetHelper;
class XclChPropSetHelper;
class XclTracer;

struct RootData;

struct XclRootData
#ifdef DBG_UTIL
    : public XclDebugObjCounter
#endif
{
    typedef std::shared_ptr< ScEditEngineDefaulter > ScEEDefaulterRef;
    typedef std::shared_ptr< ScHeaderEditEngine >    ScHeaderEERef;
    typedef std::shared_ptr< EditEngine >            EditEngineRef;
    typedef std::shared_ptr< XclFontPropSetHelper >  XclFontPropSetHlpRef;
    typedef std::shared_ptr< XclChPropSetHelper >    XclChPropSetHlpRef;
    typedef std::shared_ptr< ScExtDocOptions >       ScExtDocOptRef;
    typedef std::shared_ptr< XclTracer >             XclTracerRef;
    typedef std::shared_ptr< RootData >              RootDataRef;

    XclBiff             meBiff;             
    XclOutput           meOutput;           
    SfxMedium&          mrMedium;           
    tools::SvRef<SotStorage>       mxRootStrg;         
    ScDocument&         mrDoc;              
    OUString            maDocUrl;           
    OUString            maBasePath;         
    OUString            maUserName;         
    static constexpr OUStringLiteral gaDefPassword = u"VelvetSweatshop"; 
    rtl_TextEncoding    meTextEnc;          
    LanguageType        meSysLang;          
    LanguageType        meDocLang;          
    LanguageType        meUILang;           
    sal_Int16           mnDefApiScript;     
    ScAddress           maScMaxPos;         
    ScAddress           maXclMaxPos;        
    ScAddress           maMaxPos;           

    ScEEDefaulterRef    mxEditEngine;       
    ScHeaderEERef       mxHFEditEngine;     
    EditEngineRef       mxDrawEditEng;      

    XclFontPropSetHlpRef mxFontPropSetHlp;  
    XclChPropSetHlpRef  mxChPropSetHlp;     

    ScExtDocOptRef      mxExtDocOpt;        
    XclTracerRef        mxTracer;           
    RootDataRef         mxRD;               

    double              mfScreenPixelX;     
    double              mfScreenPixelY;     
    tools::Long         mnCharWidth;        
    tools::Long         mnSpaceWidth;       
    SCTAB               mnScTab;            
    const bool          mbExport;           

    explicit            XclRootData( XclBiff eBiff, SfxMedium& rMedium,
                            tools::SvRef<SotStorage> const & xRootStrg, ScDocument& rDoc,
                            rtl_TextEncoding eTextEnc, bool bExport );
    virtual             ~XclRootData();
};

class SfxObjectShell;
class ScModelObj;
class OutputDevice;
class SvNumberFormatter;
class SdrPage;
class ScStyleSheetPool;
class ScRangeName;
struct XclFontData;

class XclRoot
{
public:
    explicit            XclRoot( XclRootData& rRootData );
                        XclRoot( const XclRoot& rRoot );

    virtual             ~XclRoot();

    XclRoot&            operator=( const XclRoot& rRoot );

    RootData&    GetOldRoot() const { return *mrData.mxRD; }

    XclBiff      GetBiff() const { return mrData.meBiff; }
    XclOutput    GetOutput() const { return mrData.meOutput; }
    bool         IsImport() const { return !mrData.mbExport; }
    rtl_TextEncoding GetTextEncoding() const { return mrData.meTextEnc; }
    LanguageType GetSysLanguage() const { return mrData.meSysLang; }
    LanguageType GetDocLanguage() const { return mrData.meDocLang; }
    LanguageType GetUILanguage() const { return mrData.meUILang; }
    sal_Int16    GetDefApiScript() const { return mrData.mnDefApiScript; }
    tools::Long  GetCharWidth() const { return mrData.mnCharWidth; }
    tools::Long  GetSpaceWidth() const { return mrData.mnSpaceWidth; }
    bool         IsInGlobals() const { return mrData.mnScTab == SCTAB_GLOBAL; }
    SCTAB        GetCurrScTab() const { return mrData.mnScTab; }

    sal_Int32           GetHmmFromPixelX( double fPixelX ) const;
    sal_Int32           GetHmmFromPixelY( double fPixelY ) const;

    SfxMedium&   GetMedium() const { return mrData.mrMedium; }
    const OUString& GetDocUrl() const { return mrData.maDocUrl; }
    const OUString& GetBasePath() const { return mrData.maBasePath; }
    const OUString& GetUserName() const { return mrData.maUserName; }

    static OUString GetDefaultPassword() { return XclRootData::gaDefPassword; }
    css::uno::Sequence< css::beans::NamedValue >
        RequestEncryptionData( ::comphelper::IDocPasswordVerifier& rVerifier ) const;

    const tools::SvRef<SotStorage>& GetRootStorage() const { return mrData.mxRootStrg; }
    bool                HasVbaStorage() const;

    tools::SvRef<SotStorage>       OpenStorage( tools::SvRef<SotStorage> const & xStrg, const OUString& rStrgName ) const;
    tools::SvRef<SotStorage>       OpenStorage( const OUString& rStrgName ) const;
    tools::SvRef<SotStorageStream> OpenStream( tools::SvRef<SotStorage> const & xStrg, const OUString& rStrmName ) const;
    tools::SvRef<SotStorageStream> OpenStream( const OUString& rStrmName ) const;

    ScDocument& GetDoc() const;

    SfxObjectShell*     GetDocShell() const;
    ScModelObj*         GetDocModelObj() const;
    OutputDevice*       GetPrinter() const;
    ScStyleSheetPool&   GetStyleSheetPool() const;
    ScRangeName&        GetNamedRanges() const;
    SdrPage*            GetSdrPage( SCTAB nScTab ) const;

    SvNumberFormatter&  GetFormatter() const;
    DateTime            GetNullDate() const;
    sal_uInt16          GetBaseYear() const;
    double              GetDoubleFromDateTime( const DateTime& rDateTime ) const;
    DateTime            GetDateTimeFromDouble( double fValue ) const;

    ScEditEngineDefaulter& GetEditEngine() const;
    ScHeaderEditEngine& GetHFEditEngine() const;
    EditEngine&         GetDrawEditEngine() const;

    XclFontPropSetHelper& GetFontPropSetHelper() const;
    XclChPropSetHelper& GetChartPropSetHelper() const;

    ScExtDocOptions&    GetExtDocOptions() const;
    XclTracer&          GetTracer() const;

    const ScAddress& GetScMaxPos() const { return mrData.maScMaxPos; }
    const ScAddress& GetXclMaxPos() const { return mrData.maXclMaxPos; }
    const ScAddress& GetMaxPos() const { return mrData.maMaxPos; }

    void         SetDocLanguage( LanguageType eLang ) { mrData.meDocLang = eLang; }
    void         SetUILanguage( LanguageType eLang ) { mrData.meUILang = eLang; }
    void                SetTextEncoding( rtl_TextEncoding eTextEnc );
    void                SetCharWidth( const XclFontData& rFontData );
    void         SetCurrScTab( SCTAB nScTab ) { mrData.mnScTab = nScTab; }
    void         IncCurrScTab() { ++mrData.mnScTab; }

private:
    XclRootData& mrData;        
};

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