Ticket #126: libview_fix_1_of_1_rev_0970def93a4c_Issue__126__Removing_hack__correctly_calculating_masDisplayBuffer_and_having_fallback_maxDisplayBuffer_is_set_to_107_characters_.patch

Depth16Image.st

@@ -204 +204 @@
     "return the number of bytes in one scanline of the image"
 
     ^ width * 2.
+!
+
+isDepth16Image
+    "return true if the image is instance of Depth16Image"
+   (self bitsPerPixel == 16) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 16:59:55 / svestkap"
 ! !
 
 !Depth16Image class methodsFor:'documentation'!
@@ -214 +222 @@
 
 version_CVS
     ^ '$Header$'
+!
+
+version_HG
+
+    ^ '$Changeset: <not expanded> $'
 ! !
 

Depth1Image.st

@@ -683 +683 @@
     ^ super colorFromValue:pixelValue.
 !
 
+isDepth1Image
+    "return true if the image is instance of Depth1Image"
+   (self bitsPerPixel == 1) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:02:34 / svestkap"
+!
+
 rgbFromValue:pixelValue
     "given a pixel value, return the corresponding 24bit rgbValue (rrggbb, red is MSB).
      Pixel values start with 0."

Depth24Image.st

@@ -1 @@
-"{ Encoding: utf8 }"
-
 "
  COPYRIGHT (c) 1993 by Claus Gittinger
               All Rights Reserved
@@ -3352 +3350 @@
     ^ -8
 !
 
+isDepth24Image
+    "return true if the image is instance of Depth24Image"
+   (self bitsPerPixel == 24) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 16:53:00 / svestkap"
+!
+
 redBitsOf:pixel
     "given a pixel-value, return the red component as byteValue (0..255)"
 

Depth2Image.st

@@ -968 +968 @@
     ^ super colorFromValue:colorValue.
 !
 
+isDepth2Image
+    "return true if the image is instance of Depth2Image"
+   (self bitsPerPixel == 2) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:02:16 / svestkap"
+!
+
 usedColors
     "return a collection of colors used in the receiver.
      For depth2 images, we return the colorMap here, assuming all

Depth32Image.st

@@ -1078 +1078 @@
     ^ true
 !
 
+isDepth32Image
+    "return true if the image is instance of Depth32Image"
+   (self bitsPerPixel == 32) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:00:39 / svestkap"
+!
+
 redBitsOf:pixel
     "given a pixel-value, return the red component as byteValue (0..255)"
 

Depth48Image.st

@@ -134 +134 @@
     "return the number of bytes in one scanline of the image"
 
     ^ width * 6.
+!
+
+isDepth48Image
+    "return true if the image is instance of Depth48Image"
+   (self bitsPerPixel == 48) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:02:03 / svestkap"
 ! !
 
 !Depth48Image class methodsFor:'documentation'!
 
 version
     ^ '$Header$'
+!
+
+version_HG
+
+    ^ '$Changeset: <not expanded> $'
 ! !
 

Depth4Image.st

@@ -1024 +1024 @@
     ^ super colorFromValue:pixelValue
 !
 
+isDepth4Image
+    "return true if the image is instance of Depth4Image"
+   (self bitsPerPixel == 4) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:01:45 / svestkap"
+!
+
 usedValues
     "return a collection of color values used in the receiver."
 

Depth64Image.st

@@ -140 +140 @@
 
 hasAlphaChannel
     ^ true
+!
+
+isDepth64Image
+    "return true if the image is instance of Depth64Image"
+   (self bitsPerPixel == 64) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:01:31 / svestkap"
 ! !
 
 !Depth64Image class methodsFor:'documentation'!

Depth8Image.st

@@ -1 @@
-"{ Encoding: utf8 }"
-
 "
  COPYRIGHT (c) 1993 by Claus Gittinger
               All Rights Reserved
@@ -2586 +2584 @@
     ^ super colorFromValue:pixelValue
 !
 
+isDepth8Image
+    "return true if the image is instance of Depth8Image"
+   (self bitsPerPixel == 8) ifTrue:[^ true].  
+    ^ false
+
+    "Created: / 16-04-2018 / 17:01:10 / svestkap"
+!
+
 nColorsUsed
     ^ colorMap size
 !

WinWorkstation.st

@@ -10777 +10777 @@
     SIZE size;
     TEXTMETRICW tmet;
     short maxDisplayBuffer;
-    int i1, i2, n, l, getMetricsResult, maxWidth, toDisplay;
+    int i1, i2, n, l;
+    int maxWidth, toDisplay;
     int nInstBytes;
 
     if (__isExternalAddress(aGCId)
@@ -10814 +10815 @@
             }
         }
 
-  /* Windows (as in 7 or newer) limits the string size for TextOut* changes 
-  according to the font size!  There is apparently an undocumented limit to 
-  the overall raster size.  The maximum value for the raster size is 16384. */
-
-
-  // GetTextMetricsW gives all needed font metrics
-  // If for any reason it does not work there is a fallback
+  /* The Windows (as in 7 or newer) limits the string size for TextOut*.  There is apparently 
+   * an undocumented limit to the overall raster size.  It changes according to the font size (width)!
+   * The maximum value for the raster size is apparently 16384 (experimentally tested on Windows 7).
+   */
+
+
+  /* GetTextMetricsW gives all needed font metrics (has a fallback when fails)
+   * - a maxWidth parameter takes in account the worst case scenario - user prints 
+   * with the widest possible characters from the selected font.
+   * - a overHang is a parameter which allows the font to grow outside the maxWidth size
+   */
+
   if (GetTextMetricsW(hDC, &tmet)) {
       maxWidth = tmet.tmMaxCharWidth;
+      // Dynamically calculate the maximum buffer size for the selected font and its size
+      maxDisplayBuffer = 16384 / (maxWidth + tmet.tmOverhang);
   } else {
-      static char *s = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzコーヒーアイスクリームケーキビールすしかき";
-      static int len;
-
-      if (len == 0) {
-          len = strlen(s);
-      }
-      assert(GetTextExtentPoint32(hDC, s, len, &size) != 0 && "GetTextExtentPoint32 != 0, fix me");
-      maxWidth = size.cx / (len / 2) + 1;
+      /* A fallback when GetTextMetricsW fails.  Should not normally happen!
+       * The works case scenario, experimentally tested from 1170 fonts, is Microsoft Uighur-build-italic-288
+       * with maxWidth = 2179.  That would mean only 7 characters at the maxDisplayBuffer (16384 / 2179).
+       * Such a buffer would be rediculously slow!. A compromise is needed (speed vs. functionality)
+       * Taking an avgWidth from all 1170 with fonts size 96pt -> avgWidth = 152,
+       * which should suffice 99.9% of time. The buffer would then be int(16384/152) = 107, which is reasonable.
+       */
+      maxDisplayBuffer = 107;
   }
 
-  // Calculate the maximum buffer size for the selected font size
-  maxDisplayBuffer = 16384 / (maxWidth + tmet.tmOverhang);
-  
-  // Debug messages
-  // PRINTF(("MaxDisplayBuffer:%d\n", maxDisplayBuffer));
-  //PRINTF(("MaxWidth:%d; overHang:%d\n", maxWidth, tmet.tmOverhang));
-
 #if 0
         /* leftover code from tries to make TextOut honor the gc-mode,
          * until I googled, that TextOut does not (by purpose, or backward-bug compatibility)

new file tests/FontTests.st

@@ +1 @@
+"{ Encoding: utf8 }"
+
+"{ Package: 'stx:libview/tests' }"
+
+"{ NameSpace: Smalltalk }"
+
+TestCase subclass:#FontTests
+        instanceVariableNames:'testFontSize fontList testString startTimer topView textView'
+        classVariableNames:''
+        poolDictionaries:''
+        category:'TestCases'
+!
+
+!FontTests class methodsFor:'documentation'!
+
+documentation
+"
+    documentation to be added.
+
+    [author:]
+        svestkap
+
+    [instance variables:]
+
+    [class variables:]
+
+    [see also:]
+
+"
+! !
+
+!FontTests methodsFor:'initialize / release'!
+
+setUp
+
+    | numberOfTestedFonts windowWidthX windowHightY |
+    self skipIf: Screen current isNil description: 'No display connection'.
+    
+    "/init
+    startTimer := Time now. 
+    numberOfTestedFonts := 100.
+    
+    "/random font size to circumvent ascanding or descending font size bugs
+    testFontSize := #(6 12 24 48 96 288) shuffled.
+    
+    "/pick random fonts available at system
+    fontList := (Display listOfAvailableFonts) shuffled.
+    fontList := ((fontList size) > numberOfTestedFonts) ifTrue: [fontList copyFrom:1 to: numberOfTestedFonts]. 
+
+    "/Japanese characters for UTF-16 testing
+    testString := Unicode16String new.
+    testString := 'コーヒーアイスクリームケーキビールすしかき空'.
+
+    "/creating a long string to be displayed at textView
+    10 timesRepeat:[testString := testString,testString].  
+
+    "/set testing window size -> large for large font testing (will probably fail for smaller)
+    windowWidthX := 640.
+    windowHightY := 400.
+
+    topView := StandardSystemView new.
+    topView extent:windowWidthX @ windowHightY.
+    topView label:'TextOut Raster testing with different font sizes and large strings'.
+    textView := EditTextView origin:0.0 @ 0.0 extent:1.0 @ 1.0 in:topView.
+    "/if styles are present, make sure we have correct setup
+    textView backgroundColor: Color white; 
+             foregroundColor: Color black.
+
+    topView open.
+    topView waitUntilVisible.
+
+    "Modified: / 25-04-2018 / 14:35:23 / svestkap"
+!
+
+tearDown
+    "common cleanup - invoked after testing."
+    | endTimer message |
+    endTimer := Time now.
+    
+    "/left here for user overview when run manually
+    "/Transcript showCR: 'FontTests time duration: '; showCR:(endTimer - startTimer) asString.
+    
+    message := 'FontTests time duration: ', (endTimer - startTimer) asString.
+    Logger log: message severity: #info.
+    
+    topView isOpen ifTrue:[ topView close ].
+
+    "Modified (format): / 25-04-2018 / 12:05:24 / svestkap"
+! !
+
+!FontTests methodsFor:'tests'!
+
+test_issue_126_TextOut_raster_size_24bit 
+    " Testing long strings display.  
+      The test takes shown textView and tries to find out non-white pixels.
+  
+    For more visit: https://swing.fit.cvut.cz/projects/stx-jv/ticket/126"
+    | imageSnapshot |
+  
+    self skipIf: (DeviceWorkstation current isWindowsPlatform not) description: 'Not a Windows platform'. 
+    self skipIf: Screen current depth ~~ 24 description: 'Different than 24bit resulution'. 
+
+    fontList do:[:font | 
+        testFontSize do:[:preselectedFontSize |   | setFontSize fontAtSize bits |
+               [   textView contents: testString.
+                   (font size = 0.0) ifTrue:[setFontSize := preselectedFontSize]  "/TrueType font
+                                     ifFalse:[setFontSize := font size].          "/Raster font
+                   fontAtSize := (font copy asSize:setFontSize) onDevice:textView device.
+                   textView font:fontAtSize.
+
+                   imageSnapshot := Image fromView:textView grab:false.
+                   self assert:(imageSnapshot photometric == #rgb).
+                   self assert:(imageSnapshot isDepth24Image).
+
+                   bits := imageSnapshot bits.
+                   self assert:(bits contains:[:bit | bit ~~ 255 ]).
+               ] ensure:[textView contents:nil].
+        ]
+    ].
+
+    "
+     FontTests run: #test_issue_126_TextOut_raster_size_24bit  
+     FontTests debug: #test_issue_126_TextOut_raster_size_24bit  
+    "
+
+    "Created: / 05-04-2018 / 12:16:57 / svestkap"
+    "Modified: / 25-04-2018 / 14:37:12 / svestkap"
+! !
+
+!FontTests class methodsFor:'documentation'!
+
+version_HG
+
+    ^ '$Changeset: <not expanded> $'
+! !
+

tests/stx_libview_tests.st

@@ -75 +75 @@
     ^ #(
         "<className> or (<className> attributes...) in load order"
         FcPatternTests
+        FontTests
         FormTests
         ImageTests
         ResourcePackTests