office-gobmx/sw/inc/SwStyleNameMapper.hxx

278 lines
11 KiB
C++

/*************************************************************************
*
* $RCSfile: SwStyleNameMapper.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: mtg $ $Date: 2001-08-16 12:07:45 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): Martin Gallwey ( gallwey@sun.com )
*
*
************************************************************************/
#ifndef _SWSTYLENAMEMAPPER_HXX
#define _SWSTYLENAMEMAPPER_HXX
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
#ifndef _GETPOOLIDFROMNAMEENUM_HXX
#include <SwGetPoolIdFromName.hxx>
#endif
#ifndef _STRING_HXX
#include <tools/string.hxx>
#endif
#include <hash_map>
/* This class holds all data about the names of styles used in the user
* interface (UI names...these are localised into different languages).
* These UI names are loaded from the resource files on demand.
*
* It also holds all information about the 'Programmatic' names of styles
* which remain static (and are hardcoded in the corresponding cxx file)
* for all languages.
*
* This class also provides static functions which can be used for the
* following conversions:
*
* 1. Programmatic Name -> UI Name
* 2. Programmatic Name -> Pool ID
* 3. UI Name -> Programmatic Name
* 4. UI Name -> Pool ID
* 5. Pool ID -> UI Name
* 6. Pool ID -> Programmatic Name
*
* The relationship of these tables to the style families is as follows:
*
* 1. Paragraph contains the Text, Lists, Extra, Register, Doc and HTML
* name arrays.
* 2. Character contains the ChrFmt and HTMLChrFmt name arrays.
* 3. Page contains the PageDesc name array.
* 4. Frame contains the FrmFmt name array.
* 5. Numbering Rule contains the NumRule name array.
*/
/*
* There is a further complication that came to light later. If someone enters
* a user-defined style name which is the same as a programmatic name, this
* name clash must be handled.
*
* Therefore, when there is a danger of a nameclash, the boolean bDisambiguate
* must be set to true in the SwStyleNameMapper call (it defaults to false).
* This will cause the following to happen:
*
* If the UI style name either equals a programmatic name or already ends
* with " (user)", then it must append " (user)" to the end.
*
* When a programmatic name is being converted to a UI name, if it ends in
* " (user)", we simply remove it.
*/
class SvStringsDtor;
class String;
struct SwTableEntry;
struct StringEq
{
sal_Bool operator() ( const String *r1,
const String *r2) const
{
return r1->Equals(*r2);
}
};
struct StringHash
{
size_t operator() ( const String *rString) const
{
sal_Int32 h, nLen;
h = nLen = rString->Len();
const sal_Unicode *pStr = rString->GetBuffer();
if ( nLen < 16 )
while ( nLen-- > 0 )
h = (h*37) + *(pStr++);
else
{
sal_Int32 nSkip;
const sal_Unicode* pEndStr = pStr+nLen-5;
/* only sample some characters */
/* the first 3, some characters between, and the last 5 */
h = (h*39) + *(pStr++);
h = (h*39) + *(pStr++);
h = (h*39) + *(pStr++);
nSkip = nLen / nLen < 32 ? 4 : 8;
nLen -= 8;
while ( nLen > 0 )
{
h = (h*39) + ( *pStr );
pStr += nSkip;
nLen -= nSkip;
}
h = (h*39) + *(pEndStr++);
h = (h*39) + *(pEndStr++);
h = (h*39) + *(pEndStr++);
h = (h*39) + *(pEndStr++);
h = (h*39) + *(pEndStr++);
}
return h;
}
};
typedef ::std::hash_map < const String*, sal_uInt16, StringHash, StringEq > NameToIdHash;
class SwStyleNameMapper
{
friend void _InitCore();
friend void _FinitCore();
protected:
// UI Name tables
static SvStringsDtor *pTextUINameArray,
*pListsUINameArray,
*pExtraUINameArray,
*pRegisterUINameArray,
*pDocUINameArray,
*pHTMLUINameArray,
*pFrmFmtUINameArray,
*pChrFmtUINameArray,
*pHTMLChrFmtUINameArray,
*pPageDescUINameArray,
*pNumRuleUINameArray,
// Programmatic Name tables
*pTextProgNameArray,
*pListsProgNameArray,
*pExtraProgNameArray,
*pRegisterProgNameArray,
*pDocProgNameArray,
*pHTMLProgNameArray,
*pFrmFmtProgNameArray,
*pChrFmtProgNameArray,
*pHTMLChrFmtProgNameArray,
*pPageDescProgNameArray,
*pNumRuleProgNameArray;
static NameToIdHash *pParaUIMap,
*pCharUIMap,
*pPageUIMap,
*pFrameUIMap,
*pNumRuleUIMap,
*pParaProgMap,
*pCharProgMap,
*pPageProgMap,
*pFrameProgMap,
*pNumRuleProgMap;
static SvStringsDtor* NewUINameArray( SvStringsDtor*&,
sal_uInt16 nStt,
sal_uInt16 nEnd );
static SvStringsDtor* NewProgNameArray( SvStringsDtor*&,
const SwTableEntry *pTable,
sal_uInt8 nCount);
static void fillNameFromId ( sal_uInt16 nId, String &rName, sal_Bool bProgName );
static const String& getNameFromId ( sal_uInt16 nId, const String &rName, sal_Bool bProgName );
static const NameToIdHash& getHashTable ( SwGetPoolIdFromName, sal_Bool bProgName );
static sal_Bool SuffixIsUser ( const String & rString );
static void CheckSuffixAndDelete ( String & rString );
public:
// This gets the UI Name from the programmatic name
static const String& GetUIName ( const String& rName, SwGetPoolIdFromName );
static void FillUIName ( const String& rName, String& rFillName, SwGetPoolIdFromName, sal_Bool bDisambiguate = sal_False );
// Get the programmatic Name from the UI name
static const String& GetProgName ( const String& rName, SwGetPoolIdFromName );
static void FillProgName ( const String& rName, String& rFillName, SwGetPoolIdFromName, sal_Bool bDisambiguate = sal_False );
// This gets the UI Name from the Pool ID
static void FillUIName ( sal_uInt16 nId, String& rFillName );
static const String& GetUIName ( sal_uInt16 nId, const String& rName );
// This gets the programmatic Name from the Pool ID
static void FillProgName( sal_uInt16 nId, String& rFillName );
static const String& GetProgName ( sal_uInt16 nId, const String& rName );
// This gets the PoolId from the UI Name
static sal_uInt16 GetPoolIdFromUIName( const String& rName, SwGetPoolIdFromName );
// Get the Pool ID from the programmatic name
static sal_uInt16 GetPoolIdFromProgName( const String& rName, SwGetPoolIdFromName );
static const SvStringsDtor& GetTextUINameArray();
static const SvStringsDtor& GetListsUINameArray();
static const SvStringsDtor& GetExtraUINameArray();
static const SvStringsDtor& GetRegisterUINameArray();
static const SvStringsDtor& GetDocUINameArray();
static const SvStringsDtor& GetHTMLUINameArray();
static const SvStringsDtor& GetFrmFmtUINameArray();
static const SvStringsDtor& GetChrFmtUINameArray();
static const SvStringsDtor& GetHTMLChrFmtUINameArray();
static const SvStringsDtor& GetPageDescUINameArray();
static const SvStringsDtor& GetNumRuleUINameArray();
static const SvStringsDtor& GetTextProgNameArray();
static const SvStringsDtor& GetListsProgNameArray();
static const SvStringsDtor& GetExtraProgNameArray();
static const SvStringsDtor& GetRegisterProgNameArray();
static const SvStringsDtor& GetDocProgNameArray();
static const SvStringsDtor& GetHTMLProgNameArray();
static const SvStringsDtor& GetFrmFmtProgNameArray();
static const SvStringsDtor& GetChrFmtProgNameArray();
static const SvStringsDtor& GetHTMLChrFmtProgNameArray();
static const SvStringsDtor& GetPageDescProgNameArray();
static const SvStringsDtor& GetNumRuleProgNameArray();
};
#endif // _NAME_MAPPER_HXX