/*
 * [TextCharCategory.java]
 *
 * Summary: top level enum to define the categories of character for the PropTokenizer.
 *
 * 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.
 */
package com.mindprod.jprep;

/**
 * top level enum to define the categories of character for the PropTokenizer.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 3.1 2009-04-12 shorter style names, improved highlighting.
 * @since 2004-05-15
 */
@SuppressWarnings( { "EnumeratedConstantNamingConvention" } )
public enum TextCharCategory
    {
        /**
         * newline
         */
        EOL,
        /**
         * whitespace, tab, space, nbsp
         */
        SPACE,
        /**
         * ignore control chars
         */
        IGNORE,
        /**
         * ordinary chars, including punct, ", space
         */
        ORDINARY;

    /**
     * Categorise one character
     *
     * @param theChar character to categorise
     *
     * @return category code, e.g. PLAIN QUOTE
     */
    static TextCharCategory categorise( char theChar )
        {
        switch ( theChar )
            {
            case ' ':
            case '\t':
            case 0xa0://  
                return SPACE;
            case '\n':
                return EOL;
            case '\r':
            case 127:
            case 0xfeff: /* bom */
            case 0xfffd: /* replaced bom */
                return IGNORE;
            default:
                if ( 0 <= theChar && theChar <= 31 )
                    {
                    return IGNORE;// control chars
                    }
                else
                    {
                    return ORDINARY;
                    }
            } // end switch
        } // end categorise
    } // end TextCharCategory