IDialect.java

/**
 * Copyright (C) 2013-2016 The Rythm Engine project
 * for LICENSE and other details see:
 * https://github.com/rythmengine/rythmengine
 */
package org.rythmengine.internal;

import org.rythmengine.RythmEngine;
import org.rythmengine.internal.compiler.TemplateClass;

public interface IDialect {

    /**
     * Return the ID of the dialect, might be something like "rythm" or "play-groovy" etc.
     *
     * @return dialect id
     */
    String id();

    /**
     * Return the primary caret marker, e.g. "#" in play-groovy, "@" in rythm and "`" in japid. To escape the
     * marker repeat the marker twice, e.g. "@@", "##", "``"
     *
     * @return the primary caret
     */
    String a();

    /**
     * Register a special case parser which will be processed before all other parsers
     * <p/>
     * <p>for example, the rythm extension for play!framework might want to register a special case parser to
     * process something like @{Controller.actionMethod()} or &{'MSG_ID'} etc.
     *
     * @param parser
     */
    void registerParserFactory(IParserFactory parser);

    boolean isMyTemplate(String template);

    void begin(IContext ctx);

    void end(IContext ctx);

    boolean enableScripting();

    boolean enableFreeForLoop();

    CodeBuilder createCodeBuilder(String template, String className, String tagName, TemplateClass templateClass, RythmEngine engine);
}