view graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/SyntaxTagged.java @ 18485:e3c95cbbb50c

Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests.
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 23 Nov 2014 16:07:23 -0800
parents 1051d6e4b61b
children 27fe86a6fb49
line wrap: on
line source

/*
 * Copyright (c) 2014, 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.instrument;

import java.util.*;

/**
 * Information about a guest language program element in a Truffle AST that can be marked as
 * belonging to 0 or more {@linkplain SyntaxTag tags}.
 * <p>
 * <strong>Disclaimer:</strong> experimental interface under development.
 */
public interface SyntaxTagged {

    /**
     * Is this node tagged as belonging to a particular human-sensible category of language
     * constructs?
     */
    boolean isTaggedAs(SyntaxTag tag);

    /**
     * In which user-sensible categories has this node been tagged (<em>empty set</em> if none).
     */
    Collection<SyntaxTag> getSyntaxTags();

}