CompilerFlags.java

// At some future point this will also be extended - in conjunction with
// Py#compileFlags - to add
// support for a compiler factory that user code can choose in place of the
// normal compiler.
// (Perhaps a better name might have been "CompilerOptions".)

package org.python.core;

import java.io.Serializable;
import java.util.Set;

import org.python.Version;

public class CompilerFlags implements Serializable {
    // These flags don't mean anything to the code, only to the compiler
    public static final int PyCF_SOURCE_IS_UTF8 = 0x0100;
    public static final int PyCF_DONT_IMPLY_DEDENT = 0x0200;
    public static final int PyCF_ONLY_AST = 0x0400;
    public boolean only_ast;
    public boolean dont_imply_dedent;
    public boolean source_is_utf8;

    public String encoding;
    private final Set<CodeFlag> flags = Version.getDefaultCodeFlags();

    public CompilerFlags() {
    }

    public CompilerFlags(int co_flags) {
        for (CodeFlag flag : CodeFlag.parse(co_flags)) {
            setFlag(flag);
        }
        only_ast = isEnabled(co_flags, PyCF_ONLY_AST);
        dont_imply_dedent = isEnabled(co_flags, PyCF_DONT_IMPLY_DEDENT);
        source_is_utf8 = isEnabled(co_flags, PyCF_SOURCE_IS_UTF8);
    }

    private boolean isEnabled(int co_flags, int codeConstant) {
        return (co_flags & codeConstant) != 0;
    }

    public int toBits() {
        int bits = (only_ast ? PyCF_ONLY_AST : 0)
                | (dont_imply_dedent ? PyCF_DONT_IMPLY_DEDENT : 0)
                | (source_is_utf8 ? PyCF_SOURCE_IS_UTF8 : 0);
        for (CodeFlag flag : flags) {
            bits |= flag.flag;
        }
        return bits;
    }

    public void setFlag(CodeFlag flag) {
        flags.add(flag);
    }

    public boolean isFlagSet(CodeFlag flag) {
        return flags.contains(flag);
    }

    @Override
    public String toString() {
        return String.format(
                "CompilerFlags[division=%s nested_scopes=%s generators=%s "
                        + "with_statement=%s absolute_import=%s only_ast=%s "
                        + "dont_imply_dedent=%s  source_is_utf8=%s]",
                isFlagSet(CodeFlag.CO_FUTURE_DIVISION),
                isFlagSet(CodeFlag.CO_NESTED),
                isFlagSet(CodeFlag.CO_GENERATOR_ALLOWED),
                isFlagSet(CodeFlag.CO_FUTURE_WITH_STATEMENT),
                isFlagSet(CodeFlag.CO_FUTURE_ABSOLUTE_IMPORT), only_ast,
                dont_imply_dedent, source_is_utf8);
    }

    public static CompilerFlags getCompilerFlags() {
        return getCompilerFlags(0, null);
    }

    private static final int CO_ALL_FEATURES = CompilerFlags.PyCF_DONT_IMPLY_DEDENT
            | CompilerFlags.PyCF_ONLY_AST
            | CompilerFlags.PyCF_SOURCE_IS_UTF8
            | CodeFlag.CO_NESTED.flag
            | CodeFlag.CO_GENERATOR_ALLOWED.flag
            | CodeFlag.CO_FUTURE_DIVISION.flag
            | CodeFlag.CO_FUTURE_ABSOLUTE_IMPORT.flag
            | CodeFlag.CO_FUTURE_WITH_STATEMENT.flag;

    public static CompilerFlags getCompilerFlags(int flags, PyFrame frame) {
        if ((flags & ~CO_ALL_FEATURES) != 0) {
            throw Py.ValueError("compile(): unrecognised flags");
        }
        return getCompilerFlags(new CompilerFlags(flags), frame);
    }

    public static CompilerFlags getCompilerFlags(CompilerFlags flags,
            PyFrame frame) {
        if (frame != null && frame.f_code != null) {
            return frame.f_code.co_flags.combine(flags);
        } else {
            return flags;
        }
    }

    // this will not strictly be an OR once we have other options, like a compiler factory
    // in that case, we would assume
    public CompilerFlags combine(CompilerFlags flags) {
        return new CompilerFlags(this.toBits() | flags.toBits());
    }

    public CompilerFlags combine(int flags) {
        return new CompilerFlags(this.toBits() | flags);
    }
}