The DSL Builder Interface

1
customDSL = {
2
    ortus = "path.model.dsl.OrtusBuilder"
3
};
4
​
5
or
6
mapDSL("ortus","path.model.dsl.OrtusBuilder");
Copied!
This will register a new injection DSL namespace called ortus that maps to that instantiation component path.model.dsl.OrtusBuilder. Here is a very simple DSL Builder:
1
<cfcomponent implements="wirebox.system.ioc.dsl.IDSLBuilder" output="false">
2
​
3
    <---  init --->
4
    <cffunction name="init" output="false" access="public" returntype="any" hint="Configure the DSL for operation and returns itself" colddoc:generic="wirebox.system.ioc.dsl.IDSLBuilder">
5
        <cfargument name="injector" type="any" required="true" hint="The linked WireBox injector" colddoc:generic="wirebox.system.ioc.Injector"/>
6
        <cfscript>
7
            instance = { injector = arguments.injector };
8
            instance.log        = instance.injector.getLogBox().getLogger( this );
9
​
10
            return this;
11
        </cfscript>
12
    </cffunction>
13
​
14
    <---  process --->
15
    <cffunction name="process" output="false" access="public" returntype="any" hint="Process an incoming DSL definition and produce an object with it.">
16
        <cfargument name="definition" required="true" hint="The injection dsl definition structure to process. Keys: name, dsl"/>
17
        <cfargument name="targetObject" required="false" hint="The target object we are building the DSL dependency for."/>
18
        <cfscript>
19
            var thisType             = arguments.definition.dsl;
20
            var thisTypeLen         = listLen(thisType,":");
21
            var utilName             = "";
22
​
23
            // DSL stages
24
            switch(thisTypeLen){
25
                // Ortus
26
                case 1 : { return instance.injector.getInstance('ortusUtil'); }
27
                // Ortus:utility
28
                case 2 : {
29
                    utilName = getToken(thisType,2,":");
30
                    // Verify that cache exists
31
                    if( instance.injector.containsInstance( 'Ortus#utilName'# ) ){
32
                        return instance.injector.getInstance( 'Ortus#utilName#' );
33
                    }
34
                    else if( instance.log.canDebug() ){
35
                        instance.log.debug("Cannot find named ortus utility #utilName# using definition: #arguments.definition.toString()#");
36
                    }
37
                    break;
38
                }
39
            } // end level 2 main DSL
40
        </cfscript>
41
    </cffunction>
42
​
43
</cfcomponent>
Copied!
As you can see from the sample, creating your own DSL builder is fairly easy. The benefits of a custom DSL builder is that you can very easily create and extend the injection DSL language to your own benefit and if you are funky enough, override the behavior of the internal DSL Namespaces.

Extending WireBox - Previous

Custom DSL

Registering a Custom DSL

Copy link