Variable: antlr-options-alists

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

Value

Large value
((("language" antlr-language-option-extra
   (20600 antlr-read-value "Generated language: " language-as-string
	  (("Java")
	   ("Cpp")
	   ("HTML")
	   ("Diagnostic")))
   (20700 antlr-read-value "Generated language: " language-as-string
	  (("Java")
	   ("Cpp")
	   ("HTML")
	   ("Diagnostic")
	   ("Sather"))))
  ("mangleLiteralPrefix" nil
   (20600 antlr-read-value "Prefix for literals (default LITERAL_): " t))
  ("namespace" antlr-c++-mode-extra
   (20700 antlr-read-value "Wrap generated C++ code in namespace: " t))
  ("namespaceStd" antlr-c++-mode-extra
   (20701 antlr-read-value "Replace ANTLR_USE_NAMESPACE(std) by: " t))
  ("namespaceAntlr" antlr-c++-mode-extra
   (20701 antlr-read-value "Replace ANTLR_USE_NAMESPACE(antlr) by: " t))
  ("genHashLines" antlr-c++-mode-extra
   (20701 antlr-read-boolean "Include #line in generated C++ code? ")))
 (("k" nil
   (20600 antlr-read-value "Lookahead depth: "))
  ("importVocab" nil
   (20600 antlr-read-value "Import vocabulary: "))
  ("exportVocab" nil
   (20600 antlr-read-value "Export vocabulary: "))
  ("testLiterals" nil
   (20600 antlr-read-boolean "Test each token against literals table? "))
  ("defaultErrorHandler" nil
   (20600 antlr-read-boolean "Generate default exception handler for each rule? "))
  ("codeGenMakeSwitchThreshold" nil
   (20600 antlr-read-value "Min number of alternatives for `switch': "))
  ("codeGenBitsetTestThreshold" nil
   (20600 antlr-read-value "Min size of lookahead set for bitset test: "))
  ("analyzerDebug" nil
   (20600 antlr-read-boolean "Display debugging info during grammar analysis? "))
  ("codeGenDebug" nil
   (20600 antlr-read-boolean "Display debugging info during code generation? "))
  ("buildAST" nil
   (20600 antlr-read-boolean "Use automatic AST construction/transformation? "))
  ("ASTLabelType" nil
   (20600 antlr-read-value "Class of user-defined AST node: " t))
  ("charVocabulary" nil
   (20600 nil "Insert character vocabulary"))
  ("interactive" nil
   (20600 antlr-read-boolean "Generate interactive lexer/parser? "))
  ("caseSensitive" nil
   (20600 antlr-read-boolean "Case significant when matching characters? "))
  ("caseSensitiveLiterals" nil
   (20600 antlr-read-boolean "Case significant when testing literals table? "))
  ("classHeaderSuffix" nil
   (20600 nil "Additional string for grammar class definition"))
  ("filter" nil
   (20600 antlr-read-boolean "Skip rule (the name, true or false): " antlr-grammar-tokens))
  ("namespace" antlr-c++-mode-extra
   (20700 antlr-read-value "Wrap generated C++ code for grammar in namespace: " t))
  ("namespaceStd" antlr-c++-mode-extra
   (20701 antlr-read-value "Replace ANTLR_USE_NAMESPACE(std) by: " t))
  ("namespaceAntlr" antlr-c++-mode-extra
   (20701 antlr-read-value "Replace ANTLR_USE_NAMESPACE(antlr) by: " t))
  ("genHashLines" antlr-c++-mode-extra
   (20701 antlr-read-boolean "Include #line in generated C++ code? ")))
 (("testLiterals" nil
   (20600 antlr-read-boolean "Test this token against literals table? "))
  ("defaultErrorHandler" nil
   (20600 antlr-read-boolean "Generate default exception handler for this rule? "))
  ("ignore" nil
   (20600 antlr-read-value "In this rule, ignore tokens of type: " nil antlr-grammar-tokens))
  ("paraphrase" nil
   (20600 antlr-read-value "In messages, replace name of this token by: " t)))
 (("warnWhenFollowAmbig" nil
   (20600 antlr-read-boolean "Display warnings for ambiguities with FOLLOW? "))
  ("generateAmbigWarnings" nil
   (20600 antlr-read-boolean "Display warnings for ambiguities? "))
  ("greedy" nil
   (20700 antlr-read-boolean "Make this optional/loop subrule greedy? "))))

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 and is either t or a symbol which is a member of antlr-options-style.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/antlr-mode.el.gz
(defvar antlr-options-alists
  '(;; file options ----------------------------------------------------------
    (("language" antlr-language-option-extra
      (20600 antlr-read-value
	     "Generated language: " language-as-string
	     (("Java") ("Cpp") ("HTML") ("Diagnostic")))
      (20700 antlr-read-value
	     "Generated language: " language-as-string
	     (("Java") ("Cpp") ("HTML") ("Diagnostic") ("Sather"))))
     ("mangleLiteralPrefix" nil
      (20600 antlr-read-value
	     "Prefix for literals (default LITERAL_): " t))
     ("namespace" antlr-c++-mode-extra
      (20700 antlr-read-value
	     "Wrap generated C++ code in namespace: " t))
     ("namespaceStd" antlr-c++-mode-extra
      (20701 antlr-read-value
	     "Replace ANTLR_USE_NAMESPACE(std) by: " t))
     ("namespaceAntlr" antlr-c++-mode-extra
      (20701 antlr-read-value
	     "Replace ANTLR_USE_NAMESPACE(antlr) by: " t))
     ("genHashLines" antlr-c++-mode-extra
      (20701 antlr-read-boolean
	     "Include #line in generated C++ code? "))
     )
    ;; grammar options --------------------------------------------------------
    (("k" nil
      (20600 antlr-read-value
	     "Lookahead depth: "))
     ("importVocab" nil
      (20600 antlr-read-value
	     "Import vocabulary: "))
     ("exportVocab" nil
      (20600 antlr-read-value
	     "Export vocabulary: "))
     ("testLiterals" nil		; lexer only
      (20600 antlr-read-boolean
	     "Test each token against literals table? "))
     ("defaultErrorHandler" nil		; not for lexer
      (20600 antlr-read-boolean
	     "Generate default exception handler for each rule? "))
     ("codeGenMakeSwitchThreshold" nil
      (20600 antlr-read-value
	     "Min number of alternatives for `switch': "))
     ("codeGenBitsetTestThreshold" nil
      (20600 antlr-read-value
	     "Min size of lookahead set for bitset test: "))
     ("analyzerDebug" nil
      (20600 antlr-read-boolean
	     "Display debugging info during grammar analysis? "))
     ("codeGenDebug" nil
      (20600 antlr-read-boolean
	     "Display debugging info during code generation? "))
     ("buildAST" nil			; not for lexer
      (20600 antlr-read-boolean
	     "Use automatic AST construction/transformation? "))
     ("ASTLabelType" nil		; not for lexer
      (20600 antlr-read-value
	     "Class of user-defined AST node: " t))
     ("charVocabulary" nil		; lexer only
      (20600 nil
	     "Insert character vocabulary"))
     ("interactive" nil
      (20600 antlr-read-boolean
	     "Generate interactive lexer/parser? "))
     ("caseSensitive" nil		; lexer only
      (20600 antlr-read-boolean
	     "Case significant when matching characters? "))
     ("caseSensitiveLiterals" nil	; lexer only
      (20600 antlr-read-boolean
	     "Case significant when testing literals table? "))
     ("classHeaderSuffix" nil
      (20600 nil
	     "Additional string for grammar class definition"))
     ("filter" nil			; lexer only
      (20600 antlr-read-boolean
	     "Skip rule (the name, true or false): "
	     antlr-grammar-tokens))
     ("namespace" antlr-c++-mode-extra
      (20700 antlr-read-value
	     "Wrap generated C++ code for grammar in namespace: " t))
     ("namespaceStd" antlr-c++-mode-extra
      (20701 antlr-read-value
	     "Replace ANTLR_USE_NAMESPACE(std) by: " t))
     ("namespaceAntlr" antlr-c++-mode-extra
      (20701 antlr-read-value
	     "Replace ANTLR_USE_NAMESPACE(antlr) by: " t))
     ("genHashLines" antlr-c++-mode-extra
      (20701 antlr-read-boolean
	     "Include #line in generated C++ code? "))
;;;     ("autoTokenDef" nil		; parser only
;;;      (80000 antlr-read-boolean		; default: true
;;;	     "Automatically define referenced token? "))
;;;     ("keywordsMeltTo" nil		; parser only
;;;      (80000 antlr-read-value
;;;	     "Change non-matching keywords to token type: "))
     )
    ;; rule options ----------------------------------------------------------
    (("testLiterals" nil		; lexer only
      (20600 antlr-read-boolean
	     "Test this token against literals table? "))
     ("defaultErrorHandler" nil		; not for lexer
      (20600 antlr-read-boolean
	     "Generate default exception handler for this rule? "))
     ("ignore" nil			; lexer only
      (20600 antlr-read-value
	     "In this rule, ignore tokens of type: " nil
	     antlr-grammar-tokens))
     ("paraphrase" nil			; lexer only
      (20600 antlr-read-value
	     "In messages, replace name of this token by: " t))
     )
    ;; subrule options -------------------------------------------------------
    (("warnWhenFollowAmbig" nil
      (20600 antlr-read-boolean
	     "Display warnings for ambiguities with FOLLOW? "))
     ("generateAmbigWarnings" nil
      (20600 antlr-read-boolean
	     "Display warnings for ambiguities? "))
     ("greedy" nil
      (20700 antlr-read-boolean
	     "Make this optional/loop subrule greedy? "))
     ))
  "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 and is either t or a symbol which is a member of
`antlr-options-style'.")