smcfsm.java

SMC takes a state machine stored in a .sm file and generates a State pattern in twelve programming l

//
// The contents of this file are subject to the Mozilla Public
// License Version 1.1 (the "License"); you may not use this file
// except in compliance with the License. You may obtain a copy
// of the License at http://www.mozilla.org/MPL/
// 
// Software distributed under the License is distributed on an
// "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
// implied. See the License for the specific language governing
// rights and limitations under the License.
// 
// The Original Code is State Machine Compiler (SMC).
// 
// The Initial Developer of the Original Code is Charles W. Rapp.
// Portions created by Charles W. Rapp are
// Copyright (C) 2000 - 2005. Charles W. Rapp.
// All Rights Reserved.
// 
// Contributor(s):
//   Eitan Suez contributed examples/Ant.
//   (Name withheld) contributed the C# code generation and
//   examples/C#.
//   Francois Perrad contributed the Python code generation and
//   examples/Python.
//   Chris Liscio contributed the Objective-C code generation
//   and examples/ObjC.
//
// RCS ID
// $Id: SmcFSM.java,v 1.7 2008/02/08 08:46:02 fperrad Exp $
//
// CHANGE LOG
// (See the bottom of this file.)
//

package net.sf.smc;

import java.io.PrintStream;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;

public final class SmcFSM
    extends SmcElement
{
//---------------------------------------------------------------
// Member methods
//

    public SmcFSM(String name)
    {
        // The abstract syntax tree always starts on line 1.
        super (name, 1);

        _startState = "";
        _source = "";
        _context = "";
        _header = "";
        _includeList = new ArrayList<String>();
        _package = null;
        _importList = new ArrayList<String>();
        _declareList = new ArrayList<String>();
        _accessLevel = "";
        _headerLine = -1;
        _maps = new ArrayList<SmcMap>();
    }

    public String getSource()
    {
        return (_source);
    }

    public void setSource(String source)
    {
        _source = source;
        return;
    }

    public int getHeaderLine()
    {
        return (_headerLine);
    }

    public void setHeaderLine(int line_number)
    {
        if (_headerLine < 0)
        {
            _headerLine = line_number;
        }

        return;
    }

    public String getStartState()
    {
        return (_startState);
    }

    public void setStartState(String state)
    {
        _startState = state;
        return;
    }

    public String getContext()
    {
        return (_context);
    }

    public void setContext(String context)
    {
        _context = context;
        return;
    }

    public String getHeader()
    {
        return (_header);
    }

    public void setHeader(String header)
    {
        char c = header.charAt(0);

        // If the header is not enclosed in quotes or <>, then
        // place quotes around the file now.
        if (c != '"' && c != '<')
        {
            _header = "\"" + header.trim() + "\"";
        }
        else
        {
            _header = header.trim();
        }

        _includeList.add(_header);

        return;
    }

    public List<String> getIncludes()
    {
        return (_includeList);
    }

    public void addInclude(String includeFile)
    {
        char c = includeFile.charAt(0);
        String filename;

        // If the header is not enclosed in quotes or <>, then
        // place quotes around the file now.
        if (c != '"' && c != '<')
        {
            filename = "\"" + includeFile.trim() + "\"";
        }
        else
        {
            filename = includeFile.trim();
        }

        _includeList.add(filename);
        return;
    }

    public String getPackage()
    {
        return (_package);
    }

    public void setPackage(String pkg)
    {
        _package = pkg;
        return;
    }

    public List<String> getImports()
    {
        return (_importList);
    }

    public void addImport(String name)
    {
        _importList.add(name);
        return;
    }

    public int getImportCount()
    {
        return (_importList.size());
    }

    public void addDeclare(String name)
    {
        _declareList.add(name);
        return;
    }

    public int getDeclareCount()
    {
        return (_declareList.size());
    }

    public List<String> getDeclarations()
    {
        return (_declareList);
    }

    public String getAccessLevel()
    {
        return (_accessLevel);
    }

    public void setAccessLevel(String accessLevel)
    {
        _accessLevel = accessLevel;
    }

    public SmcMap findMap(String name)
    {
        Iterator<SmcMap> mapIt;
        SmcMap map;
        SmcMap retval;

        for (mapIt = _maps.iterator(), retval = null;
             mapIt.hasNext() == true && retval == null;
            )
        {
            map = mapIt.next();
            if (map.getName().compareTo(name) == 0)
            {
                retval = map;
            }
        }

        return (retval);
    }

    public List<SmcMap> getMaps()
    {
        return (_maps);
    }

    public void addMap(SmcMap map)
    {
        _maps.add(map);
        return;
    }

    // Returns the list of all known transitions, all maps.
    public List<SmcTransition> getTransitions()
    {
        Comparator<SmcTransition> comparator =
            new Comparator<SmcTransition>()
            {
                public int compare(SmcTransition o1,
                                   SmcTransition o2)
                {
                    return(o1.compareTo(o2));
                }
            };
        List<SmcTransition> retval =
            new ArrayList<SmcTransition>();

        for (SmcMap map: _maps)
        {
            // Merge the new transitions into the current set.
            retval =
                Smc.merge(
                    map.getTransitions(), retval, comparator);
        }

        return (retval);
    }

    public boolean hasEntryActions()
    {
        for (SmcMap map: _maps)
        {
            if (map.hasEntryActions() == true)
            {
                return true;
            }
        }
        return false;
    }

    public boolean hasExitActions()
    {
        for (SmcMap map: _maps)
        {
            if (map.hasExitActions() == true)
            {
                return true;
            }
        }
        return false;
    }

    //-----------------------------------------------------------
    // SmcElement Abstract Methods.
    //

    public void accept(SmcVisitor visitor)
    {
        visitor.visit(this);
    }

    //
    // end of SmcElement Abstract Methods.
    //-----------------------------------------------------------

    public void dump(PrintStream stream)
    {
        stream.print("Start State: ");
        stream.println(_startState);
        stream.print("     Source:");
        if (_source.length() == 0)
        {
            stream.println(" none.");
        }
        else
        {
            stream.println();
            stream.println(_source);
        }
        stream.print("    Context: ");
        stream.println(_context);

        if (Smc._targetLanguage.hasHeaderFile() == true)
        {
            for (String include: _includeList)
            {
                stream.print("     Include: ");
                stream.println(include);
            }
        }

        stream.println("       Maps:");
        stream.println();

        for (SmcMap map: _maps)
        {
            stream.println(map);
        }

        return;
    }

//---------------------------------------------------------------
// Member data
//

    // The state map's initial state.
    private String _startState;

    // Raw source code appearing at the beginning of the state
    // map source file.
    private String _source;

    // This state map is associated with this class.
    private String _context;

    // Where the associated class is defined.
    private String _header;

    // For C++ only. List of include files. Will be output to
    // the .cpp file in the same order as they appear in the
    // .sm file.
    private List<String> _includeList;

    // This code is placed in this package/namespace.
    private String _package;

    // Place names of imports in this list.
    private List<String> _importList;

    // Place forward declarations in this list.
    private List<String> _declareList;

    // The context class access level. Empty string by default.
    private String _accessLevel;

    // The line where %start, etc. should appear.
    // Used in error messages.
    private int _headerLine;

    // The state maps.
    private List<SmcMap> _maps;
}

//
// CHANGE LOG
// $Log: SmcFSM.java,v $
// Revision 1.7  2008/02/08 08:46:02  fperrad
// C : optimize footprint when no Entry action or no Exit action
//
// Revision 1.6  2007/02/21 13:54:45  cwrapp
// Moved Java code to release 1.5.0
//
// Revision 1.5  2007/01/15 00:23:51  cwrapp
// Release 4.4.0 initial commit.
//
// Revision 1.4  2006/09/16 15:04:29  cwrapp
// Initial v. 4.3.3 check-in.
//
// Revision 1.3  2005/11/07 19:34:54  cwrapp
// Changes in release 4.3.0:
// New features:
//
// + Added -reflect option for Java, C#, VB.Net and Tcl code
//   generation. When used, allows applications to query a state
//   about its supported transitions. Returns a list of
//   transition names. This feature is useful to GUI developers
//   who want to enable/disable features based on the current
//   state. See Programmer's Manual section 11: On Reflection
//   for more information.
//
// + Updated LICENSE.txt with a missing final paragraph which allows
//   MPL 1.1 covered code to work with the GNU GPL.
//
// + Added a Maven plug-in and an ant task to a new tools
//   directory.
//   Added Eiten Suez's SMC tutorial (in PDF) to a new docs
//   directory.
//
// Fixed the following bugs:
//
// + (GraphViz) DOT file generation did not properly escape
//   double quotes appearing in transition guards. This has been
//   corrected.
//
// + A note: the SMC FAQ incorrectly stated that C/C++ generated
//   code is thread safe. This is wrong. C/C++ generated is
//   certainly *not* thread safe. Multi-threaded C/C++
//   applications are required to synchronize access to the FSM
//   to allow for correct performance.
//
// + (Java) The generated getState() method is now public.
//
// Revision 1.2  2005/06/30 10:44:23  cwrapp
// Added %access keyword which allows developers to set the
// generate Context class' accessibility level in Java and C#.
//
// Revision 1.1  2005/05/28 19:28:42  cwrapp
// Moved to visitor pattern.
//
// Revision 1.6  2005/02/21 15:35:11  charlesr
// Added Francois Perrad to Contributors section for Python work.
//
// Revision 1.5  2005/02/03 16:44:40  charlesr
// In implementing the Visitor pattern, the generateCode()
// methods have been moved to the appropriate Visitor
// subclasses (e.g. SmcJavaGenerator). This class is now
// extends SmcElement.
//
// Also changed this class name from SmcParseTree to SmcFSM.
//
// Revision 1.4  2004/10/30 16:06:54  charlesr
// Added Graphviz DOT file generation.
//
// Revision 1.3  2004/10/02 19:53:57  charlesr
// Removed "using namespace std" from the generated .cpp file.
// References to std namespace are fully-qualified with "std::".
// Also replaced all string concatenation from print statements.
//
// Revision 1.2  2004/09/06 16:40:49  charlesr
// Added C# support.
//
// Revision 1.1  2004/05/31 13:55:51  charlesr
// Added support for VB.net code generation.
//
// Revision 1.0  2003/12/14 21:04:51  charlesr
// Initial revision
//