source/modules/juce_core/text/juce_LocalisedStrings.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    The code included in this file is provided under the terms of the ISC license
  11    http://www.isc.org/downloads/software-support-policy/isc-license. Permission
  12    To use, copy, modify, and/or distribute this software for any purpose with or
  13    without fee is hereby granted provided that the above copyright notice and
  14    this permission notice appear in all copies.
  15
  16    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  17    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  18    DISCLAIMED.
  19
  20   ==============================================================================
  21 */
  22
  23 namespace juce
  24 {
  25
  26 LocalisedStrings::LocalisedStrings (const String& fileContents, bool ignoreCase)
  27 {
  28     loadFromText (fileContents, ignoreCase);
  29 }
  30
  31 LocalisedStrings::LocalisedStrings (const File& fileToLoad, bool ignoreCase)
  32 {
  33     loadFromText (fileToLoad.loadFileAsString(), ignoreCase);
  34 }
  35
  36 LocalisedStrings::LocalisedStrings (const LocalisedStrings& other)
  37     : languageName (other.languageName), countryCodes (other.countryCodes),
  38       translations (other.translations), fallback (createCopyIfNotNull (other.fallback.get()))
  39 {
  40 }
  41
  42 LocalisedStrings& LocalisedStrings::operator= (const LocalisedStrings& other)
  43 {
  44     languageName = other.languageName;
  45     countryCodes = other.countryCodes;
  46     translations = other.translations;
  47     fallback.reset (createCopyIfNotNull (other.fallback.get()));
  48     return *this;
  49 }
  50
  51 //==============================================================================
  52 String LocalisedStrings::translate (const String& text) const
  53 {
  54     if (fallback != nullptr && ! translations.containsKey (text))
  55         return fallback->translate (text);
  56
  57     return translations.getValue (text, text);
  58 }
  59
  60 String LocalisedStrings::translate (const String& text, const String& resultIfNotFound) const
  61 {
  62     if (fallback != nullptr && ! translations.containsKey (text))
  63         return fallback->translate (text, resultIfNotFound);
  64
  65     return translations.getValue (text, resultIfNotFound);
  66 }
  67
  68 namespace
  69 {
  70    #if JUCE_CHECK_MEMORY_LEAKS
  71     // By using this object to force a LocalisedStrings object to be created
  72     // before the currentMappings object, we can force the static order-of-destruction to
  73     // delete the currentMappings object first, which avoids a bogus leak warning.
  74     // (Oddly, just creating a LocalisedStrings on the stack doesn't work in gcc, it
  75     // has to be created with 'new' for this to work..)
  76     struct LeakAvoidanceTrick
  77     {
  78         LeakAvoidanceTrick()
  79         {
  80             const std::unique_ptr<LocalisedStrings> dummy (new LocalisedStrings (String(), false));
  81         }
  82     };
  83
  84     LeakAvoidanceTrick leakAvoidanceTrick;
  85    #endif
  86
  87     SpinLock currentMappingsLock;
  88     std::unique_ptr<LocalisedStrings> currentMappings;
  89
  90     static int findCloseQuote (const String& text, int startPos)
  91     {
  92         juce_wchar lastChar = 0;
  93         auto t = text.getCharPointer() + startPos;
  94
  95         for (;;)
  96         {
  97             auto c = t.getAndAdvance();
  98
  99             if (c == 0 || (c == '"' && lastChar != '\\'))
 100                 break;
 101
 102             lastChar = c;
 103             ++startPos;
 104         }
 105
 106         return startPos;
 107     }
 108
 109     static String unescapeString (const String& s)
 110     {
 111         return s.replace ("\\\"", "\"")
 112                 .replace ("\\\'", "\'")
 113                 .replace ("\\t", "\t")
 114                 .replace ("\\r", "\r")
 115                 .replace ("\\n", "\n");
 116     }
 117 }
 118
 119 void LocalisedStrings::loadFromText (const String& fileContents, bool ignoreCase)
 120 {
 121     translations.setIgnoresCase (ignoreCase);
 122
 123     StringArray lines;
 124     lines.addLines (fileContents);
 125
 126     for (auto& l : lines)
 127     {
 128         auto line = l.trim();
 129
 130         if (line.startsWithChar ('"'))
 131         {
 132             auto closeQuote = findCloseQuote (line, 1);
 133             auto originalText = unescapeString (line.substring (1, closeQuote));
 134
 135             if (originalText.isNotEmpty())
 136             {
 137                 auto openingQuote = findCloseQuote (line, closeQuote + 1);
 138                 closeQuote = findCloseQuote (line, openingQuote + 1);
 139                 auto newText = unescapeString (line.substring (openingQuote + 1, closeQuote));
 140
 141                 if (newText.isNotEmpty())
 142                     translations.set (originalText, newText);
 143             }
 144         }
 145         else if (line.startsWithIgnoreCase ("language:"))
 146         {
 147             languageName = line.substring (9).trim();
 148         }
 149         else if (line.startsWithIgnoreCase ("countries:"))
 150         {
 151             countryCodes.addTokens (line.substring (10).trim(), true);
 152             countryCodes.trim();
 153             countryCodes.removeEmptyStrings();
 154         }
 155     }
 156
 157     translations.minimiseStorageOverheads();
 158 }
 159
 160 void LocalisedStrings::addStrings (const LocalisedStrings& other)
 161 {
 162     jassert (languageName == other.languageName);
 163     jassert (countryCodes == other.countryCodes);
 164
 165     translations.addArray (other.translations);
 166 }
 167
 168 void LocalisedStrings::setFallback (LocalisedStrings* f)
 169 {
 170     fallback.reset (f);
 171 }
 172
 173 //==============================================================================
 174 void LocalisedStrings::setCurrentMappings (LocalisedStrings* newTranslations)
 175 {
 176     const SpinLock::ScopedLockType sl (currentMappingsLock);
 177     currentMappings.reset (newTranslations);
 178 }
 179
 180 LocalisedStrings* LocalisedStrings::getCurrentMappings()
 181 {
 182     return currentMappings.get();
 183 }
 184
 185 String LocalisedStrings::translateWithCurrentMappings (const String& text)  { return juce::translate (text); }
 186 String LocalisedStrings::translateWithCurrentMappings (const char* text)    { return juce::translate (text); }
 187
 188 JUCE_API String translate (const String& text)       { return juce::translate (text, text); }
 189 JUCE_API String translate (const char* text)         { return juce::translate (String (text)); }
 190 JUCE_API String translate (CharPointer_UTF8 text)    { return juce::translate (String (text)); }
 191
 192 JUCE_API String translate (const String& text, const String& resultIfNotFound)
 193 {
 194     const SpinLock::ScopedLockType sl (currentMappingsLock);
 195
 196     if (auto* mappings = LocalisedStrings::getCurrentMappings())
 197         return mappings->translate (text, resultIfNotFound);
 198
 199     return resultIfNotFound;
 200 }
 201
 202 } // namespace juce