import {Node} from "..";
import {Parser as ANTLRParser, ParserRuleContext} from "antlr4ng";
import {TylasuParser, TylasuToken} from "../parsing";
import ECore from "ecore/dist/ecore";
import {THE_AST_EPACKAGE} from "./starlasu-v2-metamodel";
import {EcoreMetamodelSupport} from "./ecore";

/**
 * A parser that supports exporting AST's to EMF/Ecore.
 * In particular, this parser can generate the metamodel. We can then use toEObject(node) to translate a tree
 * into its EMF representation.
 */
export abstract class EcoreEnabledParser<
    R extends Node, P extends ANTLRParser, C extends ParserRuleContext, T extends TylasuToken
> extends TylasuParser<R, P, C, T> implements EcoreMetamodelSupport {

    /**
     * Generates the metamodel. The standard Kolasu metamodel [EPackage][org.eclipse.emf.ecore.EPackage] is included.
     */
    generateMetamodel(resource: ECore.Resource, includingKolasuMetamodel = true): void {
        if (includingKolasuMetamodel) {
            resource.get("contents").add(THE_AST_EPACKAGE);
        }
        this.doGenerateMetamodel(resource);
    }

    /**
     * Implement this method to tell the parser how to generate the metamodel. See [MetamodelBuilder].
     */
    protected abstract doGenerateMetamodel(resource: ECore.Resource): void;
}