/*
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.api.instrumentation;

import com.oracle.truffle.api.TruffleRuntime;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.nodes.RootNode;
import com.oracle.truffle.api.source.Source;
import com.oracle.truffle.api.source.SourceSection;

A listener attached by an Instrumenter to specific locations of a guest language program to listen to sources section load events. 
Since:
0.15/**
 * A listener attached by an {@link Instrumenter} to specific locations of a guest language program
 * to listen to sources section load events.
 *
 * @since 0.15
 */
public interface LoadSourceSectionListener {

    
Invoked whenever a new source section is loaded. The listener might be notified for one source section multiple times but never with the same instrumented node. The order in which multiple source section event listeners are notified matches the order they are 
attached. Implementation Note: Source load events are notified when the guest language implementation uses a new source by invoking TruffleRuntime.createCallTarget(RootNode) with a root node that uses a new source in Node.getSourceSection(). It assumes that all nodes of an AST have the same source as their root. 

Params:
event – an event with context information
Since:
0.15/**
     * Invoked whenever a new {@link SourceSection source section} is loaded. The listener might be
     * notified for one source section multiple times but never with the same instrumented node. The
     * order in which multiple source section event listeners are notified matches the order they
     * are
     * {@link Instrumenter#attachLoadSourceSectionListener(SourceSectionFilter, LoadSourceSectionListener, boolean)
     * attached}.
     *
     * <b>Implementation Note:</b> Source load events are notified when the guest language
     * implementation uses a new {@link Source source} by invoking
     * {@link TruffleRuntime#createCallTarget(RootNode)} with a root node that uses a new source in
     * {@link Node#getSourceSection()}. It assumes that all nodes of an AST have the same
     * {@link Source source} as their root.
     * </p>
     *
     * @param event an event with context information
     * @since 0.15
     */
    void onLoad(LoadSourceSectionEvent event);

}