/*
 * [RebuildIndexShells.java]
 *
 * Summary: Rebuild skeletons of all indexes in case they are ever damaged.
 *
 * Copyright: (c) 2007-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.2 2007-04-27 use enum for each embellishment letter. use CSS for single icons.
 */
package com.mindprod.qf;

import com.mindprod.fastcat.FastCat;
import com.mindprod.htmlmacros.macro.Global;
import com.mindprod.htmlmacros.support.ConfigurationForMindprod;
import com.mindprod.hunkio.HunkIO;

import java.io.File;
import java.io.IOException;

import static java.lang.System.*;

/**
 * Rebuild skeletons of all indexes in case they are ever damaged.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 2.2 2007-04-27 use enum for each embellishment letter. use CSS for single icons.
 * @since 2007
 */
public final class RebuildIndexShells
    {
    /**
     * what to use for <br>
     */
    private static final String BR;

    /**
     * root directory of website
     */
    private static final String webrootDirname;

    static
        {
        // combine dirsWithMacros and dirsWithIncludes into dirsToProcess;
        Global.installConfiguration( new ConfigurationForMindprod() );
        webrootDirname = Global.configuration.getLocalWebrootWithSlashes();
        BR = Global.configuration.getBr();
        }
    // methods

    /**
     * connvert a filename to a webroot relative filename
     *
     * @param f absolute name of file
     *
     * @return webroot relative name of file
     */
    private static String absToPath( String f )
        {
        // chop lead E:/mindprod/
        return f.substring( webrootDirname.length() + 1 /* to account for trail / */ );
        }// /method

    /**
     * generate one Bgloss letter index shell, no guts
     *
     * @param letterCode which letter of alphabet to create index for
     *
     * @throws IOException if trouble writing out the index
     */
    private static void createBglossIndexShell( char letterCode ) throws IOException
        {
        createIndexShell( letterCode, new BglossCustomiser() );
        }// /method

    /**
     * generate one Ggloss letter index shell, no guts
     *
     * @param letterCode which letter of alphabet to create index for
     *
     * @throws IOException if trouble writing the index file
     */
    private static void createGglossIndexShell( char letterCode ) throws IOException
        {
        createIndexShell( letterCode, new GglossCustomiser() );
        }// /method

    private static void createIndexShell( char letterCode, AbstractGlossCustomiser c ) throws IOException
        {
        final File file = new File( c.getInputDirName(), c.getFilenameForLetterCode( letterCode ) );
        final char signatureLetter = c.getGlossEnum().getSignatureLetter();
        final String base = c.getBaseName();
        final FastCat sb = new FastCat( 15 );
        sb.append( "<!-- macro ", signatureLetter, "glossLetterHead ", letterCode, " -->\n" );
        if ( letterCode == '~' )
            {
            // only for master index, on page index. JGlossLetterHad provides second menu for off page index.
            // for ordinary index pages, letter menu provided by JglossLetterHead macro.
            sb.append( "<!-- macro Include ", base, "/include/", base, "/masterlettermenu.htmlfrag -->\n" );
            }
        sb.append( "<!-- macro Include " );
        sb.append( absToPath( c.getTablenameForLetterCode( letterCode ) ) );
        sb.append( " -->\n" );
        sb.append( "<!-- macro Foot -->\n" );
        HunkIO.writeEntireFile( file, sb.toString() );
        }// /method

    /**
     * generate one Jgloss letter index shell, no guts
     *
     * @param letterCode which letter of alphabet to create index for
     *
     * @throws IOException if trouble writing the index
     */
    private static void createJglossIndexShell( char letterCode ) throws IOException
        {
        createIndexShell( letterCode, new JglossCustomiser() );
        }// /method

    /**
     * create the letter menu for a glossary
     */
    private static void createLetterMenu( String glossary ) throws IOException
        {
        final FastCat sb = new FastCat( 12 );
        sb.append( "<span class=\"unobtrusive\" id=\"INDEX\">page index &rArr;</span>" );
        sb.append( "<span class=\"indexletters\">" );
        sb.append(
                "<a href=\"#PUNCT\">punctuation</a> <a href=\"#DIGITS\">0-9</a> <a href=\"#A\">A</a> <a " +
                "href=\"#B\">B</a> "
        );
        sb.append(
                "<a href=\"#C\">C</a> <a href=\"#D\">D</a> <a href=\"#E\">E</a> <a href=\"#F\">F</a> <a " +
                "href=\"#G\">G</a> "
        );
        sb.append(
                "<a href=\"#H\">H</a> <a href=\"#I\">I</a> <a href=\"#J\">J</a> <a href=\"#K\">K</a> <a " +
                "href=\"#L\">L</a> "
        );
        sb.append(
                "<a href=\"#M\">M</a> <a href=\"#N\">N</a> <a href=\"#O\">O</a> <a href=\"#P\">P</a> <a " +
                "href=\"#Q\">Q</a> "
        );
        sb.append(
                "<a href=\"#R\">R</a> <a href=\"#S\">S</a> <a href=\"#T\">T</a> <a href=\"#U\">U</a> <a " +
                "href=\"#V\">V</a> "
        );
        sb.append( "<a href=\"#W\">W</a> <a href=\"#X\">X</a> <a href=\"#Y\">Y</a> <a href=\"#Z\">Z</a></span>" );
        sb.append( BR );
        sb.append( "The following index is sorted alphabetically in columns, like a phone book." );
        final File file = new File( webrootDirname + "/" + glossary + "/include/" + glossary + "/lettermenu.htmlfrag" );
        HunkIO.writeEntireFile( file, sb.toString() );
        }// /method

    /**
     * @param args not used
     *
     * @throws IOException if trouble writing the shells.
     */
    public static void main( String[] args ) throws IOException
        {
        // does not fix egloss or lgloss.  must do that manually.
        out.println( "regenerating index shells, e.g. " + webrootDirname + "/jgloss/a.html" );
        out.println( webrootDirname + "/jgloss/include/jgloss/a.guts.htmlfrag generated later by gf." );
        // do master indexes
        createBglossIndexShell( '~' );
        createGglossIndexShell( '~' );
        createJglossIndexShell( '~' );
        // lgloss just gets master index uses lgloss.html, not a true master
        // index.
        // do punctuation
        createBglossIndexShell( '*' );
        createGglossIndexShell( '*' );
        createJglossIndexShell( '*' );
        // do digits, one page for 0-9
        createBglossIndexShell( '0' );
        createGglossIndexShell( '0' );
        createJglossIndexShell( '0' );
        // do A-Z
        for ( char letter = 'A'; letter <= 'Z'; letter++ )
            {
            createBglossIndexShell( letter );
            createGglossIndexShell( letter );
            createJglossIndexShell( letter );
            }
        createLetterMenu( "jgloss" );
        createLetterMenu( "bgloss" );
        createLetterMenu( "ggloss" );
        out.println( "done" );
        }// /method
    // /methods
    }