org.truffleruby.parser.ParseEnvironment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ruby-language Show documentation
Core module of Ruby on Truffle
The newest version!
/*
 * Copyright (c) 2014, 2024 Oracle and/or its affiliates. All rights reserved. This
 * code is released under a tri EPL/GPL/LGPL license. You can use it,
 * redistribute it and/or modify it under the terms of the:
 *
 * Eclipse Public License version 2.0, or
 * GNU General Public License version 2, or
 * GNU Lesser General Public License version 2.1.
 */
package org.truffleruby.parser;

import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.source.Source;
import org.prism.Nodes;
import org.truffleruby.RubyLanguage;
import org.truffleruby.annotations.SuppressFBWarnings;
import org.truffleruby.language.control.BreakID;
import org.truffleruby.language.control.ReturnID;


/** Translator environment, unique per parse/translation. This must be immutable to be correct for lazy translation, as
 * then multiple threads might lazy translate methods of the same file in parallel. */
public final class ParseEnvironment {

    public final RubyLanguage language;
    public final RubySource rubySource;
    public final Source source;
    /** Used to compute line numbers */
    public Nodes.Source yarpSource;
    public final ParserContext parserContext;
    public final Node currentNode;

    private final boolean inCore;
    private final boolean coverageEnabled;


    // Set once after parsing and before translating
    public Boolean allowTruffleRubyPrimitives = null;

    public ParseEnvironment(
            RubyLanguage language,
            RubySource rubySource,
            ParserContext parserContext,
            Node currentNode) {
        this.language = language;
        this.rubySource = rubySource;
        this.source = rubySource.getSource();
        this.parserContext = parserContext;
        this.currentNode = currentNode;

        this.inCore = RubyLanguage.getPath(source).startsWith(language.corePath);
        this.coverageEnabled = RubyLanguage.MIME_TYPE_COVERAGE.equals(rubySource.getSource().getMimeType());
    }

    public boolean inCore() {
        return inCore;
    }

    public boolean canUsePrimitives() {
        assert allowTruffleRubyPrimitives != null;
        return inCore() || allowTruffleRubyPrimitives;
    }

    /** Returns false if the AST is shared */
    public boolean isCoverageEnabled() {
        return coverageEnabled;
    }

    @SuppressFBWarnings("ISC_INSTANTIATE_STATIC_CLASS")
    public ReturnID allocateReturnID() {
        return new ReturnID();
    }

    @SuppressFBWarnings("ISC_INSTANTIATE_STATIC_CLASS")
    public BreakID allocateBreakID() {
        return new BreakID();
    }

}