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