Skip to main content

Roslyn shopping cart DSL - Part 2


In this post I will be reviewing some considerations that I usually have in mind while designing a DSL.

The audience
When you are working on a DSL, the first and most important thing to have in mind is the audience you are aiming for. It’s gonna be technical people, business executives, sales people, etc…, etc….

The syntax
If the audience is not a bunch of techies, here is set of design rules that you should follow (at least, they've worked out for me):
  • The syntax should be as much as closest to the domain terms that the user uses on a daily basis.
  • Use sentences like “when something_happen:” instead of “if (somethingHappen){..}”.
  • Use logical operators like “and”, “or” instead of “&&”, “||”.
  • Don't make your syntax case sensitive.
  • snake_case works better than PascalCase.
  • When syntax error happen (and it will happen) provide useful messages that lead the user to the right path.
  • Try to avoid the use of parentheses as much as you can. (our users are not Lisp programmers ;))
  • You are not building a general purpose language. Avoid loops, conditionals and variables as much as you can. Keep your DSL Turing incomplete.

Working with scripts
  • Build a professional script editor (Notepad sucks, big time)
  • Use different icons to differentiate conditions from actions.
  • Provide an autocomplete mechanism and syntax highlight.
  • Don't try to build your own version of VS. It will take a butt load of time, and most of the features you built will never be used.
  • Provide a versioning mechanism for scripts.

This is how it looks the editor provided with the sample app of this post.

The main component of the editor is a control called “Fast Colored TextBox” created by Pavel Torgashov, all the credits to this guy, the control is awesome and works like a charm.

How you will go from your DSL syntax to executable code
In this post I’m working with a technique called “source to source translation”, this means that I’ll be converting code from our DSL syntax into C# code in order to feed the Roslyn compiler.

Note: The code provided with this post does not cover in deep how source to source translation works nor is a full or complete solution, it’s just going to work with the example I’m showing and maybe give you a starting point, but nothing else.

You can get the source code from github using this link

Comments

  1. I compile and run your demo application. When I type "when", I don't get the autocomplete menu.

    ReplyDelete
    Replies
    1. In order to popup the autocompletion list you should hit Ctrl+Space. It' a pretty common shortcut in old editors. (although, it's not that friendly for end users.... my bad on that one ;))

      Delete
  2. This comment has been removed by the author.

    ReplyDelete

Post a Comment

Popular posts from this blog

Migrating an ASP.NET MVC 4 app from Azure websites to WinHost

About a week ago I've to migrate an ASP.NET MVC 4/EF5 application from Azure websites to WinHost. While the process was really smooth, there were some caveats related to database connections that I want to share with you. Create and setup the ftp profile on VS and configure the connection string was really easy, WinHost provide you those values and there is nothing special here. But once you deploy your website and try to see it online, you may get the “yellow screen of dead” with the message: "A network-related or instance-specific error occurred while establishing a connection to SQL Server. The server was not found or was not accessible. Verify that the instance name is correct and that SQL Server is configured to allow remote connections. (provider: SQL Network Interfaces, error: 26 - Error Locating Server/Instance Specified)" Assuming you wrote the connection string properly, this happens because you cannot use the default connection name in your web.c

Moving to Medium

It's been a long time since I want to give medium a try, and finally, I made some time to do it. To get started on the new platform, I'll be doing series on "Getting programming concepts, languages and tools". If it sounds interesting to you, please take a look at the first post  Getting AWK  and spread the word if you like it. I'm not going to migrate old entries to the new web site. They will remain here safe and sound! As usual, thanks for reading!

How to show excel files inside the .NET Webbrowser Control

If you are reading this, chances are you been banging your head against the wall for a couple of hours (or even days) trying to show excel files inside the WinForms webbrowser control. Possible reasons you ended up in here: You had working code that got broke after upgrading from Win 7. Your code doesn’t work the same way between machines running different (newer) versions of IE. A download box pops up every time your app tries to show an excel file inside the webbrowser control (you wanna show the actual content). You just have no clue on how to get excel working into the .NET embedded webbrowser control. You are trying to implement IInternetSecurityManager and don’t know where to start. (Or how don’t know how to delegate calls to your security manager). Among many other, maybe….. Yes, COM is a PITA, so is ActiveX and IE (Embedded or full for that matter). And no, showing excel files inside the webbrowser control shouldn’t be that hard, but sometimes we have