SMC

SMC - The State Machine Compiler Version 7.2.0 http://smc.sourceforge.net What's New? Major changes: None. Minor changes: None. Bug Fixes: (C) C code generator creates an unused default transition function. This is corrected by having that default ... [More] transition function referenced. (SF bug 224) (C) C code generator places ENTRY_STATE and EXIT_STATE macros in the .c file which may result in a link failure. This is corrected by moving the macros to the generated header file. (SF bug 225) [Less]

SMC - The State Machine Compiler Version 6.6.3 http://smc.sourceforge.net What's New? Major changes: None. Minor changes: None. Bug Fixes: (C) Generated macro "EnterStartState" in _sm.h incorrectly referenced "ENTRY_STATE" in _sm.c, causing ... [More] the C compilation to fail. This incorrect and unnecessary reference is now removed from "EnterStartState". (SF bug 214) (Graphviz) The Graphviz option "-glevel 1|2" generated an invalid .dot file when a .sm file contained a transition with multiple definitions in the same state where one of the definitions was an inner loopback and the other was not. This error was due to the previous correction for SF bug 213. (SF bug 215) [Less]

SMC v. 6.6.2 SMC The State Machine Compiler (Version: 6.6.2) http://smc.sourceforge.net What's New? Major changes: None. Minor changes: None. Bug Fixes: (Graphviz) ... [More] The Graphviz option "-glevel 1|2" generated an invalid .dot file when a .sm file contained a state Entry or Exit actions. This error was due to the previous correction for SF bug 211 and misplaced the generated Entry/Exit action code in the transition section rather than in the map subgraph. (SF bug 213) [Less]

SMC v. 6.6.1 0. What's New? Major changes: None. Minor changes: None. Bug Fixes: (All) smc-anttask now recognizes all currently supported SMC target languages. (SF bug 207, 208) (Objective C) getPreviousState() now returns the ... [More] correct value after a transition completes. (SF bug 209) (C++ using -crtp) When using -crtp, the generated code now outputs the correct getOwner() methods: inline DERIVED& getOwner() {...} inline const DERIVED getOwner() const {...} (SF bug 210) (Graphviz) The Graphviz .dot file now defines all transitions after defining subgraphs. This corrects the problem of subgraphs containing incorrect states due to jump transitions between subgraphs. (SF bug 211) (All) Corrected Makefile and smc.mk so that staging/Release directory is automatically created if it does not already exist. Also added macros to smc.mk which specify the Java source and target versions. (SF bug 212) 1. System Requirements JRE (Standard Edition) 1.7.0 or better. Whatever JRE's requirements are (see http://java.sun.com/j2se/ for more information). SMC is dual licensed under Mozzile Public License, version 1.1 and GNU General Public License, version 2.0. See the file LICENSE.txt for more information. 2. Introduction If you use state machines to define your objects behavior and are tired of the time-consuming, error-prone work of implementing those state machines as state transition matrices or widely scattered switch statements, then SMC is what you're looking for. SMC takes a state machine definition and generates State pattern classes implementing that state machine. The only code you need to add to your object is 1) create the state machine object and 2) issue transitions. ITS THAT EASY. NO, you don't have to inherit any state machine class. NO, you don't have to implement any state machine interface. YES, you add to your class constructor: _myFSM = new MyClassContext(this); YES, you issue state transitions: _myFSM.HandleMessage(msg); Congratulations! You've integrated a state machine into your object. SMC is written in Java and is truly "Write once, run anywhere". If you have at least the Java Standard Edition v. 1.6.0 loaded, then you can run SMC (if you have the Java Enterpise Edition, so much the better!) Java Standard Edition can be downloaded for FREE from http://java.sun.com/j2se/ SMC currently supports fourteen programming languages: 1. C, 2. C++, 3. C#, 4. Groovy, 5. Java, 6. Lua, 7. Objective-C, 8. Perl, 9. PHP, 10. Python, 11. Ruby, 12. Scala, 13. [incr Tcl] and 14. VB.Net. SMC is also able to generate an HTML table representation of your FSM and a GraphViz DOT file representation (http://www.graphviz.org). 3. Download Surf over to http://smc.sourceforge.net and check out "File Releases". The latest SMC version is 6.0.0. SMC downloads come in two flavors: tar/gzip (for Unix) and self-extracting zip file (for Windows). The download package contains the executable Smc.jar and supporting library: statemap.h (for C++), statemap.jar (for Java), statemap.tcl & pkgIndex.tcl (for Tcl), statemap.dll (for VB.Net) and statemap.dll (for C#). NOTE: Only the SMC-generated code uses these libraries. Your code doesn't even know they exist. However, when compiling your application, you will need to add a -I or -classpath ...: to your compile command (when running you Java application, you also need to add statemap.jar to your classpath). The download package's directory layout is: Smc -+-LICENSE.txt | +-README.txt | +-bin---Smc.jar | +-docs-+-SMC_Tutorial.pdf | | | +-javadocs--(javadoc html files) | +-lib-+-statemap.h | | | +-statemap.jar | | | +-C---statemap.h | | | +-C++---statemap.h | | | +-DotNet-+-Debug-+-NoTrace-+-statemap.dll | | | | | | | | | +-statemap.pdb | | | | | | | +-Trace---+-statemap.dll | | | | | | | +-statemap.pdb | | | | | +-Release-+-NoTrace--statemap.dll | | | | | +-Trace----statemap.dll | | | +-Java-+-SmcGenerator.jar | | | | | +-SmcModel.jar | | | | | +-SmcParser.jar | | | | | +-statemap.jar | | | | | +-statemap-+-FSMContext.class | | | | | +-State.class | | | | | +-StateUndefinedException.class | | | | | +-TransitionUndefinedException.class | | | +-Lua--+-README | | | | | +-statemap.h | | | +-ObjC-+-README.txt | | | | | +-statemap.h | | | | | +-statemap.m | | | +-Perl-+-MANIFEST | | | | | +-Makefile.pl | | | | | +-README | | | | | +-Statemap.pm | | | | | +-test.pl | | | +-Php-+-README.txt | | | | | +-package.xml | | | | | +-statemap.php | | | +-Python-+-README.py | | | | | +-setup.py | | | | | +-statemap.py | | | +-Ruby-+-README | | | | | +-statemap.rb | | | +-Scala-+-statemap.jar | | | | | +-statemap.scala | +-Tcl-+-statemap1.0-+-statemap.tcl | | | +-pkgIndex.tcl | +-misc-+-smc.ico (smc Windows icon) | +-examples-+-Ant--+-EX1 (Java source code, Ant built) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX5 | | | | | +-EX6 | | | | | +-EX7 | | | +-C----+-EX1 (C source code, Makefiles) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | +-C++--+-EX1 (C++ source code, Makefiles) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX5 | | | | | +-EX6 | | | +-CSharp-+-EX1 (C# source code) | | | | | +-EX2 | | | | | +-EX3 | | | +-Java-+-EX1 (Java source code, Makefiles) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX5 | | | | | +-EX6 | | | | | +-EX7 | | | +-Lua--+-EX1 (Lua source code) | | | | | +-EX2 | | | | | +-EX3 | | | +-ObjC-+-EX1 (Objective C source code) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX5 | | | | | +-EX7 (Mac OSX XCode Project) | | | +-Perl-+-EX1 (Perl source code) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX7 | | | | | +-Python-+-EX1 (Python source code) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX7 | | | +-Ruby-+-EX1 (Ruby source code) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX7 | | | +-Tcl--+-EX1 (Tcl source code) | | | | | +-EX2 | | | | | +-EX3 | | | | | +-EX4 | | | | | +-EX5 | | | +-VB---+-EX1 (VB.Net source code) | | | +-EX2 | | | +-EX3 | | | +-EX4 | +-tools-+-maven-+-plugin.jelly | | | +-plugin.properties | | | +-project.xml | +-smc-anttask-+-.classpath | +-.project | +-build.xml | +-smc-anttask.iml | +-smc-anttask.ipr | +-smc-anttask.iws | +-build---classes---... | +-dist---smc-ant.jar | +-lib---ant.jar | +-src---net---sf---smc---ant---SmcJarWrapper.java 4. Installation After downloading SMC (either tar/gzip or self-extracting zip file), you install SMC as follows: Figure out where you can to load the Smc directory and place the SMC package there. If you already have an "smc" directory/folder, change its name to something like "smc_old" or "smc_1_2_0". This will prevent its contents from being overwritten in case you want to back out of the new version. Once you are satisfied with the new version, you may delete the old SMC. Load the SMC package: (Unix) $ tar xvfz Smc_6_0_0.tgz (Windows) running Smc_6_0_0.zip You're done! There really is nothing more that needs to be done. You may want to take the following steps. Add the full path to .../Smc/bin to your PATH environment variable. Add the full path to statemap.jar to your CLASSPATH environment variable. Add the full path to .../Smc/lib to your TCLLIBPATH environment variable. The tools directory includes a Maven plug-in (http://www.maven.org) and an ant task to help integrate SMC into other development environments. An Eclipse plug-in is not yet available. 5. Examples The examples directory contains example SMC-based applications. The examples range from trivial (EX1) to sophisticated (EX5). Use these examples together with the SMC Programmer's Guide to learn how to use SMC. The C++ examples provide Makefiles, Microsoft DevStudio 6.0 workspace and DevStudio 7.0 solution. The Java examples in examples/Java use "make" for building. The same examples also appear in examples/Ant and use "ant". The [incr Tcl] examples are not built and require you to execute "java -jar Smc.jar" by hand. The VB.Net and C# examples use DevStudio 7.0. To learn more about each example and how to build & run each one, read the example's README.txt. 6. FAQ/Documentation/Reporting Bugs/Latest News Surf over to http://smc.sourceforge.net to: Read the SMC Frequently Asked Questions (FAQ). Download documentation - including the SMC Programmer's Guide. Talk with other SMC users in Public Forums. Report bugs. Get the latest news about SMC. Access SMC source code via a CVS web interface. Check out docs/SMC_Tutorial.pdf. 7. Notices This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative. [Less]

A PDF version of the SMC Programmer's Manual is now available for download under Files > SMC Programmer_s Manual > 6_6_0. It is available for SMC v. 6.6.0 only and not for previous versions.

SMC - The State Machine Compiler v. 6.6.0 Major changes: [C++] Added a new "-crtp" (Curiously Recurring Template Pattern) option making FSM integration into an application easier and more efficient. Instead of the user class containing ... [More] an FSM data member like "AppClassContext _fsm", the user class publicly inherits the context like: class AppClass : public AppClassContext A transition is issued by calling the transition method directly rather than through the _fsm data member. So the call "_fsm.Open()" becomes "Open()". This removes one layer of indirection from user code. All C++ examples had their Makefiles updated to include two macros for the CRTP feature. Uncomment these macros and compile to see how this feature works. [C++] Added a new "-stack max-state-stack-depth" option. This option generates a fixed-size state stack with the specified maximum depth. No dynamic memory is allocated for the state stack. Caveat: use this option only if 1) your FSM uses the push transition, and 2) your push transitions can only reach a well-defined maximum limit. Conversely, if your FSM does not use push transitions or your push limit is unbounded, then do not use this option. This option can be used in combination with "-noex" to create a C++ FSM which performs no dynamic memory allocation (since C++ exceptions automatically use dynamic memory allocation.) C++ example EX3 was updated to demonstrate this feature. Minor changes: (All) Added a new directive "%fsmfile" and modified the behavior or "%fsmclass". Previously, directive "%fsmclass" set both the FSM class name and file name. Now "%fsmclass" sets only the FSM class name and "%fsmfile" sets the file name in which it is stored. (C#) Added the attribute [System.CodeDom.Compiler.GeneratedCode("smc", "x.x.x")] to each generated class. This attribute is used by source analyzers such as FxCop. (Java) Updated -java7 -reflection to emit a public final class for each map. This class contains a public static final State7 field for each of the map's states. The purpose behind this feature is to restore the ability to reference states as ".". When using -java7, it is preferable to reference a state using the integer constant named "__STATE_ID". Bug Fixes: (All) The -version command line option returns the wrong version. (SF bug 202) (Java) -java7 generates invalid code for transitions with generic parameters. (SF bug 203) (Php) Using -php and -reflect emits an incorrect name for the Default state. In Php, the Default state is named "Default_" so as not to conflict with a Php reserved word. (SF bug 204) (Php) The previous state is not set in action-less transitions. (SF bug 205) (Java) -java7 does not correctly fall through to the Default transition. This is due to the actual transition having a different method signature than the Default transition (which has not parameters). (SF bug 206) ++++++++++++++++++++++++++++++++++++++++ If you have any questions or bugs, please surf over to http://smc.sourceforge.net and check out the discussion and bug forums. Note: you must be a SourceForge member to add articles or bugs. You do not have to be a member to read posted articles or bugs. [Less]

SMC - The State Machine Compiler v. 6.5.0 Major changes: (Java) Added a new "-java7" target language. This version represents the FSM as a transition table. The transition table maps the current state and the transition to a ... [More] java.lang.invoke.MethodHandle. The transition is executed by calling MethodHandle.invokeExact, which is only slightly slower than a compiled method call. The -java7 generated code is compatible with -java generated code. This allows developers to switch between the two without changing application code. NOTE: -java7 requires Java 1.7 or latter to run. Minor changes: (None.) Bug Fixes: (Objective-C) Incorrect initWithOwner body generated. Same fundamental problem as SF bug 200. See below. (SF bug 198) (Website) Corrected broken link in FAQ page. (SF bug 199) (C++) Corrected the invalid generated FSM class name. (SF bug 200) (C) EXIT_STATE() #define macro not generated. (SF bug 201) (Manual) Corrected examples which showed %fsmclass and %map set to the same name. This is invalid for most target languages since that would mean the nested map class would have the same name as the containing FSM class. ++++++++++++++++++++++++++++++++++++++++ If you have any questions or bugs, please surf over to http://smc.sourceforge.net and check out the discussion and bug forums. Note: you must be a SourceForge member to add articles or bugs. You do not have to be a member to read posted articles or bugs. [Less]

SMC v. 6.4.0 SMC - The State Machine Compiler v. 6.3.0 Major changes: (None.) Minor changes: (None.) Bug Fixes: (C++) When using -d and -headerd together, the generated .cpp file contains an incorrect #include for the generated .h file. ... [More] (SF bug 190) (Windows) Java's String.split(File.separator) throws an exception when passed a Windows file path using "\" because the backslash is a special regular expression character. Resolved this issue by passing Pattern.quote(File.separator) to String.split. (SF bug 191) (C#) Removed the "[NonSerialized]" marker from the FSMContext data members "name_", "state_", and "stateStack_" which prevented correct state machine serialization. Removed the deprecated FSMContext data members "debugFlag_" and "debugStream_" since they were long ago replaced by System.Diagnostics.Trace. (SF bug 193) ++++++++++++++++++++++++++++++++++++++++ If you have any questions or bugs, please surf over to http://smc.sourceforge.net and check out the discussion and bug forums. Note: you must be a SourceForge member to add articles or bugs. You do not have to be a member to read posted articles or bugs. [Less]

SMC v. 6.4.0 SMC - The State Machine Compiler v. 6.3.0 Major changes: (None.) Minor changes: (None.) Bug Fixes: (C++) When using -d and -headerd together, the generated .cpp file contains an incorrect #include for the generated .h file. ... [More] (SF bug 190) (Windows) Java's String.split(File.separator) throws an exception when passed a Windows file path using "\" because the backslash is a special regular expression character. Resolved this issue by passing Pattern.quote(File.separator) to String.split. (SF bug 191) (C#) Removed the "[NonSerialized]" marker from the FSMContext data members "name_", "state_", and "stateStack_" which prevented correct state machine serialization. Removed the deprecated FSMContext data members "debugFlag_" and "debugStream_" since they were long ago replaced by System.Diagnostics.Trace. (SF bug 193) ++++++++++++++++++++++++++++++++++++++++ If you have any questions or bugs, please surf over to http://smc.sourceforge.net and check out the discussion and bug forums. Note: you must be a SourceForge member to add articles or bugs. You do not have to be a member to read posted articles or bugs. [Less]

Happy Labor Day! SMC - The State Machine Compiler v. 6.3.0 Major changes: (None.) Minor changes: (Java) Cleaned up generated Java code so that there are no more warnings about the code. (SF feature 92) (Java) Added flag -generic7 ... [More] which uses <> braces for allocated generic classes. (SF feature 92) Bug Fixes: (All) Corrected a fatal error when "-headerd ." is specified. (SF bug 189) (Objective-C) Added "__weak" to the owner object reference to allow the owner to be decommissioned. (SF bug 188) ++++++++++++++++++++++++++++++++++++++++ If you have any questions or bugs, please surf over to http://smc.sourceforge.net and check out the discussion and bug forums. Note: you must be a SourceForge member to add articles or bugs. You do not have to be a member to read posted articles or bugs. [Less]