localization_backend.hpp

//
// Copyright (c) 2009-2011 Artyom Beilis (Tonkikh)
//
// Distributed under the Boost Software License, Version 1.0.
// https://www.boost.org/LICENSE_1_0.txt
 
#ifndef BOOST_LOCALE_LOCALIZATION_BACKEND_HPP
#define BOOST_LOCALE_LOCALIZATION_BACKEND_HPP
 
#include <boost/locale/generator.hpp>
#include <boost/locale/hold_ptr.hpp>
#include <locale>
#include <memory>
#include <string>
#include <vector>
 
#ifdef BOOST_MSVC
#    pragma warning(push)
#    pragma warning(disable : 4275 4251 4231 4660)
#endif
 
namespace boost { namespace locale {
 
    class BOOST_LOCALE_DECL localization_backend {
    protected:
        localization_backend(const localization_backend&) = default;
        localization_backend& operator=(const localization_backend&) = default;
 
    public:
        localization_backend() = default;
        virtual ~localization_backend();
 
        virtual localization_backend* clone() const = 0;
 
        virtual void set_option(const std::string& name, const std::string& value) = 0;
 
        virtual void clear_options() = 0;
 
        virtual std::locale install(const std::locale& base, category_t category, char_facet_t type) = 0;
 
    }; // localization_backend
 
    class BOOST_LOCALE_DECL localization_backend_manager {
    public:
        localization_backend_manager();
        localization_backend_manager(const localization_backend_manager&);
        localization_backend_manager& operator=(const localization_backend_manager&);
        localization_backend_manager(localization_backend_manager&&) noexcept;
        localization_backend_manager& operator=(localization_backend_manager&&) noexcept;
 
        ~localization_backend_manager();
 
        std::unique_ptr<localization_backend> create() const;
 
        BOOST_DEPRECATED("This function is deprecated, use 'create()' instead")
        std::unique_ptr<localization_backend> get() const { return create(); } // LCOV_EXCL_LINE
        BOOST_DEPRECATED("This function is deprecated, use 'create()' instead")
        std::unique_ptr<localization_backend> get_unique_ptr() const { return create(); } // LCOV_EXCL_LINE
 
        void add_backend(const std::string& name, std::unique_ptr<localization_backend> backend);
 
        // clang-format off
        BOOST_DEPRECATED("This function is deprecated, use 'add_backend' instead")
        void adopt_backend(const std::string& name, localization_backend* backend) { add_backend(name, std::unique_ptr<localization_backend>(backend)); } // LCOV_EXCL_LINE
        // clang-format on
 
        void remove_all_backends();
 
        std::vector<std::string> get_all_backends() const;
 
        void select(const std::string& backend_name, category_t category = all_categories);
 
        static localization_backend_manager global(const localization_backend_manager&);
        static localization_backend_manager global();
 
    private:
        class impl;
        hold_ptr<impl> pimpl_;
    };
 
}} // namespace boost::locale
 
#ifdef BOOST_MSVC
#    pragma warning(pop)
#endif
 
#endif