com.oracle.truffle.api.debug.SourceElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation

Truffle is a multi-language framework for executing dynamic languages that achieves high performance when combined with Graal.

There is a newer version: 1.0.0-rc7

Show newest version

/*
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.api.debug;

import com.oracle.truffle.api.instrumentation.StandardTags.ExpressionTag;
import com.oracle.truffle.api.instrumentation.StandardTags.StatementTag;
import com.oracle.truffle.api.instrumentation.Tag;

/**
 * Representation of a guest language source syntax element, that is used for debugging purposes. It
 * is based on {@link Tag} types and this enum defines the set of syntax element kinds known to the
 * debugger.
 *
 * @since 0.33
 */
public enum SourceElement {

    /**
     * Denotes program locations that represent a statement of a guest language. The appropriate
     * nodes are tagged with {@link StatementTag}.
     *
     * @since 0.33
     */
    STATEMENT(StatementTag.class),

    /**
     * Denotes program locations that represent an expression of a guest language. The appropriate
     * nodes are tagged with {@link ExpressionTag}.
     *
     * @since 0.33
     */
    EXPRESSION(ExpressionTag.class);

    private final Class tag;

    SourceElement(Class tag) {
        this.tag = tag;
    }

    Class getTag() {
        return tag;
    }
}