LibreOffice Module sc (master) 1
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ScUnoAddInCollection Class Reference

#include <addincol.hxx>

Public Member Functions

 ScUnoAddInCollection ()
 
 ~ScUnoAddInCollection ()
 
OUString FindFunction (const OUString &rUpperName, bool bLocalFirst)
 User entered name. rUpperName MUST already be upper case! More...
 
const ScUnoAddInFuncData * GetFuncData (const OUString &rName, bool bComplete=false)
 Only if bComplete is set, the function reference and argument types are initialized (component may have to be loaded). More...
 
const ScUnoAddInFuncData * GetFuncData (tools::Long nIndex)
 For enumeration in ScCompiler::OpCodeMap::getAvailableMappings(). More...
 
void Clear ()
 
void LocalizeString (OUString &rName)
 modify rName - input: exact name More...
 
tools::Long GetFuncCount ()
 
bool FillFunctionDesc (tools::Long nFunc, ScFuncDesc &rDesc, bool bEnglishFunctionNames)
 
bool GetExcelName (const OUString &rCalcName, LanguageType eDestLang, OUString &rRetExcelName)
 leave rRetExcelName unchanged, if no matching name is found More...
 
bool GetCalcName (const OUString &rExcelName, OUString &rRetCalcName)
 leave rRetCalcName unchanged, if no matching name is found More...
 

Static Public Member Functions

static bool FillFunctionDescFromData (const ScUnoAddInFuncData &rFuncData, ScFuncDesc &rDesc, bool bEnglishFunctionNames)
 

Private Member Functions

void Initialize ()
 
void ReadConfiguration ()
 
void ReadFromAddIn (const css::uno::Reference< css::uno::XInterface > &xInterface)
 
void UpdateFromAddIn (const css::uno::Reference< css::uno::XInterface > &xInterface, std::u16string_view rServiceName)
 
void LoadComponent (const ScUnoAddInFuncData &rFuncData)
 

Private Attributes

tools::Long nFuncCount
 
std::unique_ptr< std::unique_ptr< ScUnoAddInFuncData >[]> ppFuncData
 
std::unique_ptr< ScAddInHashMap > pExactHashMap
 exact internal name More...
 
std::unique_ptr< ScAddInHashMap > pNameHashMap
 internal name upper More...
 
std::unique_ptr< ScAddInHashMap > pLocalHashMap
 localized name upper More...
 
std::unique_ptr< ScAddInHashMap > pEnglishHashMap
 English name upper. More...
 
bool bInitialized
 

Detailed Description

Definition at line 144 of file addincol.hxx.

Constructor & Destructor Documentation

◆ ScUnoAddInCollection()

ScUnoAddInCollection::ScUnoAddInCollection ( )

Definition at line 232 of file addincol.cxx.

◆ ~ScUnoAddInCollection()

ScUnoAddInCollection::~ScUnoAddInCollection ( )

Definition at line 238 of file addincol.cxx.

Member Function Documentation

◆ Clear()

void ScUnoAddInCollection::Clear ( )

Definition at line 242 of file addincol.cxx.

References bInitialized, nFuncCount, pEnglishHashMap, pExactHashMap, pLocalHashMap, pNameHashMap, and ppFuncData.

Referenced by ScAddInCfg::Notify().

◆ FillFunctionDesc()

bool ScUnoAddInCollection::FillFunctionDesc ( tools::Long  nFunc,
ScFuncDesc &  rDesc,
bool  bEnglishFunctionNames 
)

Definition at line 1275 of file addincol.cxx.

References bInitialized, FillFunctionDescFromData(), Initialize(), nFuncCount, and ppFuncData.

Referenced by ScFunctionList::ScFunctionList().

◆ FillFunctionDescFromData()

bool ScUnoAddInCollection::FillFunctionDescFromData ( const ScUnoAddInFuncData &  rFuncData,
ScFuncDesc &  rDesc,
bool  bEnglishFunctionNames 
)
static

Definition at line 1288 of file addincol.cxx.

References ScAddInArgDesc::aDescription, ScAddInArgDesc::aName, ScFuncDesc::bIncomplete, ScAddInArgDesc::bOptional, ScFuncDesc::ParameterFlags::bOptional, ScFuncDesc::Clear(), eType, ScUnoAddInFuncData::GetArgumentCount(), ScUnoAddInFuncData::GetArguments(), ScUnoAddInFuncData::GetCategory(), ScUnoAddInFuncData::GetDescription(), ScUnoAddInFuncData::GetFunction(), ScUnoAddInFuncData::GetHelpId(), ScUnoAddInFuncData::GetLocalName(), ScUnoAddInFuncData::GetUpperEnglish(), ScUnoAddInFuncData::GetUpperLocal(), ScFuncDesc::maDefArgDescs, ScFuncDesc::maDefArgNames, ScFuncDesc::mxFuncDesc, ScFuncDesc::mxFuncName, ScFuncDesc::nArgCount, ScFuncDesc::nCategory, ScFuncDesc::pDefArgFlags, SAL_MAX_UINT16, SC_ADDINARG_VARARGS, ScFuncDesc::sHelpId, and VAR_ARGS.

Referenced by FillFunctionDesc(), and lcl_UpdateFunctionList().

◆ FindFunction()

OUString ScUnoAddInCollection::FindFunction ( const OUString &  rUpperName,
bool  bLocalFirst 
)

User entered name. rUpperName MUST already be upper case!

Definition at line 1181 of file addincol.cxx.

References bInitialized, Initialize(), nFuncCount, pEnglishHashMap, pLocalHashMap, and pNameHashMap.

Referenced by ScCompiler::FindAddInFunction(), ScParameterClassification::GetExternalParameterType(), ScFuncDesc::initArgumentInfo(), ScCompiler::IsEnglishSymbol(), lcl_AddFunctionToken(), and ScCompiler::ParseOpCode().

◆ GetCalcName()

bool ScUnoAddInCollection::GetCalcName ( const OUString &  rExcelName,
OUString &  rRetCalcName 
)

leave rRetCalcName unchanged, if no matching name is found

Definition at line 641 of file addincol.cxx.

References bInitialized, ScGlobal::getCharClass(), ScUnoAddInFuncData::GetCompNames(), ScUnoAddInFuncData::GetOriginalName(), i, Initialize(), nFuncCount, ppFuncData, and CharClass::uppercase().

◆ GetExcelName()

bool ScUnoAddInCollection::GetExcelName ( const OUString &  rCalcName,
LanguageType  eDestLang,
OUString &  rRetExcelName 
)

leave rRetExcelName unchanged, if no matching name is found

Definition at line 632 of file addincol.cxx.

References ScUnoAddInFuncData::GetExcelName(), and GetFuncData().

Referenced by XclExpFmlaCompImpl::AppendAddInCallToken().

◆ GetFuncCount()

tools::Long ScUnoAddInCollection::GetFuncCount ( )

Definition at line 1267 of file addincol.cxx.

References bInitialized, Initialize(), and nFuncCount.

Referenced by ScCompiler::fillAddInToken(), ScCompiler::fillFromAddInCollectionEnglishName(), ScCompiler::fillFromAddInCollectionUpperName(), and ScFunctionList::ScFunctionList().

◆ GetFuncData() [1/2]

const ScUnoAddInFuncData * ScUnoAddInCollection::GetFuncData ( const OUString &  rName,
bool  bComplete = false 
)

Only if bComplete is set, the function reference and argument types are initialized (component may have to be loaded).

Parameters
rNameis the exact Name.

Definition at line 1224 of file addincol.cxx.

References bInitialized, ScUnoAddInFuncData::GetFunction(), Initialize(), LoadComponent(), and pExactHashMap.

Referenced by ScCompiler::fillAddInToken(), ScCompiler::fillFromAddInCollectionEnglishName(), ScCompiler::fillFromAddInCollectionUpperName(), GetExcelName(), ScParameterClassification::GetExternalParameterType(), ScFuncDesc::initArgumentInfo(), ScUnoAddInCall::ScUnoAddInCall(), and UpdateFromAddIn().

◆ GetFuncData() [2/2]

const ScUnoAddInFuncData * ScUnoAddInCollection::GetFuncData ( tools::Long  nIndex)

For enumeration in ScCompiler::OpCodeMap::getAvailableMappings().

Parameters
nIndex0 <= nIndex < GetFuncCount()

Definition at line 1245 of file addincol.cxx.

References bInitialized, Initialize(), nFuncCount, nIndex, and ppFuncData.

◆ Initialize()

void ScUnoAddInCollection::Initialize ( )
private

Definition at line 254 of file addincol.cxx.

References bInitialized, comphelper::getComponentContext(), comphelper::getProcessServiceFactory(), ReadConfiguration(), ReadFromAddIn(), and SAL_WARN.

Referenced by FillFunctionDesc(), FindFunction(), GetCalcName(), GetFuncCount(), GetFuncData(), and LocalizeString().

◆ LoadComponent()

void ScUnoAddInCollection::LoadComponent ( const ScUnoAddInFuncData &  rFuncData)
private

Definition at line 608 of file addincol.cxx.

References ScUnoAddInFuncData::GetOriginalName(), comphelper::getProcessServiceFactory(), nPos, SAL_WARN, and UpdateFromAddIn().

Referenced by GetFuncData().

◆ LocalizeString()

void ScUnoAddInCollection::LocalizeString ( OUString &  rName)

modify rName - input: exact name

Definition at line 1255 of file addincol.cxx.

References bInitialized, Initialize(), and pExactHashMap.

Referenced by ScCompiler::LocalizeString().

◆ ReadConfiguration()

void ScUnoAddInCollection::ReadConfiguration ( )
private

Definition at line 357 of file addincol.cxx.

References ScAddInArgDesc::aDescription, ScAddInArgDesc::aInternalName, aName, ScAddInArgDesc::aName, aServiceNames, ScAddInArgDesc::bOptional, CFG_FUNCPROP_CATEGORY, CFG_FUNCPROP_COUNT, CFG_FUNCPROP_DESCRIPTION, CFG_FUNCPROP_DISPLAYNAME, CFGPATH_ADDINS, CFGSTR_ADDINFUNCTIONS, CFGSTR_CATEGORY, CFGSTR_COMPATIBILITYNAME, CFGSTR_DESCRIPTION, CFGSTR_DISPLAYNAME, CFGSTR_PARAMETERS, ScAddInArgDesc::eType, LanguageTag::getBcp47(), ScCompiler::GetCharClassEnglish(), ScUnoAddInHelpIdGenerator::GetHelpId(), utl::ConfigItem::GetNodeNames(), ScAddInCfg::GetProperties(), ScLinkConfigItem::GetProperties(), i, ID_FUNCTION_GRP_ADDINS, lcl_GetCategory(), nFuncCount, nIndex, pData, pEnglishHashMap, pExactHashMap, pLocalHashMap, pNameHashMap, ppFuncData, SAL_WARN, SC_ADDINARG_NONE, SC_CALLERPOS_NONE, SC_MOD, and sDisplayName.

Referenced by Initialize().

◆ ReadFromAddIn()

void ScUnoAddInCollection::ReadFromAddIn ( const css::uno::Reference< css::uno::XInterface > &  xInterface)
private

Definition at line 769 of file addincol.cxx.

References ScAddInArgDesc::aDescription, ScAddInArgDesc::aInternalName, aMethods, ScAddInArgDesc::aName, ScAddInArgDesc::bOptional, ScAddInArgDesc::eType, ScUnoAddInHelpIdGenerator::GetHelpId(), getLocale(), LanguageTag::getLocale(), comphelper::getProcessComponentContext(), Application::GetSettings(), i, IsTypeName(), LANGUAGE_ENGLISH_US, lcl_GetArgType(), lcl_GetCategory(), lcl_ValidReturnType(), nFuncCount, pData, pEnglishHashMap, pExactHashMap, pLocalHashMap, pNameHashMap, ppFuncData, SAL_WARN, SAL_WARN_IF, SC_ADDINARG_CALLER, SC_ADDINARG_NONE, SC_ADDINARG_VALUE_OR_ARRAY, SC_ADDINARG_VARARGS, SC_CALLERPOS_NONE, and sName.

Referenced by Initialize().

◆ UpdateFromAddIn()

void ScUnoAddInCollection::UpdateFromAddIn ( const css::uno::Reference< css::uno::XInterface > &  xInterface,
std::u16string_view  rServiceName 
)
private

Definition at line 1062 of file addincol.cxx.

References ScAddInArgDesc::aDescription, ScAddInArgDesc::aInternalName, aMethods, ScAddInArgDesc::aName, ScAddInArgDesc::bOptional, ScAddInArgDesc::eType, GetFuncData(), getLocale(), comphelper::getProcessComponentContext(), Application::GetSettings(), ScGlobal::GetStarCalcFunctionList(), ScGlobal::HasStarCalcFunctionList(), lcl_FindArgDesc(), lcl_GetArgType(), lcl_UpdateFunctionList(), SC_ADDINARG_CALLER, SC_ADDINARG_NONE, SC_ADDINARG_VALUE_OR_ARRAY, SC_ADDINARG_VARARGS, SC_CALLERPOS_NONE, SC_MOD, ScUnoAddInFuncData::SetArguments(), ScUnoAddInFuncData::SetCallerPos(), and ScUnoAddInFuncData::SetFunction().

Referenced by LoadComponent().

Member Data Documentation

◆ bInitialized

bool ScUnoAddInCollection::bInitialized
private

Definition at line 153 of file addincol.hxx.

Referenced by Clear(), FillFunctionDesc(), FindFunction(), GetCalcName(), GetFuncCount(), GetFuncData(), Initialize(), and LocalizeString().

◆ nFuncCount

tools::Long ScUnoAddInCollection::nFuncCount
private

Definition at line 147 of file addincol.hxx.

Referenced by Clear(), FillFunctionDesc(), FindFunction(), GetCalcName(), GetFuncCount(), GetFuncData(), ReadConfiguration(), and ReadFromAddIn().

◆ pEnglishHashMap

std::unique_ptr<ScAddInHashMap> ScUnoAddInCollection::pEnglishHashMap
private

English name upper.

Definition at line 152 of file addincol.hxx.

Referenced by Clear(), FindFunction(), ReadConfiguration(), and ReadFromAddIn().

◆ pExactHashMap

std::unique_ptr<ScAddInHashMap> ScUnoAddInCollection::pExactHashMap
private

exact internal name

Definition at line 149 of file addincol.hxx.

Referenced by Clear(), GetFuncData(), LocalizeString(), ReadConfiguration(), and ReadFromAddIn().

◆ pLocalHashMap

std::unique_ptr<ScAddInHashMap> ScUnoAddInCollection::pLocalHashMap
private

localized name upper

Definition at line 151 of file addincol.hxx.

Referenced by Clear(), FindFunction(), ReadConfiguration(), and ReadFromAddIn().

◆ pNameHashMap

std::unique_ptr<ScAddInHashMap> ScUnoAddInCollection::pNameHashMap
private

internal name upper

Definition at line 150 of file addincol.hxx.

Referenced by Clear(), FindFunction(), ReadConfiguration(), and ReadFromAddIn().

◆ ppFuncData

std::unique_ptr<std::unique_ptr<ScUnoAddInFuncData>[]> ScUnoAddInCollection::ppFuncData
private

Definition at line 148 of file addincol.hxx.

Referenced by Clear(), FillFunctionDesc(), GetCalcName(), GetFuncData(), ReadConfiguration(), and ReadFromAddIn().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:31:12 for LibreOffice Module sc (master) by doxygen 1.9.3