UTResource.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_RESOURCE_H_
#define _UT_RESOURCE_H_


//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTVersionInfo.h"
#include "UTLists.h"
#include "UTString.h"
#include "UTMutex.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class Buffer_t;
class ResourcePlatformInfo_t;
class ModuleLocaleStrings_t;
class ModuleLocales_t;
class InputStream_t;


//==================================================================================================
class UT_EXPORT Resource_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                            Resource_t(stringliteral* library_name = NULL);

                            ~Resource_t();

    inline const String_t&  ModuleName() const;

    int                     Load( int resource_id, out byte* contents, int max_size ) const;

    void                    Load( int resource_id, out Buffer_t* contents ) const;

    void                    LoadText( int resource_id, out String_t* string ) const;

    void        SetLocale( stringliteral* locale, bool global );

    void        GetLocalizedString( int string_id, out String_t* string ) const;

    bool        IsSystemDefaultLocaleSupported(bool support_language_only = true) const;

    int         CountSupportedLocales() const;

    void        GetSupportedLocale( int index, out String_t* string ) const;

    // \cond DOXYGEN_DOCUMENT_NEVER
    static void InitSystemDefaultLocale();
                    // Called once at startup by the UT library to set up the system default locale.
    static void TerminateResourceSupport();
                    // Called once at exit by the UT library to tear down resource support.
    static bool IsValidLocale(stringliteral* locale);
    // \endcond

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    void                FindBestLocale(stringliteral* locale);
    static void         PlatformGetVersionInfo( stringliteral* module,
                                                out InternalVersionInfo_t* version_info );
    ModuleLocales_t*    AddModuleLocales();

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    String_t                                                m_module_name;
    mutable ResourcePlatformInfo_t*                         m_platform_info;
    mutable ModuleLocaleStrings_t*                          m_current_locale;

    static bool                                             ms_resource_system_initialized;
    static int32                                            ms_num_resource_objects;

    static Mutex_t                                          ms_resource_mutex;
    static String_t                                         ms_system_default_locale;
    static String_t                                         ms_global_locale;
    static OwnedBTree_t< ModuleLocales_t, stringliteral* >  ms_module_locales;

    friend class ResourcePlatformInfo_t;
    friend class VersionInfo_t;
    friend class ModuleLocales_t;
    friend class ModuleLocaleStrings_t;
    friend class ModuleResources_t;
};


// \cond DOXYGEN_DOCUMENT_NEVER


//==================================================================================================
class ModuleLocales_t
//==================================================================================================
: public BTreeNode_t< ModuleLocales_t, stringliteral* >
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                            ModuleLocales_t( const String_t& module_name, Resource_t* load_from );
    ModuleLocaleStrings_t*  FindBestLocale( stringliteral* locale,
                                            const String_t& global_locale,
                                            const String_t& system_default_locale,
                                            Resource_t* load_from );

    inline int              Compare(stringliteral* other) const;
    inline                  operator stringliteral*() const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    String_t                            m_module_name;
    OwnedList_t<ModuleLocaleStrings_t>  m_locales;
    int                                 m_num_strings_per_locale;

    friend class Resource_t;
};


//==================================================================================================
class ModuleLocaleStrings_t
//==================================================================================================
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline                  ModuleLocaleStrings_t( const utf8* name, int resource_id );
    inline                  ~ModuleLocaleStrings_t();

    inline String_t*        AllocateStrings(int num_strings);

    inline const String_t&  Name() const;
    inline int              ResourceID() const;
    inline bool             IsPopulated() const;
    void                    Populate( const Resource_t* load_from, int num_strings );

    inline void             GetString( int string_id, out String_t* string ) const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    String_t                m_name;
    int                     m_resource_id;
    volatile bool           m_is_populated;
    String_t*               m_strings;
    int                     m_num_strings;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline const String_t&
Resource_t::ModuleName() const
{
    return m_module_name;
}


inline int
ModuleLocales_t::Compare(stringliteral* other) const
{
    return m_module_name.Compare(other);
}


inline
ModuleLocales_t::operator stringliteral*() const
{
    return m_module_name.ConstChars();
}


inline
ModuleLocaleStrings_t::ModuleLocaleStrings_t( const utf8* name, int resource_id )
{
    m_name = name;
    m_resource_id = resource_id;
    m_is_populated = false;
    m_strings = NULL;
    m_num_strings = 0;
}


inline
ModuleLocaleStrings_t::~ModuleLocaleStrings_t()
{
    if(m_strings)
        delete[] m_strings;
}


inline String_t*
ModuleLocaleStrings_t::AllocateStrings(int num_strings)
{
    rel_assert(m_num_strings == 0 && !m_strings);
    m_num_strings = num_strings;
    m_strings = new String_t[num_strings];
    return m_strings;
}


inline const String_t&
ModuleLocaleStrings_t::Name() const
{
    return m_name;
}


inline int
ModuleLocaleStrings_t::ResourceID() const
{
    return m_resource_id;
}


inline bool
ModuleLocaleStrings_t::IsPopulated() const
{
    return m_is_populated;
};


inline void
ModuleLocaleStrings_t::GetString( int string_id, out String_t* string ) const
{
    rel_assert(string_id < m_num_strings);
    string->Set(m_strings[string_id]);
}


// \endcond


#endif // _UT_RESOURCE_H_