CATStringTable.h

Go to the documentation of this file.

/// \file CATStringTable.h
/// \brief String table for internationalization
/// \ingroup CAT
///
/// Copyright (c) 2007-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-12 11:38:12 -0600 (Sat, 12 Jan 2008) $
// $Revision:   $
// $NoKeywords: $

#ifndef _CATStringTable_H_
#define _CATStringTable_H_

#include "CATInternal.h"

enum CATLangId
{
    CATLANG_EN
};

/// \class CATStringTable
/// \brief Base class for string tables for internationalization
/// \ingroup CAT
///
/// Right now this is just a place holder, really.
///
/// We need to move the result declarations and associated strings
/// to a seperate process where they are autogenerated.  In the meantime, though,
/// having at least this much abstractions will allow us to do the conversion to
/// an external string table later much more easily.
///
/// Note on usage: GetString() should be safe to call across threads by itself.
/// HOWEVER, it would not be safe while another thread was mucking with the 
/// AddSubTable() / RemoveSubTable() functions.  My suggestion would be to 
/// load up the string tables in main() prior to starting threads.
///
/// Failing that, the add/remove procedures will need to be synchronized
/// against GetString(). This is not currently done.
///
class CATStringTable
{
    public:
                                CATStringTable   ();
        virtual                 ~CATStringTable  ();

        CATResult               AddSubTable     ( CATStringTable*  childTable );
        CATResult               RemoveSubTable  ( CATStringTable*  childTable );
        virtual const CATWChar* GetString       ( CATResult        stringId,
                                                  CATLangId        langId = CATLANG_EN) const;
    protected:
        std::vector<CATStringTable*>              fSubTables;
};

#endif // _CATStringTable_H_

---