Difference between revisions of "The Latex to LSC Compiler"

From WeizmannWiki
Jump to: navigation, search
Line 39: Line 39:
<div></div><div><br/></div><div>Please note that the LSC.tex file must have at least one LSC diagram. Also, no Latex command should appear outside the \begin \end.</div>
== The Latex2PlayGo Compiler ==
== The Latex2PlayGo Compiler ==

Revision as of 19:51, 18 May 2017

This page explains how to write Contextul LSCs (Con-LSC) in Latex, compile them into PlayGo LSC instances, and finally execute them.

In nutshell, these are the required steps:

  1. Download the PlayGo Environment.
  2. Add Latex Con-LSCs to LSC.tex.
  3. Execute the Latex2PlayGo compiler.
  4. Import the compiled file in PlayGo and execute it.

The PlayGo Environment

First you need to download (here) a PlayGo version that includes a template project and the Latex2PlayGo compiler.

After extracting the zip file you will find the following directory structure (the structure includes only directories relevant to this tutorial). Directories are marked with (D) and files with (F):

(D) PlayGo_4.0_19042017
(D) playgo
(F) playgo.exe
(D) workspace
(D) Latex2Lsc
(F) LSC.tex
(F) GeneratedLSC.lsc
(D) src
(F) Latex2PlayGoCompiler.java

Executin playgo.exe will start PlayGo.

General links:

PlayGo userguide.

PlayGo homepage - more information and tutorials.

Latex Con-LSC

The Latex Con-LSC Language

Our group has developed a dedicated Latex package for easily creating diagrams with a simple textual notation, and presenting them graphically.

The package, called pgf-playgo-lsc, is built upon the pgf[1] and pgf-uml[2] packages. The package imlements only part of the PlayGo LSC idioms. The complete list of the supported idioms in Latex Con-LSC is given in the Latex Con-LSC package. The language semantics is defined in the PlayGo userguide, except for the context idioms that are given in the paper.

We present here a short example for creating an LSC chart using pgf-playgo-lsc:

[title width=p{65px}]
{Turn lights off when motion has stopped}

\newlifeline {light} {light}
\newlifeline {office} {office}
\newlifeline {sensor} {mSensor}

\coldmonitor {sensor} {motionStopped()} {office}
\hotexecute {office} {setOff()} {light}


Compiled pgf-playgo-lsc chart

Please note that the LSC.tex file must have at least one LSC diagram. Also, no Latex command should appear outside the \begin \end.

The Latex2PlayGo Compiler

The Latex2PlayGo Compiler takes the Latex charts given in the LSC.tex file and compiles them to a PlayGo LSC file named GeneratedLSC.lsc. The compiler source code is the Latex2PlayGoCompiler.java file. Executing the compiler can be done in two ways:

  1. Compiling the file using javac and running it with java.
  2. In PlayGo - Right click the source file and choose "Run as > Java Application".

Preparing the PlayGo Project

Before we can execcute the generated LSCs, we need to prepare the project:


  1. T. Tantau and C. Feuersnger, “pgf—Create PostScript and PDF graphics in TEX,” Version 3.01a, 08 2015. [Online]. Available: https://www.ctan.org/pkg/pgf
  2. X. Yuan, “pgf-umlsd—Draw UML Sequence Diagrams,” Version 0.7, 02 2014. [Online]. Available: https://www.ctan.org/pkg/pgf-umlsd