src/support/Messages.h

   1 // -*- C++ -*-
   2 /* \file Messages.h
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #ifndef MESSAGES_H
  12 #define MESSAGES_H
  13
  14 #include "support/docstring.h"
  15
  16 #include <map>
  17 #include <string>
  18
  19 namespace lyx {
  20
  21 ///
  22 class Messages {
  23 public:
  24         /// messages in the language \p l.
  25         /// If \p l is empty, the language will be defined by the environment.
  26         Messages(std::string const & l = std::string());
  27         ///
  28         docstring const get(std::string const & msg) const;
  29         /// What is the language associated with this translation?
  30         std::string language() const;
  31         /// Is an (at least partial) translation of language with code \p c available?
  32         static bool available(std::string const & c);
  33         ///
  34         static void init();
  35
  36 private:
  37         ///
  38         std::string lang_;
  39         /// Did we warn about unavailable locale already?
  40         mutable bool warned_;
  41         ///
  42         typedef std::map<std::string, docstring> TranslationCache;
  43         /// Internal cache for gettext translated strings.
  44         /// This is needed for performance reason within \c updateBuffer()
  45         /// under Windows.
  46         mutable TranslationCache cache_;
  47 };
  48
  49 /// Access to the unique Messages object for the passed \p language.
  50 /// Implementation is in LyX.cpp.
  51 extern Messages const & getMessages(std::string const & language);
  52 /// Access to the unique Messages object used for GUI element.
  53 /// Implementation is in LyX.cpp.
  54 extern Messages const & getGuiMessages();
  55
  56 /// Remove the context suffix from \p trans
  57 extern void cleanTranslation(docstring & trans);
  58
  59 } // namespace lyx
  60
  61 #endif