core/Translator.h
author Scott Ehlert <ds@alliedmods.net>
Fri Jun 22 15:37:12 2007 +0000 (2007-06-22)
changeset 1001 8de56a71f200
parent 732 13f3a417a340
child 1105 ce907ba50921
permissions -rw-r--r--
Implemented amb423 - Added IsClientObserver() native
dvander@591
     1
/**
ds@653
     2
 * vim: set ts=4 :
dvander@591
     3
 * ===============================================================
dvander@591
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@591
     5
 * ===============================================================
dvander@591
     6
 *
dvander@591
     7
 * This file is not open source and may not be copied without explicit
dvander@591
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@591
     9
 * in whole or significant part.
dvander@591
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@591
    11
 *
dvander@591
    12
 * Version: $Id$
dvander@591
    13
 */
dvander@591
    14
dvander@591
    15
#ifndef _INCLUDE_SOURCEMOD_TRANSLATOR_H_
dvander@591
    16
#define _INCLUDE_SOURCEMOD_TRANSLATOR_H_
dvander@591
    17
dvander@591
    18
#include "sm_trie.h"
dvander@591
    19
#include <sh_string.h>
dvander@591
    20
#include <sh_vector.h>
dvander@591
    21
#include "sm_globals.h"
dvander@591
    22
#include "sm_memtable.h"
dvander@591
    23
#include "ITextParsers.h"
dvander@591
    24
dvander@591
    25
#define MAX_TRANSLATE_PARAMS		32
dvander@732
    26
#define CORELANG_ENGLISH			0
dvander@591
    27
dvander@591
    28
/* :TODO: write a templatized version of tries? */
dvander@591
    29
dvander@591
    30
using namespace SourceHook;
dvander@616
    31
class Translator;
dvander@591
    32
dvander@591
    33
enum PhraseParseState
dvander@591
    34
{
dvander@591
    35
	PPS_None = 0,
dvander@591
    36
	PPS_Phrases,
dvander@591
    37
	PPS_InPhrase,
dvander@591
    38
};
dvander@591
    39
dvander@591
    40
struct Language
dvander@591
    41
{
dvander@591
    42
	char m_code2[3];
dvander@591
    43
	int m_FullName;
dvander@591
    44
};
dvander@591
    45
dvander@591
    46
struct Translation
dvander@591
    47
{
dvander@591
    48
	const char *szPhrase;		/**< Translated phrase. */
dvander@591
    49
	unsigned int fmt_count;		/**< Number of format parameters. */
dvander@591
    50
	int *fmt_order;				/**< Format phrase order. */
dvander@591
    51
};
dvander@591
    52
dvander@663
    53
#define LANGUAGE_ENGLISH			0
dvander@663
    54
dvander@591
    55
enum TransError
dvander@591
    56
{
dvander@591
    57
	Trans_Okay = 0,
dvander@591
    58
	Trans_BadLanguage = 1,
dvander@591
    59
	Trans_BadPhrase = 2,
dvander@591
    60
	Trans_BadPhraseLanguage = 3,
dvander@591
    61
	Trans_BadPhraseFile = 4,
dvander@591
    62
};
dvander@591
    63
dvander@591
    64
class CPhraseFile : public ITextListener_SMC
dvander@591
    65
{
dvander@591
    66
public:
dvander@616
    67
	CPhraseFile(Translator *pTranslator, const char *file);
dvander@591
    68
	~CPhraseFile();
dvander@591
    69
public:
dvander@591
    70
	void ReparseFile();
dvander@591
    71
	const char *GetFilename();
dvander@591
    72
	TransError GetTranslation(const char *szPhrase, unsigned int lang_id, Translation *pTrans);
dvander@591
    73
public: //ITextListener_SMC
dvander@591
    74
	void ReadSMC_ParseStart();
dvander@591
    75
	void ReadSMC_ParseEnd(bool halted, bool failed);
dvander@591
    76
	SMCParseResult ReadSMC_NewSection(const char *name, bool opt_quotes);
dvander@591
    77
	SMCParseResult ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes);
dvander@591
    78
	SMCParseResult ReadSMC_LeavingSection();
dvander@591
    79
	SMCParseResult ReadSMC_RawLine(const char *line, unsigned int curline);
dvander@591
    80
private:
dvander@591
    81
	void ParseError(const char *message, ...);
dvander@591
    82
	void ParseWarning(const char *message, ...);
dvander@591
    83
private:
dvander@591
    84
	Trie *m_pPhraseLookup;
dvander@591
    85
	String m_File;
dvander@616
    86
	Translator *m_pTranslator;
dvander@591
    87
	PhraseParseState m_ParseState;
dvander@591
    88
	int m_CurPhrase;
dvander@591
    89
	BaseMemTable *m_pMemory;
dvander@591
    90
	BaseStringTable *m_pStringTab;
dvander@591
    91
	unsigned int m_LangCount;
dvander@591
    92
	String m_ParseError;
dvander@591
    93
	String m_LastPhraseString;
dvander@591
    94
	unsigned int m_CurLine;
dvander@591
    95
	bool m_FileLogged;
dvander@591
    96
};
dvander@591
    97
dvander@616
    98
class Translator : 
dvander@591
    99
	public ITextListener_SMC,
dvander@591
   100
	public SMGlobalClass
dvander@591
   101
{
dvander@591
   102
public:
dvander@616
   103
	Translator();
dvander@616
   104
	~Translator();
ds@661
   105
public: // SMGlobalClass
dvander@663
   106
	ConfigResult OnSourceModConfigChanged(const char *key, 
dvander@663
   107
		const char *value, 
dvander@663
   108
		ConfigSource source, 
dvander@663
   109
		char *error, 
dvander@663
   110
		size_t maxlength);
dvander@591
   111
	void OnSourceModAllInitialized();
dvander@673
   112
	void OnSourceModLevelChange(const char *mapName);
ds@661
   113
public: // ITextListener_SMC
dvander@591
   114
	void ReadSMC_ParseStart();
dvander@591
   115
	SMCParseResult ReadSMC_NewSection(const char *name, bool opt_quotes);
dvander@591
   116
	SMCParseResult ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes);
dvander@591
   117
	SMCParseResult ReadSMC_LeavingSection();
dvander@591
   118
public:
dvander@591
   119
	void RebuildLanguageDatabase(const char *lang_header_file);
dvander@591
   120
	unsigned int FindOrAddPhraseFile(const char *phrase_file);
dvander@591
   121
	BaseStringTable *GetStringTable();
dvander@591
   122
	unsigned int GetLanguageCount();
dvander@591
   123
	bool GetLanguageByCode(const char *code, unsigned int *index);
dvander@591
   124
	size_t Translate(char *buffer, size_t maxlength, void **params, const Translation *pTrans);
dvander@591
   125
	CPhraseFile *GetFileByIndex(unsigned int index);
dvander@591
   126
	TransError CoreTrans(int client, 
dvander@591
   127
						 char *buffer, 
dvander@591
   128
						 size_t maxlength, 
dvander@591
   129
						 const char *phrase, 
dvander@591
   130
						 void **params, 
dvander@591
   131
						 size_t *outlen=NULL);
ds@669
   132
	unsigned int GetServerLanguage();
dvander@591
   133
private:
dvander@591
   134
	bool AddLanguage(const char *langcode, const char *description);
dvander@591
   135
private:
dvander@591
   136
	CVector<Language *> m_Languages;
dvander@591
   137
	CVector<CPhraseFile *> m_Files;
dvander@591
   138
	BaseStringTable *m_pStringTab;
dvander@591
   139
	Trie *m_pLCodeLookup;
dvander@591
   140
	bool m_InLanguageSection;
dvander@591
   141
	String m_CustomError;
ds@669
   142
	unsigned int m_ServerLang;
ds@669
   143
	char m_InitialLang[3];
dvander@591
   144
};
dvander@591
   145
dvander@591
   146
extern CPhraseFile *g_pCorePhrases;
dvander@616
   147
extern Translator g_Translator;
dvander@591
   148
dvander@591
   149
#endif //_INCLUDE_SOURCEMOD_TRANSLATOR_H_