Changeset 91390 in vbox

Timestamp:

Sep 27, 2021 11:45:15 AM (3 years ago)

Author:

vboxsync

Message:

Main/NLS: TRCOMPONENT -> PTRCOMPONENT w/ some added type safety. unregisterTranslation should mostly ignore NULL. Docs. bugref:1909

Location:

trunk/src/VBox/Main

Files:

• include/VirtualBoxClientImpl.h (modified) (1 diff)
• include/VirtualBoxTranslator.h (modified) (7 diffs)
• src-all/ExtPackManagerImpl.cpp (modified) (1 diff)
• src-all/VirtualBoxTranslator.cpp (modified) (7 diffs)
• src-server/VirtualBoxImpl.cpp (modified) (1 diff)

trunk/src/VBox/Main/include/VirtualBoxClientImpl.h

@@ -106 +106 @@
 #ifdef VBOX_WITH_MAIN_NLS
         VirtualBoxTranslator *m_pVBoxTranslator;
-        TRCOMPONENT           m_pTrComponent;
+        PTRCOMPONENT          m_pTrComponent;
 #endif
     };

trunk/src/VBox/Main/include/VirtualBoxTranslator.h

@@ -27 +27 @@
 #include <VBox/com/AutoLock.h>
 
-typedef void *TRCOMPONENT;
-
 class QMTranslator;
 
@@ -35 +33 @@
 {
 public:
-
     virtual ~VirtualBoxTranslator();
 
@@ -46 +43 @@
     HRESULT loadLanguage(ComPtr<IVirtualBox> aVirtualBox);
 
+    /** Pointer to a translator component. */
+    typedef struct TranslatorComponent *PTRCOMPONENT;
+
     /**
-     * Adds path containing translation files into list of known paths.
-     * Path should include translation file prefix.
+     * Registers the translation for a component.
      *
      * @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
+     * @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,
-                                   TRCOMPONENT *aComponent);
+                                   PTRCOMPONENT *aComponent);
 
     /**
-     * Removes the path from list of known paths.
-     * Does not remove already loaded translation from string cache.
+     * Removes translations for a component.
+     *
+     * @returns VBox status code
+     * @param   aComponent      The component.  NULL is quietly (VWRN_NOT_FOUND)
+     *                          ignored .
      */
-    static int unregisterTranslation(TRCOMPONENT aComponent);
+    static int unregisterTranslation(PTRCOMPONENT aComponent);
 
     /**
@@ -74 +79 @@
      *          valid only during lifetime of the translator instance.
      */
-    static const char *translate(TRCOMPONENT aComponent,
+    static const char *translate(PTRCOMPONENT aComponent,
                                  const char *aContext,
                                  const char *aSourceText,
@@ -97 +102 @@
     uint32_t m_cInstanceRefs;
 
+    /** Translator component. */
     struct TranslatorComponent
     {
         QMTranslator *pTranslator;
-        /* Path to translation files. It includes file prefix, i.e
-         * /path/to/folder/file_prefix */
+        /** Path to translation files. It includes file prefix, i.e '/path/to/folder/file_prefix'. */
         com::Utf8Str  strPath;
 
@@ -128 +133 @@
     int i_registerTranslation(const char *aTranslationPath,
                               bool aDefault,
-                              TRCOMPONENT *aComponent);
+                              PTRCOMPONENT *aComponent);
 
-    int i_unregisterTranslation(TRCOMPONENT aComponent);
+    int i_unregisterTranslation(PTRCOMPONENT aComponent);
 
-    const char *i_translate(TRCOMPONENT aComponent,
+    const char *i_translate(PTRCOMPONENT aComponent,
                             const char *aContext,
                             const char *aSourceText,
@@ -139 +144 @@
 };
 
+/** Pointer to a translator component. */
+typedef VirtualBoxTranslator::PTRCOMPONENT PTRCOMPONENT;
+
 #endif /* !MAIN_INCLUDED_VirtualBoxTranslator_h */
 /* vi: set tabstop=4 shiftwidth=4 expandtab: */

trunk/src/VBox/Main/src-all/ExtPackManagerImpl.cpp

@@ -150 +150 @@
 #endif
 #ifdef VBOX_WITH_MAIN_NLS
-    TRCOMPONENT         pTrComponent;
+    PTRCOMPONENT        pTrComponent;
 #endif
 

trunk/src/VBox/Main/src-all/VirtualBoxTranslator.cpp

@@ -330 +330 @@
 int VirtualBoxTranslator::registerTranslation(const char *aTranslationPath,
                                               bool aDefault,
-                                              TRCOMPONENT *aComponent)
+                                              PTRCOMPONENT *aComponent)
 {
     VirtualBoxTranslator *pCurrInstance = VirtualBoxTranslator::tryInstance();
@@ -345 +345 @@
 int VirtualBoxTranslator::i_registerTranslation(const char *aTranslationPath,
                                                 bool aDefault,
-                                                TRCOMPONENT *aComponent)
+                                                PTRCOMPONENT *aComponent)
 {
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
@@ -358 +358 @@
             if (aDefault)
                 m_pDefaultComponent = pComponent;
-            *aComponent = (TRCOMPONENT)pComponent;
+            *aComponent = (PTRCOMPONENT)pComponent;
             return VINF_SUCCESS;
         }
@@ -376 +376 @@
     if (aDefault)
         m_pDefaultComponent = pComponent;
-    *aComponent = (TRCOMPONENT)pComponent;
+    *aComponent = (PTRCOMPONENT)pComponent;
     /* ignore the error during loading because path
      * could contain no translation for current language */
@@ -384 +384 @@
 
 
-int VirtualBoxTranslator::unregisterTranslation(TRCOMPONENT aComponent)
-{
-    VirtualBoxTranslator *pCurrInstance = VirtualBoxTranslator::tryInstance();
-    int rc = VERR_GENERAL_FAILURE;
-    if (pCurrInstance != NULL)
-    {
-        rc = pCurrInstance->i_unregisterTranslation(aComponent);
-        pCurrInstance->release();
-    }
+int VirtualBoxTranslator::unregisterTranslation(PTRCOMPONENT aComponent)
+{
+    int rc;
+    if (aComponent != NULL)
+    {
+        VirtualBoxTranslator *pCurrInstance = VirtualBoxTranslator::tryInstance();
+        if (pCurrInstance != NULL)
+        {
+            rc = pCurrInstance->i_unregisterTranslation(aComponent);
+            pCurrInstance->release();
+        }
+        else
+            rc = VERR_GENERAL_FAILURE;
+    }
+    else
+        rc = VWRN_NOT_FOUND;
     return rc;
 }
 
 
-int VirtualBoxTranslator::i_unregisterTranslation(TRCOMPONENT aComponent)
+int VirtualBoxTranslator::i_unregisterTranslation(PTRCOMPONENT aComponent)
 {
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
@@ -422 +429 @@
 
 
-const char *VirtualBoxTranslator::translate(TRCOMPONENT aComponent,
+const char *VirtualBoxTranslator::translate(PTRCOMPONENT aComponent,
                                             const char *aContext,
                                             const char *aSourceText,
@@ -466 +473 @@
 
 
-const char *VirtualBoxTranslator::i_translate(TRCOMPONENT aComponent,
+const char *VirtualBoxTranslator::i_translate(PTRCOMPONENT aComponent,
                                               const char *aContext,
                                               const char *aSourceText,

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -411 +411 @@
 #ifdef VBOX_WITH_MAIN_NLS
     VirtualBoxTranslator               *pVBoxTranslator;
-    TRCOMPONENT                         pTrComponent;
+    PTRCOMPONENT                        pTrComponent;
 #endif
 #if defined(RT_OS_WINDOWS) && defined(VBOXSVC_WITH_CLIENT_WATCHER)