ResourceBundle Class Reference

#include <ResourceBundle.h>

Inheritance diagram for ResourceBundle:

List of all members.

Public Member Functions
const set< string >	getKeys () const
const string &	getMessage (const string &key) const
bool	hasMessage (const string &key) const
const string &	getBaseName () const
const Locale &	getLocale () const
Static Public Member Functions
static void	setGlobalResourceFileLocation (const string &location)
static RecursiveMutex &	getMutex ()
Protected Member Functions
	ResourceBundle (const string &baseName, const Locale &locale, const string &location)
virtual	~ResourceBundle ()
void	setParent (ResourceBundle *bundle)
Private Member Functions
void	loadMessages ()
Private Attributes
const string	_baseName
const Locale	_locale
const string	_location
ResourceBundle *	_parent
map< string, string >	_messages
Static Private Attributes
static RecursiveMutex	mutex

---

Detailed Description

Definition at line 38 of file ResourceBundle.h.

---

Constructor & Destructor Documentation

ResourceBundle::ResourceBundle	(	const string &	baseName,
		const Locale &	locale,
		const string &	location
	)			[explicit, protected]

Definition at line 55 of file ResourceBundle.cpp.

References loadMessages().

    : _baseName(baseName),
      _locale(locale),
      _location(location),
      _parent(NULL)
{
    loadMessages();
}

ResourceBundle::~ResourceBundle

(

)

[protected, virtual]

Definition at line 67 of file ResourceBundle.cpp.

{
}

---

Member Function Documentation

void ResourceBundle::setParent

(

ResourceBundle *

bundle

)

[protected]

Definition at line 71 of file ResourceBundle.cpp.

References _parent.

{
    _parent = bundle;
}

const set< string > ResourceBundle::getKeys

(

)

const

Definition at line 76 of file ResourceBundle.cpp.

References _messages, _parent, and getKeys().

Referenced by getKeys().

{
    set<string> keys;

    map<string, string>::const_iterator iter = _messages.begin(),
        end = _messages.end();

    while (iter != end) {
        keys.insert((*iter).first);
        iter++;
    }

    if (_parent) {
        set<string> parentKeys = _parent->getKeys();

        keys.insert(parentKeys.begin(), parentKeys.end());
    }

    return keys;
}

const string & ResourceBundle::getMessage

(

const string &

key

)

const

Definition at line 99 of file ResourceBundle.cpp.

References _messages, _parent, and MISSING_KEY().

Referenced by ResourceDefinition::format(), and ResourceDefinition::prepareFormatter().

{
    map<string, string>::const_iterator iter;
    iter = _messages.find(key);
    if (iter == _messages.end()) {
        if (_parent) {
            return _parent->getMessage(key);
        }

        return MISSING_KEY;
    }

    return (*iter).second;
}

bool ResourceBundle::hasMessage

(

const string &

key

)

const

Definition at line 115 of file ResourceBundle.cpp.

References _messages, _parent, and hasMessage().

Referenced by ResourceDefinition::format(), hasMessage(), and ResourceDefinition::prepareFormatter().

{
    return
        _messages.find(key) != _messages.end()
        || (_parent && _parent->hasMessage(key));
}

const string & ResourceBundle::getBaseName

(

)

const

Definition at line 128 of file ResourceBundle.cpp.

References _baseName.

Referenced by ResourceDefinition::format(), and ResourceDefinition::prepareFormatter().

{
    return _baseName;
}

const Locale & ResourceBundle::getLocale

(

)

const

Definition at line 122 of file ResourceBundle.cpp.

References _locale.

Referenced by ResourceDefinition::format(), and ResourceDefinition::prepareFormatter().

{
    return _locale;
}

void ResourceBundle::setGlobalResourceFileLocation

(

const string &

location

)

[static]

Definition at line 50 of file ResourceBundle.cpp.

References globalResourceLocation().

{
    globalResourceLocation = location;
}

RecursiveMutex & ResourceBundle::getMutex

(

)

[static]

Definition at line 45 of file ResourceBundle.cpp.

References mutex.

Referenced by makeInstance().

{
    return mutex;
}

void ResourceBundle::loadMessages

(

)

[private]

Definition at line 245 of file ResourceBundle.cpp.

References _baseName, _locale, _location, _messages, convertPropertyToBoost(), Locale::getDisplayName(), and globalResourceLocation().

Referenced by ResourceBundle().

{
    fstream in;

    // e.g. GeneratedResourceBundle_en_US.resources
    string fileName;

    if (_locale == Locale("")) {
        fileName.assign(_baseName
                        + ".properties");
    } else {
        fileName.assign(_baseName
                        + "_"
                        + _locale.getDisplayName()
                        + ".properties");
    }

    // look in _location first
    bool tryGlobalLocation = true;
    if (!_location.empty()) {
        string path = _location + "/" + fileName;
        in.open(path.c_str(), ios::in);
        if (in.good()) {
            tryGlobalLocation = false;
        }
    }

    // failing that, try the gobal location, if any
    if (tryGlobalLocation) {
        bool tryEnvVar = true;

        // TODO jvs 18-Feb-2004: once Fennel starts using Boost's
        // platform-independent filesystem library, use it here too.
        if (!globalResourceLocation.empty()) {
            string path = globalResourceLocation + "/" + fileName;
            in.open(path.c_str(), ios::in);
            if (in.good()) {
                tryEnvVar = false;
            }
        }

        if (tryEnvVar) {
            const char *fennelHome = getenv("FENNEL_HOME");
            if (fennelHome == NULL) {
                return; // give up
            }

            string path = string(fennelHome) + "/common/" + fileName;
            in.open(path.c_str(), ios::in);
            if (!in.good()) {
                return; // give up
            }
        }
    }

    string line, key, message;
    while (in.good()) {
        getline(in, line);

        if (line.length() == 0 || line[0] == '#') {
            // ignore blank lines and comments
            continue;
        }

        string::size_type pos = line.find('=');
        if (pos == string::npos) {
            // bad message format?
            continue;
        }

        key = line.substr(0, pos);
        message = line.substr(pos + 1);

        _messages[key] = convertPropertyToBoost(message);
    }

    in.close();
}

---

Member Data Documentation

const string ResourceBundle::_baseName [private]

Definition at line 64 of file ResourceBundle.h.

Referenced by getBaseName(), and loadMessages().

const Locale ResourceBundle::_locale [private]

Definition at line 65 of file ResourceBundle.h.

Referenced by getLocale(), and loadMessages().

const string ResourceBundle::_location [private]

Definition at line 66 of file ResourceBundle.h.

Referenced by loadMessages().

ResourceBundle* ResourceBundle::_parent [private]

Definition at line 68 of file ResourceBundle.h.

Referenced by getKeys(), getMessage(), hasMessage(), and setParent().

map<string, string> ResourceBundle::_messages [private]

Definition at line 70 of file ResourceBundle.h.

Referenced by getKeys(), getMessage(), hasMessage(), and loadMessages().

RecursiveMutex ResourceBundle::mutex [static, private]

Definition at line 72 of file ResourceBundle.h.

Referenced by getMutex().

---

The documentation for this class was generated from the following files:

• /home/pub/open/dev/fennel/common/ResourceBundle.h
• /home/pub/open/dev/fennel/common/ResourceBundle.cpp

---