org.codehaus.groovy.tools.shell.completion.KeywordSyntaxCompletor.groovy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of groovy-all Show documentation
Groovy: A powerful, dynamic language for the JVM
There is a newer version: 3.0.22
/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.codehaus.groovy.tools.shell.completion

import org.codehaus.groovy.antlr.GroovySourceToken

/**
 * Completor completing Groovy keywords and special functions
 */
class KeywordSyntaxCompletor implements IdentifierCompletor {

    private static final String[] KEYWORDS = [
            'abstract',
            'assert', 'boolean', 'break', 'byte',
            'case',
            // 'catch (', // special
            'char', 'class', 'continue',
            'def', // short, but keep, else 'default' completes, annoyingly
            'default',
            'do',
            'double',
            'else', 'enum',

            //'false',// value
            'final',
            //'finally {', // special
            'float',
            //'for (', // special
            //'if (', // special
            //'import', // command anyway

            'int', // short, but keeping for consistency, all primitives
            'interface',
            'long',
            //'native',
            'new',
            //'null', // value
            'private', 'protected', 'public',
            'return', 'short',
            'static',
            //'super',// value
            //'switch (', // special
            'synchronized',
            //'this', // value
            //threadsafe,
            'throw', 'throws',
            'transient',
            //'true', // value
            //'try {', //special
            'void', 'volatile'
            //'while (' // special
    ]

    // VALUE_KEYWORDS and SPECIAL_FUNCTIONS completed without added blank
    private static final String[] VALUE_KEYWORDS = [
            'true',
            'false',
            'this',
            'super',
            'null']

    private static final String[] SPECIAL_FUNCTIONS = [
            'catch (',
            'finally {',
            'for (',
            'if (',
            'switch (',
            'try {',
            'while (']

    private static final String[] DEFAULT_METHODS = [
            'use (',
            'print ',
            'println ',
            'printf ',
            'sprintf ',
    ]

    @Override
    boolean complete(final List tokens, final List candidates) {
        String prefix = tokens.last().text
        boolean foundMatch = false
        for (String varName in KEYWORDS) {
            if (varName.startsWith(prefix)) {
                candidates << varName + ' '
                foundMatch = true
            }
        }
        for (String varName in VALUE_KEYWORDS) {
            if (varName.startsWith(prefix)) {
                candidates << varName
                foundMatch = true
            }
        }
        for (String varName in SPECIAL_FUNCTIONS) {
            if (varName.startsWith(prefix)) {
                candidates << varName
                foundMatch = true
            }
        }
        for (String varName in DEFAULT_METHODS) {
            if (varName.startsWith(prefix)) {
                candidates << varName
                foundMatch = true
            }
        }

        return foundMatch
    }
}