1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/* $Id$ */
/** @file
* VirtualBox Translator.
*/
/*
* Copyright (C) 2005-2020 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef MAIN_INCLUDED_VirtualBoxTranslator_h
#define MAIN_INCLUDED_VirtualBoxTranslator_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cdefs.h>
#include <iprt/thread.h>
#include <VBox/com/defs.h>
#include <VBox/com/ptr.h>
#include <VBox/com/Guid.h>
#include <VBox/com/string.h>
#include <VBox/com/AutoLock.h>
#include <iprt/cpp/lock.h>
#ifdef VBOX_WITH_MAIN_NLS
#define DECLARE_TRANSLATION_CONTEXT(ctx) \
struct ctx \
{\
static const char *tr(const char *pszSource, const char *pszComment = NULL, const int iNum = -1) \
{ \
return VirtualBoxTranslator::translate(NULL, #ctx, pszSource, pszComment, iNum); \
} \
};
#else
#define DECLARE_TRANSLATION_CONTEXT(ctx) \
struct ctx \
{\
static const char *tr(const char *pszSource, const char *pszComment = NULL, const int iNum = -1) \
{ \
NOREF(pszComment); \
NOREF(iNum); \
return pszSource; \
} \
};
#endif
typedef void *TRCOMPONENT;
#ifdef VBOX_WITH_MAIN_NLS
COM_STRUCT_OR_CLASS(IVirtualBox);
class QMTranslator;
class VirtualBoxTranslator
: public util::RWLockHandle
{
public:
virtual ~VirtualBoxTranslator();
static VirtualBoxTranslator *instance();
/* Returns instance if exists, returns NULL otherwise. */
static VirtualBoxTranslator *tryInstance();
void release();
/* Load language based on settings in the VirtualBox config */
HRESULT loadLanguage(ComPtr<IVirtualBox> aVirtualBox);
/**
* Adds path containing translation files into list of known paths.
* Path should include translation file prefix.
*
* @returns VBox status code
* @param aTranslationPath Path to translation files including file prefix
* @param aDefault Use as default translation component, i.e.
* Use this path for translation if component
* is NULL
* @param aComponent Where is the pointer to component returned
*/
static int registerTranslation(const char *aTranslationPath,
bool aDefault,
TRCOMPONENT *aComponent);
/**
* Removes the path from list of known paths.
* Does not remove already loaded translation from string cache.
*/
static int unregisterTranslation(TRCOMPONENT aComponent);
/**
* Translates @a aSourceText to user language.
* Uses component marked as default if @a aTranslationComponent is NULL
*
* @returns Translated string or @a aSourceText. The returned string is
* valid only during lifetime of the translator instance.
*/
static const char *translate(TRCOMPONENT aComponent,
const char *aContext,
const char *aSourceText,
const char *aComment = NULL,
const int aNum = -1);
/**
* Returns source text stored in the cache if exists.
* Otherwise, the pszTranslation itself returned.
*/
static const char *trSource(const char *aTranslation);
/* Convenience function used by VirtualBox::init */
int i_loadLanguage(const char *pszLang);
static int32_t initCritSect();
private:
static RTCRITSECTRW s_instanceRwLock;
static VirtualBoxTranslator *s_pInstance;
uint32_t m_cInstanceRefs;
struct TranslatorComponent
{
QMTranslator *pTranslator;
/* Path to translation files. It includes file prefix, i.e
* /path/to/folder/file_prefix */
com::Utf8Str strPath;
TranslatorComponent() : pTranslator(NULL) {}
};
typedef std::list<TranslatorComponent> TranslatorList;
TranslatorList m_lTranslators;
TranslatorComponent *m_pDefaultComponent;
/* keep the language code for registration */
com::Utf8Str m_strLanguage;
/** String cache that all translation strings are stored in.
* This is a add-only cache, which allows translate() to return C-strings w/o
* needing to think about racing loadLanguage() wrt string lifetime. */
RTSTRCACHE m_hStrCache;
/** RTStrCacheCreate status code. */
int m_rcCache;
VirtualBoxTranslator();
int i_loadLanguageForComponent(TranslatorComponent *aComponent, const char *aLang);
int i_setLanguageFile(TranslatorComponent *aComponent, const char *aFileName);
int i_registerTranslation(const char *aTranslationPath,
bool aDefault,
TRCOMPONENT *aComponent);
int i_unregisterTranslation(TRCOMPONENT aComponent);
const char *i_translate(TRCOMPONENT aComponent,
const char *aContext,
const char *aSourceText,
const char *aComment = NULL,
const int aNum = -1);
};
#endif /* !VBOX_WITH_MAIN_NLS */
#endif /* !MAIN_INCLUDED_VirtualBoxTranslator_h */
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
