defnamesbuffer.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 "workbookhelper.hxx"
#include <oox/helper/binarystreambase.hxx>
#include <oox/helper/refvector.hxx>
 
#include <memory>
 
class ScTokenArray;
 
namespace oox { class AttributeList; }
namespace oox { class SequenceInputStream; }
 
namespace oox::xls {
 
// codes for built-in names
const sal_Unicode BIFF_DEFNAME_CONSOLIDATEAREA  = '\x00';
const sal_Unicode BIFF_DEFNAME_AUTOOPEN         = '\x01';   // Sheet macro executed when workbook is opened.
const sal_Unicode BIFF_DEFNAME_AUTOCLOSE        = '\x02';   // Sheet macro executed when workbook is closed.
const sal_Unicode BIFF_DEFNAME_EXTRACT          = '\x03';   // Filter output destination for advanced filter.
const sal_Unicode BIFF_DEFNAME_DATABASE         = '\x04';
const sal_Unicode BIFF_DEFNAME_CRITERIA         = '\x05';   // Filter criteria source range for advanced filter.
const sal_Unicode BIFF_DEFNAME_PRINTAREA        = '\x06';   // Print ranges.
const sal_Unicode BIFF_DEFNAME_PRINTTITLES      = '\x07';   // Rows/columns repeated on each page when printing.
const sal_Unicode BIFF_DEFNAME_RECORDER         = '\x08';
const sal_Unicode BIFF_DEFNAME_DATAFORM         = '\x09';
const sal_Unicode BIFF_DEFNAME_AUTOACTIVATE     = '\x0A';   // Sheet macro executed when workbook is activated.
const sal_Unicode BIFF_DEFNAME_AUTODEACTIVATE   = '\x0B';   // Sheet macro executed when workbook is deactivated.
const sal_Unicode BIFF_DEFNAME_SHEETTITLE       = '\x0C';
const sal_Unicode BIFF_DEFNAME_FILTERDATABASE   = '\x0D';   // Sheet range autofilter or advanced filter works on.
const sal_Unicode BIFF_DEFNAME_UNKNOWN          = '\x0E';
 
struct DefinedNameModel
{
    OUString     maName;         
    OUString     maFormula;      
    sal_Int32           mnSheet;        
    sal_Int32           mnFuncGroupId;  
    bool                mbMacro;        
    bool                mbFunction;     
    bool                mbVBName;       
    bool                mbHidden;       
 
    explicit            DefinedNameModel();
};
 
class DefinedNameBase : public WorkbookHelper
{
public:
    explicit            DefinedNameBase( const WorkbookHelper& rHelper );
 
    const OUString& getModelName() const { return maModel.maName; }
    const OUString& getCalcName() const { return maCalcName; }
 
    const OUString& getUpcaseModelName() const;
 
protected:
    DefinedNameModel    maModel;        
    mutable OUString    maUpModelName;  
    OUString            maCalcName;     
};
 
class DefinedName final : public DefinedNameBase
{
public:
    explicit            DefinedName( const WorkbookHelper& rHelper );
    virtual ~DefinedName() override;
 
    void                importDefinedName( const AttributeList& rAttribs );
    void                setFormula( const OUString& rFormula );
    void                importDefinedName( SequenceInputStream& rStrm );
 
    void                createNameObject( sal_Int32 nIndex );
    void                convertFormula( const css::uno::Sequence<css::sheet::ExternalLinkInfo>& rExternalLinks );
    std::unique_ptr<ScTokenArray> getScTokens( const css::uno::Sequence<css::sheet::ExternalLinkInfo>& rExternalLinks );
    bool         isGlobalName() const { return mnCalcSheet < 0; }
    bool         isBuiltinName() const { return mcBuiltinId != BIFF_DEFNAME_UNKNOWN; }
    bool         isMacroFunction() const { return maModel.mbMacro && maModel.mbFunction; }
    bool         isVBName() const { return maModel.mbMacro && maModel.mbVBName; }
 
    sal_Int16    getLocalCalcSheet() const { return mnCalcSheet; }
    sal_Unicode  getBuiltinId() const { return mcBuiltinId; }
    sal_Int32    getTokenIndex() const { return mnTokenIndex; }
    bool                getAbsoluteRange( ScRange& orRange ) const;
    bool isValid(const css::uno::Sequence<css::sheet::ExternalLinkInfo>& rExternalLinks) const;
 
private:
    typedef ::std::unique_ptr< StreamDataSequence >   StreamDataSeqPtr;
 
    RangeDataRet        maScRangeData;      
    sal_Int32           mnTokenIndex;       
    sal_Int16           mnCalcSheet;        
    sal_Unicode         mcBuiltinId;        
    StreamDataSeqPtr    mxFormula;          
};
 
typedef std::shared_ptr< DefinedName > DefinedNameRef;
 
class DefinedNamesBuffer final : public WorkbookHelper
{
public:
    explicit            DefinedNamesBuffer( const WorkbookHelper& rHelper );
 
    DefinedNameRef      importDefinedName( const AttributeList& rAttribs );
    void                importDefinedName( SequenceInputStream& rStrm );
 
    void                finalizeImport();
 
    DefinedNameRef      getByIndex( sal_Int32 nIndex ) const;
    DefinedNameRef      getByTokenIndex( sal_Int32 nIndex ) const;
    DefinedNameRef      getByModelName( const OUString& rModelName, sal_Int16 nCalcSheet = -1 ) const;
    DefinedNameRef      getByBuiltinId( sal_Unicode cBuiltinId, sal_Int16 nCalcSheet ) const;
 
private:
    DefinedNameRef      createDefinedName();
 
private:
    typedef ::std::pair< sal_Int16, OUString >   SheetNameKey;
    typedef ::std::pair< sal_Int16, sal_Unicode >       BuiltinKey;
 
    typedef RefVector< DefinedName >            DefNameVector;
    typedef RefMap< SheetNameKey, DefinedName > DefNameNameMap;
    typedef RefMap< BuiltinKey, DefinedName >   DefNameBuiltinMap;
    typedef RefMap< sal_Int32, DefinedName >    DefNameTokenIdMap;
 
    DefNameVector       maDefNames;         
    DefNameNameMap      maModelNameMap;     
    DefNameBuiltinMap   maBuiltinMap;       
    DefNameTokenIdMap   maTokenIdMap;       
};
 
} // namespace oox::xls
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */