From f215e02bf85f68d3a6106c2a1f4f7f063f819064 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 11 Apr 2024 10:17:27 +0200 Subject: Adding upstream version 7.0.14-dfsg. Signed-off-by: Daniel Baumann --- src/VBox/Main/include/VirtualBoxTranslator.h | 165 +++++++++++++++++++++++++++ 1 file changed, 165 insertions(+) create mode 100644 src/VBox/Main/include/VirtualBoxTranslator.h (limited to 'src/VBox/Main/include/VirtualBoxTranslator.h') diff --git a/src/VBox/Main/include/VirtualBoxTranslator.h b/src/VBox/Main/include/VirtualBoxTranslator.h new file mode 100644 index 00000000..ef87ff4e --- /dev/null +++ b/src/VBox/Main/include/VirtualBoxTranslator.h @@ -0,0 +1,165 @@ +/* $Id: VirtualBoxTranslator.h $ */ +/** @file + * VirtualBox Translator. + */ + +/* + * Copyright (C) 2005-2023 Oracle and/or its affiliates. + * + * This file is part of VirtualBox base platform packages, as + * available from https://www.virtualbox.org. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, in version 3 of the + * License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, see . + * + * SPDX-License-Identifier: GPL-3.0-only + */ + +#ifndef MAIN_INCLUDED_VirtualBoxTranslator_h +#define MAIN_INCLUDED_VirtualBoxTranslator_h +#ifndef RT_WITHOUT_PRAGMA_ONCE +# pragma once +#endif + +#include + +#include +#include + +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() RT_NOEXCEPT; + void release(); + + /* Load language based on settings in the VirtualBox config */ + HRESULT loadLanguage(ComPtr aVirtualBox); + +private: + /** Translator component. */ + 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) {} + }; +public: + /** Pointer to a translator component. */ + typedef TranslatorComponent *PTRCOMPONENT; + + /** + * Registers the translation for a component. + * + * @returns VBox status code + * @param aTranslationPath Path to the translation files, this includes the + * base filename prefix. + * @param aDefault Use this as the default translation component, i.e. + * when translate() is called with NULL for @a + * aComponent. + * @param aComponent Pointer to where is the component handle should be + * returned on success. The return value must be used + * for all subsequent calls to translate(). + */ + static int registerTranslation(const char *aTranslationPath, + bool aDefault, + PTRCOMPONENT *aComponent); + + /** + * Removes translations for a component. + * + * @returns VBox status code + * @param aComponent The component. NULL is quietly (VWRN_NOT_FOUND) + * ignored . + */ + static int unregisterTranslation(PTRCOMPONENT 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(PTRCOMPONENT aComponent, + const char *aContext, + const char *aSourceText, + const char *aComment = NULL, + const size_t aNum = ~(size_t)0) RT_NOEXCEPT; + + /** + * Returns source text stored in the cache if exists. + * Otherwise, the pszTranslation itself returned. + */ + static const char *trSource(const char *aTranslation) RT_NOEXCEPT; + + /* Convenience function used by VirtualBox::init */ + int i_loadLanguage(const char *pszLang); + + static int32_t initCritSect(); + + com::Utf8Str language(); + +private: + static RTCRITSECTRW s_instanceRwLock; + static VirtualBoxTranslator *s_pInstance; + + uint32_t m_cInstanceRefs; + + typedef std::list 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, + PTRCOMPONENT *aComponent); + + int i_unregisterTranslation(PTRCOMPONENT aComponent); + + const char *i_translate(PTRCOMPONENT aComponent, + const char *aContext, + const char *aSourceText, + const char *aComment = NULL, + const size_t aNum = ~(size_t)0) RT_NOEXCEPT; +}; + +/** Pointer to a translator component. */ +typedef VirtualBoxTranslator::PTRCOMPONENT PTRCOMPONENT; + +#endif /* !MAIN_INCLUDED_VirtualBoxTranslator_h */ +/* vi: set tabstop=4 shiftwidth=4 expandtab: */ -- cgit v1.2.3