meta_interface

call_command(Category,Command,FormalArgs,ActualArgs,OptionalArgs) :-
    command_category(Command,Category),
    command_arguments(Command,FormalArgs), % to do: more flexible matching of args ?
    !,
    (command_unavailable(Command,Msg)
    -> ajoin(['Command ', Command, ' not available: '],Msg1),
    add_error(meta_interface,Msg1,Msg),
    fail
    ; setup_optional_args(Command,OptionalArgs,OptArgValueList),
    (command_call(Command,ActualArgs,OptArgValueList,Call)
    -> debug_println(4,command_call(Call)),
    call(Call)
    ; command_call(Command,ArgsExpected,_,_),length(ArgsExpected,Exp),length(ActualArgs,Form) %, Exp \= Form
    ->
    ajoin(['Command ', Command, ' expects ', Exp, ' arguments, but obtained ',Form,'!'],Msg1),
    add_internal_error(Msg1,command_call(Command,ActualArgs,OptArgValueList,_)),
    fail
    ; add_internal_error('Cannot construct command call: ',command_call(Command,ActualArgs,OptArgValueList,_)),
    fail
)
).

call_command(Category,Command,FormalArgs,_ActualArgs,_OptArgs) :- command_category(Command,Category),
    !,
    add_error(meta_interface,'Argument mis-match when calling command: ',Command:FormalArgs),fail.

call_command(Category,Command,_,_,_) :- command_category(Command,_OtherCategory),!,
    add_error(meta_interface,'Command belongs to other category: ',Category:Command),fail.

call_command(Category,Command,_,_,_) :-
    add_error(meta_interface,'Unknown command: ',Category:Command),fail.

call_dot_command(Command,File) :- call_dot_command(Command,File,[]).

call_dot_command(Command,File,OptionalArgs) :- %print(cmd(Command,File,OptionalArgs)),nl,
    call_command(dot,Command,[dotfile],[File],OptionalArgs).

call_dot_command_for_expr(Command,Expr,File) :-
    call_dot_command_for_expr(Command,Expr,File,[]).

call_dot_command_for_expr(Command,Expr,File,OptionalArgs) :- % print(cmd(Command,Expr,File,OptionalArgs)),nl,
    call_command(dot,Command,[expression_atom,dotfile],[Expr,File],OptionalArgs).

call_dot_command_with_engine(Command,File,OptionalArgs,DotEngine) :-
    dot_filename_extension_can_be_converted(File,Ext,DotFile),
    !, % we can convert a dot file to this format
    call_dot_command(Command,DotFile,OptionalArgs),
    % DotEngine = default, sfdp, circo, ...
    gen_dot_output(DotFile,DotEngine,Ext,File).

call_dot_command_with_engine(Command,File,OptionalArgs,_) :-
    call_dot_command(Command,File,OptionalArgs).

call_dot_command_with_engine_for_expr(Command,Expr,File,OptionalArgs,DotEngine) :-
    dot_filename_extension_can_be_converted(File,Ext,DotFile),
    !, % we can convert a dot file to this format
    call_dot_command_for_expr(Command,Expr,DotFile,OptionalArgs),
    gen_dot_output(DotFile,DotEngine,Ext,File).

call_dot_command_with_engine_for_expr(Command,Expr,File,OptionalArgs,_) :-
    call_dot_command_for_expr(Command,Expr,File,OptionalArgs).

call_plantuml_command(Command,File) :- call_plantuml_command(Command,File,[]).

call_plantuml_command(Command,File,OptionalArgs) :-
    plantuml_filename_extension_can_be_converted(File,Ext,UmlFile),
    !, % we can convert a plantuml file to this format
    call_plantuml_command(Command,UmlFile,OptionalArgs),
    gen_plantuml_output([UmlFile],Ext,File).

call_plantuml_command(Command,File,OptionalArgs) :-
    split_filename(File,FileRoot,Ext),
    (Ext \= puml
    -> add_warning(get_puml_output,'Unsupported file extension for PlantUML output, create .puml file: ',Ext),
    ajoin([FileRoot,'.puml'],PumlFile)
    ; PumlFile = File),
    call_command(plantuml,Command,[plantumlfile],[PumlFile],OptionalArgs).

call_plantuml_command_for_expr(Command,Expr,File) :-
    plantuml_filename_extension_can_be_converted(File,Ext,UmlFile),
    !, % we can convert a plantuml file to this format
    call_plantuml_command_for_expr(Command,Expr,File,[]),
    gen_plantuml_output([UmlFile],Ext,File).

call_plantuml_command_for_expr(Command,Expr,File,OptionalArgs) :-
    call_command(plantuml,Command,[expression_atom,plantumlfile],[Expr,File],OptionalArgs).

command_additional_info(machine_hierarchy,group(machine_info)).

command_additional_info(operations,group(machine_info)).

command_additional_info(event_hierarchy,group(machine_info)).

command_additional_info(variable_hierarchy,group(machine_info)).

command_additional_info(state_space,group(state_space_visualisation)).

command_additional_info(state_space_sfdp,preferred_dot_type(sfdp)). % sfdp preferred

command_additional_info(state_space_sfdp,group(state_space_visualisation)).

command_additional_info(current_state,group(state_space_visualisation)).

command_additional_info(history,group(trace_visualisation)).

command_additional_info(signature_merge,group(state_space_visualisation)).

command_additional_info(dfa_merge,group(state_space_visualisation)).

command_additional_info(transition_diagram,group(state_space_visualisation)).

command_additional_info(enable_graph,group(data_flow_info)).

command_additional_info(state_as_graph,group(state_visualisation)).

command_additional_info(custom_graph,group(state_visualisation)).

command_additional_info(expr_as_graph,group(formula_visualisation)).

command_additional_info(formula_tree,group(formula_visualisation)).

command_additional_info(invariant,group(formula_visualisation)).

command_additional_info(properties,group(formula_visualisation)).

command_additional_info(assertions,group(formula_visualisation)).

command_additional_info(deadlock,group(formula_visualisation)).

command_additional_info(goal,group(formula_visualisation)).

command_additional_info(dependence_graph,group(data_flow_info)).

command_additional_info(variable_modification_graph,group(data_flow_info)).

command_additional_info(definitions,group(debug_info)).

command_additional_info(predicate_dependency,group(debug_info)).

command_additional_info(last_error,group(formula_visualisation)).

command_additional_info(last_mcts_tree,group(formula_visualisation)).

command_additional_info(uml_sequence_chart,group(trace_visualisation)).

command_additional_info(machine_statistics,group(machine_info)).

command_additional_info(expr_as_table,group(formula_visualisation)).

command_additional_info(quick_operation_coverage,group(coverage_info)).

command_additional_info(precise_operation_coverage,group(coverage_info)).

command_additional_info(show_typing,group(machine_info)).

command_additional_info(variable_coverage,group(coverage_info)).

command_additional_info(constants_coverage,group(coverage_info)).

command_additional_info(constants_analysis,group(debug_info)).

command_additional_info(expression_coverage,group(coverage_info)).

command_additional_info(minmax_table,group(coverage_info)).

command_additional_info(inv_coverage,group(coverage_info)).

command_additional_info(vacuous_invariants,group(coverage_info)).

command_additional_info(specialized_invariants,group(debug_info)).

command_additional_info(vacuous_guards,group(coverage_info)).

command_additional_info(read_write_matrix,group(machine_info)).

command_additional_info(variable_read_write_matrix,group(machine_info)).

command_additional_info(wd_pos,group(wd_info)).

command_additional_info(wd_pos_and_hyps,group(wd_info)).

command_additional_info(det_check_constants,group(debug_info)).

command_additional_info(unsat_core_properties,group(debug_info)).

command_additional_info(visb_attributes,group(visb_info)).

command_additional_info(visb_events,group(visb_info)).

command_additional_info(visb_objects,group(visb_info)).

command_additional_info(visb_hovers,group(visb_info)).

command_additional_info(find_value,group(debug_info)).

command_additional_info(id_value_formula_tree,group(formula_visualisation)).

command_additional_info(mcdc_coverage,group(coverage_info)).

command_additional_info(mcdc_inv_coverage,group(coverage_info)).

command_additional_info(prob_profile_info,group(debug_info)).

command_additional_info(prob_constants_profile_info,group(debug_info)).

command_additional_info(prob_external_fun_profile_info,group(debug_info)).

command_additional_info(prob_opcache_info,group(debug_info)).

command_additional_info(prob_memo_profile,group(debug_info)).

command_additional_info(constant_expr_analysis,group(debug_info)).

command_arguments(machine_hierarchy,[dotfile]).

command_arguments(operations,[dotfile]).

command_arguments(event_hierarchy,[dotfile]).

command_arguments(variable_hierarchy,[dotfile]).

command_arguments(state_space,[dotfile]).

command_arguments(state_space_sfdp,[dotfile]).

command_arguments(current_state,[dotfile]).

command_arguments(history,[dotfile]).

command_arguments(signature_merge,[dotfile]).

command_arguments(dfa_merge,[dotfile]).

command_arguments(transition_diagram,[expression_atom,dotfile]). % also accepts expression_raw_ast

command_arguments(enable_graph,[dotfile]).

command_arguments(state_as_graph,[dotfile]).

command_arguments(custom_graph,[dotfile]). % also accepts expression_raw_ast

command_arguments(expr_as_graph,[expression_atom,dotfile]). % also accepts expression_raw_ast

command_arguments(formula_tree,[expression_atom,dotfile]). % is actually predicate_atom, also accepts expression_raw_ast

command_arguments(invariant,[dotfile]).

command_arguments(properties,[dotfile]).

command_arguments(assertions,[dotfile]).

command_arguments(deadlock,[dotfile]).

command_arguments(goal,[dotfile]).

command_arguments(dependence_graph,[dotfile]).

command_arguments(variable_modification_graph,[dotfile]).

command_arguments(definitions,[dotfile]).

command_arguments(predicate_dependency,[expression_atom,dotfile]). % also accepts expression_raw_ast

command_arguments(last_error,[dotfile]).

command_arguments(last_mcts_tree,[dotfile]).

command_arguments(uml_sequence_chart,[plantumlfile]).

command_arguments(machine_statistics,[table_result]).

command_arguments(expr_as_table,[expression_atom,table_result]). % also accepts expression_raw_ast

command_arguments(quick_operation_coverage,[table_result]). % also accepts expression_raw_ast

command_arguments(precise_operation_coverage,[table_result]). % also accepts expression_raw_ast

command_arguments(show_typing,[table_result]). % also accepts expression_raw_ast

command_arguments(variable_coverage,[table_result]). % also accepts expression_raw_ast

command_arguments(constants_coverage,[table_result]).

command_arguments(constants_analysis,[table_result]).

command_arguments(expression_coverage,[expression_atom,table_result]).

command_arguments(minmax_table,[table_result]).

command_arguments(inv_coverage,[table_result]).

command_arguments(vacuous_invariants,[table_result]).

command_arguments(specialized_invariants,[table_result]).

command_arguments(vacuous_guards,[table_result]).

command_arguments(read_write_matrix,[table_result]).

command_arguments(variable_read_write_matrix,[table_result]).

command_arguments(wd_pos,[table_result]).

command_arguments(wd_pos_and_hyps,[table_result]).

command_arguments(det_check_constants,[table_result]).

command_arguments(unsat_core_properties,[table_result]).

command_arguments(visb_attributes,[table_result]).

command_arguments(visb_events,[table_result]).

command_arguments(visb_objects,[table_result]).

command_arguments(visb_hovers,[table_result]).

command_arguments(find_value,[expression_atom,table_result]). % also accepts expression_raw_ast

command_arguments(id_value_formula_tree,[expression_atom,dotfile]). % is actually predicate_atom, also accepts expression_raw_ast

command_arguments(mcdc_coverage,[table_result]).

command_arguments(mcdc_inv_coverage,[table_result]).

command_arguments(prob_profile_info,[table_result]). % also accepts expression_raw_ast

command_arguments(prob_constants_profile_info,[table_result]). % also accepts expression_raw_ast

command_arguments(prob_external_fun_profile_info,[table_result]). % also accepts expression_raw_ast

command_arguments(prob_opcache_info,[table_result]).

command_arguments(prob_memo_profile,[table_result]).

command_arguments(constant_expr_analysis,[table_result]).

command_call(machine_hierarchy,[File],[],b_machine_hierarchy:write_dot_hierarchy_to_file(File)).

command_call(operations,[File],[],b_machine_hierarchy:write_dot_op_hierarchy_to_file(File)).

command_call(event_hierarchy,[File],[],b_machine_hierarchy:write_dot_event_hierarchy_to_file(File)).

command_call(variable_hierarchy,[File],[],b_machine_hierarchy:write_dot_variable_hierarchy_to_file(File)).

command_call(state_space,[File],[ColourTransitions],visualize_graph:tcltk_print_states_for_dot(File,ColourTransitions)).

command_call(state_space_sfdp,[File],[ColourTransitions],visualize_graph:tcltk_print_states_for_dot_sfdp(File,ColourTransitions)).

command_call(current_state,[File],[],visualize_graph:tcltk_print_current_state_for_dot(File)).

command_call(history,[File],[],visualize_graph:tcltk_print_history_to_current_state_for_dot(File)).

command_call(signature_merge,[File],[IgnoredEvents],state_space_reduction:write_signature_merge_to_dotfile(IgnoredEvents,File)).

command_call(dfa_merge,[File],[],reduce_graph_state_space:print_dot_for_dfa_from_nfa(File)).

command_call(transition_diagram,[Expression,File],[],
    state_space_reduction:write_transition_diagram_for_expr_to_dotfile(Expression,File)).

command_call(enable_graph,[File],[],dot_graphs_static_analysis:tcltk_create_enable_graph(File)).

command_call(state_as_graph,[File],[],state_as_dot_graph:print_cstate_graph(File)).

command_call(custom_graph,[File],[],state_custom_dot_graph:tcltk_generate_state_custom_dot_graph(File)).

command_call(expr_as_graph,[Expression,File],[],tcltk_interface:tcltk_show_expression_as_dot(Expression,File)).

command_call(formula_tree,[Expression,File],[],tcltk_interface:generate_dot_from_formula(Expression,File)).

command_call(invariant,[File],[],tcltk_interface:generate_dot_from_invariant(File)).

command_call(properties,[File],[],tcltk_interface:generate_dot_from_properties(File)).

command_call(assertions,[File],[],tcltk_interface:generate_dot_from_assertions(File)).

command_call(deadlock,[File],[],tcltk_interface:generate_dot_from_deadlock_po(File)).

command_call(goal,[File],[],tcltk_interface:generate_dot_from_goal(File)).

command_call(dependence_graph,[File],[],dot_graphs_static_analysis:tcltk_create_dependence_graph(File)).

command_call(variable_modification_graph,[File],[],b_read_write_info:tcltk_dot_variable_modification_analysis(File)).

command_call(definitions,[File],[],visualize_graph:tcltk_print_definitions_as_graph_for_dot(File)).

command_call(predicate_dependency,[Pred,File],[],visualize_graph:tcltk_print_predicate_dependency_as_graph_for_dot(Pred,File)).

command_call(last_error,[File],[],tcltk_interface:generate_dot_from_last_span_predicate(File)).

command_call(last_mcts_tree,[File],[],mcts_game_play:tcltk_gen_last_mcts_tree(2,File)).

command_call(uml_sequence_chart,[File],[],write_uml_sequence_chart(File)).

command_call(machine_statistics,[Result],[],meta_interface:meta_get_machine_stats(Result)).

command_call(expr_as_table,[Expression,Result],[],tcltk_interface:tcltk_eval_as_table(Expression,Result)).

command_call(quick_operation_coverage,[Result],[],tcltk_interface:tcltk_operations_covered_info(Result,_,quick)).

command_call(precise_operation_coverage,[Result],[],tcltk_interface:tcltk_operations_covered_info(Result,_,precise)).

command_call(show_typing,[Result],[],meta_interface:show_typing_table(Result)).

command_call(variable_coverage,[Result],[],state_space_reduction:tcltk_compute_nr_covered_values_for_all_variables(Result)).

command_call(constants_coverage,[Result],[],state_space_reduction:tcltk_compute_nr_covered_values_for_all_constants(Result)).

command_call(constants_analysis,[Result],[],coverage_statistics:tcltk_analyse_constants(Result)).

command_call(expression_coverage,[Expr,Result],[],meta_interface:expression_coverage(Expr,Result)).

command_call(minmax_table,[Result],[],meta_interface:minmax_table(Result)).

command_call(inv_coverage,[Result],[],mcdc_coverage:tcltk_get_invariant_coverage(Result)).

command_call(vacuous_invariants,[Result],[],meta_interface:vacuous_invariants(Result)).

command_call(specialized_invariants,[Result],[],meta_interface:specialized_invariants(Result)).

command_call(vacuous_guards,[Result],[],meta_interface:vacuous_guards(Result)).

command_call(read_write_matrix,[Result],[],b_read_write_info:tcltk_read_write_matrix(Result)).

command_call(variable_read_write_matrix,[Result],[],b_read_write_info:tcltk_variable_read_write_matrix(no_check,Result)).

command_call(wd_pos,[Result],[],well_def_analyser:tcltk_get_machine_wd_pos(only_goal,Result,_,_)).

command_call(wd_pos_and_hyps,[Result],[],well_def_analyser:tcltk_get_machine_wd_pos(goal_and_hyps,Result,_,_)).

command_call(det_check_constants,[Result],[],b_state_model_check:tcltk_cbc_constants_det_check(Result)).

command_call(unsat_core_properties,[Result],[],unsat_cores:unsat_core_properties_table(Result)).

command_call(visb_attributes,[Result],[],visb_visualiser:tcltk_get_visb_items(Result)).

command_call(visb_events,[Result],[],visb_visualiser:tcltk_get_visb_events(Result)).

command_call(visb_objects,[Result],[],visb_visualiser:tcltk_get_visb_objects(Result)).

command_call(visb_hovers,[Result],[],visb_visualiser:tcltk_get_visb_hovers(Result)).

command_call(find_value,[Expression,Result],[],tcltk_interface:tcltk_find_value_as_table(Expression,[prefix],Result)).

command_call(id_value_formula_tree,[ID,File],[],tcltk_interface:tcltk_show_identifier_value_as_dot_tree(ID,File)).

command_call(mcdc_coverage,[Result],[],mcdc_coverage:tcltk_compute_mcdc_operation_coverage(Result)).

command_call(mcdc_inv_coverage,[Result],[],mcdc_coverage:tcltk_compute_mcdc_invariant_coverage(Result)).

command_call(prob_profile_info,[Result],[],runtime_profiler:tcltk_get_operations_profile_info(Result)).

command_call(prob_constants_profile_info,[Result],[],runtime_profiler:tcltk_get_constants_profile_info(Result)).

command_call(prob_external_fun_profile_info,[Result],[],runtime_profiler:tcltk_get_profile_info(external_functions,Result)).

command_call(prob_opcache_info,[Result],[],b_operation_cache:tcltk_op_cache_stats(Result)).

command_call(prob_memo_profile,[Result],[],memoization:tcltk_get_memo_profile_table(Result)).

command_call(constant_expr_analysis,[Result],[],bmachine_static_checks:find_constant_expressions_in_operations(Result)).

command_category(machine_hierarchy,dot).

command_category(operations,dot).

command_category(event_hierarchy,dot).

command_category(variable_hierarchy,dot).

command_category(state_space,dot).

command_category(state_space_sfdp,dot).

command_category(current_state,dot).

command_category(history,dot).

command_category(signature_merge,dot).

command_category(dfa_merge,dot).

command_category(transition_diagram,dot).

command_category(enable_graph,dot).

command_category(state_as_graph,dot).

command_category(custom_graph,dot).

command_category(expr_as_graph,dot).

command_category(formula_tree,dot).

command_category(invariant,dot).

command_category(properties,dot).

command_category(assertions,dot).

command_category(deadlock,dot).

command_category(goal,dot).

command_category(dependence_graph,dot).

command_category(variable_modification_graph,dot).

command_category(definitions,dot).

command_category(predicate_dependency,dot).

command_category(last_error,dot).

command_category(last_mcts_tree,dot).

command_category(uml_sequence_chart,plantuml).

command_category(machine_statistics,table).

command_category(expr_as_table,table).

command_category(quick_operation_coverage,table).

command_category(precise_operation_coverage,table).

command_category(show_typing,table).

command_category(variable_coverage,table).

command_category(constants_coverage,table).

command_category(constants_analysis,table).

command_category(expression_coverage,table).

command_category(minmax_table,table).

command_category(inv_coverage,table).

command_category(vacuous_invariants,table).

command_category(specialized_invariants,table).

command_category(vacuous_guards,table).

command_category(read_write_matrix,table).

command_category(variable_read_write_matrix,table).

command_category(wd_pos,table).

command_category(wd_pos_and_hyps,table).

command_category(det_check_constants,table).

command_category(unsat_core_properties,table).

command_category(visb_attributes,table).

command_category(visb_events,table).

command_category(visb_objects,table).

command_category(visb_hovers,table).

command_category(find_value,table).

command_category(id_value_formula_tree,dot).

command_category(mcdc_coverage,table).

command_category(mcdc_inv_coverage,table).

command_category(prob_profile_info,table).

command_category(prob_constants_profile_info,table).

command_category(prob_external_fun_profile_info,table).

command_category(prob_opcache_info,table).

command_category(prob_memo_profile,table).

command_category(constant_expr_analysis,table).

command_description(machine_hierarchy,'Machine Hierarchy','Shows the machine hierarchy of a classical B model').

command_description(operations,'Operation Call Graph','Shows the call graph of a classical B model').

command_description(event_hierarchy,'Event Hierarchy','Shows the event hierarchy of an Event-B model').

command_description(variable_hierarchy,'Variable Refinement Hierarchy','Shows variables within the refinement hierarchy of an Event-B model').

command_description(state_space,'State Space','Show state space').

command_description(state_space_sfdp,'State Space (Fast)','Show state space (faster layout with less information and more overlaps)').

command_description(current_state,'Current State in State Space','Show current state and successors in state space').

command_description(history,'Path to Current State','Show a path leading to current state').

command_description(signature_merge,'Signature Merge','Show signature-merged reduced state space (i.e., merge states which have same set of enabled events/operations)').

command_description(dfa_merge,'DFA Merge','Show state space as deterministic automaton (DFA)').

command_description(transition_diagram,'State Space Expression Projection...','Project state space onto expression values and show transition diagram').

command_description(enable_graph,'Event Enable Graph','Show enabling graph of events (i.e., which event/operation can enable/disable which other event)').

command_description(state_as_graph,'Current State as Graph','Show values of variables in current state as one graph').

command_description(custom_graph,'Customized Current State as Graph','Show values in current state as a graph using CUSTOM_GRAPH definition').

command_description(expr_as_graph,'(Relational) Expression as Graph...','Show (relational) expression value as a graph').

command_description(formula_tree,'Custom Predicate/Expression Formula Tree...','Show predicate/expressions and sub-formulas as a tree').

command_description(invariant,'Invariant Formula Tree','Show invariant as a formula tree').

command_description(properties,'Properties Formula Tree','Show properties/axioms as a formula tree').

command_description(assertions,'Assertions Formula Tree','Show assertions/theorems as a formula tree').

command_description(deadlock,'Deadlock Formula Tree','Show deadlocking status (i.e., guards of all operations/events) in current state as a formula tree').

command_description(goal,'Goal Formula Tree','Show GOAL as a formula tree').

command_description(dependence_graph,'Event Dependence Graph','Show dependency graph of events (i.e., which events are not commutative)'). % difference to enable graph : not whether we have enabling/disabling but influence on effect

command_description(variable_modification_graph,'Variable Read/Write Graph','Show variable modification by operations and reading in guards').

command_description(definitions,'Definitions Graph','Show dependency graph of DEFINITIONS').

command_description(predicate_dependency,'Predicate Dependency Graph...','Show dependency graph of conjuncts of a predicate').

command_description(last_error,'Last State Error Formula Tree','Try and visualise last state error source as a formula tree').

command_description(last_mcts_tree,'MCTS Game Tree','Show two levels of last MCTS (Monte Carlo Tree Search) game tree').

command_description(uml_sequence_chart,'UML Sequence Chart','Visualise the current trace as a UML sequence chart.').

command_description(machine_statistics,'Machine Statistics','Show statistics for main machine/specification').

command_description(expr_as_table,'Expression Table...','Show expression value as a table').

command_description(quick_operation_coverage,'Operation Coverage','Show which operations are covered in current state space').

command_description(precise_operation_coverage,'Operation Coverage and Feasibility','Show which feasible operations are covered (possible means operation is in principle feasible given invariant)').

command_description(show_typing,'Show Typing','Show types for variables and constants').

command_description(variable_coverage,'Variable Coverage','Show number of distinct covered values for variables in current state space').

command_description(constants_coverage,'Constant Coverage','Show number of distinct covered values for constants in current state space').

command_description(constants_analysis,'Constant Analysis','Show size (B and Prolog term size) and other infos about constants').

command_description(expression_coverage,'Expression Coverage...','Evaluate expression over current state space and compute distinct values and their number of occurence').

command_description(minmax_table,'Min/Max Values','Show minimum/maximum values for constants and variables in current state space; useful to analyse state explosion problems').

command_description(inv_coverage,'Invariant Analysis','Analyse the truth value of individual invariants in current state space').

command_description(vacuous_invariants,'Vacuous Invariants','Show list of vacuous invariants (implications or disjunctions wich are useless, given current explicit state space)').

command_description(specialized_invariants,'Specialized Invariants','Show list of invariants (specialized using proof information for each operation; used by ProB for faster model checking)').

command_description(vacuous_guards,'Vacuous Guards','Show list of vacuous Guards (i.e., guards which cannot be individually false and are thus useless, given current explicit state space)').

command_description(read_write_matrix,'Operation Read/Write Matrix','Show identifiers read and written by operations').

command_description(variable_read_write_matrix,'Variable Read/Write Matrix','Show for variables which operations read and write them').

command_description(wd_pos,'WD POs','Show Well-Definedness Proof Obligations').

command_description(wd_pos_and_hyps,'WD POs and Hyps','Show Well-Definedness Proof Obligations and Hypotheses necessary for successful proof (for discharged POs)').

command_description(det_check_constants,'Compute Forced Constants','Analyse which values of CONSTANTS are forced and optionally compute an explanation (i.e., core of PROPERTIES which imply the value)').

command_description(unsat_core_properties,'Unsat Core of Properties/Axioms','Analyse a minimal unsatisfiable core of the PROPERTIES/Axioms').

command_description(visb_attributes,'VisB Items','Show VisB items which set SVG attributes based on current state').

command_description(visb_events,'VisB Events','Show VisB click events that are available in current state').

command_description(visb_objects,'VisB Objects','Show VisB SVG objects which were created in addition to the SVG file').

command_description(visb_hovers,'VisB Hovers','Show VisB hovers with enter and exit values').

command_description(find_value,'Find Value...','Find value inside variables and constants').

command_description(id_value_formula_tree,'Value of Identifier as Formula Tree...','Show value of an identifier as a formula tree (mainly useful for symbolic values)').

command_description(mcdc_coverage,'MC/DC Operation Coverage','Show MC/DC operation coverage').

command_description(mcdc_inv_coverage,'MC/DC Invariant Coverage','Show MC/DC invariant coverage').

command_description(prob_profile_info,'ProB Profile Info','Show runtime information for operations and invariants').

command_description(prob_constants_profile_info,'ProB Constants Profile Info','Show runtime information for calculation of constants by equations').

command_description(prob_external_fun_profile_info,'ProB External Functions Profile Info','Show runtime information for external function calls').

command_description(prob_opcache_info,'ProB Operation Caching Info','Show information for operation caching (see OPERATION_REUSE preference)').

command_description(prob_memo_profile,'ProB Memoization Info','Show information for memoized constants').

command_description(constant_expr_analysis,'Constant Expressions in Operations','Detect potentially expensive constant expressions in operations').

command_optional_arguments(state_space,[colouring],[atom],[no_colour_for_transitions]).

command_optional_arguments(state_space_sfdp,[colouring],[atom],[no_colour_for_transitions]).

command_optional_arguments(signature_merge,[ignored_events],[list(operations)],[[]]).

command_preferences_category(machine_hierarchy,dot_machine_hierarchy).

command_preferences_category(operations,dot_graph_generator).

command_preferences_category(event_hierarchy,dot_event_hierarchy).

command_preferences_category(variable_hierarchy,dot_variable_hierarchy).

command_preferences_category(state_space,dot_state_space).

command_preferences_category(state_space_sfdp,dot_state_space). % TODO: maybe remove those that are fixed and have no effect

command_preferences_category(current_state,dot_state_space).

command_preferences_category(history,dot_state_space).

command_preferences_category(signature_merge,dot_graph_generator).

command_preferences_category(transition_diagram,dot_projection).

command_preferences_category(enable_graph,dot_enable_graph).

command_preferences_category(state_as_graph,state_as_graph).

command_preferences_category(custom_graph,dot_graph_generator).

command_preferences_category(expr_as_graph,state_as_graph).

command_preferences_category(formula_tree,dot_formula_tree).

command_preferences_category(invariant,dot_formula_tree).

command_preferences_category(properties,dot_formula_tree).

command_preferences_category(assertions,dot_formula_tree).

command_preferences_category(deadlock,dot_formula_tree).

command_preferences_category(goal,dot_formula_tree).

command_preferences_category(dependence_graph,dot_enable_graph).

command_preferences_category(variable_modification_graph,dot_variable_modification).

command_preferences_category(definitions,dot_definitions).

command_preferences_category(wd_pos,wd_commands).

command_preferences_category(wd_pos_and_hyps,wd_commands).

command_preferences_category(det_check_constants,cbc_commands).

command_preferences_category(unsat_core_properties,table_commands).

command_preferences_category(visb_attributes,table_commands).

command_preferences_category(visb_events,table_commands).

command_preferences_category(visb_objects,table_commands).

command_preferences_category(visb_hovers,table_commands).

command_preferences_category(id_value_formula_tree,dot_formula_tree).

command_preferences_category(mcdc_coverage,mc_dc_commands).

command_preferences_category(mcdc_inv_coverage,mc_dc_commands).

command_unavailable(machine_hierarchy,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(operations,'only available for B or Z models with OPERATIONS') :-
    (\+ (b_or_z_mode,b_machine_has_operations) ; eventb_mode).

command_unavailable(event_hierarchy,'only available for Event-B models with events') :-
    \+ (eventb_mode, b_machine_has_operations).

command_unavailable(variable_hierarchy,'only available for Event-B models with variables') :-
    \+ (eventb_mode, b_machine_has_variables).

command_unavailable(state_space,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(state_space_sfdp,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(current_state,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(history,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(signature_merge,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(dfa_merge,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(transition_diagram,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(enable_graph,Txt) :- command_unavailable(operations_events,Txt).

command_unavailable(state_as_graph,'only available for B,Z or Event-B models after constant setup or initialisation') :- \+ current_state_corresponds_to_setup_constants_b_machine.

command_unavailable(custom_graph,'only available when CUSTOM_GRAPH or CUSTOM_GRAPH_NODES and CUSTOM_GRAPH_EDGES are defined in the DEFINITIONS of a B machine') :-
    \+ state_custom_dot_graph_available.

command_unavailable(custom_graph,'only available for initialised B,Z or Event-B models') :-
    state_custom_dot_graph_available,
    \+ current_state_corresponds_to_fully_setup_b_machine.

command_unavailable(expr_as_graph,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(formula_tree,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(invariant,'only available for initialised B,Z or Event-B models') :- \+ current_state_corresponds_to_fully_setup_b_machine.

command_unavailable(properties,'only available for B,Z or Event-B models with PROPERTIES after constant setup or initialisation') :-
    \+ (current_state_corresponds_to_setup_constants_b_machine,b_machine_has_constants_or_properties).

command_unavailable(assertions,'only available for B,Z or Event-B models with ASSERTIONS after constant setup or initialisation') :-
    \+ (current_state_corresponds_to_setup_constants_b_machine, b_machine_has_assertions).

command_unavailable(deadlock,'only available for initialised B,Z or Event-B models with OPERATIONS') :-
    \+ (current_state_corresponds_to_fully_setup_b_machine, b_machine_has_operations).

command_unavailable(goal,'only available for initialised B,Z or Event-B models with a GOAL DEFINITION') :-
    (\+ b_or_z_mode ; \+ b_get_machine_goal(_)).

command_unavailable(dependence_graph,Txt) :- command_unavailable(operations_events,Txt).

command_unavailable(variable_modification_graph,Txt) :- command_unavailable(variables,Txt).

command_unavailable(definitions,'only available for B or Z models') :- (b_or_z_mode -> eventb_mode ; true).

command_unavailable(predicate_dependency,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(last_error,'only available when (state) error occured') :-
    \+ tcltk_interface:can_generate_dot_from_last_state_error.

command_unavailable(last_mcts_tree,'only available when GAME_OVER, ... definitions generated') :- \+ mcts_game_play:mcts_auto_play_available.

command_unavailable(last_mcts_tree,'only available after a game move has been computed by MCTS') :- mcts_game_play:mcts_auto_play_available, \+ mcts_game_play:mcts_tree_available.

command_unavailable(uml_sequence_chart,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(machine_statistics,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(expr_as_table,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(quick_operation_coverage,'only available for B,Z, Event-B with OPERATIONS, or CSP models') :-
    \+ (b_or_z_mode, b_machine_has_operations), \+ csp_mode.

command_unavailable(precise_operation_coverage,Txt) :- command_unavailable(operations_events,Txt).

command_unavailable(show_typing,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(variable_coverage,Txt) :- command_unavailable(variables,Txt).

command_unavailable(constants_coverage,Txt) :- command_unavailable(constants,Txt).

command_unavailable(constants_analysis,Txt) :- command_unavailable(constants,Txt).

command_unavailable(expression_coverage,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(minmax_table,'only available when model successfully loaded') :- \+ spec_file_has_been_successfully_loaded.

command_unavailable(inv_coverage,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(vacuous_invariants,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(specialized_invariants,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(vacuous_guards,Txt) :- command_unavailable(operations_events,Txt).

command_unavailable(read_write_matrix,Txt) :- command_unavailable(operations_events,Txt).

command_unavailable(variable_read_write_matrix,Txt) :- command_unavailable(variables,Txt).

command_unavailable(wd_pos,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(wd_pos_and_hyps,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(det_check_constants,Txt) :- command_unavailable(constants,Txt).

command_unavailable(unsat_core_properties,'only available for B,Z or Event-B models with CONSTANTS or PROPERTIES') :-
    \+ (b_or_z_mode, b_machine_has_constants_or_properties).

command_unavailable(visb_attributes,'only available after a VisB file was loaded') :-
    \+ visb_visualiser:visb_file_is_loaded(_).

command_unavailable(visb_events,'only available after a VisB file was loaded') :-
    \+ visb_visualiser:visb_file_is_loaded(_).

command_unavailable(visb_objects,'only available after a VisB file was loaded') :-
    \+ visb_visualiser:visb_file_is_loaded(_).

command_unavailable(visb_hovers,'only available after a VisB file was loaded') :-
    \+ visb_visualiser:visb_file_is_loaded(_).

command_unavailable(find_value,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(id_value_formula_tree,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(mcdc_coverage,Txt) :- command_unavailable(operations_events,Txt).

command_unavailable(mcdc_inv_coverage,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(prob_profile_info,'no profiling information available, set PROFILING_INFO preference to TRUE') :- \+ runtime_profile_available,!. % and possibly remove -Dprob_profile=false flag

command_unavailable(prob_profile_info,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(prob_constants_profile_info,'no profiling information available, set PROFILING_INFO and PERFORMANCE_INFO preference to TRUE') :- \+ runtime_profile_available,!.

command_unavailable(prob_constants_profile_info,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(prob_external_fun_profile_info,'no profiling information available, set PROFILING_INFO preference to TRUE') :- \+ runtime_profile_available,!. % and possibly remove -Dprob_profile=false flag

command_unavailable(prob_external_fun_profile_info,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(prob_opcache_info,'only available when OPERATION_REUSE is TRUE or full.') :-
    get_preference(try_operation_reuse,false).

command_unavailable(prob_opcache_info,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(prob_memo_profile,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(constant_expr_analysis,Txt) :- command_unavailable(b_mode,Txt).

command_unavailable(constants,'only available for B,Z or Event-B models with CONSTANTS') :-
    \+ (b_or_z_mode, b_machine_has_constants).

command_unavailable(variables,'only available for B,Z or Event-B models with VARIABLES') :-
    \+ (b_or_z_mode, b_machine_has_variables).

command_unavailable(operations_events,'only available for B,Z or Event-B models with OPERATIONS/events') :-
    \+ (b_or_z_mode, b_machine_has_operations).

command_unavailable(b_mode,'only available for B,Z or Event-B models') :- \+ b_or_z_mode.

csv_escape_codes([],[]).

csv_escape_codes([0'" | T],R) :- !,"
    R=[0'", 0'" |ET], % quotes in a CSV record must be preceded by another quote
    csv_escape_codes(T,ET).

csv_escape_codes([H|T],[H|ET]) :- csv_escape_codes(T,ET).

dot_filename_extension_can_be_converted(File,Ext,DotFile) :-
    split_filename(File,FileRoot,Ext), Ext \= dot,
    valid_dot_output_format(Ext),!, % we can convert a dot file to this format
    ajoin([FileRoot,'.dot'],DotFile). % TODO: we could generate a temp file in /tmp

expression_coverage(ExprToEvaluate,list(LRes)) :-
    compute_covered_values_for_expression(ExprToEvaluate,_MaxTypeCard,_TotalNrOfValuesFound,list(Res)),
    maplist(wrap_into_list,Res,LRes).

get_command_preferences(Command,Preferences) :-
    findall(Pref, (command_preferences_category(Command,PrefCat),
    virtual_preference_category(Pref,PrefCat)), Preferences).

is_dot_command(Command) :- command_category(Command,dot), command_arguments(Command,[dotfile]).

is_dot_command(Command,Name,Description,NumberOfFormulaArgs,Preferences,AdditionalInfo) :-
    command_description(Command,Name,Description), % move forward to ensure ordering of found commands is same as in file
    (is_dot_command(Command),NumberOfFormulaArgs=0 ;
    is_dot_command_for_expr(Command),NumberOfFormulaArgs=1),
    get_command_preferences(Command, Preferences),
    findall(Info, command_additional_info(Command, Info), AdditionalInfo).

is_dot_command_for_expr(Command) :-
    command_category(Command,dot), command_arguments(Command,[expression_atom,dotfile]).

is_plantuml_command(Command) :- command_category(Command,plantuml), command_arguments(Command,[plantumlfile]).

is_plantuml_command(Command,Name,Description,NumberOfFormulaArgs,Preferences,AdditionalInfo) :-
    command_description(Command,Name,Description), % move forward to ensure ordering of found commands is same as in file
    (is_plantuml_command(Command),NumberOfFormulaArgs=0 ;
    is_plantuml_command_for_expr(Command),NumberOfFormulaArgs=1),
    get_command_preferences(Command, Preferences),
    findall(Info, command_additional_info(Command, Info), AdditionalInfo).

is_plantuml_command_for_expr(Command) :-
    command_category(Command,plantuml), command_arguments(Command,[expression_atom,plantumlfile]).

is_table_command(Command) :-
    is_table_command(Command,_,_,0,_,_).

is_table_command(Command,Name,Description,NumberOfFormulaArgs,Preferences,AdditionalInfo) :-
    command_category(Command,table),
    command_arguments(Command,Args), last(Args,table_result),
    length(Args,Len), NumberOfFormulaArgs is Len - 1,
    command_description(Command,Name,Description),
    get_command_preferences(Command, Preferences),
    findall(Info, command_additional_info(Command, Info), AdditionalInfo).

is_table_command_for_expr(Command) :-
    command_category(Command,table), command_arguments(Command,[expression_atom,table_result]).

meta_get_machine_stats(list([list(['Key','Nr'])|L])) :- findall(list([Key,Nr]),b_machine_statistics(Key,Nr),L).

minmax_table(R) :- tcltk_compute_min_max(R).

plantuml_filename_extension_can_be_converted(File,Ext,DotFile) :-
    split_filename(File,FileRoot,Ext), Ext \= puml,
    valid_plantuml_output_format(Ext),!, % we can convert a plantuml file to this format
    ajoin([FileRoot,'.puml'],DotFile). % TODO: we could generate a temp file in /tmp

setup_opt_args_aux([],[],OptArgs,Command,Res) :-
    (OptArgs = [] -> true ; add_internal_error('Too many optional arguments: ',Command:OptArgs)),
    Res = [].

setup_opt_args_aux([Name|NT],[Default|DT],OptArgs,Command,Res) :-
    (select('='(Name,Value),OptArgs,OA2)
    -> Res = [Value|RT], setup_opt_args_aux(NT,DT,OA2,Command,RT)
    ; Res = [Default|RT], setup_opt_args_aux(NT,DT,OptArgs,Command,RT)
).

setup_optional_args(Command,OptionalArgs,OptArgValueList) :-
    command_optional_arguments(Command,Names,_Types,DefaultValues),!,
    setup_opt_args_aux(Names,DefaultValues,OptionalArgs,Command,OptArgValueList).

setup_optional_args(_,[],Res) :- !, Res=[].

setup_optional_args(Cmd,Opt,Res) :- add_internal_error('Illegal optional arguments: ',setup_optional_args(Cmd,Opt,Res)),
    Res=[].

show_typing_table(list([list(['Typing'])|LRes])) :- tcltk_interface:tcltk_show_typing_of_variables_and_constants(list(Res)),
    maplist(wrap_into_list,Res,LRes).

specialized_invariants(list([list(['Operation','Unproven','Predicate'])|LRes])) :-
    bmachine:tcltk_get_specialized_invariants_for_ops(list(Res)),
    maplist(wrap_into_list,Res,LRes).

vacuous_guards(list([list(['Vacuous Guards'])|LRes])) :-
    tcltk_interface:tcltk_get_vacuous_guards(list(Res)),
    maplist(wrap_into_list,Res,LRes).

vacuous_invariants(Res) :-
    tcltk_interface:tcltk_get_vacuous_invariants_table(Res).

wrap_into_list(list(L),R) :- !, R=list(L).

wrap_into_list([],R) :- !, R=list([]).

wrap_into_list([H|T],R) :- !, R=list([H|T]).

wrap_into_list(X,list([X])).

write_row([],_,_) :- !.

write_row(list(L),Options,Stream) :- !, write_row(L,Options,Stream).

write_row([H],Options,Stream) :- !, write_value(H,Options,Stream).

write_row([H|T],Options,Stream) :- !, write_value(H,Options,Stream), write_sep(Options,Stream),
    write_row(T,Options,Stream).

write_row(Other,Options,Stream) :- write(Stream,Other),nl(Stream),
    add_internal_error('Table row is not a list: ',write_table_to_csv_stream(Stream,Options,Other)).

write_sep(Options,Stream) :- member(csv_separator(Sep),Options), !, write(Stream,Sep).

write_sep(_,Stream) :- write(Stream,',').

write_table_to_csv_file(CSVFile,Table) :-
    write_table_to_csv_file(CSVFile,[],Table).

write_table_to_csv_file(CSVFile,Opts,Table) :-
    (CSVFile=user_output ;
    member(text_output,Opts)),
    !, % use textual output on user_output
    Options = [csv_separator(' '),no_quoting|Opts],
    safe_intelligent_open_file(CSVFile,write,Stream),
    call_cleanup(write_table_to_csv_stream(Stream,Options,Table), close(Stream)).

write_table_to_csv_file(CSVFile,Options,Table) :-
    safe_intelligent_open_file(CSVFile,write,Stream),
    call_cleanup(write_table_to_csv_stream(Stream,Options,Table), close(Stream)).

write_table_to_csv_stream(Stream,Options,list(L)) :- !,
    write_table_to_csv_stream(Stream,Options,L).

write_table_to_csv_stream(_Stream,_,[]) :- !.

write_table_to_csv_stream(Stream,Options,[H|T]) :- !, write_row(H,Options,Stream), nl(Stream),
    write_table_to_csv_stream(Stream,Options,T).

write_table_to_csv_stream(Stream,Options,Other) :- write(Stream,Other),nl(Stream),
    add_internal_error('Table is not a list: ',write_table_to_csv_stream(Stream,Options,Other)).

write_table_to_text_file(TextFile,Table) :-
    write_table_to_csv_file(TextFile,[text_output],Table).

write_value(Nr,_,Stream) :- number(Nr), !, write(Stream,Nr).

write_value(Val,Options,Stream) :- member(no_quoting,Options), !, write(Stream,Val).

write_value(Atom,_,Stream) :- atom(Atom), atom_codes(Atom,AC),!,
    csv_escape_codes(AC,EC),
    format(Stream,'"~s"',[EC]). % quote for CSV

write_value(Other,_,Stream) :- format(Stream,'"~w"',[Other]).