menu_generator (library)

Usage:menu(M)

Like menu(M,true).

Usage:menu(M,Bool)

Like menu/4 with no selected options, taking the menu level from the term M (example: ana(1) is expert, ana is naive), and using Bool to decide whether print help message or not.

Usage:menu(M,Level,Bool)

Like menu/4 with no selected options.

Usage:menu(M,Level,Bool,AlreadySelectedOpts)

Execute the menu X. Level specifies the menu level. Bool decides whether print the help message. AlreadySelectedOpts is a list with the selected options.

Usage:exists_menu_flag(M,F)

The flag F in the menu (-branch) M has a default value.

• The following properties should hold at call time:
  (basic_props:atm/1)M is an atom.
  (basic_props:atm/1)F is an atom.

Usage:get_menu_flag(M,F,V)

Returns the value in V of the flag F in the menu (-branch) M.

• The following properties should hold at call time:
  (basic_props:atm/1)M is an atom.
  (basic_props:atm/1)F is an atom.
  (term_typing:var/1)V is a free variable.

Usage:set_menu_flag(M,F,V)

Set the value V of the flag F in the menu (-branch) M.

• The following properties should hold at call time:
  (basic_props:atm/1)M is an atom.
  (basic_props:atm/1)F is an atom.
  (term_typing:var/1)V is a free variable.

Usage:space(N)

prints N spaces.

• The following properties should hold at call time:
  (basic_props:num/1)N is a number.

Usage:get_menu_configs(X)

Returns a list of atoms in X with the name of stored configurations.

• The following properties should hold at call time:
  (term_typing:var/1)X is a free variable.
• The following properties should hold upon exit:
  (basic_props:list/2)X is a list of atms.

Usage:save_menu_config(Name)

Save the current flags configuration under the Name key.

• The following properties should hold at call time:
  (basic_props:atm/1)Name is an atom.

Usage:remove_menu_config(Name)

Remove the configuration stored with the Name key (the same provided in save_menu_config/1).

• The following properties should hold at call time:
  (basic_props:atm/1)Name is an atom.

Usage:restore_menu_config(Name)

Restore the configuration saved with the Name key (the same provided in save_menu_config/1).

• The following properties should hold at call time:
  (basic_props:atm/1)Name is an atom.

Usage:

Show all stored configurations.

Usage:show_menu_config(C)

Show specific configuration values pointed by C key (the same provided in save_menu_config/1).

• The following properties should hold at call time:
  (basic_props:atm/1)C is an atom.

Usage:get_menu_flags(L)

Return a list L of all current menu flags, composed by terms with the form (M,F,V), where M is the menu, F the flag, and V the value. This list can be used as argument of restore_flags_list/1

• The following properties should hold at call time:
  (term_typing:var/1)L is a free variable.
• The following properties should hold upon exit:
  (basic_props:list/1)L is a list.

Usage:restore_menu_flags_list(L)

Restores menu flags. L is a list of tuple (M,F,V) where M is the menu, F is the flag, and V is the value of the flag F in the menu M.

• The following properties should hold at call time:
  (basic_props:list/1)L is a list.

Usage:get_menu_flags(M,L)

Return a list L of the current menu M composed by terms with the form (F=V), F the flag, and V the value. This list can be used as argument of restore_menu_flags/2

• The following properties should hold at call time:
  (basic_props:term/1)M is any term.
  (term_typing:var/1)L is a free variable.
• The following properties should hold upon exit:
  (basic_props:list/1)L is a list.

Usage:restore_menu_flags(M,F)

Restore the flag of the menu M. F is a list of terms F=V, which indicate the flag (F) and the value (V). M is the target menu to which those flags "belong". Additionally, F can contains terms like changed_to_menu(NM) that will put NM as the new target menu.

• The following properties should hold at call time:
  (basic_props:atm/1)M is an atom.
  (basic_props:list/1)F is a list.

Usage:generate_offline_menu(EntryMenu,MenuItems)

Generate an offline menu MenuItems for the given EntryMenu

• The following properties should hold at call time:
  (basic_props:term/1)EntryMenu is any term.
  (basic_props:term/1)MenuItems is any term.

Usage:eq(Type,A,B)

Type is the value returned by the 2nd arg of uni_type. A and B are whatever terms. This predicate success if they are equal (like A=B).

Usage:neq(Type,A,B)

Type is the value returned by the 2nd arg of uni_type. A and B are whatever terms. The semantic is similar to A == B.

Usage:uni_type(Var,Type)

Var should be the argument passed to the menu guard. Type is an abstract type that decides how unifications should be done in eq/3 and neq/3.

Usage:vmember(Var,List)

It is member equivalent predicate to be used in guards.

Usage:menu_flag_values(X)

Flag values