xref: /trunk/main/svx/source/form/fmsrccfg.cxx (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_svx.hxx"
#include "svx/fmsrccfg.hxx"
#include <svl/filerec.hxx>
#include <com/sun/star/i18n/TransliterationModules.hpp>
#include <comphelper/processfactory.hxx>


using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::i18n;

//........................................................................
namespace svxform
{
//........................................................................

	// ====================================================================
	// = struct FmSearchParams - Parameter einer Suche
	// ====================================================================

	//---------------------------------------------------------------------
	//--- 20.08.01 18:17:34 -----------------------------------------------

	FmSearchParams::FmSearchParams()
        :nTransliterationFlags( 0 )
		,nSearchForType     ( 0 )
		,nPosition			( MATCHING_ANYWHERE )
		,nLevOther			( 2 )
		,nLevShorter		( 2 )
		,nLevLonger			( 2 )
		,bLevRelaxed		( sal_True )
        ,bAllFields			( sal_False )
        ,bUseFormatter		( sal_True )
		,bBackwards			( sal_False )
		,bWildcard			( sal_False )
		,bRegular			( sal_False )
		,bApproxSearch		( sal_False )
		,bSoundsLikeCJK		( sal_False )
	{
		nTransliterationFlags =
				TransliterationModules_ignoreSpace_ja_JP
			|	TransliterationModules_ignoreMiddleDot_ja_JP
			|	TransliterationModules_ignoreProlongedSoundMark_ja_JP
			|	TransliterationModules_ignoreSeparator_ja_JP
			|	TransliterationModules_IGNORE_CASE;
	}

	//---------------------------------------------------------------------
	//--- 21.08.01 13:31:48 -----------------------------------------------

	sal_Bool FmSearchParams::isIgnoreWidthCJK( ) const
	{
		return 0 != (nTransliterationFlags & TransliterationModules_IGNORE_WIDTH);
	}

	//---------------------------------------------------------------------
	//--- 21.08.01 13:32:03 -----------------------------------------------

	void FmSearchParams::setIgnoreWidthCJK( sal_Bool _bIgnore )
	{
		if ( _bIgnore )
			nTransliterationFlags |= TransliterationModules_IGNORE_WIDTH;
		else
			nTransliterationFlags &= ~TransliterationModules_IGNORE_WIDTH;
	}

	//---------------------------------------------------------------------
	//--- 21.08.01 13:47:52 -----------------------------------------------

	sal_Bool FmSearchParams::isCaseSensitive( ) const
	{
	    return 0 == (nTransliterationFlags & TransliterationModules_IGNORE_CASE);
	}

	//---------------------------------------------------------------------
	//--- 21.08.01 13:48:00 -----------------------------------------------

	void FmSearchParams::setCaseSensitive( sal_Bool _bCase )
	{
		if ( _bCase )
			nTransliterationFlags &= ~TransliterationModules_IGNORE_CASE;
		else
			nTransliterationFlags |= TransliterationModules_IGNORE_CASE;
	}

	// ====================================================================
	// = maps from ascii values to int values
	// ====================================================================

	struct Ascii2Int16
	{
		const sal_Char*	pAscii;
		sal_Int16		nValue;
	};

	//---------------------------------------------------------------------
	//--- 20.08.01 18:28:38 -----------------------------------------------

	static const Ascii2Int16* lcl_getSearchForTypeValueMap()
	{
		static const Ascii2Int16 s_aSearchForTypeMap[] =
		{
			{ "text",		0 },
			{ "null",		1 },
			{ "non-null",	2 },
			{ NULL,			-1 }
		};
		return s_aSearchForTypeMap;
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:28:38 -----------------------------------------------

	static const Ascii2Int16* lcl_getSearchPositionValueMap()
	{
		static const Ascii2Int16 s_aSearchPositionMap[] =
		{
			{ "anywhere-in-field",		MATCHING_ANYWHERE },
			{ "beginning-of-field",		MATCHING_BEGINNING },
			{ "end-of-field",			MATCHING_END },
			{ "complete-field",			MATCHING_WHOLETEXT },
			{ NULL,						-1 }
		};
		return s_aSearchPositionMap;
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:30:15 -----------------------------------------------

	static sal_Int16 lcl_implMapAsciiValue( const ::rtl::OUString& _rAsciiValue, const Ascii2Int16* _pMap )
	{
		// search the map for the given ascii value
		const Ascii2Int16* pSearch = _pMap;
		while ( pSearch && pSearch->pAscii )
		{
			if ( 0 == _rAsciiValue.compareToAscii( pSearch->pAscii ) )
				// found
				return pSearch->nValue;
			++pSearch;
		}

		DBG_ERROR(
			(	::rtl::OString( "lcl_implMapAsciiValue: could not convert the ascii value " )
			+=	::rtl::OString( _rAsciiValue.getStr(), _rAsciiValue.getLength(), RTL_TEXTENCODING_ASCII_US )
			+=	::rtl::OString( " !" )
			).getStr()
		);
		return -1;
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:33:06 -----------------------------------------------

	static const sal_Char* lcl_implMapIntValue( const sal_Int16 _nValue, const Ascii2Int16* _pMap )
	{
		// search the map for the given integer value
		const Ascii2Int16* pSearch = _pMap;
		while ( pSearch && pSearch->pAscii )
		{
			if ( _nValue == pSearch->nValue )
				// found
				return pSearch->pAscii;
			++pSearch;
		}

		DBG_ERROR(
			(	::rtl::OString( "lcl_implMapIntValue: could not convert the integer value " )
			+=	::rtl::OString::valueOf( (sal_Int32)_nValue )
			+=	::rtl::OString( " !" )
			).getStr()
		);
		static const sal_Char* s_pDummy = "";
			// just as a fallback ....
		return s_pDummy;
	}

	// ====================================================================
	// = class FmSearchConfigItem - ein ConfigItem, dass sich Suchparameter merkt
	// ====================================================================

#define TA( c )		&c, getCppuType( &c )

	//---------------------------------------------------------------------
	//--- 20.08.01 18:19:59 -----------------------------------------------

	FmSearchConfigItem::FmSearchConfigItem()
		:OConfigurationValueContainer( ::comphelper::getProcessServiceFactory(), m_aMutex, "/org.openoffice.Office.DataAccess/FormSearchOptions", CVC_UPDATE_ACCESS | CVC_LAZY_UPDATE, 2 )
	{
		// register our members so the data exchange with the node values is done automatically

		registerExchangeLocation( "SearchHistory",						TA( aHistory ) );
		registerExchangeLocation( "LevenshteinOther",					TA( nLevOther ) );
		registerExchangeLocation( "LevenshteinShorter",					TA( nLevShorter ) );
		registerExchangeLocation( "LevenshteinLonger",					TA( nLevLonger ) );
		registerExchangeLocation( "IsLevenshteinRelaxed",				TA( bLevRelaxed ) );
		registerExchangeLocation( "IsSearchAllFields",					TA( bAllFields ) );
		registerExchangeLocation( "IsUseFormatter",						TA( bUseFormatter ) );
		registerExchangeLocation( "IsBackwards",						TA( bBackwards ) );
		registerExchangeLocation( "IsWildcardSearch",					TA( bWildcard ) );
		registerExchangeLocation( "IsUseRegularExpression",				TA( bRegular ) );
		registerExchangeLocation( "IsSimilaritySearch",					TA( bApproxSearch ) );
		registerExchangeLocation( "IsUseAsianOptions",					TA( bSoundsLikeCJK ) );

		// the properties which need to be translated
		registerExchangeLocation( "SearchType",							TA( m_sSearchForType ) );
		registerExchangeLocation( "SearchPosition",						TA( m_sSearchPosition ) );

		registerExchangeLocation( "IsMatchCase",						TA( m_bIsMatchCase ) );
		registerExchangeLocation( "Japanese/IsMatchFullHalfWidthForms",	TA( m_bIsMatchFullHalfWidthForms ) );
		registerExchangeLocation( "Japanese/IsMatchHiraganaKatakana",	TA( m_bIsMatchHiraganaKatakana ) );
		registerExchangeLocation( "Japanese/IsMatchContractions",		TA( m_bIsMatchContractions ) );
		registerExchangeLocation( "Japanese/IsMatchMinusDashCho-on",	TA( m_bIsMatchMinusDashCho_on ) );
		registerExchangeLocation( "Japanese/IsMatchRepeatCharMarks",	TA( m_bIsMatchRepeatCharMarks ) );
		registerExchangeLocation( "Japanese/IsMatchVariantFormKanji",	TA( m_bIsMatchVariantFormKanji ) );
		registerExchangeLocation( "Japanese/IsMatchOldKanaForms",		TA( m_bIsMatchOldKanaForms ) );
		registerExchangeLocation( "Japanese/IsMatch_DiZi_DuZu",			TA( m_bIsMatch_DiZi_DuZu ) );
		registerExchangeLocation( "Japanese/IsMatch_BaVa_HaFa",			TA( m_bIsMatch_BaVa_HaFa ) );
		registerExchangeLocation( "Japanese/IsMatch_TsiThiChi_DhiZi",	TA( m_bIsMatch_TsiThiChi_DhiZi ) );
		registerExchangeLocation( "Japanese/IsMatch_HyuIyu_ByuVyu",		TA( m_bIsMatch_HyuIyu_ByuVyu ) );
		registerExchangeLocation( "Japanese/IsMatch_SeShe_ZeJe",		TA( m_bIsMatch_SeShe_ZeJe ) );
		registerExchangeLocation( "Japanese/IsMatch_IaIya",				TA( m_bIsMatch_IaIya ) );
		registerExchangeLocation( "Japanese/IsMatch_KiKu",				TA( m_bIsMatch_KiKu ) );
		registerExchangeLocation( "Japanese/IsIgnorePunctuation",		TA( m_bIsIgnorePunctuation ) );
		registerExchangeLocation( "Japanese/IsIgnoreWhitespace",		TA( m_bIsIgnoreWhitespace ) );
		registerExchangeLocation( "Japanese/IsIgnoreProlongedSoundMark",TA( m_bIsIgnoreProlongedSoundMark ) );
		registerExchangeLocation( "Japanese/IsIgnoreMiddleDot",			TA( m_bIsIgnoreMiddleDot ) );

		read( );
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:19:57 -----------------------------------------------

	FmSearchConfigItem::~FmSearchConfigItem()
	{
		commit( );
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:20:48 -----------------------------------------------

	void FmSearchConfigItem::implTranslateFromConfig( )
	{
		// the search-for string
		nSearchForType = lcl_implMapAsciiValue( m_sSearchForType, lcl_getSearchForTypeValueMap() );

		// the search position
		nPosition = lcl_implMapAsciiValue( m_sSearchPosition, lcl_getSearchPositionValueMap() );

		// the transliteration flags
		nTransliterationFlags = 0;

		if ( !m_bIsMatchCase				)	nTransliterationFlags |= TransliterationModules_IGNORE_CASE;
		if ( m_bIsMatchFullHalfWidthForms	)	nTransliterationFlags |= TransliterationModules_IGNORE_WIDTH;
		if ( m_bIsMatchHiraganaKatakana		)	nTransliterationFlags |= TransliterationModules_IGNORE_KANA;
		if ( m_bIsMatchContractions			)	nTransliterationFlags |= TransliterationModules_ignoreSize_ja_JP;
		if ( m_bIsMatchMinusDashCho_on		)	nTransliterationFlags |= TransliterationModules_ignoreMinusSign_ja_JP;
		if ( m_bIsMatchRepeatCharMarks		)	nTransliterationFlags |= TransliterationModules_ignoreIterationMark_ja_JP;
		if ( m_bIsMatchVariantFormKanji		)	nTransliterationFlags |= TransliterationModules_ignoreTraditionalKanji_ja_JP;
		if ( m_bIsMatchOldKanaForms			)	nTransliterationFlags |= TransliterationModules_ignoreTraditionalKana_ja_JP;
		if ( m_bIsMatch_DiZi_DuZu			)	nTransliterationFlags |= TransliterationModules_ignoreZiZu_ja_JP;
		if ( m_bIsMatch_BaVa_HaFa			)	nTransliterationFlags |= TransliterationModules_ignoreBaFa_ja_JP;
		if ( m_bIsMatch_TsiThiChi_DhiZi		)	nTransliterationFlags |= TransliterationModules_ignoreTiJi_ja_JP;
		if ( m_bIsMatch_HyuIyu_ByuVyu		)	nTransliterationFlags |= TransliterationModules_ignoreHyuByu_ja_JP;
		if ( m_bIsMatch_SeShe_ZeJe			)	nTransliterationFlags |= TransliterationModules_ignoreSeZe_ja_JP;
		if ( m_bIsMatch_IaIya				)	nTransliterationFlags |= TransliterationModules_ignoreIandEfollowedByYa_ja_JP;
		if ( m_bIsMatch_KiKu				)	nTransliterationFlags |= TransliterationModules_ignoreKiKuFollowedBySa_ja_JP;

		if ( m_bIsIgnorePunctuation			)	nTransliterationFlags |= TransliterationModules_ignoreSeparator_ja_JP;
		if ( m_bIsIgnoreWhitespace			)	nTransliterationFlags |= TransliterationModules_ignoreSpace_ja_JP;
		if ( m_bIsIgnoreProlongedSoundMark	)	nTransliterationFlags |= TransliterationModules_ignoreProlongedSoundMark_ja_JP;
		if ( m_bIsIgnoreMiddleDot			)	nTransliterationFlags |= TransliterationModules_ignoreMiddleDot_ja_JP;
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:42:23 -----------------------------------------------

	void FmSearchConfigItem::implTranslateToConfig( )
	{
		// the search-for string
		m_sSearchForType = ::rtl::OUString::createFromAscii( lcl_implMapIntValue( nSearchForType, lcl_getSearchForTypeValueMap() ) );

		// the search position
		m_sSearchPosition = ::rtl::OUString::createFromAscii( lcl_implMapIntValue( nPosition, lcl_getSearchPositionValueMap() ) );

		// the transliteration flags

		m_bIsMatchCase					= ( 0 == ( nTransliterationFlags & TransliterationModules_IGNORE_CASE ) );
		m_bIsMatchFullHalfWidthForms	= ( 0 != ( nTransliterationFlags & TransliterationModules_IGNORE_WIDTH ) );
		m_bIsMatchHiraganaKatakana		= ( 0 != ( nTransliterationFlags & TransliterationModules_IGNORE_KANA ) );
		m_bIsMatchContractions			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreSize_ja_JP ) );
		m_bIsMatchMinusDashCho_on		= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreMinusSign_ja_JP ) );
		m_bIsMatchRepeatCharMarks		= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreIterationMark_ja_JP ) );
		m_bIsMatchVariantFormKanji		= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreTraditionalKanji_ja_JP ) );
		m_bIsMatchOldKanaForms			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreTraditionalKana_ja_JP ) );
		m_bIsMatch_DiZi_DuZu			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreZiZu_ja_JP ) );
		m_bIsMatch_BaVa_HaFa			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreBaFa_ja_JP ) );
		m_bIsMatch_TsiThiChi_DhiZi		= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreTiJi_ja_JP ) );
		m_bIsMatch_HyuIyu_ByuVyu		= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreHyuByu_ja_JP ) );
		m_bIsMatch_SeShe_ZeJe			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreSeZe_ja_JP ) );
		m_bIsMatch_IaIya				= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreIandEfollowedByYa_ja_JP ) );
		m_bIsMatch_KiKu					= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreKiKuFollowedBySa_ja_JP ) );

		m_bIsIgnorePunctuation			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreSeparator_ja_JP ) );
		m_bIsIgnoreWhitespace			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreSpace_ja_JP ) );
		m_bIsIgnoreProlongedSoundMark	= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreProlongedSoundMark_ja_JP ) );
		m_bIsIgnoreMiddleDot			= ( 0 != ( nTransliterationFlags & TransliterationModules_ignoreMiddleDot_ja_JP ) );
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:20:01 -----------------------------------------------

	const FmSearchParams& FmSearchConfigItem::getParams() const
	{
		// ensure that the properties which are not stored directly are up-to-date
		const_cast< FmSearchConfigItem* >( this )->implTranslateFromConfig( );

		// and return our FmSearchParams part
		return *this;
	}

	//---------------------------------------------------------------------
	//--- 20.08.01 18:41:57 -----------------------------------------------

	void FmSearchConfigItem::setParams( const FmSearchParams& _rParams )
	{
		// copy the FmSearchParams part
		*static_cast< FmSearchParams* >( this ) = _rParams;

		// translate the settings not represented by a direct config value
		implTranslateToConfig();
	}

//........................................................................
}	// namespace svxform
//........................................................................