Channels ▼

Al Williams

Dr. Dobb's Bloggers

State Machine Compilation

October 09, 2012

I've mentioned a few times before that I'm always a little surprised that I don't see more developers writing code as state machines. A lot of embedded systems really lend themselves to state machine descriptions and, as I've demonstrated before (click here and here), it is easy to write some simple tools to handle state machines.

This week I ran into a SourceForge project called SMC or the State Machine Compiler. It allows you to describe your state machine more in a simple language (it reminds me a little of writing yacc grammars) and then compile it into code suitable for different target languages. Although the compiler itself uses Java, it can emit code for C++, C#, Objective C, and even C. It also can handle Python, Ruby, Lua, and a handful of other languages including, of course, Java and JavaScript.

I haven't tried the program on a real project yet, but it seems pretty easy to use. Here's an example from one of the getting started tutorials:

%class Turnstile
%package turnstile

%start MainMap::Locked

%map MainMap
  coin Unlocked { unlock(); }
  pass nil   { alarm(); }
   Pass Locked { lock(); }
   coin nil { thankyou(); }

You can probably puzzle this out. It represents a simple state machine for a turnstile. The %class statement tells the compiler what the name of the class is that you will provide (it creates some classes based on this name, too).

The turnstile starts in the locked state. If a coin appears, it unlocks the gate (the unlock() action) and moves to the Unlocked state. If someone passes through while it is locked, no state change occurs (nil), but an alarm sounds.

When the turnstile is unlocked, someone passing will cause the turnstile to lock again. A new coin calls thankyou().

You specify the target language when you compile. Here's a line I used to compile the above source:

java –jar bin/Smc.jar –java –d ddj ddj/

The –java argument would change, of course, if I were using a different language. I won't reproduce the compiler output here (you can download it online) but it created a class named turnContext. There is also an abstract class called TurnstileState. The context object accepts calls that indicate events (like the coin and pass events). It, in turn, calls back to its owner to implement any actions.

That means in your code, you have to instantiate a context and call the event functions as needed. You also implement the actions, usually in the same class.

The documentation touts that you can write one state machine and compile it for many different languages. I'm sure that is somewhat true, but I did notice that a C++ compile needed a statement (%header) that the Java code didn't require. Of course, the output code for each language is different. I compiled for C and — naturally — there are no classes in C, so you wind up with lots of global functions and #defines (along with a header).

Are you using state machines in your designs? Do you use a tool and if not, would you use something like SMC? I haven't answered that last question myself yet, but I'll let you know.

Related Reading

More Insights

Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.