xltools.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 <types.hxx>
#include "ftools.hxx"

#include <tools/long.hxx>
#include <tools/degree.hxx>

class SfxObjectShell;
enum class FormulaError : sal_uInt16;

// BIFF versions ==============================================================

#define DBG_ERROR_BIFF()        OSL_FAIL( "Unknown BIFF type!" )
#define OSL_ENSURE_BIFF( c )    OSL_ENSURE( c, "Unknown BIFF type!" )

// Enumerations ===============================================================

enum XclBoolError
{
    xlErrNull,                  
    xlErrDiv0,                  
    xlErrValue,                 
    xlErrRef,                   
    xlErrName,                  
    xlErrNum,                   
    xlErrNA,                    
    xlErrTrue,                  
    xlErrFalse,                 
    xlErrUnknown                
};

// GUID import/export =========================================================

class XclImpStream;
class XclExpStream;

struct XclGuid
{
    sal_uInt8           mpnData[ 16 ];  

    explicit            XclGuid();
    explicit            XclGuid(
                            sal_uInt32 nData1,
                            sal_uInt16 nData2, sal_uInt16 nData3,
                            sal_uInt8 nData41, sal_uInt8 nData42,
                            sal_uInt8 nData43, sal_uInt8 nData44,
                            sal_uInt8 nData45, sal_uInt8 nData46,
                            sal_uInt8 nData47, sal_uInt8 nData48 );
};

bool operator==( const XclGuid& rCmp1, const XclGuid& rCmp2 );

XclImpStream& operator>>( XclImpStream& rStrm, XclGuid& rGuid );
XclExpStream& operator<<( XclExpStream& rStrm, const XclGuid& rGuid );

// Excel Tools ================================================================

class XclTools
{
public:
    // noncopyable nonconstructable -------------------------------------------

    XclTools(const XclTools&) = delete;
    const XclTools& operator=(const XclTools&) = delete;
    XclTools() = delete;


    // GUID's -----------------------------------------------------------------

    static const XclGuid maGuidStdLink;     
    static const XclGuid maGuidUrlMoniker;  
    static const XclGuid maGuidFileMoniker; 

    // numeric conversion -----------------------------------------------------

    static double       GetDoubleFromRK( sal_Int32 nRKValue );
    static bool         GetRKFromDouble( sal_Int32& rnRKValue, double fValue );

    static Degree100    GetScRotation( sal_uInt16 nXclRot, Degree100 nRotForStacked );
    static sal_uInt8    GetXclRotation( Degree100 nScRot );

    static sal_uInt8    GetXclRotFromOrient( sal_uInt8 nXclOrient );
    static sal_uInt8    GetXclOrientFromRot( sal_uInt16 nXclRot );

    static sal_uInt8    GetXclErrorCode( FormulaError nScError );
    static FormulaError GetScErrorCode( sal_uInt8 nXclError );

    static double       ErrorToDouble( sal_uInt8 nXclError );
    static XclBoolError ErrorToEnum( double& rfDblValue, bool bErrOrBool, sal_uInt8 nValue );

    static sal_uInt16   GetTwipsFromInch( double fInches );
    static sal_uInt16   GetTwipsFromHmm( sal_Int32 nHmm );

    static double       GetInchFromTwips( sal_Int32 nTwips );
    static double       GetInchFromHmm( sal_Int32 nHmm );

    static sal_Int32    GetHmmFromInch( double fInches );
    static sal_Int32    GetHmmFromTwips( sal_Int32 nTwips );

    static sal_uInt16       GetScColumnWidth( sal_uInt16 nXclWidth, tools::Long nScCharWidth );
    static sal_uInt16   GetXclColumnWidth( sal_uInt16 nScWidth, tools::Long nScCharWidth );

    static double       GetXclDefColWidthCorrection( tools::Long nXclDefFontHeight );

    // formatting -------------------------------------------------------------

    static Color        GetPatternColor( const Color& rPattColor, const Color& rBackColor, sal_uInt16 nXclPattern );

    // text encoding ----------------------------------------------------------

    static rtl_TextEncoding GetTextEncoding( sal_uInt16 nCodePage );

    static sal_uInt16   GetXclCodePage( rtl_TextEncoding eTextEnc );

    // font names -------------------------------------------------------------

    static OUString GetXclFontName( const OUString& rFontName );

    // built-in defined names -------------------------------------------------

    static OUString GetXclBuiltInDefName( sal_Unicode cBuiltIn );
    static OUString GetBuiltInDefName( sal_Unicode cBuiltIn );
    static OUString GetBuiltInDefNameXml( sal_Unicode cBuiltIn );
    static sal_Unicode  GetBuiltInDefNameIndex( const OUString& rDefName );

    // built-in style names ---------------------------------------------------

    static OUString GetBuiltInStyleName( sal_uInt8 nStyleId, std::u16string_view rName, sal_uInt8 nLevel );

    static bool         IsBuiltInStyleName( const OUString& rStyleName, sal_uInt8* pnStyleId = nullptr, sal_Int32* pnNextChar = nullptr );
    static bool         GetBuiltInStyleId(
                            sal_uInt8& rnStyleId, sal_uInt8& rnLevel,
                            const OUString& rStyleName );

    // conditional formatting style names -------------------------------------

    static OUString GetCondFormatStyleName( SCTAB nScTab, sal_Int32 nFormat, sal_uInt16 nCondition );
    static bool         IsCondFormatStyleName( const OUString& rStyleName );

    // stream handling --------------------------------------------------------

    static void         SkipSubStream( XclImpStream& rStrm );

    // Basic macro names ------------------------------------------------------

    static OUString GetSbMacroUrl( const OUString& rMacroName, SfxObjectShell* pDocShell );
    static OUString GetXclMacroName( const OUString& rSbMacroUrl );

};

// read/write colors ----------------------------------------------------------

XclImpStream& operator>>( XclImpStream& rStrm, Color& rColor );

XclExpStream& operator<<( XclExpStream& rStrm, const Color& rColor );

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