YaST2 Developers Documentation: yast2

yast2

modules/Sequencer.ycp
Wizard Sequencer
  • Michal Svec

This module has an unstable interface.

This is an implementation of the wizard sequencer, the tool for processing workflows of dialogs.
All errors are reported to y2log, so if anything is unfunctional look to the y2log.

Global Functions

Local Functions

local WS_testall (map aliases) -> list

Test (run) all dialogs in the aliases map

Parameters:
aliases the map of aliases
Return value:
returned values of tested dialogs
See
WS documentation for the format of aliases map
local WS_check (map aliases, map sequence) -> boolean

Check correct types in maps and alias presence for sequence.

Parameters:
aliases the map of aliases
sequence the sequence of dialogs
Return value:
check passed?
local WS_error (string error) -> any

Report error and return nil

Parameters:
error the error message text
Return value:
always nil
See
bug #6474
local WS_alias (map aliases, string alias) -> any

Find an aliases in the aliases map

Parameters:
aliases map of aliases
alias given alias
Return value:
belonging to the given alias or nil, if error
local WS_special (map aliases, string alias) -> boolean

Decide if an alias is special

Parameters:
aliases map of aliases
alias given alias
Return value:
true if the given alias is special or nil, if not found
local WS_next (map sequence, string current, symbol ret) -> any

Find a next item in the sequence

Parameters:
sequence sequence of dialogs
current current dialog
ret returned value (determines the next dialog)
Return value:
next dialog (symbol), WS action (string) or nil, if error (current or next not found)
local WS_run (map aliases, string id) -> symbol

Run a function from the aliases map

Parameters:
aliases map of aliases
id function to run
Return value:
returned value from function or nil, if function is nil or returned something else than symbol
local WS_push (list stack, any item) -> list

Push one item to the stack

Parameters:
stack stack of previously run dialogs
item item to be pushed
Return value:
the new stack or nil, if the stack is nil
local WS_pop (list stack) -> list

Pop one item from the stack (remove an item and return the stack top item)

Parameters:
stack stack of previously run dialogsk
Return value:
[ new stack, poped value ] or nil if the stack is empty or nil
global Run (map aliases, map sequence) -> symbol

The Wizard Sequencer

Parameters:
aliases the map of aliases
sequence the sequence of dialogs
Return value:
final symbol or nil, if error (see the y2log)