com.alee.utils.DebugUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.utils;

import com.alee.extended.inspector.ComponentHighlighter;
import com.alee.managers.style.BoundsType;

import javax.swing.*;
import java.awt.*;
import java.lang.management.ManagementFactory;
import java.lang.management.ThreadInfo;
import java.lang.management.ThreadMXBean;
import java.text.DecimalFormat;
import java.text.NumberFormat;

/**
 * This class provides a set of utilities for various code and graphics debug cases.
 *
 * @author Mikle Garin
 */
public final class DebugUtils
{
    /**
     * Global debug information output mark.
     */
    private static boolean GLOBAL_DEBUG_ENABLED = false;

    /**
     * Debug {@link Font}.
     */
    public static final Font DEBUG_FONT = new Font ( "Dialog", Font.BOLD, 8 );

    /**
     * Debug {@link NumberFormat}
     */
    public static final NumberFormat DEBUG_FORMAT = new DecimalFormat ( "#0.00" );

    /**
     * Private constructor to avoid instantiation.
     */
    private DebugUtils ()
    {
        throw new UtilityException ( "Utility classes are not meant to be instantiated" );
    }

    /**
     * Returns whether or not global debug information output is enabled.
     *
     * @return {@code true} if global debug information output is enabled, {@code false} otherwise
     */
    public static boolean isGlobalDebugEnabled ()
    {
        return GLOBAL_DEBUG_ENABLED;
    }

    /**
     * Sets whether or not global debug information output is enabled.
     *
     * @param enabled whether or not global debug information output is enabled
     */
    public static void setGlobalDebugEnabled ( final boolean enabled )
    {
        DebugUtils.GLOBAL_DEBUG_ENABLED = enabled;
    }

    /**
     * Returns deadlocked threads stack trace.
     *
     * @return deadlocked threads stack trace
     */
    public static String getDeadlockStackTrace ()
    {
        final ThreadMXBean bean = ManagementFactory.getThreadMXBean ();
        final long[] threadIds = bean.findDeadlockedThreads ();
        final StringBuilder stackTrace = new StringBuilder ();
        if ( threadIds != null )
        {
            final ThreadInfo[] infos = bean.getThreadInfo ( threadIds );
            for ( final ThreadInfo info : infos )
            {
                final StackTraceElement[] stack = info.getStackTrace ();
                stackTrace.append ( ExceptionUtils.getStackTrace ( stack ) );
                stackTrace.append ( info != infos[ infos.length - 1 ] ? "\n" : "" );
            }
        }
        return stackTrace.toString ();
    }

    /**
     * Initializes time debugging.
     * Call this when you want to start measuring painting time.
     */
    public static void initTimeDebugInfo ()
    {
        if ( isGlobalDebugEnabled () )
        {
            TimeUtils.pinNanoTime ();
        }
    }

    /**
     * Paints time debug information.
     * Call this when you want to paint time debug information.
     *
     * @param g graphics
     */
    public static void paintTimeDebugInfo ( final Graphics g )
    {
        if ( isGlobalDebugEnabled () )
        {
            paintDebugInfoImpl ( ( Graphics2D ) g );
        }
    }

    /**
     * Paints time debug information.
     * Call this when you want to paint time debug information.
     *
     * @param g2d graphics
     */
    public static void paintTimeDebugInfo ( final Graphics2D g2d )
    {
        if ( isGlobalDebugEnabled () )
        {
            paintDebugInfoImpl ( g2d );
        }
    }

    /**
     * Debug information painting method.
     *
     * @param g2d graphics
     */
    private static void paintDebugInfoImpl ( final Graphics2D g2d )
    {
        final double ms = TimeUtils.getPassedNanoTime () / 1000000f;
        final String micro = "" + DEBUG_FORMAT.format ( ms );
        final Rectangle cb = g2d.getClip ().getBounds ();
        final Font font = g2d.getFont ();

        g2d.setFont ( DEBUG_FONT );
        final Object aa = GraphicsUtils.setupAntialias ( g2d );

        final FontMetrics fm = g2d.getFontMetrics ();
        final int w = fm.stringWidth ( micro ) + 4;
        final int h = fm.getHeight ();

        g2d.setPaint ( Color.BLACK );
        g2d.fillRect ( cb.x + cb.width - w, cb.y, w, h );

        g2d.setPaint ( Color.WHITE );
        g2d.drawString ( micro, cb.x + cb.width - w + 2, cb.y + h - fm.getDescent () );

        GraphicsUtils.restoreAntialias ( g2d, aa );
        g2d.setFont ( font );
    }

    /**
     * Paints border debug information.
     * This will display different bounds within the component.
     *
     * @param g graphics
     * @param c component
     */
    public static void paintBorderDebugInfo ( final Graphics g, final JComponent c )
    {
        Rectangle bounds = new Rectangle ( 0, 0, c.getWidth () - 1, c.getHeight () - 1 );
        g.setColor ( ColorUtils.opaque ( ComponentHighlighter.marginColor ) );
        g.drawRect ( bounds.x, bounds.y, bounds.width, bounds.height );

        final Insets margin = BoundsType.margin.insets ( c );
        if ( !SwingUtils.isEmpty ( margin ) )
        {
            bounds = SwingUtils.shrink ( bounds, margin );
            g.setColor ( ColorUtils.opaque ( ComponentHighlighter.borderColor ) );
            g.drawRect ( bounds.x, bounds.y, bounds.width, bounds.height );
        }

        final Insets border = BoundsType.border.insets ( c );
        if ( !SwingUtils.isEmpty ( border ) )
        {
            bounds = SwingUtils.shrink ( bounds, border );
            g.setColor ( ColorUtils.opaque ( ComponentHighlighter.paddingColor ) );
            g.drawRect ( bounds.x, bounds.y, bounds.width, bounds.height );
        }

        final Insets padding = BoundsType.padding.insets ( c );
        if ( !SwingUtils.isEmpty ( padding ) )
        {
            bounds = SwingUtils.shrink ( bounds, padding );
            g.setColor ( ColorUtils.opaque ( ComponentHighlighter.contentColor ) );
            g.drawRect ( bounds.x, bounds.y, bounds.width, bounds.height );
        }
    }

    /**
     * Paints baseline debug information.
     * This will display the component baseline within its bounds.
     *
     * @param g graphics
     * @param c component
     */
    public static void paintBaselineDebugInfo ( final Graphics g, final JComponent c )
    {
        paintBaselineDebugInfo ( g, c, Color.RED );
    }

    /**
     * Paints baseline debug information.
     * This will display the component baseline within its bounds.
     *
     * @param g     graphics
     * @param c     component
     * @param color debug shape color
     */
    public static void paintBaselineDebugInfo ( final Graphics g, final JComponent c, final Color color )
    {
        final int baseline = c.getBaseline ( c.getWidth (), c.getHeight () );
        g.setColor ( color );
        g.drawLine ( 0, baseline, c.getWidth () - 1, baseline );
    }
}