Chris@16: //
Chris@16: //  Copyright (c) 2009-2011 Artyom Beilis (Tonkikh)
Chris@16: //
Chris@16: //  Distributed under the Boost Software License, Version 1.0. (See
Chris@16: //  accompanying file LICENSE_1_0.txt or copy at
Chris@16: //  http://www.boost.org/LICENSE_1_0.txt)
Chris@16: //
Chris@16: #ifndef BOOST_LOCALE_GENERATOR_HPP
Chris@16: #define BOOST_LOCALE_GENERATOR_HPP
Chris@16: #include <boost/locale/config.hpp>
Chris@16: #include <boost/cstdint.hpp>
Chris@16: #ifdef BOOST_MSVC
Chris@16: #  pragma warning(push)
Chris@16: #  pragma warning(disable : 4275 4251 4231 4660)
Chris@16: #endif
Chris@16: #include <string>
Chris@16: #include <locale>
Chris@16: #include <memory>
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16:     template<typename Type>
Chris@16:     class shared_ptr;
Chris@16: 
Chris@16:     ///
Chris@16:     /// \brief This is the main namespace that encloses all localization classes 
Chris@16:     ///
Chris@16:     namespace locale {
Chris@16: 
Chris@16:         class localization_backend;
Chris@16:         class localization_backend_manager;
Chris@16: 
Chris@16:         static const uint32_t nochar_facet    = 0;        ///< Unspecified character category for character independent facets
Chris@16:         static const uint32_t char_facet      = 1 << 0;   ///< 8-bit character facets
Chris@16:         static const uint32_t wchar_t_facet   = 1 << 1;   ///< wide character facets
Chris@16:         static const uint32_t char16_t_facet  = 1 << 2;   ///< C++0x char16_t facets
Chris@16:         static const uint32_t char32_t_facet  = 1 << 3;   ///< C++0x char32_t facets
Chris@16: 
Chris@16:         static const uint32_t character_first_facet = char_facet;  ///< First facet specific for character type
Chris@16:         static const uint32_t character_last_facet = char32_t_facet; ///< Last facet specific for character type
Chris@16:         static const uint32_t all_characters = 0xFFFF;     ///< Special mask -- generate all
Chris@16:         
Chris@16:         typedef uint32_t character_facet_type; ///<type that specifies the character type that locales can be generated for
Chris@16: 
Chris@16:         static const uint32_t     convert_facet   = 1 << 0;   ///< Generate conversion facets
Chris@16:         static const uint32_t     collation_facet = 1 << 1;   ///< Generate collation facets
Chris@16:         static const uint32_t     formatting_facet= 1 << 2;   ///< Generate numbers, currency, date-time formatting facets
Chris@16:         static const uint32_t     parsing_facet   = 1 << 3;   ///< Generate numbers, currency, date-time formatting facets
Chris@16:         static const uint32_t     message_facet   = 1 << 4;   ///< Generate message facets
Chris@16:         static const uint32_t     codepage_facet  = 1 << 5;   ///< Generate character set conversion facets (derived from std::codecvt)
Chris@16:         static const uint32_t     boundary_facet  = 1 << 6;   ///< Generate boundary analysis facet
Chris@16:             
Chris@16:         static const uint32_t     per_character_facet_first = convert_facet; ///< First facet specific for character
Chris@16:         static const uint32_t     per_character_facet_last = boundary_facet; ///< Last facet specific for character
Chris@16: 
Chris@16:         static const uint32_t     calendar_facet  = 1 << 16;   ///< Generate boundary analysis facet
Chris@16:         static const uint32_t     information_facet = 1 << 17;   ///< Generate general locale information facet
Chris@16: 
Chris@16:         static const uint32_t    non_character_facet_first = calendar_facet; ///< First character independent facet 
Chris@16:         static const uint32_t    non_character_facet_last = information_facet;///< Last character independent facet 
Chris@16: 
Chris@16:             
Chris@16:         static const uint32_t    all_categories  = 0xFFFFFFFFu;   ///< Generate all of them
Chris@16:         
Chris@16:         typedef uint32_t locale_category_type; ///< a type used for more fine grained generation of facets
Chris@16: 
Chris@16:         ///
Chris@16:         /// \brief the major class used for locale generation
Chris@16:         ///
Chris@16:         /// This class is used for specification of all parameters required for locale generation and
Chris@16:         /// caching. This class const member functions are thread safe if locale class implementation is thread safe.
Chris@16:         ///
Chris@16: 
Chris@16:         class BOOST_LOCALE_DECL generator {
Chris@16:         public:
Chris@16: 
Chris@16:             ///
Chris@16:             /// Create new generator using global localization_backend_manager 
Chris@16:             ///
Chris@16:             generator();
Chris@16:             ///
Chris@16:             /// Create new generator using specific localization_backend_manager 
Chris@16:             ///
Chris@16:             generator(localization_backend_manager const &);
Chris@16: 
Chris@16:             ~generator();
Chris@16: 
Chris@16:             ///
Chris@16:             /// Set types of facets that should be generated, default all
Chris@16:             ///
Chris@16:             void categories(locale_category_type cats);
Chris@16:             ///
Chris@16:             /// Get types of facets that should be generated, default all
Chris@16:             ///
Chris@16:             locale_category_type categories() const;
Chris@16:             
Chris@16:             ///
Chris@16:             /// Set the characters type for which the facets should be generated, default all supported
Chris@16:             ///
Chris@16:             void characters(character_facet_type chars);
Chris@16:             ///
Chris@16:             /// Get the characters type for which the facets should be generated, default all supported
Chris@16:             ///
Chris@16:             character_facet_type characters() const;
Chris@16: 
Chris@16:             ///
Chris@16:             /// Add a new domain of messages that would be generated. It should be set in order to enable
Chris@16:             /// messages support.
Chris@16:             ///
Chris@16:             /// Messages domain has following format: "name" or "name/encoding"
Chris@16:             /// where name is the base name of the "mo" file where the catalog is stored
Chris@16:             /// without ".mo" extension. For example for file \c /usr/share/locale/he/LC_MESSAGES/blog.mo
Chris@16:             /// it would be \c blog.
Chris@16:             ///
Chris@16:             /// You can optionally specify the encoding of the keys in the sources by adding "/encoding_name"
Chris@16:             /// For example blog/cp1255.
Chris@16:             ///
Chris@16:             /// If not defined all keys are assumed to be UTF-8 encoded.
Chris@16:             ///
Chris@16:             /// \note When you select a domain for the program using dgettext or message API, you
Chris@16:             /// do not specify the encoding part. So for example if the provided
Chris@16:             /// domain name was "blog/windows-1255" then for translation
Chris@16:             /// you should use dgettext("blog","Hello")
Chris@16:             ///
Chris@16:             ///
Chris@16:             void add_messages_domain(std::string const &domain);
Chris@16:             ///
Chris@16:             /// Set default message domain. If this member was not called, the first added messages domain is used.
Chris@16:             /// If the domain \a domain is not added yet it is added.
Chris@16:             ///
Chris@16:             void set_default_messages_domain(std::string const &domain);
Chris@16: 
Chris@16:             ///
Chris@16:             /// Remove all added domains from the list
Chris@16:             ///
Chris@16:             void clear_domains();
Chris@16: 
Chris@16:             ///
Chris@16:             /// Add a search path where dictionaries are looked in.
Chris@16:             ///
Chris@16:             /// \note
Chris@16:             ///
Chris@16:             /// - Under the Windows platform the path is treated as a path in the locale's encoding so
Chris@16:             ///   if you create locale "en_US.windows-1251" then path would be treated as cp1255,
Chris@16:             ///   and if it is en_US.UTF-8 it is treated as UTF-8. File name is always opened with 
Chris@16:             ///   a wide file name as wide file names are the native file name on Windows.
Chris@16:             ///
Chris@16:             /// - Under POSIX platforms all paths passed as-is regardless of encoding as narrow
Chris@16:             ///   encodings are the native encodings for POSIX platforms.
Chris@16:             ///   
Chris@16:             /// 
Chris@16:             void add_messages_path(std::string const &path);
Chris@16: 
Chris@16:             ///
Chris@16:             /// Remove all added paths
Chris@16:             ///
Chris@16:             void clear_paths();
Chris@16: 
Chris@16:             ///
Chris@16:             /// Remove all cached locales
Chris@16:             ///
Chris@16:             void clear_cache();
Chris@16: 
Chris@16:             ///
Chris@16:             /// Turn locale caching ON
Chris@16:             ///
Chris@16:             void locale_cache_enabled(bool on);
Chris@16: 
Chris@16:             ///
Chris@16:             /// Get locale cache option
Chris@16:             ///
Chris@16:             bool locale_cache_enabled() const;
Chris@16: 
Chris@16:             ///
Chris@16:             /// Check if by default ANSI encoding is selected or UTF-8 onces. The default is false.
Chris@16:             ///
Chris@16:             bool use_ansi_encoding() const;
Chris@16: 
Chris@16:             ///
Chris@16:             /// Select ANSI encodings as default system encoding rather then UTF-8 by default
Chris@16:             /// under Windows.
Chris@16:             ///
Chris@16:             /// The default is the most portable and most powerful encoding, UTF-8, but the user
Chris@16:             /// can select "system" one if dealing with legacy applications
Chris@16:             ///
Chris@16:             void use_ansi_encoding(bool enc);
Chris@16: 
Chris@16:             ///
Chris@16:             /// Generate a locale with id \a id
Chris@16:             ///
Chris@16:             std::locale generate(std::string const &id) const;
Chris@16:             ///
Chris@16:             /// Generate a locale with id \a id. Use \a base as a locale to which all facets are added,
Chris@16:             /// instead of std::locale::classic().
Chris@16:             ///
Chris@16:             std::locale generate(std::locale const &base,std::string const &id) const;
Chris@16:             ///
Chris@16:             /// Shortcut to generate(id)
Chris@16:             ///
Chris@16:             std::locale operator()(std::string const &id) const
Chris@16:             {
Chris@16:                 return generate(id);
Chris@16:             }
Chris@16:             
Chris@16:             ///
Chris@16:             /// Set backend specific option
Chris@16:             ///
Chris@16:             void set_option(std::string const &name,std::string const &value);
Chris@16: 
Chris@16:             ///
Chris@16:             /// Clear backend specific options
Chris@16:             ///
Chris@16:             void clear_options();
Chris@16: 
Chris@16:         private:
Chris@16: 
Chris@16:             void set_all_options(shared_ptr<localization_backend> backend,std::string const &id) const;
Chris@16: 
Chris@16:             generator(generator const &);
Chris@16:             void operator=(generator const &);
Chris@16: 
Chris@16:             struct data;
Chris@16:             std::auto_ptr<data> d;
Chris@16:         };
Chris@16: 
Chris@16:     }
Chris@16: }
Chris@16: #ifdef BOOST_MSVC
Chris@16: #pragma warning(pop)
Chris@16: #endif
Chris@16: 
Chris@16: 
Chris@16: #endif
Chris@16: // vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 
Chris@16: