net.sourceforge.anotherfsm.qfsm

Class CodeGenerator

java.lang.Object

net.sourceforge.anotherfsm.qfsm.CodeGenerator

public class CodeGenerator
extends java.lang.Object

The code generator main class.

Author:

Michal Turek

Field Summary

Fields

Modifier and Type	Field and Description
private Configuration	configuration Configuration of generator.
private static java.lang.String	FSM_CLASS_SUFFIX Suffix of generated state machine class name.
private static FsmLogger	logger The logger.
private QfsmMachine	machine Qfsm state machine.
private CodeGeneratorParameters	parameters Program parameters.
private static java.lang.String	PROCESSOR_CLASS_SUFFIX Suffix of generated processor class name.
private QfsmProject	qfsm Qfsm data file.
private static boolean	systemExitCallAllowed Helper flag for unit tests to disable System.exit() calls.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CodeGenerator(CodeGeneratorParameters parameters) Create the object.

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.String	formatPrompt(java.lang.String[] args)
private void	generateProcessor()
private void	genFsmFile() Generate the state machine file.
private java.lang.String	genGlobalStateListeners() Generate the global state listener.
private java.lang.String	genGlobalTransitionListener() Generate the global transition listener.
private java.lang.String	genStateDeclarations() Generate declarations of states.
private java.lang.String	genStateInitializations() Generate initializations of states.
private java.lang.String	genStateListeners() Generate the state listeners.
private java.lang.String	genTransitionDeclarations() Generate declarations of transitions.
private java.lang.String	genTransitionInitializations() Generate initializations of transitions.
private java.lang.String	genTransitionListeners() Generate the transition listeners.
private java.lang.String	identifier(QfsmState state) Generate a Java identifier from a state.
private java.lang.String	identifier(QfsmTransition transition) Generate a Java identifier from a transition.
private java.lang.String	identifier(java.lang.String str) Generate a Java identifier from a string.
private static java.lang.String	loadTemplate(java.lang.String name) Load a template for the code generation.
static void	main(java.lang.String[] args) The program enter.
(package private) static void	setSystemExitCallAllowed(boolean systemExitCallAllowed) Enable/disable System.exit() calls.
private static void	writeFile(java.io.File file, java.lang.String content, boolean force) Write a text file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static final FsmLogger logger

The logger.

systemExitCallAllowed

private static boolean systemExitCallAllowed

Helper flag for unit tests to disable System.exit() calls.

FSM_CLASS_SUFFIX

private static final java.lang.String FSM_CLASS_SUFFIX

Suffix of generated state machine class name.

See Also:

Constant Field Values

PROCESSOR_CLASS_SUFFIX

private static final java.lang.String PROCESSOR_CLASS_SUFFIX

Suffix of generated processor class name.

See Also:

Constant Field Values

parameters

private final CodeGeneratorParameters parameters

Program parameters.

configuration

private final Configuration configuration

Configuration of generator.

qfsm

private final QfsmProject qfsm

Qfsm data file.

machine

private final QfsmMachine machine

Qfsm state machine.

Constructor Detail

CodeGenerator

private CodeGenerator(CodeGeneratorParameters parameters)
               throws QfsmException

Create the object.

Parameters:

parameters - program arguments

Throws:

QfsmException

Method Detail

genFsmFile

private void genFsmFile()
                 throws QfsmException

Generate the state machine file.

Throws:

QfsmException - if something fails

generateProcessor

private void generateProcessor()
                        throws QfsmException

Throws:

QfsmException

genStateDeclarations

private java.lang.String genStateDeclarations()
                                       throws QfsmException

Generate declarations of states.

Returns:

the string representation of declarations

Throws:

QfsmException - if something fails

genStateInitializations

private java.lang.String genStateInitializations()
                                          throws QfsmException

Generate initializations of states.

Returns:

the string representation of initializations

Throws:

QfsmException - if something fails

genStateListeners

private java.lang.String genStateListeners()
                                    throws QfsmException

Generate the state listeners.

Returns:

the string representation of listeners

Throws:

QfsmException - if something fails

genGlobalStateListeners

private java.lang.String genGlobalStateListeners()
                                          throws QfsmException

Generate the global state listener.

Returns:

the string representation of listener

Throws:

QfsmException - if something fails

genTransitionDeclarations

private java.lang.String genTransitionDeclarations()
                                            throws QfsmException

Generate declarations of transitions.

Returns:

the string representations of declarations

Throws:

QfsmException - if something fails

genTransitionInitializations

private java.lang.String genTransitionInitializations()
                                               throws QfsmException

Generate initializations of transitions.

Returns:

the string representation of initializations

Throws:

QfsmException - if something fails

genTransitionListeners

private java.lang.String genTransitionListeners()
                                         throws QfsmException

Generate the transition listeners.

Returns:

the string representation of listeners

Throws:

QfsmException - if something fails

genGlobalTransitionListener

private java.lang.String genGlobalTransitionListener()
                                              throws QfsmException

Generate the global transition listener.

Returns:

the string representation of listener

Throws:

QfsmException - if something fails

writeFile

private static void writeFile(java.io.File file,
             java.lang.String content,
             boolean force)
                       throws QfsmException

Write a text file.

Parameters:

file - the destination file

content - the text content of the file

force - rewrite existing file

Throws:

QfsmException - if something fails

identifier

private java.lang.String identifier(java.lang.String str)

Generate a Java identifier from a string.

Parameters:

str - the input string

Returns:

the generated Java identifier

identifier

private java.lang.String identifier(QfsmState state)

Generate a Java identifier from a state.

Parameters:

state - the state

Returns:

the Java identifier

identifier

private java.lang.String identifier(QfsmTransition transition)

Generate a Java identifier from a transition.

Parameters:

transition - the transition

Returns:

the Java identifier

loadTemplate

private static java.lang.String loadTemplate(java.lang.String name)
                                      throws QfsmException

Load a template for the code generation.

Parameters:

name - the path in file system or in jar package

Returns:

the text content of the template file

Throws:

QfsmException - if something fails

formatPrompt

private static java.lang.String formatPrompt(java.lang.String[] args)

setSystemExitCallAllowed

static void setSystemExitCallAllowed(boolean systemExitCallAllowed)

Enable/disable System.exit() calls.

Parameters:

systemExitCallAllowed - enable flag

main

public static void main(java.lang.String[] args)

The program enter.

Parameters:

args - the input arguments

See Also:

CodeGeneratorParameters