sc/source/core/inc/cellkeytranslator.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: cellkeytranslator.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_CELLKEY_TRANSLATOR_HXX
  32 #define SC_CELLKEY_TRANSLATOR_HXX
  33
  34 #include "global.hxx"
  35 #include "formula/opcode.hxx"
  36 #include "unotools/transliterationwrapper.hxx"
  37 #include <hash_map>
  38 #include <list>
  39 #include <memory>
  40
  41 #include <com/sun/star/lang/Locale.hpp>
  42
  43 struct TransItem;
  44
  45 struct ScCellKeyword
  46 {
  47     const sal_Char* mpName;
  48     OpCode meOpCode;
  49     const ::com::sun::star::lang::Locale& mrLocale;
  50
  51     ScCellKeyword(const sal_Char* pName, OpCode eOpCode, const ::com::sun::star::lang::Locale& rLocale);
  52 };
  53
  54 typedef ::std::hash_map< String, ::std::list<ScCellKeyword>, ScStringHashCode, ::std::equal_to<String> > ScCellKeywordHashMap;
  55
  56 /** Translate cell function keywords.
  57
  58     This class provides a convenient way to translate a string keyword used as
  59     a cell function argument.  Since Calc's built-in cell functions don't
  60     localize string keywords, this class is used mainly to deal with an Excel
  61     document where string names may be localized.
  62
  63     To use, simply call the
  64
  65        ScCellKeywordTranslator::transKeyword(...)
  66
  67     function.
  68
  69     Note that when the locale and/or the opcode is specified, the function
  70     tries to find a string with matching locale and/or opcode. But when it
  71     fails to find one that satisfies the specified locale and/or opcode, it
  72     returns a translated string with non-matching locale and/or opcode if
  73     available. */
  74 class ScCellKeywordTranslator
  75 {
  76 public:
  77     static void transKeyword(String& rName, const ::com::sun::star::lang::Locale* pLocale = NULL, OpCode eOpCode = ocNone);
  78     ~ScCellKeywordTranslator();
  79
  80 private:
  81     ScCellKeywordTranslator();
  82
  83     void init();
  84     void addToMap(const String& rKey, const sal_Char* pName,
  85                   const ::com::sun::star::lang::Locale& rLocale,
  86                   OpCode eOpCode = ocNone);
  87     void addToMap(const TransItem* pItems, const ::com::sun::star::lang::Locale& rLocale);
  88
  89     static ::std::auto_ptr<ScCellKeywordTranslator> spInstance;
  90     ScCellKeywordHashMap maStringNameMap;
  91     ::utl::TransliterationWrapper maTransWrapper;
  92 };
  93
  94 #endif