Skip to main content

Automatically Triggering Code Generation From A DSL Model

If you've used Microsoft DSL Tools, you know that normally the user has to click 'Transform Templates' button in the Solution Explorer - to start running text templates on your DSL Model. Well, what if you need to trigger the code generation automatically, when ever the model changes? Here is a simple solution.

Firs of all, create a code generator class in your DSL Project - inheriting the TemplatedCodeGenerator. Override the GenerateCodeMethod. The first parameter is the DSL model filename against which you need to generate the code, and the second parameter is the template file content you may execute against your model. You can substitute the templateFileContent with your own template code. Here, I'm loading the same from my resource file.
[Guid("ECF4D6E6-0656-48d6-BD32-8F1EADD98D7F")]
    public class MyModelCodeGenerator : TemplatedCodeGenerator
    {

        protected override byte[] 
            GenerateCode(string modelFileName, string templateFileContent)
        {
                    // Replace the supplied file contents 
                    // with the template we want to run
                    templateFileContent=Resources.CodeGenTemplate; 
                    // Substitute the name of the current 
                    // model file into the template.
                    FileInfo fi = new FileInfo(modelFileName);
                    templateFileContent = templateFileContent.Replace
                                 ("%modelfile%", fi.Name);

                    // Now just delegate the rest of the 
                    //work to the base class
                    byte[] data = base.GenerateCode
                           (modelFileName, templateFileContent);
                    return data;
        }
    }

Interestingly, I'm replacing the token %modelfile% in my template content with the actual model file name. The template content I loaded from the resource file looks something like this.
<#@ template inherits="TextTemplating.VSHost.ModelingTextTransformation" #>
<#@ output extension=".cs" #>
<#@ MyDSL processor="MyDSLDirectiveProcessor" 
                requires="fileName='%modelfile%'" #>

//--- More Template Code --//


As the final step, we should specify our MyModelCodeGenerator as the code generator of our DSL Package, using the ProvideCodeGenerator attribute.

For this, create a partial class of your package in your DSLPackage project, and use the ProvideCodeGenerator attribute to register your generator.
    [ProvideCodeGenerator(typeof(MyModelCodeGenerator), 
         "MyModelCodeGenerator", "Generates code from the model", true)]
    internal sealed partial class MyDSLPackage
    {
    }


And you are done!!

Comments

Popular posts from this blog

Top 7 Coding Standards & Guideline Documents For C#/.NET Developers

Some time back, I collated a list of 7 Must Read, Free EBooks for .NET Developers, and a lot of people found it useful. So, I thought about putting together a list of Coding Standard guidelines/checklists for .NET /C# developers as well.As you may already know, it is easy to come up with a document - the key is in implementing these standards in your organization, through methods like internal trainings, Peer Reviews, Check in policies, Automated code review tools etc. You can have a look at FxCop and/or StyleCop for automating the review process to some extent, and can customize the rules based on your requirements.Anyway, here is a list of some good Coding Standard Documents. They are useful not just from a review perspective - going through these documents can definitely help you and me to iron out few hidden glitches we might have in the programming portion of our brain. So, here we go, the listing is not in any specific order.1 – IDesign C# Coding StandardsIDesign C# coding stand…

Creating a quick Todo listing app on Windows using IIS7, Node.js and Mongodb

As I mentioned in my last post, more and more organizations are leaning towards Web Oriented Architecture (WOA) which are highly scalable. If you were exploring cool, scalable options to build highly performing web applications, you know what Node.js is for.After following the recent post from Scott Hanselman, I was up and running quickly with Node.js. In this post, I’ll explain step by step how I’ve setup Node.js and Mongodb to create a simple Todo listing application.Setting up Node.jsThis is what I’ve done.1 – Goto http://nodejs.org/, scroll down and download node.exe for Windows, and place it in your c:\node folder2 – Goto IIS Node project in Git at https://github.com/tjanczuk/iisnode, download the correct ‘retail’ link of IIS Node zip file (I downloaded the already built retail package, otherwise you can download and build from the source).3 – Extract the zip file some where, and run the install.bat or install_iisexpress.bat depending on your IIS Version. If you don’t have IIS in…

5 Awesome Learning Resources For Programmers (To help you and your kids to grow the geek neurons)

Happy New Year, this is my first post in 2012. I’ll be sharing few awesome learning resources I’ve bookmarked, and will be pointing out some specific computer/programming related courses I've found interesting from these resources.Also, thought about saving this blog post for my kids as well - instead of investing in these Child education schemes (though they are too small as of today, 2 years and 60 days respectively ). Anyway, personally my new year resolution is to see as much videos from this course collections (assuming I can find some free time in between my regular job && changing my babies diapers).1 – Khan AcademyAs I mentioned some time back, you and your kids are missing some thing huge if you havn’t heard about Khan Academy.  It is an awesome learning resource, especially if you want to re-visit your basics in Math, Science etc.With a library of over 2,600 videos covering everything from arithmetic to physics, finance, and history and 268 practice exercises, th…