onlinecompiler.png commandlinecompiler2.pngCommand Line Compiler quickstart.pngQuick Start Guide (pre 0.13)


An450px-Xtext_logo.png -based Project.


There is no valid license for Pro Macros. Please visit the Licenses section.


SCCharts are typically modeled using the textual SCT language defined as an Xtext grammar in KIELER. Generally, if you do not know which elements can be placed at a certain cursor position you are assisted by a content-assist that can be called pressing <Ctrl>+<Space>. It will display all possible valid elements also considering scoping of variables.

In the following we will demonstrate SCT using the famous ABRO example (the hello world of synchronous programming/modelling). We will then give details for modelling other SCCharts language constructs with SCT. For details on their semantics please be referred to  our PLDI paper [1].

[1] R. von Hanxleden, B. Duderstadt, C. Motika, S. Smyth, M. Mendler, J. Aguado, S. Mercer, and O. O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. In Proc. ACM SIGPLAN Conference on Programming Language Design and Implementation (PLDI’14), Edinburgh, UK, June 2014. (pdf)


ABRO Example

In the following we will describe some basic elements using the famous ABRO example:

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

  1. In the first line you see how an SCChart is defined using the scchart keyword where the ID of the SCChart will be ABRO. An optional label can be inserted after ABRO using "<LABEL>".
  2. In the next three lines variables are declared, namely, A, B, R and O, where O is initialized with the value false. A, B, and R are inputs which must not be initialized and get there valued from the environment.
  3. An SCChart typically contains concurrent regions which are introduced with the keyword region as shown in Line 9.
  4. Every region must at least have one state, and every region must exactly have one initial state. An initial state ABO is defined for region Main in Line 6.
  5. Every state is terminated by a ; as shown in line 11 for state HandleA.
  6. If you like to specify internal behavior of a state, you can add concurrent regions to a state in { <regions> } as done for state ABO or state WaitAB.
  7. Transitions outgoing from a state must be declared right before a state is terminated with ;. For example a transition from state wA to state dA is declared in Line 11.
  8. Transitions can have triggers and effects which are separated by a dash: <trigger>/<effects>. Multiple sequential effects are separated by a ;. The transition in Line 11 declares just a trigger A (a dash is not necessary in this case), while the transition from line 18 declares only an effect O = true (here the dash is mandatory).
  9. There are three types of transitions: 1. normal/weak abort transitions -->,  2. strong abort transitions o-> and 3. termination/join transitions >->.


Detailed SCT Syntax of SCCharts Elements

sccharts-features.jpg

SCChart, Initial State, State, Transition and Immediate Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.


Variable

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Transition: Trigger & Effect

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Super State

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Super State: Final States & Termination Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Super State: Weak Abort Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Super State: Strong Abort Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Concurrent Regions (inside a Super State)

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Entry Action, During Action, Exit Action

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Shallow History Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Deep History Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Deferred Transition

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Transition with Count Delay

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Array

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Signal

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Reference States

Important: To use the referenced SCCharts feature, activate the Xtext nature for your project!

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.


Hostcode

You can also use you host language directly.

Function Calls

Call host code functions with dependency analysis. Use angle brackets to point to an extern function. You can also declare extern variables.

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.


Hostcode (inline)

Inline hostcode just as it is. Use the @hostcode annotation to add hostcode line before the tick function. Also use hostcode in single quotes as hostcode effects.

Important: Inline hostcode is not type-safe. Be careful.

There is no valid license for Pro Macros. Please visit the Licenses section.

There is no valid license for Pro Macros. Please visit the Licenses section.

Annotations

The textual SCCharts language supports several annotations to influence the visual representation of the model.

Annotation are processed in sequential order.

Pattern

Usage

Description

Example

Unknown macro: noformat. Click on this message for details.

Location:

scchart

<key>

The name of the synthesis option. The given name is evaluated case-insensitive and whitespace-ignoring. The options are searched for the first matching prefix.

<value>

The value type depends on the option type:

CheckBox: true or false

Choice: Name of choice item

Slider: Float value

Sets the synthesis option identified by <key> to the given value.

The available synthesis options for a diagram are displayed in the sidebar of the diagram view.

The values from the sidebar will be ignored if a corresponding annotation is present.

@diagram[paper] true
scchart Testing {
  initial state A
  --> B;
  final state B;
}

Unknown macro: noformat. Click on this message for details.

Location:

scchart, state, region, transition

<key>

The ID of the layout option. The options are searched for the first matching postfix.

<value>

The value type depends on the option type. The value is parsed case-sensitive.

Sets the layout property identified by <key> to the given value on the annotated element.

The available layout options are documented here.

Layout options will only affect the annotated element and no underlying hierarchy levels.

If a layout direction is specified with this annotation it overrides the layout direction set by HV-/VH-Layout in any parent element for this element.

Special case: If the direction is set on the scchart element (top level) it overrides the default alternating layout.

There is no valid license for Pro Macros. Please visit the Licenses section.

scchart Testing {
    @layout[algorithm] de.cau.cs.kieler.graphviz.circo
    region:
    initial final state A
    --> B;
    state B
    --> C;
    state C
    --> A;
}



scchart Testing {
    @layout[direction] UP
    region "up":
    initial state A
    --> B;
    final state B;
    @layout[direction] LEFT
    region "left":
    initial state A
    --> B;
    final state B;
}



Unknown macro: noformat. Click on this message for details.

Location:

scchart, state, region

Defines the order of the alternating layout directions.

The annotation can be mixed and nested in the SCChart and will only affect succeeding hierarchy levels.

The default is an implicit HVLayout starting at the top level state.

@VHLayout
scchart Testing {
  initial state A
  --> B;
  final state B;
}

Unknown macro: noformat. Click on this message for details.

Location:

region

The annotated region will be initially collapse or expanded.

scchart Testing {
  @collapse  
  region:
  initial state A
  --> B;
  final state B;
}

Unknown macro: noformat. Click on this message for details.

Location:

scchart, state, region, transition

The annotated element will be excluded from the diagram.

Transitions with a hidden source or target state will be hidden as well.

scchart Testing {
  initial state A
  --> B;
  @hide
  final state B;
}


Overview of Operators

The following briefly describes the operators that can be used in expressions.

Assignment Operator

Description

Example

=

Assignment operator

x = 42

Arithmetic Operators

Description

Example

+

Addition

2 + 1

-

Subtraction

2 - 1

*

Multiplication

3 * 2

:

Division

6 : 2

Unary Operator

Description

Example

+

Indicate a positive number

+2

-

Negate a number

-2

++

Increment

x++

--

Decrement

x--

Boolean Operator

Description

Example

==

Equal to

x == 2

!

Negate a boolean value

! (x == 2)

!=

Not equal to

x != 2

>

Greater than

x > 2

>=

Greather than or equal to

x >= 2

<

Less than

x < 2

<=

Less than or equal to

x <= 2

&&

Conditional-AND

x > 0 && x < 9

||

Conditional-OR

x < 0 || x > 9

Tags: