Reference

Table of Contents  ▸  List of Commands  ▸  Input / Output  ▸  parse_gui◀  parse_cli    |    pass  ▶

parse_gui

Arguments:

Description:

Parse selected filter definitions and generate info about filters in selected output mode.

outputmode can be { json | list | print | strings | update | zart }.

It is possible to define a custom output mode, by implementing the following commands
(outputmode must be replaced by the name of the custom user output mode):
parse_gui_outputmode : A command that outputs the parsing information with a custom format.
parse_gui_parseparams_outputmode (optional): A simple command that returns 0 or 1. It tells the parser whether parameters of matching filter must be analyzed (slower) or not.
parse_gui_trigger_outputmode (optional): A command that is called by the parser just before parsing the set of each matching filters.
Here is the list of global variables set by the parser, accessible in command 'parse_gui_outputmode':

$_nbfilters: Number of matching filters.
$_nongui (stored as an image): All merged lines in the file that do not correspond to #@gui lines.

For each filter #F (F in range [0,$_nbfilters-1]):
$_fF_name : Filter name.
$_fF_path : Full path.
$_fF_locale : Filter locale (empty, if not specified).
$_fF_command : Filter command.
$_fF_commandpreview : Filter preview command (empty, if not specified).
$_fF_zoomfactor : Default zoom factor (empty, if not specified).
$_fF_zoomaccurate : Is preview accurate when zoom changes ? (can be { 0=false | 1=true }).
$_fF_inputmode : Default preferred input mode (empty, if not specified).
$_fF_hide : Path of filter hid by current filter (for localized filters, empty if not specified).
$_fF_nbparams : Number of parameters.
For each parameter #P of the filter #F (P in range [0,$_fF_nbparams-1]):
$_fF_pP_name : Parameter name.
$_fF_pP_type : Parameter type.
$_fF_pP_responsivity : Parameter responsivity (can be { 0 | 1 }).
$_fF_pP_visibility : Parameter visibility.
$_fF_pP_propagation : Propagation of the parameter visibility.
$_fF_pP_nbargs : Number of parameter arguments.
For each argument #A of the parameter #P (A in range [0,$_fF_pP_nbargs-1]):
$_fF_pP_aA : Argument value
Default parameters: filter_name=* and output_format=print.