commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gu...@apache.org
Subject svn commit: r946611 - /commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt
Date Thu, 20 May 2010 12:44:29 GMT
Author: guixl
Date: Thu May 20 12:44:28 2010
New Revision: 946611

URL: http://svn.apache.org/viewvc?rev=946611&view=rev
Log:
add project introduction

Added:
    commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt   (with props)

Added: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt
URL: http://svn.apache.org/viewvc/commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt?rev=946611&view=auto
==============================================================================
--- commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt (added)
+++ commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt Thu May 20 12:44:28
2010
@@ -0,0 +1,22 @@
+Title: An Eclipse-based Visual State Chart XML editor/debuger that generates SCXML documents
+
+ Abstract:
+
+State Chart XML (SCXML) provides a generic state-machine based execution environment based
on Harel State Tables.It is very useful to handler complex status transfer logic,but if a
SCXML file is really so huge and complex,it will become too difficult to maintain and refactor
or to test its logic validity.This project aims to provide a Eclipse and GMF based Visual
Editor and Debugger for SCXML,and we can also use it to generate SCXML document and specific
codes according to a State Chart XML.
+
+Detailed Description:
+
+State Chart XML is very useful to handler complex status transfer logic. Commons SCXML is
an implementation aimed at creating and maintaining a Java SCXML engine capable of executing
a state machine defined using a SCXML document, while abstracting out the environment interfaces.
Now,more and more developers use it to help handler complex program logic,but edit a State
Chart XML is so boring and mistakable.If a SCXML file is really so huge and complex,it will
become too difficult to maintain and refactor or to test its logic validity.For example,if
a SCXML flow has more than 20 States,it is possible to form an dead loop due to developer's
glitch. In fact, the archives of the Apache Commons SCXML user mailing list will show many
queries asking for it over the years.Obviously, Eclipse is the most power and popular Integration
Develop Environment for developers, if it supplies an editor or even debuger for State Chart
XML, isn't it cool ?
+
+In fact, an open-source Eclipse-based plugin that uses visual state chart editors and generates
SCXML documents is much needed -- the archives of the Apache Commons user mailing list  show
many queries asking for it over the years. And SCXML commiters told me it is a good topic
for a open source and GSoC endeavor.
+
+This project aims to develop an GMF based Eclipse plunge-in visual editor which is capable
of showing a graphical representation of the process model and allows for adding breakpoints
to activities, variable modifications and managing the debugging process for SCXML.I have
already done some work on both SCXML and Eclipse GMF,even i tried to implement a SCXML editor
using GMF and got a little achievement,so i want to develop this editor with GMF and have
enough confidence to finish it.
+
+Usually,State Chart XML file will be running on a SCXML engine,such as our Commons SCXML,if
some one only want to achieve the SCXML file's business logic,but do not want to or can not
use some SCXML engine due to some reasons(for example,some guy want to run scxml on web page,but
he can not find JavaScript SCXML engine),this code generation module will leverage the Commons
SCXML APIs and assume those jars are available. In my plan, i will implement Java,JavaScript,C++
and python support for it.
+
+So,I want to mainly complete the following funcitons:
+
+   1. Create a Eclipse plunge-in and GMF based Visual editor for SCXML. This editor can be
used to add or edit State Chart Diagram by drap and drop operations, and user can modify State
properties of SCXML in Eclipes property view.
+   2. State Chart XML export function. State Chart Diagram can be saved as a SCXML file.
+   3. Implement debug function for the editor. This SCXML editor will integrate Apache Commons
SCXML engine to run State Chart XML file, show context attributes and variables at the breakpoints.Implement
step by step,state by state debug function.
+   4. Code generation function. I will finish Java code generation module. And in the future,this
tool will can generate Java,C++,JavaScript and Python codes according to State Chart Diagram.
But as we know,i have only more than two months to finish a GSoC project,so, i will hold this
as a long term open source project under Apache,during this summer,i will finish Java code
generation job.In the short run, i will implement JavaScript,C++ and Python code generation
jobs.

Propchange: commons/sandbox/gsoc/2010/scxml-eclipse/trunk/sdocbook/introduction.txt
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message