Rodin Keyboard User Guide

From Event-B
Jump to: navigation, search

Introduction

This short help page provides necessary information on the Rodin Keyboard plug-in and also on how to extend the plug-in.

Getting Started

Overview

The Rodin Keyboard plug-in creates a view (namely "Rodin Keyboard") under Event-B category.

You can open "Rodin Keyboard" view now:

  1. Go to Window/Show View/Other.
  2. Choose the "Rodin Keyboard" view from the Event-B category.

The view contains a text area which takes an ASCII input and translate it into the mathematical language (defined by extensions).

Special Combos

Below are the special combos (set of ASCII characters) and their translations into the Event-B mathematical language.

ASCII LaTeX Math Meaning Unicode
NAT \nat <math>\nat</math> The set of natural numbers U+2115
NAT1 \natn <math>\natn</math> The set of positive natural numbers U+2115 U+0031
INT \intg <math>\intg</math> The set of integer numbers U+2124
POW \pow <math>\pow</math> The set of all subsets (power set) U+2119
POW1 \pown <math>\pown</math> The set of all non-empty subsets U+2119 U+0031
 
( ( ( Left parenthesis U+0028
) ) ) Right parenthesis U+0029
<=> \leqv <math>\leqv</math> Logical equivalence U+21D4
=> \limp <math>\limp</math> Logical implication U+21D2
& \land <math>\land</math> Logical conjunction U+2227
or \lor <math>\lor</math> Logical disjunction U+2228
not \lnot <math>\lnot</math> Not sign U+00AC
true \btrue <math>\btrue</math> True predicate U+22A4
false \bfalse <math>\bfalse</math> False predicate U+22A5
! \forall <math>\forall</math> For all U+2200
# \exists <math>\exists</math> There exists U+2203
, , , Comma U+002C
. \qdot <math>\qdot</math> Middle dot U+00B7
 
= = = Equal to U+003D
/= \neq <math>\neq</math> Not equal to U+2260
< < < Less than U+003C
<= \leq <math>\leq</math> Less than or equal to U+2264
> > > Greater than U+003E
>= \geq <math>\geq</math> Greater than or equal to U+2265
: \in <math>\in</math> Element of U+2208
/: \notin <math>\notin</math> Not an element of U+2209
<<: \subset <math>\subset</math> (Proper) Subset of U+2282
/<<: \notsubset <math>\not\subset</math> Not a (proper) subset of U+2284
<: \subseteq <math>\subseteq</math> Subset of or equal to U+2286
/<: \notsubseteq <math>\not\subseteq</math> Neither a subset of nor equal to U+2288
 
<-> \rel <math>\rel</math> Relation U+2194
<<-> \trel <math>\trel</math> Total relation U+E100
<->> \srel <math>\srel</math> Surjective relation U+E101
<<->> \strel <math>\strel</math> Total surjective relation U+E102
+-> \pfun <math>\pfun</math> Partial function U+21F8
--> \tfun <math>\tfun</math> Total function U+2192
>+> \pinj <math>\pinj</math> Partial injection U+2914
>-> \tinj <math>\tinj</math> Total injection U+21A3
+>> \psur <math>\psur</math> Partial surjection U+2900
->> \tsur <math>\tsur</math> Total surjection U+21A0
>->> \tbij <math>\tbij</math> Bijection U+2916
 
{ { { Left curly bracket U+007B
} } } Right curly bracket U+007D
|-> \mapsto <math>\mapsto</math> Maplet U+21A6
,,
{} \emptyset <math>\emptyset</math> Empty set U+2205
/\ \binter <math>\binter</math> Intersection U+2229
\/ \bunion <math>\bunion</math> Union U+222A
\ \setminus <math>\setminus</math> Set minus U+2216
** \cprod <math>\cprod</math> Cartesian product U+00D7
 
[ [ [ Left square bracket U+005B
] ] ] Right square bracket U+005D
<+ \ovl <math>\ovl</math> Relation overriding U+E103
circ \bcomp <math>\bcomp</math> Backward composition U+2218
; \fcomp <math>\fcomp</math> Forward composition U+003B
>< \dprod <math>\dprod</math> Direct product U+2297
|| \pprod <math>\pprod</math> Parallel product U+2225
~ \conv ~ Tilde operator U+223C
<| \domres <math>\domres</math> Domain restriction U+25C1
<<| \domsub <math>\domsub</math> Domain subtraction U+2A64
|> \ranres <math>\ranres</math> Range restriction U+25B7
|>> \ransub <math>\ransub</math> Range subtraction U+2A65
 
% \lambda <math>\lambda</math> Lambda U+03BB
INTER \Inter <math>\Inter</math> N-ary intersection U+22C2
UNION \Union <math>\Union</math> N-ary union U+22C3
| \mid <math>\mid</math> Such that U+2223
 
.. \upto <math>\upto</math> Upto sign U+2025
+ + + Addition sign U+002B
- - - Subtraction sign U+2212
* * * Multiplication sign U+2217
/ \div <math>\div</math> Division sign U+00F7
^ \expn <math>\expn</math> Exponentiation sign U+005E
 
oftype \oftype
Error creating thumbnail: Unable to save thumbnail to destination
Typing operator U+2982
 
:= \bcmeq <math>\bcmeq</math> Becomes equal to U+2254
:: \bcmin <math>\bcmin</math> Becomes an element of U+003A U+2208
:| \bcmsuch <math>\bcmsuch</math> Becomes such that U+003A U+2223

Concepts

Rodin Keyboard View

The view contains a text area where ASCII input can be typed in. The text will be translated into the mathematical language (which is extensible) when there is a modification of the text. The translation is done for the whole text spanned over multiple lines.

Below is an example of the view which is attached to the bottom area of the workbench.

Error creating thumbnail: Unable to save thumbnail to destination

Tasks

Entering a Mathematical Formula

A formula in the mathematical language of Event-B can be typed in the text area of the Rodin Keyboard view. The view will translate the formula from ASCII into the mathematical language as specified here. The formula can be copied as normal (Unicode) text.

Changing the Font

In order to display the Unicode characters for the mathematical language, there is a special font associated with the text area. This font can be changed in the Preferences page associated with the Colors and Fonts. It can be opened from the category "General/Appearance/Colors And Fonts". Any font can be chosen, but mathematical language formulas can be displayed correctly only if the chosen font contains the Unicode characters for the mathematical language. From the Preferences page, you can choose the font, the style and the size for the text area.

More information about the Preferences page can be found here.

Extending the Keyboard

There is an extension point to extend the keyboard namely org.rodinp.keyboard.symbols. An example of using this extension point is shown below.

<extension
    point="org.rodinp.keyboard.symbols">
    <symbol
	combo="not"
	id="neg"
	name="%negName"
	translation="¬" />
    <symbolProvider
	class="my.package.name.MyClassProvidingSymbols" />
</extension>

The first extension contributes a symbol with all the details for translating an ASCII combination into a symbol. The second extension contributes a class. This class will be instantiated by the Rodin Keyboard plug-in to fetch additional symbol definitions. This allows for contributing new symbols dynamically.

Reference

Release Notes

See the Keyboard Release History.

Preferences

The Preferences page is used to change the font of the text area in the Rodin Keyboard view. You can access it from the "General/Appearance/Colors and Fonts" page.

A sample of this preferences page is shown below.

Error creating thumbnail: Unable to save thumbnail to destination

The button "Change Font" is used to choose a new font. A pop-up dialog will be open and you can choose from the set of system fonts. The button "Reset" is used to set the font to the default Brave Sans Mono font.

There are four other buttons at the bottom of the page:

  • Restore Default: Restore the default fonts. It does not affect the Keyboard view.
  • Apply: Apply the current chosen font for the Keyboard view.
  • OK: Store the preference values to the preference store and close the page. It also applies the current chosen font for the Keyboard view.
  • Cancel: Close the page immediately without saving the preference values. Obviously, this does not affect the Keyboard view.

Samples

Expression

TODO

Jumping

TODO