funcdesc.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
 
/* Function descriptions for function wizard / autopilot */
 
#include "scfuncs.hxx"
 
#include <formula/IFunctionDescription.hxx>
#include <sal/types.h>
#include <rtl/ustring.hxx>
#include <optional>
#include <map>
#include <memory>
 
#define MAX_FUNCCAT 12  /* maximum number of categories for functions */
#define LRU_MAX 10 /* maximal number of last recently used functions */
 
class ScFuncDesc final : public formula::IFunctionDescription
{
public:
    ScFuncDesc();
    virtual ~ScFuncDesc();
 
    void Clear();
 
    virtual void fillVisibleArgumentMapping(::std::vector<sal_uInt16>& _rArguments) const override ;
 
    virtual const formula::IFunctionCategory* getCategory() const override ;
 
    virtual OUString getDescription() const override ;
 
    virtual OUString getFormula(const ::std::vector< OUString >& _aArguments) const override ;
 
    virtual OUString getFunctionName() const override ;
 
    virtual OUString getHelpId() const override ;
 
    virtual bool isHidden() const override;
 
    virtual sal_uInt32 getParameterCount() const override ;
 
    virtual sal_uInt32 getVarArgsStart() const override ;
 
    virtual sal_uInt32 getVarArgsLimit() const override ;
 
    virtual OUString getParameterDescription(sal_uInt32 _nPos) const override ;
 
    virtual OUString getParameterName(sal_uInt32 _nPos) const override ;
 
    OUString GetParamList() const;
 
    virtual OUString getSignature() const override ;
 
    sal_uInt16  GetSuppressedArgCount() const;
    virtual sal_Int32 getSuppressedArgumentCount() const override ;
 
    virtual void initArgumentInfo()  const override;
 
    virtual bool isParameterOptional(sal_uInt32 _nPos) const override ;
 
    static bool compareByName(const ScFuncDesc* a, const ScFuncDesc* b);
 
    struct ParameterFlags
    {
        bool    bOptional   :1;     
        ParameterFlags() : bOptional(false) {}
    };
 
    std::optional<OUString> mxFuncName;         
    std::optional<OUString> mxFuncDesc;         
    std::vector<OUString> maDefArgNames;          
    std::vector<OUString> maDefArgDescs;          
    ParameterFlags       *pDefArgFlags;           
    sal_uInt16            nFIndex;                
    sal_uInt16            nCategory;              
    sal_uInt16            nArgCount;              
    sal_uInt16            nVarArgsStart;          
    sal_uInt16            nVarArgsLimit;          
    OUString              sHelpId;                
    bool                  bIncomplete         :1; 
    bool                  mbHidden            :1; 
};
 
class ScFunctionList
{
public:
    explicit ScFunctionList( bool bEnglishFunctionNames );
    ~ScFunctionList();
 
    sal_uInt32 GetCount() const
               { return aFunctionList.size(); }
 
    const ScFuncDesc* First();
 
    const ScFuncDesc* Next();
 
    const ScFuncDesc* GetFunction( sal_uInt32 nIndex ) const;
 
    bool IsEnglishFunctionNames() const { return mbEnglishFunctionNames; }
 
private:
    ::std::vector<const ScFuncDesc*> aFunctionList; 
    ::std::vector<const ScFuncDesc*>::iterator aFunctionListIter; 
    bool mbEnglishFunctionNames;
};
 
class ScFunctionCategory final : public formula::IFunctionCategory
{
public:
    ScFunctionCategory(const ::std::vector<const ScFuncDesc*>& _rCategory,sal_uInt32 _nCategory)
            : m_rCategory(_rCategory),m_nCategory(_nCategory){}
    virtual ~ScFunctionCategory(){}
 
    virtual sal_uInt32 getCount() const override;
 
    virtual const formula::IFunctionDescription* getFunction(sal_uInt32 _nPos) const override;
 
    virtual sal_uInt32 getNumber() const override;
    virtual OUString getName() const override;
 
private:
    const ::std::vector<const ScFuncDesc*>& m_rCategory; 
    mutable OUString m_sName; 
    sal_uInt32 m_nCategory; 
};
 
#define SC_FUNCGROUP_COUNT  ID_FUNCTION_GRP_ADDINS
class ScFunctionMgr final : public formula::IFunctionManager
{
public:
            ScFunctionMgr();
    virtual ~ScFunctionMgr();
 
    static OUString GetCategoryName(sal_uInt32 _nCategoryNumber );
 
    const ScFuncDesc* Get( sal_uInt16 nFIndex ) const;
 
    const ScFuncDesc* First( sal_uInt16 nCategory = 0 ) const;
 
    const ScFuncDesc* Next() const;
 
    virtual sal_uInt32 getCount() const override;
 
    virtual const formula::IFunctionCategory* getCategory(sal_uInt32 nPos) const override;
 
    virtual void fillLastRecentlyUsedFunctions(::std::vector< const formula::IFunctionDescription*>& _rLastRUFunctions) const override;
 
    virtual sal_Unicode getSingleToken(const formula::IFunctionManager::EToken _eToken) const override;
 
private:
    std::vector<const ScFuncDesc*> aCatLists[MAX_FUNCCAT]; 
    mutable std::map< sal_uInt32, std::shared_ptr<ScFunctionCategory> > m_aCategories; 
    mutable std::vector<const ScFuncDesc*>::const_iterator pCurCatListIter; 
    mutable std::vector<const ScFuncDesc*>::const_iterator pCurCatListEnd; 
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */