/*
 * [JPrepTokenizer.java]
 *
 * Summary: What all tokenizers implement to hook into JPrep.
 *
 * 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:
 *  3.1 2009-04-12 shorter style names, improved highlighting.
 *                 JprepTokenizer is part of JPrep. It never needed online.
 */
package com.mindprod.jprep;

import com.mindprod.jtokens.Token;

/**
 * What all tokenizers implement to hook into JPrep.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 3.1 2009-04-12 shorter style names, improved highlighting.
 * JprepTokenizer is part of JPrep. It never needed online.
 * @since 2004-05-15
 */
public interface JPrepTokenizer
    {
    // Torkenizers must be registered in Jprep.prepareAllSnippetsForOneDirectory.

    /**
     * Provide a list of the extensions in lower case <br> e.g. new String { "bat", "btm", "batfrag" }<br> that this
     * parser handles. Do NOT include the .!
     *
     * @return list of extensions
     */
    public String[] getExtensions();

    /**
     * convert string reprenting a snippet into an array of Tokens to describe the display of each "word"
     *
     * @param big the bat file text we are going to render
     *
     * @return tokenized text containing font, and colour for each word.
     */
    public Token[] tokenize( String big );
    }