wbrawner/Unciv
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Translation code cleanup - purely decorative changes (#2544)

Browse source
This commit is contained in:
SomeTroglodyte 2020-04-30 13:08:08 +02:00 committed by GitHub
parent ba2e6d26e5
commit 3808c006ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 47 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
core/src/com/unciv/models/translations/TranslationEntry.kt
View file

@ -2,12 +2,14 @@ package com.unciv.models.translations
import java.util.HashMap
/**
* One 'translatable' string
*
* @property entry: Original translatable string as defined in the game,
* including [placeholders] or {subsentences}
* @property keys: The languages
* @property values: The translations
* @see Translations
*/
class TranslationEntry(val entry: String) : HashMap<String, String>() {
// Now stored in the key of the hashmap storing the instances of this class
// /** For memory performance on .tr(), which was atrociously memory-expensive */
// val entryWithShortenedSquareBrackets =
// if (entry.contains('['))
// entry.replace(squareBraceRegex,"[]")
// else ""
}

10
core/src/com/unciv/models/translations/TranslationFileWriter.kt
View file

@ -87,11 +87,6 @@ object TranslationFileWriter {
translationsOfThisLanguage++
} else stringBuilder.appendln(" # Requires translation!")
// Testing assertion only
if (translationEntry != null && translationEntry.entry != translationKey) {
println("Assertion failure in generateTranslationFiles: translationEntry.entry != translationKey")
}
val lineToWrite = translationKey.replace("\n", "\\n") +
" = " + translationValue.replace("\n", "\\n")
stringBuilder.appendln(lineToWrite)
@ -222,6 +217,11 @@ object TranslationFileWriter {
}
private fun isFieldTranslatable(field: Field, fieldValue: Any?): Boolean {
// Exclude fields by name that contain references to items defined elsewhere
// - the definition should cause the inclusion in our translatables list, not the reference.
// This prevents duplication within the base game (e.g. Mines were duplicated by being output
// by both TerrainResources and TerrainImprovements) and duplication of base game items into
// mods. Note "uniques" is not in this list and might still generate dupes - TODO
return fieldValue != null &&
fieldValue != "" &&
field.name !in setOf (

47
core/src/com/unciv/models/translations/Translations.kt
View file

@ -5,6 +5,25 @@ import com.unciv.UncivGame
import java.util.*
import kotlin.collections.HashMap
/**
* This collection holds all translations for the game.
*
* The collection may be instantiated loading any number of languages, but normally it contains
* either one (player-selected) language or all of them for the translation file writer.
*
* Translatables have two forms: normal or containing placeholders (delimited by square brackets).
* Translation _requests_ can have a third form: containing {subsentences} - these are split into their
* components and passed individually back into the translator, therefore they need no entry in this collection
*
* @property keys: The key is a copy of the translatable string in the normal case.
* For the placeholder case, the key is modified: placeholders reduced to empty [] pairs.
* @property values: Each a [TranslationEntry] containing the original translatable and 0..n translations.
* @property percentCompleteOfLanguages: Holds the completion percentage for each language,
* read from its file "completionPercentages.properties" which is generated
* by the [TranslationFileWriter] utility.
*
* @see String.tr for more explanations (below)
*/
class Translations : LinkedHashMap<String, TranslationEntry>(){
var percentCompleteOfLanguages = HashMap<String,Int>()
@ -52,8 +71,6 @@ class Translations : LinkedHashMap<String, TranslationEntry>(){
}
for (translation in languageTranslations) {
// The key for placeholder-containing entries was unused before, let's make it useful
// What was previously stored as entryWithShortenedSquareBrackets is now the key
val hashKey = if (translation.key.contains('['))
translation.key.replace(squareBraceRegex,"[]")
else translation.key
@ -155,20 +172,22 @@ val eitherSquareBraceRegex = Regex("""\[|]""")
// Analogous as above: Expect a {} pair with any chars but } in between and capture that
val curlyBraceRegex = Regex("""\{([^}]*)}""")
/**
* This function does the actual translation work,
* using an instance of [Translations] stored in UncivGame.Current
*
* @receiver The string to be translated, can take three forms:
* plain - translated directly by hashset lookup
* placeholders - contains at least one '[' - see below
* sentences - contains at least one '{'
* - phrases between curly braces are translated individually
* @return The translated string
* defaults to the input string if no translation is available,
* but with placeholder or sentence brackets removed.
*/
fun String.tr(): String {
// Latest optimizations: cached precompiled curlyBraceRegex and converted loop-based placeholder
// lookup into hash key lookup. Test result: 50s -> 24s
// *Discarded optimizations*:
// String.indexOf(Char) looks like it might be better than String.contains(String),
// (Char test should be cheaper than string comparison, and contains delegates to indexOf anyway)
// but measurements are equal within margin of error.
// Making our get() overload do two hash lookups instead of up to five: Zero difference.
// val entry: TranslationEntry = this[text] ?: return text
// return entry[language] ?: text
// THIS IS INCREDIBLY INEFFICIENT and causes loads of memory problems!
// There might still be optimization potential here!
if (contains("[")) { // Placeholders!
/**
* I'm SURE there's an easier way to do this but I can't think of it =\