smccodegenerator.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) 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: SmcCodeGenerator.java,v 1.7 2008/04/24 15:41:12 fperrad Exp $
//
// CHANGE LOG
// (See the bottom of this file.)
//

package net.sf.smc;

import java.io.PrintStream;
import java.io.StringWriter;
import java.util.Iterator;
import java.util.List;
import java.text.MessageFormat;

/**
 * Base class for all target language code generators.
 * @see SmcElement
 * @see SmcVisitor
 *
 * @author <a href="mailto:[e-mail]">Charles Rapp</a>
 */

public abstract class SmcCodeGenerator
    extends SmcVisitor
{
//---------------------------------------------------------------
// Member methods
//

    // Constructs the target code generator.
    protected SmcCodeGenerator(String srcfileBase,
                               String sourceNameFormat,
                               String suffix)
    {
        super ();

        _srcfileBase = srcfileBase;
        _sourceNameFormat = sourceNameFormat;
        _suffix = suffix;
        _source = null;
        _indent = "";
        _guardCount = 0;
        _guardIndex = 0;
    }

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

    // Scope the state name. If the state is unscoped, then
    // return "<mapName>.<stateName>". If the state named
    // contains the scope string "::", replace that with a ".".
    protected String scopeStateName(String stateName,
                                    String mapName)
    {
        int index;
        StringWriter retval = new StringWriter();

        index = stateName.indexOf("::");
        if (index < 0)
        {
            retval.write(mapName);
            retval.write(".");
            retval.write(stateName);
        }
        else
        {
            retval.write(stateName.substring(0, index));
            retval.write('.');
            retval.write(stateName.substring(index + 2));
        }

        return (retval.toString());
    }

    // Returns true if this transition is a loopback and false
    // otherwise. If this is a loopback, then do not perform the
    // exit and entry actions.
    protected boolean isLoopback(int transType,
                                 String currentState,
                                 String endState)
    {
        return ((transType == Smc.TRANS_SET ||
                 transType == Smc.TRANS_PUSH) &&
                 endState.equals(NIL_STATE) == true);
    }

    // Returns true if each of the transition guards uses
    // the nil end state.
    protected boolean allNilEndStates(List<SmcGuard> guards)
    {
        Iterator<SmcGuard> git;
        SmcGuard guard;
        boolean retcode = true;

        for (git = guards.iterator();
             git.hasNext() == true && retcode == true;
            )
        {
            guard = git.next();
            retcode =
                (guard.getTransType() == Smc.TRANS_SET &&
                 (guard.getEndState()).equals("nil") == true);
        }

        return (retcode);
    }

    public String sourceFile(String path,
                             String basename,
                             String suffix)
    {
        if (suffix == null)
        {
            suffix = _suffix;
        }

        MessageFormat formatter =
            new MessageFormat(_sourceNameFormat);
        Object[] args = new Object[3];

        args[0] = path;
        args[1] = basename;
        args[2] = suffix;

        return (formatter.format(args));
    }

//---------------------------------------------------------------
// Member data
//
    private final String _sourceNameFormat;

    // Append this suffix to the end of the output file.
    private static String _suffix;

    // Emit the target source code to this file.
    protected PrintStream _source;

    // The .sm file's base name.
    protected final String _srcfileBase;

    // Output this indent before generating a line of code.
    protected String _indent;

    // This information is common between the transition and
    // guard visitor methods.
    protected int _guardCount;
    protected int _guardIndex;

    //-----------------------------------------------------------
    // Constants.
    //
    /* package */ static final String NIL_STATE = "nil";
}

//
// CHANGE LOG
// $Log: SmcCodeGenerator.java,v $
// Revision 1.7  2008/04/24 15:41:12  fperrad
// + new feature #1876271 : SMC Loopback
//
// Revision 1.6  2008/03/21 14:03:16  fperrad
// refactor : move from the main file Smc.java to each language generator the following data :
//  - the default file name suffix,
//  - the file name format for the generated SMC files
//
// Revision 1.5  2007/12/28 12:34:41  cwrapp
// Version 5.0.1 check-in.
//
// Revision 1.4  2007/02/21 13:54:20  cwrapp
// Moved Java code to release 1.5.0
//
// Revision 1.3  2007/01/15 00:23:50  cwrapp
// Release 4.4.0 initial commit.
//
// Revision 1.2  2006/09/16 15:04:28  cwrapp
// Initial v. 4.3.3 check-in.
//
// Revision 1.1  2005/05/28 19:28:42  cwrapp
// Moved to visitor pattern.
//
// Revision 1.2  2005/02/21 15:34:54  charlesr
// Added Francois Perrad to Contributors section for Python work.
//
// Revision 1.1  2005/02/21 15:11:47  charlesr
// Moved isLoopback() method from SmcGuard to this class.
// Added additional parameters.
//
// Revision 1.0  2005/02/03 17:09:49  charlesr
// Initial revision
//