sc/source/core/inc/cellkeytranslator.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef SC_CELLKEY_TRANSLATOR_HXX
  21 #define SC_CELLKEY_TRANSLATOR_HXX
  22
  23 #include "global.hxx"
  24 #include "formula/opcode.hxx"
  25 #include "unotools/transliterationwrapper.hxx"
  26 #include <boost/unordered_map.hpp>
  27 #include <list>
  28 #include <memory>
  29
  30 #include <com/sun/star/lang/Locale.hpp>
  31
  32 struct TransItem;
  33
  34 struct ScCellKeyword
  35 {
  36     const sal_Char* mpName;
  37     OpCode meOpCode;
  38     const ::com::sun::star::lang::Locale& mrLocale;
  39
  40     ScCellKeyword(const sal_Char* pName, OpCode eOpCode, const ::com::sun::star::lang::Locale& rLocale);
  41 };
  42
  43 typedef ::boost::unordered_map< OUString, ::std::list<ScCellKeyword>, OUStringHash > ScCellKeywordHashMap;
  44
  45 /** Translate cell function keywords.
  46
  47     This class provides a convenient way to translate a string keyword used as
  48     a cell function argument.  Since Calc's built-in cell functions don't
  49     localize string keywords, this class is used mainly to deal with an Excel
  50     document where string names may be localized.
  51
  52     To use, simply call the
  53
  54        ScCellKeywordTranslator::transKeyword(...)
  55
  56     function.
  57
  58     Note that when the locale and/or the opcode is specified, the function
  59     tries to find a string with matching locale and/or opcode. But when it
  60     fails to find one that satisfies the specified locale and/or opcode, it
  61     returns a translated string with non-matching locale and/or opcode if
  62     available. */
  63 class ScCellKeywordTranslator
  64 {
  65 public:
  66     static void transKeyword(OUString& rName, const ::com::sun::star::lang::Locale* pLocale = NULL, OpCode eOpCode = ocNone);
  67     ~ScCellKeywordTranslator();
  68
  69 private:
  70     ScCellKeywordTranslator();
  71
  72     void init();
  73     void addToMap(const OUString& rKey, const sal_Char* pName,
  74                   const ::com::sun::star::lang::Locale& rLocale,
  75                   OpCode eOpCode = ocNone);
  76     void addToMap(const TransItem* pItems, const ::com::sun::star::lang::Locale& rLocale);
  77
  78     static ::std::auto_ptr<ScCellKeywordTranslator> spInstance;
  79     ScCellKeywordHashMap maStringNameMap;
  80     ::utl::TransliterationWrapper maTransWrapper;
  81 };
  82
  83 #endif
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */