ProB Tcl/Tk Architecture - Revision history

Michael Leuschel: /* How to add a simple menu command */

2014-07-13T09:07:10Z

How to add a simple menu command

← Older revision		Revision as of 09:07, 13 July 2014
Line 62:		Line 62:
	The command is now available and ready to use:		The command is now available and ready to use:

	[[file:ProB_TclTk_CountVarMenu.png\|center\|\|~~200px~~]]		[[file:ProB_TclTk_CountVarMenu.png\|center\|\|400px]]

	=== Some useful ProB Tcl/Tk procedures ===		=== Some useful ProB Tcl/Tk procedures ===

Michael Leuschel: /* How to add a simple menu command */

2014-07-13T09:06:35Z

How to add a simple menu command

← Older revision		Revision as of 09:06, 13 July 2014
Line 59:		Line 59:

	The use of format is more for debugging (the output will not be seen by ProB Tcl/Tk, just on the console (if any) used to launch ProB Tcl/Tk).		The use of format is more for debugging (the output will not be seen by ProB Tcl/Tk, just on the console (if any) used to launch ProB Tcl/Tk).

			The command is now available and ready to use:

			[[file:ProB_TclTk_CountVarMenu.png\|center\|\|200px]]

	=== Some useful ProB Tcl/Tk procedures ===		=== Some useful ProB Tcl/Tk procedures ===

Michael Leuschel: /* Some useful ProB Tcl/Tk procedures */

2014-07-13T06:44:25Z

Some useful ProB Tcl/Tk procedures

← Older revision		Revision as of 06:44, 13 July 2014
Line 65:		Line 65:
	* procShowList, procShowTable: pops up dialog boxes to display lists or tables (lists of lists). Parameters are title of dialog box,…		* procShowList, procShowTable: pops up dialog boxes to display lists or tables (lists of lists). Parameters are title of dialog box,…
	* procInsertHistoryOptionsState: updates the State, History and Operations (Options) views by calling Prolog and getting information about the current state		* procInsertHistoryOptionsState: updates the State, History and Operations (Options) views by calling Prolog and getting information about the current state

			Note: the Tcl/Tk code is mostly state-less, almost everything is stored inside Prolog:
			* current animation state
			* animation history and forward history
			* state space (all visited states and transitions)
			* all errors that have occurred (stored by the error_manager.pl)
			* the current specification
			* the state of all the preferences (inside preferences.pl)
			* ...

Michael Leuschel at 06:39, 13 July 2014

2014-07-13T06:39:01Z

← Older revision		Revision as of 06:39, 13 July 2014
Line 59:		Line 59:

	The use of format is more for debugging (the output will not be seen by ProB Tcl/Tk, just on the console (if any) used to launch ProB Tcl/Tk).		The use of format is more for debugging (the output will not be seen by ProB Tcl/Tk, just on the console (if any) used to launch ProB Tcl/Tk).

			=== Some useful ProB Tcl/Tk procedures ===

			* procShowErrors: collect all new errors and warnings from the Prolog error_manager and displays them in a dialog (in batch mode they are printed on the console only)
			* procShowList, procShowTable: pops up dialog boxes to display lists or tables (lists of lists). Parameters are title of dialog box,…
			* procInsertHistoryOptionsState: updates the State, History and Operations (Options) views by calling Prolog and getting information about the current state

Michael Leuschel at 06:33, 13 July 2014

2014-07-13T06:33:35Z

← Older revision		Revision as of 06:33, 13 July 2014
Line 22:		Line 22:
	* lists of integer or atoms		* lists of integer or atoms
	* nested lists of the above; in this case the Prolog code should not return the list but wrap the list result inside a <tt>list(.)</tt> constructor		* nested lists of the above; in this case the Prolog code should not return the list but wrap the list result inside a <tt>list(.)</tt> constructor

			=== How to add a simple menu command ===

			You need to add an entry in the ProB Tcl/Tk menu. The menus are defined at the top of the file <tt> main_prob_tcltk_gui.tcl</tt>

			<pre>
			.frmMenu.mnuAnalyse.mnuCoverage add command -label "Number of Values for all Variables" -command {procNrVariableValuesOverStatespace}
			</pre>

			You also need to define the Tcl/Tk part of your command (probably inside <tt> main_prob_tcltk_gui.tcl</tt>):

			<pre>
			proc procNrVariableValuesOverStatespace {} {
			if [prolog “tcltk_compute_nr_covered_values_for_all_variables(Res)"] {
			procShowErrors
			procShowTable $prolog_variables(Res) "Coverage Table" "Number of Covered Values for Variables" "CoverageVariablesTable" "" ""
			} else {
			procShowErrors
			}
			}
			</pre>

			Observe the use of <tt>prolog</tt> to call Prolog predicates and <tt>$prolog_variables</tt> to extract return values obtained from Prolog (which should instantiate the corresponding variable/argument).
			Also observer that we call <tt>procShowErrors</tt>, a Tcl/Tk procedure, which extracts all pending error messages and displays them to the user.
			</tt>procShowTable</tt> is a utility to display a dialog box containing a table.

			Finally, we need to define the called Prolog predicate somewhere in the Prolog code:

			<pre>
			tcltk_compute_nr_covered_values_for_all_variables(list([list(['Variable', 'Number of Values'])\|VL])) :-
			state_space:get_state_space_stats(NrNodes,_,_),
			format('Computing all values in ~w states for all variables~n',[NrNodes]),
			findall(list([ID,Count]),number_of_values_for_variable(ID,Count),VL),
			format('Finished computing all values for all variables~n',[]).
			</pre>

			The use of format is more for debugging (the output will not be seen by ProB Tcl/Tk, just on the console (if any) used to launch ProB Tcl/Tk).

Michael Leuschel: /* TheProB Tcl/Tk cross-language architecture */

2014-07-13T06:17:41Z

TheProB Tcl/Tk cross-language architecture

← Older revision		Revision as of 06:17, 13 July 2014
Line 10:		Line 10:

	Overall, the communication works as follows:		Overall, the communication works as follows:
	* on startup ProB launches Tcl/Tk		* on startup ProB launches Tcl/Tk; most of the GUI code can be found inside <tt> main_prob_tcltk_gui.tcl</tt>
	* from then on Tcl/Tk controls the GUI and calls Prolog predicates		* from then on Tcl/Tk controls the GUI and calls Prolog predicates
	* Tcl/Tk code calls Prolog using <tt> prolog PRED(…X…Y…)</tt>		* Tcl/Tk code calls Prolog using <tt> prolog PRED(…X…Y…)</tt>

Michael Leuschel: Created page with 'Category:Developer Manual NOTOC === TheProB Tcl/Tk cross-language architecture === The ProB Tcl/Tk contains a mixture of Prolog and Tcl/Tk source code. The core (i.e., …'

2014-07-13T06:16:43Z

Created page with 'Category:Developer Manual __NOTOC__ === TheProB Tcl/Tk cross-language architecture === The ProB Tcl/Tk contains a mixture of Prolog and Tcl/Tk source code. The core (i.e., …'

New page

[[Category:Developer Manual]]
__NOTOC__

=== TheProB Tcl/Tk cross-language architecture ===

The ProB Tcl/Tk contains a mixture of Prolog and Tcl/Tk source code.
The core (i.e., the constraint solver, the animation engine, the model checker, ...) are all written in Prolog (which in turn may call some C external functions, e.g., for LTL model checking).

We use the SICStus library(tcltk) (see chapter 10.40 of SICStus manual)

Overall, the communication works as follows:
* on startup ProB launches Tcl/Tk
* from then on Tcl/Tk controls the GUI and calls Prolog predicates
* Tcl/Tk code calls Prolog using <tt> prolog PRED(…X…Y…)</tt>
* Tcl/Tk then gets result values using  <tt>$prolog_variables(X)</tt> or <tt>$prolog_variables(Y)</tt>. There are only limited Prolog datatypes that can be transferred from Prolog to Tcl/Tk in this way; see below.
* Tcl/Tk code can also check if a Prolog call was successful, e.g.: <tt> if [prolog tcltk_backtrack] { … }</tt>
* Tcl/Tk code usually calls predicates with tcltk in their name; but there are exception (evaluation_view.tcl calls bvisual2 predicates)

The library(tcltk) puts restrictions on what can be transferred from Prolog to Tcl/Tk and then extracted using <tt>$prolog_variables(VAR)</tt>:
* integer
* atoms (which get translated to Tcl strings)
* lists of integer or atoms
* nested lists of the above; in this case the Prolog code should not return the list but wrap the list result inside a <tt>list(.)</tt> constructor

ProB Tcl/Tk Architecture - Revision history

Michael Leuschel: /* How to add a simple menu command */

Michael Leuschel: /* How to add a simple menu command */

Michael Leuschel: /* Some useful ProB Tcl/Tk procedures */

Michael Leuschel at 06:39, 13 July 2014

Michael Leuschel at 06:33, 13 July 2014

Michael Leuschel: /* TheProB Tcl/Tk cross-language architecture */

Michael Leuschel: Created page with 'Category:Developer Manual __NOTOC__ === TheProB Tcl/Tk cross-language architecture === The ProB Tcl/Tk contains a mixture of Prolog and Tcl/Tk source code. The core (i.e., …'

Michael Leuschel: Created page with 'Category:Developer Manual NOTOC === TheProB Tcl/Tk cross-language architecture === The ProB Tcl/Tk contains a mixture of Prolog and Tcl/Tk source code. The core (i.e., …'