eu.mihosoft.g4j.lang.Keywords Maven / Gradle / Ivy

Go to download
/* 
 * Keywords.java
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007–2018 by Michael Hoffer,
 * Copyright (c) 2015–2018 G-CSC, Uni Frankfurt,
 * Copyright (c) 2009–2015 Steinbeis Forschungszentrum (STZ Ölbronn)
 * 
 * This file is part of Visual Reflection Library (VRL).
 *
 * VRL is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 * 
 * see: http://opensource.org/licenses/LGPL-3.0
 *      file://path/to/VRL/src/eu/mihosoft/vrl/resources/license/lgplv3.txt
 *
 * VRL is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * This version of VRL includes copyright notice and attribution requirements.
 * According to the LGPL this information must be displayed even if you modify
 * the source code of VRL. Neither the VRL Canvas attribution icon nor any
 * copyright statement/attribution may be removed.
 *
 * Attribution Requirements:
 *
 * If you create derived work you must do three things regarding copyright
 * notice and author attribution.
 *
 * First, the following text must be displayed on the Canvas:
 * "based on VRL source code". In this case the VRL canvas icon must be removed.
 * 
 * Second, the copyright notice must remain. It must be reproduced in any
 * program that uses VRL.
 *
 * Third, add an additional notice, stating that you modified VRL. A suitable
 * notice might read
 * "VRL source code modified by YourName 2012".
 * 
 * Note, that these requirements are in full accordance with the LGPL v3
 * (see 7. Additional Terms, b).
 *
 * Please cite the publication(s) listed below.
 *
 * Publications:
 *
 * M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
 * a framework for declarative GUI programming on the Java platform.
 * Computing and Visualization in Science, 2013, 16(4),
 * 181–192. http://doi.org/10.1007/s00791-014-0230-y
 */

package eu.mihosoft.g4j.lang;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * mIndicates whether the specified word is a reserved language keyword
   (currently only java and groovy are supported).
 * @author Michael Hoffer <[email protected]>
 */
public class Keywords {

    private static Set keywords = new HashSet();

    static {
        
        // Java Keywords
        String keywordString = readKeyWords(
                "/eu/mihosoft/vrl/lang/keywords_java6");
        keywords.addAll(Arrays.asList(keywordString.split("\n")));
        
        // Groovy Keywords
        keywordString = readKeyWords(
                "/eu/mihosoft/vrl/lang/keywords_groovy");
        
        keywords.addAll(Arrays.asList(keywordString.split("\n")));
    }

    /**
     * Indicates whether the specified word is a reserved language keyword
     * (currently only java and groovy are supported).
     * @param word word to check
     * @return true if the specified word is a reserved
     *         language keyword; false otherwise
     */
    public static boolean isKeyword(String word) {

        for (String s : keywords) {
            if (s.equals(word)) {
                return true;
            }
        }

        return false;
    }
    
    /**
     * Returns all reserved language keywords
     * (currently only java and groovy are supported).
     * @return all reserved language keywords
     */
    public static Iterable getKeywords() {
        return keywords;
    }

    private static String readKeyWords(String codeName) {
        // load Sample Code
        InputStream iStream = Keywords.class.getResourceAsStream(
                codeName);

        BufferedReader reader =
                new BufferedReader(new InputStreamReader(iStream));

        String code = "";

        try {
            while (reader.ready()) {
                String line = reader.readLine();
                // lines starting with # and empty lines are ignored
                if (line.trim().startsWith("#") || line.trim().isEmpty()) {
                    continue;
                }
                code += line + "\n";
            }
        } catch (IOException ex) {
            Logger.getLogger(Keywords.class.getName()).
                    log(Level.SEVERE, null, ex);
        } finally {
            try {
                reader.close();
            } catch (IOException ex) {
                Logger.getLogger(Keywords.class.getName()).
                        log(Level.SEVERE, null, ex);
            }
        }
        return code;
    }
}