Changeset 26915

Timestamp:

Jun 2, 2022, 2:56:53 PM (2 years ago)

Author:

wraitii

Message:

Fix text alignment handling of spaces around wrapping.

Follows rP26889.

There is an issue with text-wrapping and word separators (aka spaces).
Because 0 A.D. collates the space after a word to the same TextCall, we occasionally need to ignore it when considering line-wrapping, because we don't want empty spaces on the right-side of right-aligned text.
However, the logic to handle this is currently broken and inconsistent.

The method introduced here uses the SFeedback structure to properly report it and generalises the checks.

Note that multiples spaces are not collapsed in 0 A.D., and for consistency the word-separator-collapsing behaviour is ignored.

Comments by: phosit, vlasdislavbelov

Fixes #6551

Differential Revision: ​https://code.wildfiregames.com/D4662

Location:

ps/trunk

Files:

• binaries/data/mods/_test.minimal/fonts/console.fnt (modified) (1 diff)
• source/gui/CGUIText.cpp (modified) (7 diffs)
• source/gui/SettingTypes/CGUIString.cpp (modified) (1 diff)
• source/gui/SettingTypes/CGUIString.h (modified) (2 diffs)
• source/gui/tests/test_CGUIText.h (added)

ps/trunk/binaries/data/mods/_test.minimal/fonts/console.fnt

@@ -1 @@
-100
+10
 256 256
+
 606
-20
+15
+12
 32 0 256 0 0 0 0 5
 33 250 154 3 11 1 11 4

ps/trunk/source/gui/CGUIText.cpp

@@ -80 +80 @@
                             //  in order to avoid duplicate processing.
 
-    // Go through string word by word
+    // The calculated width of each word includes the space between the current
+    // word and the next. When we're wrapping, we need subtract the width of the
+    // space after the last word on the line before the wrap.
+    CFontMetrics currentFont(font);
+    float spaceWidth = currentFont.GetCharacterWidth(L' ');
+
+    // Go through string word by word.
+    // a word is defined as [start, end[ in string.m_Words so we skip the last item.
     for (int i = 0; i < static_cast<int>(string.m_Words.size()) - 1; ++i)
     {
@@ -103 +110 @@
         prelimLineHeight = std::max(prelimLineHeight, feedback.m_Size.Height);
 
+
+
         // If width is 0, then there's no word-wrapping, disable NewLine.
-        if ((width != 0 && from != i && (lineWidth + 2 * bufferZone > width || feedback.m_NewLine)) || i == static_cast<int>(string.m_Words.size()) - 2)
+        if ((width != 0 && from != i && (lineWidth + 2 * bufferZone > width || feedback.m_NewLine)) || i == static_cast<int>(string.m_Words.size()) - 2)
         {
             if (ProcessLine(pGUI, string, font, pObject, images, align, prelimLineHeight, width, bufferZone, firstLine, y, i, from))
@@ -174 +183 @@
     CSize2D& lineSize) const
 {
+
+
+
+
+
+
+
+
     float x = widthRangeFrom;
     for (int j = tempFrom; j <= i; ++j)
@@ -188 +205 @@
         x += feedback2.m_Size.Width;
 
-        if (width != 0 && x > widthRangeTo && j != tempFrom && !feedback2.m_NewLine)
-        {
-            // The calculated width of each word includes the space between the current
-            // word and the next. When we're wrapping, we need subtract the width of the
-            // space after the last word on the line before the wrap.
-            CFontMetrics currentFont(font);
-            lineSize.Width -= currentFont.GetCharacterWidth(*L" ");
+        if (width != 0 && x - spaceCorrection > widthRangeTo && j != tempFrom && !feedback2.m_NewLine)
             break;
-        }
+
+        // Update after the line-break detection, because otherwise spaceCorrection above
+        // will refer to the wrapped word and not the last-word-before-the-line-break.
+        spaceCorrection = feedback2.m_EndsWithSpace ? spaceWidth : 0.f;
 
         // Let lineSize.cy be the maximum m_Height we encounter.
@@ -210 +224 @@
         lineSize.Width += feedback2.m_Size.Width;
     }
+
+
 }
 
@@ -365 +381 @@
         }
 
-        // Append X value.
         x += feedback2.m_Size.Width;
 
-        // The first word overrides the width limit, what we
-        //  do, in those cases, are just drawing that word even
-        //  though it'll extend the object.
         if (width != 0) // only if word-wrapping is applicable
         {
+
+
+
+
+
+
             if (feedback2.m_NewLine)
             {
@@ -393 +411 @@
                 break;
             }
-            else if (x > widthRangeTo && j == tempFrom)
+            else if (x > widthRangeTo && j == tempFrom)
             {
+
+
+
+
                 from = j+1;
-                // do not break, since we want it to be added to m_TextCalls
+                // To avoid doing redundant computations, set up j to exit the loop right away.
+                j = i + 1;
             }
-            else if (x > widthRangeTo)
+            else if (x > widthRangeTo)
             {
                 from = j;

ps/trunk/source/gui/SettingTypes/CGUIString.cpp

@@ -230 +230 @@
             if (!TextCall.m_String.empty() && TextCall.m_String[0] == '\n')
                 Feedback.m_NewLine = true;
+
+
+
+
+
+
+
+
+
+
+
 
             // Add text-chunk

ps/trunk/source/gui/SettingTypes/CGUIString.h

@@ -1 @@
-/* Copyright (C) 2021 Wildfire Games.
+/* Copyright (C) 202 Wildfire Games.
  * This file is part of 0 A.D.
  *
@@ -157 +157 @@
          */
         bool m_NewLine;
+
+
+
+
+
     };