[OpenJDK 2D-Dev] RFR : 8248802: Add log helper methods to FontUtilities.java

Tue Jul 14 15:43:33 UTC 2020

Hi Matthias,

this looks good to me. I agree that one could look at refactoring regarding Suppliers and maybe also improving the isLogging checks in a subsequent change.

I found a few lines where spaces around the plus signs are missing. Maybe you can correct this formatting before pushing:

CFontManager.java L99:, CMap.java L402, SunFontManager.java L565, L628

This should probably also be pushed to the client repo.

Thanks
Christoph

From: Baesken, Matthias <matthias.baesken at sap.com>
Sent: Dienstag, 14. Juli 2020 17:22
To: Philip Race <philip.race at oracle.com>
Cc: Peter Hull <peterhull90 at gmail.com>; Jayathirth D v <JAYATHIRTH.D.V at oracle.com>; Langer, Christoph <christoph.langer at sap.com>; 2d-dev at openjdk.java.net
Subject: RE: [OpenJDK 2D-Dev] RFR : 8248802: Add log helper methods to FontUtilities.java

>BTW I suppose you believe you have found all the cases in various packages
>and platform folders and converted them ?
>Or were there some cases you intentionally left alone ?

Hi Phil,   I kept  a few  FontUtilities.getLogger -   calls because  they are a bit special or they use later when logging a second parameter :

grep -nH -r "FontUtilities.getLogger(" *

java.desktop/share/classes/sun/font/SunFontManager.java:1634:        PlatformLogger logger = FontUtilities.getLogger();
java.desktop/share/classes/sun/font/SunFontManager.java:2898:                && FontUtilities.getLogger().isLoggable(PlatformLogger.Level.INFO)) {
java.desktop/share/classes/sun/font/TrueTypeFont.java:366:                FontUtilities.getLogger().severe("While reading " + platName, e);
java.desktop/share/classes/sun/font/TrueTypeFont.java:386:                FontUtilities.getLogger().severe("While reading " + platName, e);

New webrev (that keeps the FontUtilities.isLogging()  outside the new  FontUtilities.log* functions ) :

http://cr.openjdk.java.net/~mbaesken/webrevs/8248802.1/

I also adjusted  http://cr.openjdk.java.net/~mbaesken/webrevs/8248802.1/src/java.desktop/share/classes/sun/font/FontUtilities.java.frames.html

Following Christophs advice :

>Furthermore, initialization of logging in FontUtilities looks a bit awkward. I think the if (debugFonts) in line 117 is unnecessary and the code of that block could be added to the block before (of line 107: if (debugLevel != null && >!debugLevel.equals("false"))). And you could also remove the following imports there (line 29ff):
>import java.io.BufferedReader;
>import java.io.File;
>import java.io.FileInputStream;
>import java.io.InputStreamReader;

However  enhancing PlatformLogger with Supplier stuff is out of scope of this change (maybe another one) .

Best regards, Matthias

From: Philip Race <philip.race at oracle.com<mailto:philip.race at oracle.com>>
Sent: Freitag, 10. Juli 2020 16:45
To: Baesken, Matthias <matthias.baesken at sap.com<mailto:matthias.baesken at sap.com>>
Cc: Peter Hull <peterhull90 at gmail.com<mailto:peterhull90 at gmail.com>>; Jayathirth D v <JAYATHIRTH.D.V at oracle.com<mailto:JAYATHIRTH.D.V at oracle.com>>; Langer, Christoph <christoph.langer at sap.com<mailto:christoph.langer at sap.com>>; 2d-dev at openjdk.java.net<mailto:2d-dev at openjdk.java.net>
Subject: Re: [OpenJDK 2D-Dev] RFR : 8248802: Add log helper methods to FontUtilities.java

That is a good question. I am not sure any more how we ended up with
the mixed usage but isLogging() seems appropriate to guard the call to log.

So maybe make them consistent for all cases that make sense.

If the end result of that is there is no other usage that calls debugFonts()
that might be something else to take a look if it is basically synonomous.

BTW I suppose you believe you have found all the cases in various packages
and platform folders and converted them ?
Or were there some cases you intentionally left alone ?

Not saying you missed any - just want to know what to expect when I go checking.

-phil.

On 7/10/20, 12:34 AM, Baesken, Matthias wrote:
Hi Phil, okay get  your point , thanks for clarification about  avoiding  the string concatenation if FontUtilities.isLogging()  returns false .
But I guess the  coding  guarded  by FontUtilities.debugFonts()   for example :

src/java.desktop/share/classes/sun/awt/FontConfiguration.java-85-        if (FontUtilities.debugFonts()) {
src/java.desktop/share/classes/sun/awt/FontConfiguration.java:86:            FontUtilities.getLogger()
src/java.desktop/share/classes/sun/awt/FontConfiguration.java-87-                .info("Creating standard Font Configuration");

would continue using  FontUtilities.debugFonts(),   correct ?
So this would change to :

src/java.desktop/share/classes/sun/awt/FontConfiguration.java-85-        if (FontUtilities.debugFonts()) {
src/java.desktop/share/classes/sun/awt/FontConfiguration.java:86:            FontUtilities.logInfo("Creating standard Font Configuration");

Best regards, Matthias

From: Philip Race <philip.race at oracle.com><mailto:philip.race at oracle.com>
Sent: Donnerstag, 9. Juli 2020 19:17
To: Baesken, Matthias <matthias.baesken at sap.com><mailto:matthias.baesken at sap.com>
Cc: Peter Hull <peterhull90 at gmail.com><mailto:peterhull90 at gmail.com>; Jayathirth D v <JAYATHIRTH.D.V at oracle.com><mailto:JAYATHIRTH.D.V at oracle.com>; Langer, Christoph <christoph.langer at sap.com><mailto:christoph.langer at sap.com>; 2d-dev at openjdk.java.net<mailto:2d-dev at openjdk.java.net>
Subject: Re: [OpenJDK 2D-Dev] RFR : 8248802: Add log helper methods to FontUtilities.java

There is no harm in repeating isLogging() inside logWarning() but
I don't think it is sufficient.

What we mean is that in some cases the code looks now like this :-

http://cr.openjdk.java.net/~mbaesken/webrevs/8248802.0/src/java.desktop/share/classes/sun/font/FileFontStrike.java.udiff.html<http://cr.openjdk.java.net/%7Embaesken/webrevs/8248802.0/src/java.desktop/share/classes/sun/font/FileFontStrike.java.udiff.html>

-            if (FontUtilities.isLogging()) {

-                FontUtilities.getLogger().warning(

-                        "Failed to render glyph using GDI: code=" + glyphCode

+            FontUtilities.logWarning("Failed to render glyph using GDI: code=" + glyphCode

                                 + ", fontFamily=" + family + ", style=" + style

                                 + ", size=" + size);

-            }

So all that string concatenation always happens, even if we don't log.

The code before probably wasn't 100% consistent but if updating it
then I suggest to make it 100% consistent to always check isLogging()
before calling logWarning().

I suggest to do it even in cases like this
http://cr.openjdk.java.net/~mbaesken/webrevs/8248802.0/src/java.desktop/share/classes/sun/font/CMap.java.udiff.html<http://cr.openjdk.java.net/%7Embaesken/webrevs/8248802.0/src/java.desktop/share/classes/sun/font/CMap.java.udiff.html>

+                FontUtilities.logWarning("Cmap UVS subtable overflows buffer.");

where there is no concatenation work happening, just to establish a
consistent pattern.

-phil.

On 7/9/20, 8:07 AM, Baesken, Matthias wrote:

There always should be a call such as FontUtilities.isLogging() test

protecting doing unnecessary work.

Hi,  in my patch I always  call  isLogging()  in the new methods in

http://cr.openjdk.java.net/~mbaesken/webrevs/8248802.0/src/java.desktop/share/classes/sun/font/FontUtilities.java.frames.html<http://cr.openjdk.java.net/%7Embaesken/webrevs/8248802.0/src/java.desktop/share/classes/sun/font/FontUtilities.java.frames.html>

So are you talking about other places in the coding ?

Best regards, Matthias

-----Original Message-----

From: Philip Race <philip.race at oracle.com><mailto:philip.race at oracle.com>

Sent: Donnerstag, 9. Juli 2020 17:04

To: Peter Hull <peterhull90 at gmail.com><mailto:peterhull90 at gmail.com>

Cc: Baesken, Matthias <matthias.baesken at sap.com><mailto:matthias.baesken at sap.com>; Jayathirth D v <JAYATHIRTH.D.V at oracle.com><mailto:JAYATHIRTH.D.V at oracle.com>; Langer, Christoph <christoph.langer at sap.com><mailto:christoph.langer at sap.com>; 2d-dev at openjdk.java.net<mailto:2d-dev at openjdk.java.net>

Subject: Re: [OpenJDK 2D-Dev] RFR : 8248802: Add log helper methods to FontUtilities.java

I agree.

There always should be a call such as FontUtilities.isLogging() test

protecting doing unnecessary work.

-phil.

On 7/9/20, 3:24 AM, Peter Hull wrote:

Probably not my place to comment, but, does it matter that it's doing

unnecessary work evaluating the argument to logWarning et al, in the

case where logging is not enabled? It only seems to be string

concatenation and maybe would be optimised out anyway, I don't know.

Peter

On Thu, 9 Jul 2020 at 08:32, Baesken, Matthias<matthias.baesken at sap.com><mailto:matthias.baesken at sap.com>  wrote:

Thank's  for the review !

May I get a second  review ?

Best regards, Matthias

From: Jayathirth D v<JAYATHIRTH.D.V at ORACLE.COM><mailto:JAYATHIRTH.D.V at ORACLE.COM>

Sent: Donnerstag, 9. Juli 2020 07:21

To: Baesken, Matthias<matthias.baesken at sap.com><mailto:matthias.baesken at sap.com>

Cc: 2d-dev at openjdk.java.net<mailto:2d-dev at openjdk.java.net>

Subject: Re: [OpenJDK 2D-Dev] RFR : 8248802: Add log helper methods to FontUtilities.java

Looks good to me.

Thanks,

Jay

On 06-Jul-2020, at 12:43 PM, Baesken, Matthias<matthias.baesken at sap.com><mailto:matthias.baesken at sap.com>  wrote:

Hello, please review this small change to font related logging .

We have a lot of font logging calls in java.desktop that look similar to this coding :

         if (FontUtilities.isLogging()) {

             FontUtilities.getLogger().info("Here comes my important info");

         }

This coding could be simplified by adding static log methods to FontUtilities.java

public static void logWarning(String s);

public static void logInfo(String s);

public static void logSevere(String s);

   doing the isLogging check + FontUtilities.getLogger(). ...

Bug/webrev :

https://bugs.openjdk.java.net/browse/JDK-8248802

http://cr.openjdk.java.net/~mbaesken/webrevs/8248802.0/<http://cr.openjdk.java.net/%7Embaesken/webrevs/8248802.0/>

Thanks, Matthias

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/2d-dev/attachments/20200714/9bf573ec/attachment-0001.htm>