Cache table for external reference data. More...

#include <externalrefmgr.hxx>

Collaboration diagram for ScExternalRefCache:

Classes
struct	Cell
	individual cell within cached external ref table. More...

struct	CellFormat

struct	DocItem
	Represents data cached for a single external document. More...

struct	RangeHash

struct	ReferencedStatus

struct	SingleRangeData

class	Table
	Represents a single cached table in an external document. More...

struct	TableName

Public Types
typedef ::formula::FormulaTokenRef	TokenRef

typedef std::shared_ptr< ScTokenArray >	TokenArrayRef

typedef std::shared_ptr< Table >	TableTypeRef

typedef std::unordered_map< OUString, size_t >	TableNameIndexMap

Public Member Functions
	ScExternalRefCache ()

	~ScExternalRefCache ()

const OUString *	getRealTableName (sal_uInt16 nFileId, const OUString &rTabName) const

const OUString *	getRealRangeName (sal_uInt16 nFileId, const OUString &rRangeName) const

ScExternalRefCache::TokenRef	getCellData (sal_uInt16 nFileId, const OUString &rTabName, SCCOL nCol, SCROW nRow, sal_uInt32 *pnFmtIndex)
	Get a cached cell data at specified cell location. More...

ScExternalRefCache::TokenArrayRef	getCellRangeData (sal_uInt16 nFileId, const OUString &rTabName, const ScRange &rRange)
	Get a cached cell range data. More...

ScExternalRefCache::TokenArrayRef	getRangeNameTokens (sal_uInt16 nFileId, const OUString &rName)

void	setRangeNameTokens (sal_uInt16 nFileId, const OUString &rName, TokenArrayRef pArray)

bool	isValidRangeName (sal_uInt16 nFileId, const OUString &rName) const

void	setRangeName (sal_uInt16 nFileId, const OUString &rName)

void	setCellData (sal_uInt16 nFileId, const OUString &rTabName, SCCOL nCol, SCROW nRow, TokenRef const &pToken, sal_uLong nFmtIndex)

void	setCellRangeData (sal_uInt16 nFileId, const ScRange &rRange, const ::std::vector< SingleRangeData > &rData, const TokenArrayRef &pArray)

bool	isDocInitialized (sal_uInt16 nFileId)

void	initializeDoc (sal_uInt16 nFileId, const ::std::vector< OUString > &rTabNames, const OUString &rBaseName)

OUString	getTableName (sal_uInt16 nFileId, size_t nCacheId) const

void	getAllTableNames (sal_uInt16 nFileId,::std::vector< OUString > &rTabNames) const

SCTAB	getTabSpan (sal_uInt16 nFileId, const OUString &rStartTabName, const OUString &rEndTabName) const

void	getAllNumberFormats (::std::vector< sal_uInt32 > &rNumFmts) const

bool	setCacheDocReferenced (sal_uInt16 nFileId)
	Set all tables of a document as referenced, used only during store-to-file. More...

bool	setCacheTableReferenced (sal_uInt16 nFileId, const OUString &rTabName, size_t nSheets)
	Set a table as referenced, used only during store-to-file. More...

void	setAllCacheTableReferencedStati (bool bReferenced)

bool	areAllCacheTablesReferenced () const

void	getAllCachedDataSpans (const ScDocument &rSrcDoc, sal_uInt16 nFileId, sc::ColumnSpanSet &rSet) const
	Collect all cached non-empty cell positions, inferred directly from the cached data, not the cached range metadata stored separately in the Table. More...

bool	getSrcDocTable (const ScDocument &rSrcDoc, const OUString &rTabName, SCTAB &rTab, sal_uInt16 nFileId) const

ScExternalRefCache::TableTypeRef	getCacheTable (sal_uInt16 nFileId, size_t nTabIndex) const

ScExternalRefCache::TableTypeRef	getCacheTable (sal_uInt16 nFileId, const OUString &rTabName, bool bCreateNew, size_t pnIndex, const OUString pExtUrl)

void	clearCache (sal_uInt16 nFileId)
	Clear all caches including the cache tables. More...

void	clearCacheTables (sal_uInt16 nFileId)
	Clear all caches but keep the tables. More...

const ScDocument *	getFakeDoc () const

Private Types
typedef std::unordered_map< SCCOL, Cell >	RowDataType

typedef std::unordered_map< SCROW, RowDataType >	RowsDataType

typedef std::unordered_map< OUString, TokenArrayRef >	RangeNameMap

typedef std::unordered_map< ScRange, TokenArrayRef, RangeHash >	RangeArrayMap

typedef std::unordered_map< OUString, OUString >	NamePairMap

typedef std::unordered_map< sal_uInt16, DocItem >	DocDataType

Private Member Functions
void	addCacheTableToReferenced (sal_uInt16 nFileId, size_t nIndex)

void	addCacheDocToReferenced (sal_uInt16 nFileId)

DocItem *	getDocItem (sal_uInt16 nFileId) const

Private Attributes
struct ScExternalRefCache::ReferencedStatus	maReferenced

osl::Mutex	maMtxDocs

DocDataType	maDocs

ScDocumentUniquePtr	mxFakeDoc

Detailed Description

Cache table for external reference data.

Definition at line 80 of file externalrefmgr.hxx.

Member Typedef Documentation

typedef std::unordered_map<sal_uInt16, DocItem> ScExternalRefCache::DocDataType

private

Definition at line 355 of file externalrefmgr.hxx.

typedef std::unordered_map<OUString, OUString> ScExternalRefCache::NamePairMap

private

Definition at line 324 of file externalrefmgr.hxx.

typedef std::unordered_map<ScRange, TokenArrayRef, RangeHash> ScExternalRefCache::RangeArrayMap

private

Definition at line 323 of file externalrefmgr.hxx.

typedef std::unordered_map<OUString, TokenArrayRef> ScExternalRefCache::RangeNameMap

private

Definition at line 322 of file externalrefmgr.hxx.

typedef std::unordered_map<SCCOL, Cell> ScExternalRefCache::RowDataType

private

Definition at line 110 of file externalrefmgr.hxx.

typedef std::unordered_map<SCROW, RowDataType> ScExternalRefCache::RowsDataType

private

Definition at line 111 of file externalrefmgr.hxx.

typedef std::unordered_map< OUString, size_t> ScExternalRefCache::TableNameIndexMap

Definition at line 183 of file externalrefmgr.hxx.

typedef std::shared_ptr<Table> ScExternalRefCache::TableTypeRef

Definition at line 181 of file externalrefmgr.hxx.

typedef std::shared_ptr<ScTokenArray> ScExternalRefCache::TokenArrayRef

Definition at line 84 of file externalrefmgr.hxx.

typedef ::formula::FormulaTokenRef ScExternalRefCache::TokenRef

Definition at line 83 of file externalrefmgr.hxx.

Constructor & Destructor Documentation

ScExternalRefCache::ScExternalRefCache ( )

Definition at line 460 of file externalrefmgr.cxx.

ScExternalRefCache::~ScExternalRefCache ( )

Definition at line 464 of file externalrefmgr.cxx.

Member Function Documentation

void ScExternalRefCache::addCacheDocToReferenced ( sal_uInt16 nFileId )

private

Definition at line 1218 of file externalrefmgr.cxx.

References ScExternalRefCache::ReferencedStatus::checkAllDocs(), i, ScExternalRefCache::ReferencedStatus::maDocs, and maReferenced.

Referenced by setCacheDocReferenced().

void ScExternalRefCache::addCacheTableToReferenced	(	sal_uInt16	nFileId,
		size_t	nIndex
	)

private

Definition at line 1194 of file externalrefmgr.cxx.

References ScExternalRefCache::ReferencedStatus::checkAllDocs(), i, ScExternalRefCache::ReferencedStatus::maDocs, and maReferenced.

Referenced by setCacheTableReferenced().

bool ScExternalRefCache::areAllCacheTablesReferenced ( ) const

inline

Definition at line 251 of file externalrefmgr.hxx.

References maReferenced, and ScExternalRefCache::ReferencedStatus::mbAllReferenced.

Referenced by setCacheDocReferenced(), and setCacheTableReferenced().

void ScExternalRefCache::clearCache ( sal_uInt16 nFileId )

Clear all caches including the cache tables.

Definition at line 1364 of file externalrefmgr.cxx.

References maDocs, and maMtxDocs.

Referenced by ScExternalRefManager::clearCache().

void ScExternalRefCache::clearCacheTables ( sal_uInt16 nFileId )

Clear all caches but keep the tables.

All cache tables will be empty after the call, but the tables will not be removed.

Definition at line 1370 of file externalrefmgr.cxx.

References getDocItem(), maMtxDocs, ScExternalRefCache::DocItem::maRangeArrays, ScExternalRefCache::DocItem::maRangeNames, ScExternalRefCache::DocItem::maRealRangeNameMap, and ScExternalRefCache::DocItem::maTables.

Referenced by ScExternalRefManager::refreshSrcDocument().

void ScExternalRefCache::getAllCachedDataSpans	(	const ScDocument &	rSrcDoc,
		sal_uInt16	nFileId,
		sc::ColumnSpanSet &	rSet
	)		const

Collect all cached non-empty cell positions, inferred directly from the cached data, not the cached range metadata stored separately in the Table.

Definition at line 1234 of file externalrefmgr.cxx.

References getDocItem(), ScExternalRefCache::DocItem::maTables, and sc::ColumnSpanSet::set().

Referenced by ScExternalRefManager::refreshSrcDocument().

void ScExternalRefCache::getAllNumberFormats ( ::std::vector< sal_uInt32 > & rNumFmts ) const

Definition at line 1078 of file externalrefmgr.cxx.

References maDocs, and maMtxDocs.

Referenced by ScExternalRefManager::getAllCachedNumberFormats().

void ScExternalRefCache::getAllTableNames	(	sal_uInt16	nFileId,
		::std::vector< OUString > &	rTabNames
	)		const

Definition at line 1041 of file externalrefmgr.cxx.

References getDocItem(), ScExternalRefCache::DocItem::maTableNames, and n.

Referenced by ScExternalRefManager::getAllCachedTableNames().

ScExternalRefCache::TableTypeRef ScExternalRefCache::getCacheTable	(	sal_uInt16	nFileId,
		size_t	nTabIndex
	)		const

Definition at line 1290 of file externalrefmgr.cxx.

References getDocItem(), and ScExternalRefCache::DocItem::maTables.

Referenced by ScExternalRefManager::getCacheTable(), and ScExternalRefManager::getSingleRefToken().

ScExternalRefCache::TableTypeRef ScExternalRefCache::getCacheTable	(	sal_uInt16	nFileId,
		const OUString &	rTabName,
		bool	bCreateNew,
		size_t *	pnIndex,
		const OUString *	pExtUrl
	)

Definition at line 1299 of file externalrefmgr.cxx.

References INetURLObject::GetBase(), ScGlobal::getCharClass(), getDocItem(), ScExternalRefCache::DocItem::getTableDataIndex(), ScGlobal::GetTransliteration(), ScExternalRefCache::DocItem::maSingleTableNameAlias, ScExternalRefCache::DocItem::maTableNameIndex, ScExternalRefCache::DocItem::maTableNames, ScExternalRefCache::DocItem::maTables, nIndex, and CharClass::uppercase().

ScExternalRefCache::TokenRef ScExternalRefCache::getCellData	(	sal_uInt16	nFileId,
		const OUString &	rTabName,
		SCCOL	nCol,
		SCROW	nRow,
		sal_uInt32 *	pnFmtIndex
	)

Get a cached cell data at specified cell location.

Parameters

nFileId	file ID of an external document
rTabName	sheet name
nCol
nRow

Returns: pointer to the token instance in the cache.

Definition at line 509 of file externalrefmgr.cxx.

References ScExternalRefCache::DocItem::findTableNameIndex(), maDocs, maMtxDocs, ScExternalRefCache::DocItem::maTableNameIndex, and ScExternalRefCache::DocItem::maTables.

Referenced by ScExternalRefManager::getSingleRefToken().

ScExternalRefCache::TokenArrayRef ScExternalRefCache::getCellRangeData	(	sal_uInt16	nFileId,
		const OUString &	rTabName,
		const ScRange &	rRange
	)

Get a cached cell range data.

Returns: a new token array instance. Note that the caller must manage the life cycle of the returned instance, which is guaranteed if the TokenArrayRef is properly used...

Definition at line 539 of file externalrefmgr.cxx.

References ScRange::aEnd, ScRange::aStart, ScAddress::Col(), ScExternalRefCache::DocItem::findTableNameIndex(), maDocs, o3tl::make_unsigned(), maMtxDocs, ScExternalRefCache::DocItem::maRangeArrays, ScExternalRefCache::DocItem::maTableNameIndex, ScExternalRefCache::DocItem::maTables, MAXCOL, MAXROW, ocSep, ScAddress::Row(), svDouble, svString, and ScAddress::Tab().

Referenced by ScExternalRefManager::getDoubleRefTokens().

ScExternalRefCache::DocItem * ScExternalRefCache::getDocItem ( sal_uInt16 nFileId ) const

private

Definition at line 1394 of file externalrefmgr.cxx.

References maDocs, and maMtxDocs.

Referenced by clearCacheTables(), getAllCachedDataSpans(), getAllTableNames(), getCacheTable(), getRangeNameTokens(), getSrcDocTable(), getTableName(), getTabSpan(), initializeDoc(), isDocInitialized(), isValidRangeName(), setCacheDocReferenced(), setCacheTableReferenced(), setCellData(), setCellRangeData(), setRangeName(), and setRangeNameTokens().

const ScDocument* ScExternalRefCache::getFakeDoc ( ) const

inline

Definition at line 302 of file externalrefmgr.hxx.

References mxFakeDoc.

Referenced by ScExternalRefManager::getDoubleRefTokens().

ScExternalRefCache::TokenArrayRef ScExternalRefCache::getRangeNameTokens	(	sal_uInt16	nFileId,
		const OUString &	rName
	)

Definition at line 710 of file externalrefmgr.cxx.

References ScGlobal::getCharClass(), getDocItem(), maMtxDocs, and ScExternalRefCache::DocItem::maRangeNames.

Referenced by ScExternalRefManager::getRangeNameTokens().

const OUString * ScExternalRefCache::getRealRangeName	(	sal_uInt16	nFileId,
		const OUString &	rRangeName
	)		const

Definition at line 488 of file externalrefmgr.cxx.

References ScGlobal::getCharClass(), maDocs, maMtxDocs, and ScExternalRefCache::DocItem::maRealRangeNameMap.

Referenced by ScExternalRefManager::getRealRangeName().

const OUString * ScExternalRefCache::getRealTableName	(	sal_uInt16	nFileId,
		const OUString &	rTabName
	)		const

Definition at line 466 of file externalrefmgr.cxx.

References ScExternalRefCache::DocItem::findTableNameIndex(), maDocs, maMtxDocs, ScExternalRefCache::DocItem::maTableNameIndex, and ScExternalRefCache::DocItem::maTableNames.

Referenced by ScExternalRefManager::getRealTableName().

bool ScExternalRefCache::getSrcDocTable	(	const ScDocument &	rSrcDoc,
		const OUString &	rTabName,
		SCTAB &	rTab,
		sal_uInt16	nFileId
	)		const

Definition at line 1015 of file externalrefmgr.cxx.

References getDocItem(), ScExternalRefCache::DocItem::getSingleTableNameAlternative(), and ScDocument::GetTable().

Referenced by ScExternalRefManager::getSrcDocTable().

OUString ScExternalRefCache::getTableName	(	sal_uInt16	nFileId,
		size_t	nCacheId
	)		const

Definition at line 1033 of file externalrefmgr.cxx.

References EMPTY_OUSTRING, and getDocItem().

Referenced by ScExternalRefManager::getCacheTableName(), and ScExternalRefManager::storeRangeNameTokens().

SCTAB ScExternalRefCache::getTabSpan	(	sal_uInt16	nFileId,
		const OUString &	rStartTabName,
		const OUString &	rEndTabName
	)		const

Definition at line 1054 of file externalrefmgr.cxx.

References getDocItem(), and ScExternalRefCache::DocItem::maTableNames.

Referenced by ScExternalRefManager::getCachedTabSpan().

void ScExternalRefCache::initializeDoc	(	sal_uInt16	nFileId,
		const ::std::vector< OUString > &	rTabNames,
		const OUString &	rBaseName
	)

Definition at line 917 of file externalrefmgr.cxx.

References ScGlobal::getCharClass(), getDocItem(), ScGlobal::GetTransliteration(), i, lcl_getStrictTableDataIndex(), ScExternalRefCache::DocItem::maSingleTableNameAlias, ScExternalRefCache::DocItem::maTableNameIndex, ScExternalRefCache::DocItem::maTableNames, ScExternalRefCache::DocItem::maTables, ScExternalRefCache::DocItem::mbInitFromSource, n, and nIndex.

bool ScExternalRefCache::isDocInitialized ( sal_uInt16 nFileId )

Definition at line 877 of file externalrefmgr.cxx.

References getDocItem(), and ScExternalRefCache::DocItem::mbInitFromSource.

Referenced by setCellData(), and setCellRangeData().

bool ScExternalRefCache::isValidRangeName	(	sal_uInt16	nFileId,
		const OUString &	rName
	)		const

Definition at line 741 of file externalrefmgr.cxx.

References ScGlobal::getCharClass(), getDocItem(), maMtxDocs, ScExternalRefCache::DocItem::maRangeNames, and CharClass::uppercase().

Referenced by ScExternalRefManager::isValidRangeName().

void ScExternalRefCache::setAllCacheTableReferencedStati ( bool bReferenced )

Definition at line 1145 of file externalrefmgr.cxx.

References a, i, ScExternalRefCache::ReferencedStatus::maDocs, maDocs, maMtxDocs, maReferenced, ScExternalRefCache::ReferencedStatus::DocReferenced::maTables, ScExternalRefCache::DocItem::maTables, ScExternalRefCache::ReferencedStatus::mbAllReferenced, ScExternalRefCache::ReferencedStatus::DocReferenced::mbAllTablesReferenced, and ScExternalRefCache::ReferencedStatus::reset().

Referenced by ScExternalRefManager::setAllCacheTableReferencedStati().

bool ScExternalRefCache::setCacheDocReferenced ( sal_uInt16 nFileId )

Set all tables of a document as referenced, used only during store-to-file.

Returns: <TRUE> if ALL tables of ALL documents are marked.

Definition at line 1104 of file externalrefmgr.cxx.

References addCacheDocToReferenced(), areAllCacheTablesReferenced(), getDocItem(), and ScExternalRefCache::DocItem::maTables.

Referenced by ScExternalRefManager::markUsedByLinkListeners().

bool ScExternalRefCache::setCacheTableReferenced	(	sal_uInt16	nFileId,
		const OUString &	rTabName,
		size_t	nSheets
	)

Set a table as referenced, used only during store-to-file.

Returns: <TRUE> if ALL tables of ALL documents are marked.

Definition at line 1119 of file externalrefmgr.cxx.

References addCacheTableToReferenced(), areAllCacheTablesReferenced(), getDocItem(), ScExternalRefCache::DocItem::getTableDataIndex(), i, ScExternalRefCache::DocItem::maTables, and nIndex.

Referenced by ScExternalRefManager::setCacheTableReferenced().

void ScExternalRefCache::setCellData	(	sal_uInt16	nFileId,
		const OUString &	rTabName,
		SCCOL	nCol,
		SCROW	nRow,
		TokenRef const &	pToken,
		sal_uLong	nFmtIndex
	)

Definition at line 766 of file externalrefmgr.cxx.

References ScExternalRefCache::DocItem::findTableNameIndex(), getDocItem(), isDocInitialized(), ScExternalRefCache::DocItem::maTableNameIndex, and ScExternalRefCache::DocItem::maTables.

void ScExternalRefCache::setCellRangeData	(	sal_uInt16	nFileId,
		const ScRange &	rRange,
		const ::std::vector< SingleRangeData > &	rData,
		const TokenArrayRef &	pArray
	)