| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef _SWSTYLENAMEMAPPER_HXX |
| #define _SWSTYLENAMEMAPPER_HXX |
| |
| #include <sal/types.h> |
| #include <tools/string.hxx> |
| #include <SwGetPoolIdFromName.hxx> |
| #include "swdllapi.h" |
| |
| #ifndef INCLUDED_HASH_MAP |
| #include <hash_map> |
| #define INCLUDED_HASH_MAP |
| #endif |
| #include <stringhash.hxx> |
| |
| /* 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; |
| |
| |
| 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 |
| SW_DLLPUBLIC static void FillUIName ( sal_uInt16 nId, String& rFillName ); |
| SW_DLLPUBLIC 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 ); |
| SW_DLLPUBLIC static const String& GetProgName ( sal_uInt16 nId, const String& rName ); |
| |
| // This gets the PoolId from the UI Name |
| SW_DLLPUBLIC static sal_uInt16 GetPoolIdFromUIName( const String& rName, SwGetPoolIdFromName ); |
| |
| // Get the Pool ID from the programmatic name |
| static sal_uInt16 GetPoolIdFromProgName( const String& rName, SwGetPoolIdFromName ); |
| |
| // used to convert the 4 special ExtraProg/UINames for |
| // RES_POOLCOLL_LABEL_DRAWING, RES_POOLCOLL_LABEL_ABB, |
| // RES_POOLCOLL_LABEL_TABLE, RES_POOLCOLL_LABEL_FRAME |
| // forth and back. |
| // Non-matching names remain unchanged. |
| SW_DLLPUBLIC static const String GetSpecialExtraProgName( const String& rExtraUIName ); |
| static const String GetSpecialExtraUIName( const String& rExtraProgName ); |
| |
| 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 |