Variable: antlr-options-alists

antlr-options-alists is a variable defined in antlr-mode.el.gz.

Value

nil

Documentation

Definitions for Antlr's options of all four different kinds.

The value looks like (FILE GRAMMAR RULE SUBRULE) where each FILE, GRAMMAR, RULE, and SUBRULE is a list of option definitions of the corresponding kind, i.e., looks like (OPTION-DEF...).

Each OPTION-DEF looks like (OPTION-NAME EXTRA-FN VALUE-SPEC...) which defines a file/grammar/rule/subrule option with name OPTION-NAME. The OPTION-NAMEs are used for the creation of the "Insert XXX Option" submenus, see antlr-options-use-submenus, and to allow the insertion of the option name with completion when using M-x antlr-insert-option (antlr-insert-option).

If EXTRA-FN is a function, it is called at different phases of the insertion with arguments (PHASE OPTION-NAME). PHASE can have the values before-input or after-insertion, additional phases might be defined in future versions of this mode. The phase before-input occurs before the user is asked to insert a value. The phase after-insertion occurs after the option value has been inserted. EXTRA-FN might be called with additional arguments in future versions of this mode.

Each specification VALUE-SPEC looks like (VERSION READ-FN ARG...). The last VALUE-SPEC in an OPTION-DEF whose VERSION is smaller or equal to antlr-tool-version specifies how the user is asked for the value of the option.

If READ-FN is nil, the only ARG is a string which is printed at the echo area to guide the user what to insert at point. Otherwise, READ-FN is called with arguments (INIT-VALUE ARG...) to get the new value of the option. INIT-VALUE is the old value of the option or nil.

The standard value contains the following functions as READ-FN: antlr-read-value with ARGs = (PROMPT AS-STRING TABLE) which reads a general value, or antlr-read-boolean with ARGs = (PROMPT TABLE) which reads a boolean value or a member of TABLE. PROMPT is the prompt when asking for a new value. If non-nil, TABLE is a table for completion or a function evaluating to such a table. The return value is quoted if AS-STRING is non-nil.

The value is tool-dependent, see antlr-tool-version-variables.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/antlr-mode.el.gz
(defvar antlr-options-alists nil
  ;; TODO: distinguish between "no known option" (options{} is allowed), and
  ;; does not exist (file options in v3 and v4)
  "Definitions for Antlr's options of all four different kinds.

The value looks like \(FILE GRAMMAR RULE SUBRULE) where each FILE,
GRAMMAR, RULE, and SUBRULE is a list of option definitions of the
corresponding kind, i.e., looks like \(OPTION-DEF...).

Each OPTION-DEF looks like \(OPTION-NAME EXTRA-FN VALUE-SPEC...) which
defines a file/grammar/rule/subrule option with name OPTION-NAME.  The
OPTION-NAMEs are used for the creation of the \"Insert XXX Option\"
submenus, see `antlr-options-use-submenus', and to allow the insertion
of the option name with completion when using \\[antlr-insert-option].

If EXTRA-FN is a function, it is called at different phases of the
insertion with arguments \(PHASE OPTION-NAME).  PHASE can have the
values `before-input' or `after-insertion', additional phases might be
defined in future versions of this mode.  The phase `before-input'
occurs before the user is asked to insert a value.  The phase
`after-insertion' occurs after the option value has been inserted.
EXTRA-FN might be called with additional arguments in future versions of
this mode.

Each specification VALUE-SPEC looks like \(VERSION READ-FN ARG...).  The
last VALUE-SPEC in an OPTION-DEF whose VERSION is smaller or equal to
`antlr-tool-version' specifies how the user is asked for the value of
the option.

If READ-FN is nil, the only ARG is a string which is printed at the echo
area to guide the user what to insert at point.  Otherwise, READ-FN is
called with arguments \(INIT-VALUE ARG...) to get the new value of the
option.  INIT-VALUE is the old value of the option or nil.

The standard value contains the following functions as READ-FN:
`antlr-read-value' with ARGs = \(PROMPT AS-STRING TABLE) which reads a
general value, or `antlr-read-boolean' with ARGs = \(PROMPT TABLE) which
reads a boolean value or a member of TABLE.  PROMPT is the prompt when
asking for a new value.  If non-nil, TABLE is a table for completion or
a function evaluating to such a table.  The return value is quoted if
AS-STRING is non-nil.

The value is tool-dependent, see `antlr-tool-version-variables'.")