/*
 * [JDK.java]
 *
 * Summary: Expand JDK reference to some sort of version.
 *
 * Copyright: (c) 2009-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:
 *  1.8 2009-02-06 include go package in ZIP bundle.
 *                 macro JDK micro --> 0 <br> <!-- macro JDK fullversion -> 1.7.0 <br> <!-- macro JDK dir --> jdk1.8.0_131
 *                 0 <br> <!--
 *                 macro JDK path --> J:\Program Files\Java\jdk_1.7.0<br> <!-- macro JDK url -->
 *                 file://localhost/J:/Program
 *                 Files/Java/jdk_1.7.0
 *  1.9 2014-08-04 addend trailing \ to path variables to idicate they are dirs.
 */
package com.mindprod.htmlmacros.macro;

import com.mindprod.htmlmacros.support.VersionFlavour;

import java.io.File;

import static com.mindprod.common18.Build.INTELLIJ_DIR;
import static com.mindprod.common18.Build.INTELLIJ_FULL_VERSION;
import static com.mindprod.common18.Build.JET_FULL_VERSION;
import static com.mindprod.common18.Build.JET_PROFILE_VERSION;
import static com.mindprod.htmlmacros.support.JDKandJREVersions.*;
import static java.lang.System.*;

/**
 * Expand JDK reference to some sort of version.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 1.9 2014-08-04 addend trailing \ to path variables to idicate they are dirs.
 * @see com.mindprod.htmlmacros.macro.JRE
 * @see com.mindprod.htmlmacros.support.JDKandJREVersions
 * @see JDKLocation
 * @since 2009
 */
public final class JDK extends Macro
    {
    // declarations
    /** how to use the macro */
    /**
     * how to use the macro
     */
    private static final String USAGE = "\nJDK macro needs a flavour, e.g. macro version fullversion micro dir path url";
    // /declarations
    // methods

    /**
     * guts to Generate reference to the JDK.
     *
     * @param flavour enumeration for type of version wanted
     *
     * @return expanded to the type of JDK version wanted
     */
    private static String expand( final VersionFlavour flavour, final File fileBeingProcessed )
        {
        switch ( flavour )
            {
            case macroversion:
                // 1.8
                return "<span class=\"version\">" + JDK_MACRO_VERSION + "</span>";
            // 1.8.0
            case version:
                return "<span class=\"version\">" + JDK_VERSION + "</span>";
            case fullversion:
                // 1.8.0_131
                return "<span class=\"version\">" + JDK_FULL_VERSION + "</span>";
            case recommendedversion:
                // 1.8.0_131
                return "<span class=\"version\">" + RECOMMENDED_JDK_FULL_VERSION + "</span>";
            case microversion:
                // 0
                return "<span class=\"version\">" + JDK_MICRO_VERSION + "</span>";
            case releaseversion:
                // 0
                return "<span class=\"version\">" + JDK_RELEASE_VERSION + "</span>";
            case dir:
                // jdk1.8.0_131
                return "<span class=\"dir\">" + JDK_DIR + "</span>";
            case path:
                // J:\Program&nbsp;Files\Java\jdk1.8.0_131
                return Path.decorate( JDK_PATH, false, /* is dir even though has no trailing / */ fileBeingProcessed );
            case path32:
                // J:\Program&nbsp;Files&nbsp;(x86)\java\jdk1.8.0_131
                return Path.decorate( JDK_PATH32, false, /* is dir even though has no trailing / */ fileBeingProcessed );
            case defaultpath:
                // default dir where JDK installed
                //  J:\Program&nbsp;Files &nbsp;(x86)\java\jdk1.8.0_131
                return Path.decorate( JDK_DEFAULT_PATH, false, /* is dir even though has no trailing / */ fileBeingProcessed );
            case url:
                return "<span class=\"url\">" + JDK_URL + "</span>";
            case url32:
                return "<span class=\"url\">" + JDK_URL32 + "</span>";
            case jetprofileversion:
                // 1.7.0_55
                return "<span class=\"version\">" + JET_PROFILE_VERSION + "</span>";
            case jetversion:
                return "<span class=\"version\">" + JET_FULL_VERSION + "</span>";
            case jetfullversion:
                // jet10.0-pro-x8
                return "<span class=\"version\">" + JET_FULL_VERSION + "</span>";
            case ideadir:
                return "<span class=\"version\">" + INTELLIJ_DIR + "</span>";
            case ideafullversion:
                return "<span class=\"version\">" + INTELLIJ_FULL_VERSION + "</span>";
            // old versions
            case oldmacroversion:
                // 1.8
                return "<span class=\"version\">" + OLD_JDK_MACRO_VERSION + "</span>";
            // 1.8.0
            case oldversion:
                return "<span class=\"version\">" + OLD_JDK_VERSION + "</span>";
            case oldfullversion:
                // 1.8.0_131
                return "<span class=\"version\">" + OLD_JDK_FULL_VERSION + "</span>";
            case oldmicroversion:
                // 0
                return "<span class=\"version\">" + OLD_JDK_MICRO_VERSION + "</span>";
            case oldreleaseversion:
                // 0
                return "<span class=\"version\">" + OLD_JDK_RELEASE_VERSION + "</span>";
            case olddir:
                // jdk1.8.0_131
                return "<span class=\"dir\">" + OLD_JDK_DIR + "</span>";
            case oldpath:
                // J:\Program&nbsp;Files\Java\jdk1.8.0_131
                return Path.decorate( OLD_JDK_PATH, false, /* is dir even though has no trailing / */ fileBeingProcessed );
            case oldpath32:
                // J:\Program&nbsp;Files&nbsp;(x86)\java\jdk1.8.0_131
                return Path.decorate( OLD_JDK_PATH32, false, /* is dir even though has no trailing / */ fileBeingProcessed );
            case olddefaultpath:
                // default dir where JDK installed
                //  J:\Program&nbsp;Files &nbsp;(x86)\java\jdk1.8.0_131
                return Path.decorate( OLD_JDK_DEFAULT_PATH, false, /* is dir even though has no trailing / */ fileBeingProcessed );
            case oldurl:
                return "<span class=\"url\">" + OLD_JDK_URL + "</span>";
            case oldurl32:
                return "<span class=\"url\">" + OLD_JDK_URL32 + "</span>";
            default:
                throw new IllegalArgumentException( "JDK unknown flavour" );
            }
        }// /method

    /**
     * Expands: <!-- macro JDK version/macroversion/microversion/dir/path/url --> Generate a reference to a Oracle
     * file in
     * the JR. see samples of use in mindprod\jgloss\registry.html
     *
     * @param parms   first is description, second the reference lib/rt.jar Can use either /s or \s in the
     *                url. Generates file://localhost/J:/Program Files/jdk1.5.0_03/lib/rt.jar
     * @param quiet   true if want output suppressed.
     * @param verbose @return expanded macro HTML
     */
    public String expandMacro( String[] parms, final boolean quiet, final boolean verbose )
        {
        if ( !quiet )
            {
            out.print( "J" );
            }
        if ( parms.length != 1 )
            {
            throw new IllegalArgumentException( USAGE );
            }
        String f = parms[ 0 ];
        VersionFlavour flavour;
        try
            {
            // will throw IllegalArgumentException if no match
            flavour = VersionFlavour.valueOf( VersionFlavour.class, f );
            }
        catch ( IllegalArgumentException e )
            {
            throw new IllegalArgumentException( "macro JDK invalid parameter: " + f );
            }
        return expand( flavour, fileBeingProcessed );
        }// /method
    // /methods
    }