ITranslator.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_TRANSLATOR_INTERFACE_H_
#define _INCLUDE_SOURCEMOD_TRANSLATOR_INTERFACE_H_

#include <IShareSys.h>

#define SMINTERFACE_TRANSLATOR_NAME             "ITranslator"
#define SMINTERFACE_TRANSLATOR_VERSION  4

#define MAX_TRANSLATE_PARAMS            32
#define CORELANG_ENGLISH                        0

namespace SourceMod
{
        #define SOURCEMOD_LANGUAGE_ENGLISH                      0

        #define SOURCEMOD_SERVER_LANGUAGE                       0

        enum TransError
        {
                Trans_Okay = 0,                                 
                Trans_BadLanguage = 1,                  
                Trans_BadPhrase = 2,                    
                Trans_BadPhraseLanguage = 3,    
                Trans_BadPhraseFile = 4,                
        };

        struct Translation
        {
                const char *szPhrase;           
                unsigned int fmt_count;         
                int *fmt_order;                         
        };

        class IPhraseFile
        {
        public:
                virtual TransError GetTranslation(
                        const char *szPhrase, 
                        unsigned int lang_id, 
                        Translation *pTrans) =0;

                virtual const char *GetFilename() =0;
        };

        class IPhraseCollection
        {
        public:
                virtual IPhraseFile *AddPhraseFile(const char *filename) =0;

                virtual unsigned int GetFileCount() =0;
                
                virtual IPhraseFile *GetFile(unsigned int file) =0;

                virtual void Destroy() =0;

                virtual TransError FindTranslation(
                        const char *key,
                        unsigned int langid,
                        Translation *pTrans) =0;

                virtual bool FormatString(
                        char *buffer,
                        size_t maxlength,
                        const char *format,
                        void **params,
                        unsigned int numparams,
                        size_t *pOutLength,
                        const char **pFailPhrase) =0;
        };

         class ITranslator : public SMInterface
        {
        public:
                virtual const char *GetInterfaceName() =0;
                virtual unsigned int GetInterfaceVersion() =0;
        public:
                virtual IPhraseCollection *CreatePhraseCollection() =0;

                virtual unsigned int GetServerLanguage() =0;

                virtual unsigned int GetClientLanguage(int client) =0;

                virtual int SetGlobalTarget(int index) =0;

                virtual int GetGlobalTarget() const =0;

                virtual bool FormatString(
                        char *buffer,
                        size_t maxlength,
                        const char *format,
                        IPhraseCollection *pPhrases,
                        void **params,
                        unsigned int numparams,
                        size_t *pOutLength,
                        const char **pFailPhrase) =0;

                virtual unsigned int GetLanguageCount() =0;

                virtual bool GetLanguageByName(const char *name, unsigned int *index) =0;

                virtual bool GetLanguageInfo(unsigned int number, const char **code, const char **name) =0;

                virtual void RebuildLanguageDatabase() =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_TRANSLATOR_INTERFACE_H_