/*
 * [Var.java]
 *
 * Summary: Describes one variable name token for display.
 *
 * Copyright: (c) 2004-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  2.0 2009-04-19 tidy comments, more accurate colour names
 */
package com.mindprod.jtokens.java;

import java.awt.Color;
import java.awt.Font;

import static com.mindprod.jtokens.TokenColourScheme.JAVA_FOREGROUND_FOR_VAR;
import static com.mindprod.jtokens.TokenFonts.MONO_FONTS;
import static com.mindprod.jtokens.TokenFonts.NORMAL_FONT_SIZE_IN_POINTS;
import static java.lang.System.*;

/**
 * Describes one variable name token for display.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 2.0 2009-04-19 tidy comments, more accurate colour names
 * @since 2004-04-24
 */
public final class Var extends Definable
    {
    /**
     * version number for this class
     */
    static final long serialVersionUID = 1L;

    @SuppressWarnings( { "ConstantNamingConvention" } )
    private static final Font fontDef =
            bestFont( MONO_FONTS, Font.BOLD, NORMAL_FONT_SIZE_IN_POINTS );

    /**
     * Font to render this token
     */
    @SuppressWarnings( { "ConstantNamingConvention" } )
    private static final Font fontRef =
            bestFont( MONO_FONTS, Font.PLAIN, NORMAL_FONT_SIZE_IN_POINTS );

    /**
     * Constructor
     *
     * @param varName  the name of a variable e.g. i, temp.
     * @param defining true if this where the variable is defined. false if it is a reference to the variable.
     */
    public Var( String varName, boolean defining )
        {
        super( varName, defining );
        char firstLetter = varName.charAt( 0 );
        if ( !( firstLetter == '_'
                || firstLetter == '$'
                || Character.isLowerCase( firstLetter ) ) )
            {
            // don't throw exception. Snippets don't have to be perfect.
            err.println( "\007variable "
                         + varName
                         + " should begin with a lower case letter." );
            }
        }

    /**
     * @inheritDoc
     */
    public Font getFont()
        {
        return defining ? fontDef : fontRef;
        }

    /**
     * @inheritDoc
     */
    public Color getForeground()
        {
        return JAVA_FOREGROUND_FOR_VAR;
        }

    /**
     * @inheritDoc
     */
    public String getHTML()
        {
        return ( defining
                 ? "<span class=\"vardef\">"
                 : "<span class=\"var\">" ) + getRawHTML() + "</span>";
        }
    }