1 ;;; antlr-mode.el --- major mode for ANTLR grammar files
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005 Free Software Foundation, Inc.
5 ;; Author: Christoph.Wedler@sap.com
6 ;; Keywords: languages, ANTLR, code generator
7 ;; Version: (see `antlr-version' below)
8 ;; X-URL: http://antlr-mode.sourceforge.net/
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; The Emacs package ANTLR-Mode provides: syntax highlighting for ANTLR grammar
30 ;; files, automatic indentation, menus containing rule/token definitions and
31 ;; supported options and various other things like running ANTLR from within
34 ;; For details, check <http://antlr-mode.sourceforge.net/> or, if you prefer
35 ;; the manual style, follow all commands mentioned in the documentation of
36 ;; `antlr-mode'. ANTLR is a LL(k)-based recognition tool which generates
37 ;; lexers, parsers and tree transformers in Java, C++ or Sather and can be
38 ;; found at <http://www.antlr.org/>.
40 ;; Bug fixes, bug reports, improvements, and suggestions for the newest version
41 ;; are strongly appreciated.
45 ;; * Next Version [C-c C-w]. Produce HTML document with syntax highlighted
46 ;; and hyper-links (using htmlize).
47 ;; * Next Version [C-c C-u]. Insert/update special comments: each rule lists
48 ;; all rules which use the current rule. With font-lock update.
49 ;; * Next Version. Make hiding much more customizable.
50 ;; * Planned [C-c C-j]. Jump to generated coding.
51 ;; * Planned. Further support for imenu, i.e., include entries for method
52 ;; definitions at beginning of grammar class.
53 ;; * Planned [C-c C-p]. Pack/unpack rule/subrule & options (one/multi-line).
55 ;; * Probably. Show rules/dependencies for ANT like for Makefile (does ANT
56 ;; support vocabularies and grammar inheritance?), I have to look at
57 ;; jde-ant.el: http://jakarta.apache.org/ant/manual/OptionalTasks/antlr.html
58 ;; * Probably. Make `indent-region' faster, especially in actions. ELP
59 ;; profiling in a class init action shows half the time is spent in
60 ;; `antlr-next-rule', the other half in `c-guess-basic-syntax'.
61 ;; * Unlikely. Sather as generated language with syntax highlighting etc/.
62 ;; Questions/problems: is sather-mode.el the standard mode for sather, is it
63 ;; still supported, what is its relationship to eiffel3.el? Requirement:
64 ;; this mode must not depend on a Sather mode.
65 ;; * Unlikely. Faster syntax highlighting: sectionize the buffer into Antlr
66 ;; and action code and run special highlighting functions on these regions.
67 ;; Problems: code size, this mode would depend on font-lock internals.
71 ;; This file requires Emacs-20.3, XEmacs-20.4 or higher and package cc-mode.
73 ;; If antlr-mode is not part of your distribution, put this file into your
74 ;; load-path and the following into your ~/.emacs:
75 ;; (autoload 'antlr-mode "antlr-mode" nil t)
76 ;; (setq auto-mode-alist (cons '("\\.g\\'" . antlr-mode) auto-mode-alist))
77 ;; (add-hook 'speedbar-load-hook ; would be too late in antlr-mode.el
78 ;; (lambda () (speedbar-add-supported-extension ".g")))
80 ;; I strongly recommend to use font-lock with a support mode like fast-lock,
81 ;; lazy-lock or better jit-lock (Emacs-21.1+) / lazy-shot (XEmacs).
83 ;; To customize, use menu item "Antlr" -> "Customize Antlr".
90 ;; General Emacs/XEmacs-compatibility compile-time macros
93 (defmacro cond-emacs-xemacs (&rest args)
94 (cond-emacs-xemacs-macfn
95 args "`cond-emacs-xemacs' must return exactly one element"))
96 (defun cond-emacs-xemacs-macfn (args &optional msg)
98 (and (eq (car args) :@) (null msg) ; (:@ ...spliced...)
100 msg "(:@ ....) must return exactly one element"))
101 (let ((ignore (if (string-match "XEmacs" emacs-version) :EMACS :XEMACS))
104 (if (memq (car args) '(:EMACS :XEMACS :BOTH)) (setq mode (pop args)))
106 (or args (error "Used selector %s without elements" mode))
108 (push (cond-emacs-xemacs-macfn (car args)) code))
110 (cond (msg (if (or args (cdr code)) (error msg) (car code)))
111 ((or (null args) (eq ignore mode)) (nreverse code))
112 (t (nconc (nreverse code) args))))))
113 ;; Emacs/XEmacs-compatibility `defun': remove interactive "_" for Emacs, use
114 ;; existing functions when they are `fboundp', provide shortcuts if they are
115 ;; known to be defined in a specific Emacs branch (for short .elc)
116 (defmacro defunx (name arglist &rest definition)
117 (let ((xemacsp (string-match "XEmacs" emacs-version)) reuses)
118 (while (memq (car definition)
119 '(:try :emacs-and-try :xemacs-and-try))
120 (if (eq (pop definition) (if xemacsp :xemacs-and-try :emacs-and-try))
121 (setq reuses (car definition)
123 (push (pop definition) reuses)))
124 (if (and reuses (symbolp reuses))
125 `(defalias ',name ',reuses)
126 (let* ((docstring (if (stringp (car definition)) (pop definition)))
127 (spec (and (not xemacsp)
128 (eq (car-safe (car definition)) 'interactive)
129 (null (cddar definition))
130 (cadar definition))))
131 (if (and (stringp spec)
132 (not (string-equal spec ""))
133 (eq (aref spec 0) ?_))
135 (cons (if (string-equal spec "_")
137 `(interactive ,(substring spec 1)))
140 `(defun ,name ,arglist ,docstring
141 ,@(cond-emacs-xemacs-macfn definition))
142 ;; no dynamic docstring in this case
143 `(eval-and-compile ; no warnings in Emacs
145 (cond ,@(mapcar (lambda (func) `((fboundp ',func) ',func))
148 `(lambda ,arglist ,docstring
149 ,@(cond-emacs-xemacs-macfn definition))
151 (defmacro ignore-errors-x (&rest body)
152 (let ((specials '((scan-sexps . 4) (scan-lists . 5)))
154 (if (and (string-match "XEmacs" emacs-version)
155 (null (cdr body)) (consp (car body))
156 (setq spec (assq (caar body) specials))
157 (>= (setq nils (- (cdr spec) (length (car body)))) 0))
158 `(,@(car body) ,@(make-list nils nil) t)
159 `(ignore-errors ,@body)))))
161 ;; More compile-time-macros
163 (defmacro save-buffer-state-x (&rest body) ; similar to EMACS/lazy-lock.el
164 (let ((modified (with-no-warnings (gensym "save-buffer-state-x-modified-"))))
165 `(let ((,modified (buffer-modified-p)))
167 (let ((buffer-undo-list t) (inhibit-read-only t)
168 ,@(unless (string-match "XEmacs" emacs-version)
169 '((inhibit-point-motion-hooks t) deactivate-mark))
170 before-change-functions after-change-functions
171 buffer-file-name buffer-file-truename)
173 (and (not ,modified) (buffer-modified-p)
174 (set-buffer-modified-p nil)))))))
175 (put 'save-buffer-state-x 'lisp-indent-function 0)
177 ;; get rid of byte-compile warnings
178 (eval-when-compile ; required and optional libraries
180 (ignore-errors (require 'font-lock))
181 (ignore-errors (require 'compile))
182 ;;(ignore-errors (defun c-init-language-vars))) dangerous on Emacs!
183 ;;(ignore-errors (defun c-init-c-language-vars))) dangerous on Emacs!
184 ;;(ignore-errors (defun c-basic-common-init)) dangerous on Emacs!
185 (defvar outline-level) (defvar imenu-use-markers)
186 (defvar imenu-create-index-function))
188 ;; We cannot use `c-forward-syntactic-ws' directly since it is a macro since
189 ;; cc-mode-5.30 => antlr-mode compiled with older cc-mode would fail (macro
190 ;; call) when used with newer cc-mode. Also, antlr-mode compiled with newer
191 ;; cc-mode would fail (undefined `c-forward-sws') when used with older cc-mode.
192 ;; Additional to the `defalias' below, we must set `antlr-c-forward-sws' to
193 ;; `c-forward-syntactic-ws' when `c-forward-sws' is not defined after requiring
195 (defalias 'antlr-c-forward-sws 'c-forward-sws)
198 ;;;;##########################################################################
200 ;;;;##########################################################################
204 "Major mode for ANTLR grammar files."
206 :link '(emacs-commentary-link "antlr-mode.el")
207 :link '(url-link "http://antlr-mode.sourceforge.net/")
210 (defconst antlr-version "2.2c"
211 "ANTLR major mode version number.
212 Check <http://antlr-mode.sourceforge.net/> for the newest.")
215 ;;;===========================================================================
216 ;;; Controlling ANTLR's code generator (language option)
217 ;;;===========================================================================
219 (defvar antlr-language nil
220 "Major mode corresponding to ANTLR's \"language\" option.
221 Set via `antlr-language-alist'. The only useful place to change this
222 buffer-local variable yourself is in `antlr-mode-hook' or in the \"local
223 variable list\" near the end of the file, see
224 `enable-local-variables'.")
226 (defcustom antlr-language-alist
227 '((java-mode "Java" nil "\"Java\"" "Java")
228 (c++-mode "C++" "\"Cpp\"" "Cpp"))
229 "List of ANTLR's supported languages.
230 Each element in this list looks like
231 \(MAJOR-MODE MODELINE-STRING OPTION-VALUE...)
233 MAJOR-MODE, the major mode of the code in the grammar's actions, is the
234 value of `antlr-language' if the first group in the string matched by
235 REGEXP in `antlr-language-limit-n-regexp' is one of the OPTION-VALUEs.
236 An OPTION-VALUE of nil denotes the fallback element. MODELINE-STRING is
237 also displayed in the modeline next to \"Antlr\"."
239 :type '(repeat (group :value (java-mode "")
240 (function :tag "Major mode")
241 (string :tag "Modeline string")
242 (repeat :tag "ANTLR language option" :inline t
243 (choice (const :tag "Default" nil)
246 (defcustom antlr-language-limit-n-regexp
247 '(8192 . "language[ \t]*=[ \t]*\\(\"?[A-Z][A-Za-z_]*\"?\\)")
248 "Used to set a reasonable value for `antlr-language'.
249 Looks like \(LIMIT \. REGEXP). Search for REGEXP from the beginning of
250 the buffer to LIMIT and use the first group in the matched string to set
251 the language according to `antlr-language-alist'."
253 :type '(cons (choice :tag "Limit" (const :tag "No" nil) (integer :value 0))
257 ;;;===========================================================================
258 ;;; Hide/Unhide, Indent/Tabs
259 ;;;===========================================================================
261 (defcustom antlr-action-visibility 3
262 "Visibility of actions when command `antlr-hide-actions' is used.
263 If nil, the actions with their surrounding braces are hidden. If a
264 number, do not hide the braces, only hide the contents if its length is
265 greater than this number."
267 :type '(choice (const :tag "Completely hidden" nil)
268 (integer :tag "Hidden if longer than" :value 3)))
270 (defcustom antlr-indent-comment 'tab
271 "*Non-nil, if the indentation should touch lines in block comments.
272 If nil, no continuation line of a block comment is changed. If t, they
273 are changed according to `c-indentation-line'. When not nil and not t,
274 they are only changed by \\[antlr-indent-command]."
276 :type '(radio (const :tag "No" nil)
277 (const :tag "Always" t)
278 (sexp :tag "With TAB" :format "%t" :value tab)))
280 (defcustom antlr-tab-offset-alist
281 '((antlr-mode nil 4 nil)
282 (java-mode "antlr" 4 nil))
283 "Alist to determine whether to use ANTLR's convention for TABs.
284 Each element looks like \(MAJOR-MODE REGEXP TAB-WIDTH INDENT-TABS-MODE).
285 The first element whose MAJOR-MODE is nil or equal to `major-mode' and
286 whose REGEXP is nil or matches variable `buffer-file-name' is used to
287 set `tab-width' and `indent-tabs-mode'. This is useful to support both
288 ANTLR's and Java's indentation styles. Used by `antlr-set-tabs'."
290 :type '(repeat (group :value (antlr-mode nil 8 nil)
291 (choice (const :tag "All" nil)
292 (function :tag "Major mode"))
293 (choice (const :tag "All" nil) regexp)
294 (integer :tag "Tab width")
295 (boolean :tag "Indent-tabs-mode"))))
297 (defcustom antlr-indent-style "java"
298 "*If non-nil, cc-mode indentation style used for `antlr-mode'.
299 See `c-set-style' and for details, where the most interesting part in
300 `c-style-alist' is the value of `c-basic-offset'."
302 :type '(choice (const nil) regexp))
304 (defcustom antlr-indent-item-regexp
305 "[]}):;|&]" ; & is local ANTLR extension (SGML's and-connector)
306 "Regexp matching lines which should be indented by one TAB less.
307 See `antlr-indent-line' and command \\[antlr-indent-command]."
311 (defcustom antlr-indent-at-bol-alist
312 ;; eval-when-compile not usable with defcustom...
313 '((java-mode . "\\(package\\|import\\)\\>")
314 (c++-mode . "#\\(assert\\|cpu\\|define\\|endif\\|el\\(if\\|se\\)\\|i\\(dent\\|f\\(def\\|ndef\\)?\\|mport\\|nclude\\(_next\\)?\\)\\|line\\|machine\\|pragma\\|system\\|un\\(assert\\|def\\)\\|warning\\)\\>"))
315 "Alist of regexps matching lines are indented at column 0.
316 Each element in this list looks like (MODE . REGEXP) where MODE is a
317 function and REGEXP is a regular expression.
319 If `antlr-language' equals to a MODE, the line starting at the first
320 non-whitespace is matched by the corresponding REGEXP, and the line is
321 part of an header action, indent the line at column 0 instead according
322 to the normal rules of `antlr-indent-line'."
324 :type '(repeat (cons (function :tag "Major mode") regexp)))
326 ;; adopt indentation to cc-engine
327 (defvar antlr-disabling-cc-syntactic-symbols
328 '(statement-block-intro
329 defun-block-intro topmost-intro statement-case-intro member-init-intro
330 arglist-intro brace-list-intro knr-argdecl-intro inher-intro
332 block-close defun-close class-close brace-list-close arglist-close
333 inline-close extern-lang-close namespace-close))
336 ;;;===========================================================================
337 ;;; Options: customization
338 ;;;===========================================================================
340 (defcustom antlr-options-use-submenus t
341 "*Non-nil, if the major mode menu should include option submenus.
342 If nil, the menu just includes a command to insert options. Otherwise,
343 it includes four submenus to insert file/grammar/rule/subrule options."
347 (defcustom antlr-tool-version 20701
348 "*The version number of the Antlr tool.
349 The value is an integer of the form XYYZZ which stands for vX.YY.ZZ.
350 This variable is used to warn about non-supported options and to supply
351 version correct option values when using \\[antlr-insert-option].
353 Don't use a number smaller than 20600 since the stored history of
354 Antlr's options starts with v2.06.00, see `antlr-options-alists'. You
355 can make this variable buffer-local."
359 (defcustom antlr-options-auto-colon t
360 "*Non-nil, if `:' is inserted with a rule or subrule options section.
361 A `:' is only inserted if this value is non-nil, if a rule or subrule
362 option is inserted with \\[antlr-insert-option], if there was no rule or
363 subrule options section before, and if a `:' is not already present
364 after the section, ignoring whitespace, comments and the init action."
368 (defcustom antlr-options-style nil
369 "List of symbols which determine the style of option values.
370 If a style symbol is present, the corresponding option value is put into
371 quotes, i.e., represented as a string, otherwise it is represented as an
374 The only style symbol used in the default value of `antlr-options-alist'
375 is `language-as-string'. See also `antlr-read-value'."
377 :type '(repeat (symbol :tag "Style symbol")))
379 (defcustom antlr-options-push-mark t
380 "*Non-nil, if inserting an option should set & push mark.
381 If nil, never set mark when inserting an option with command
382 \\[antlr-insert-option]. If t, always set mark via `push-mark'. If a
383 number, only set mark if point was outside the options area before and
384 the number of lines between point and the insert position is greater
385 than this value. Otherwise, only set mark if point was outside the
386 options area before."
388 :type '(radio (const :tag "No" nil)
389 (const :tag "Always" t)
390 (integer :tag "Lines between" :value 10)
391 (sexp :tag "If outside options" :format "%t" :value outside)))
393 (defcustom antlr-options-assign-string " = "
394 "*String containing `=' to use between option name and value.
395 This string is only used if the option to insert did not exist before
396 or if there was no `=' after it. In other words, the spacing around an
397 existing `=' won't be changed when changing an option value."
402 ;;;===========================================================================
403 ;;; Options: definitions
404 ;;;===========================================================================
406 (defvar antlr-options-headings '("file" "grammar" "rule" "subrule")
407 "Headings for the four different option kinds.
408 The standard value is (\"file\" \"grammar\" \"rule\" \"subrule\"). See
409 `antlr-options-alists'")
411 (defvar antlr-options-alists
412 '(;; file options ----------------------------------------------------------
413 (("language" antlr-language-option-extra
414 (20600 antlr-read-value
415 "Generated language: " language-as-string
416 (("Java") ("Cpp") ("HTML") ("Diagnostic")))
417 (20700 antlr-read-value
418 "Generated language: " language-as-string
419 (("Java") ("Cpp") ("HTML") ("Diagnostic") ("Sather"))))
420 ("mangleLiteralPrefix" nil
421 (20600 antlr-read-value
422 "Prefix for literals (default LITERAL_): " t))
423 ("namespace" antlr-c++-mode-extra
424 (20700 antlr-read-value
425 "Wrap generated C++ code in namespace: " t))
426 ("namespaceStd" antlr-c++-mode-extra
427 (20701 antlr-read-value
428 "Replace ANTLR_USE_NAMESPACE(std) by: " t))
429 ("namespaceAntlr" antlr-c++-mode-extra
430 (20701 antlr-read-value
431 "Replace ANTLR_USE_NAMESPACE(antlr) by: " t))
432 ("genHashLines" antlr-c++-mode-extra
433 (20701 antlr-read-boolean
434 "Include #line in generated C++ code? "))
436 ;; grammar options --------------------------------------------------------
438 (20600 antlr-read-value
439 "Lookahead depth: "))
441 (20600 antlr-read-value
442 "Import vocabulary: "))
444 (20600 antlr-read-value
445 "Export vocabulary: "))
446 ("testLiterals" nil ; lexer only
447 (20600 antlr-read-boolean
448 "Test each token against literals table? "))
449 ("defaultErrorHandler" nil ; not for lexer
450 (20600 antlr-read-boolean
451 "Generate default exception handler for each rule? "))
452 ("codeGenMakeSwitchThreshold" nil
453 (20600 antlr-read-value
454 "Min number of alternatives for 'switch': "))
455 ("codeGenBitsetTestThreshold" nil
456 (20600 antlr-read-value
457 "Min size of lookahead set for bitset test: "))
459 (20600 antlr-read-boolean
460 "Display debugging info during grammar analysis? "))
462 (20600 antlr-read-boolean
463 "Display debugging info during code generation? "))
464 ("buildAST" nil ; not for lexer
465 (20600 antlr-read-boolean
466 "Use automatic AST construction/transformation? "))
467 ("ASTLabelType" nil ; not for lexer
468 (20600 antlr-read-value
469 "Class of user-defined AST node: " t))
470 ("charVocabulary" nil ; lexer only
472 "Insert character vocabulary"))
474 (20600 antlr-read-boolean
475 "Generate interactive lexer/parser? "))
476 ("caseSensitive" nil ; lexer only
477 (20600 antlr-read-boolean
478 "Case significant when matching characters? "))
479 ("caseSensitiveLiterals" nil ; lexer only
480 (20600 antlr-read-boolean
481 "Case significant when testing literals table? "))
482 ("classHeaderSuffix" nil
484 "Additional string for grammar class definition"))
485 ("filter" nil ; lexer only
486 (20600 antlr-read-boolean
487 "Skip rule (the name, true or false): "
488 antlr-grammar-tokens))
489 ("namespace" antlr-c++-mode-extra
490 (20700 antlr-read-value
491 "Wrap generated C++ code for grammar in namespace: " t))
492 ("namespaceStd" antlr-c++-mode-extra
493 (20701 antlr-read-value
494 "Replace ANTLR_USE_NAMESPACE(std) by: " t))
495 ("namespaceAntlr" antlr-c++-mode-extra
496 (20701 antlr-read-value
497 "Replace ANTLR_USE_NAMESPACE(antlr) by: " t))
498 ("genHashLines" antlr-c++-mode-extra
499 (20701 antlr-read-boolean
500 "Include #line in generated C++ code? "))
501 ;;; ("autoTokenDef" nil ; parser only
502 ;;; (80000 antlr-read-boolean ; default: true
503 ;;; "Automatically define referenced token? "))
504 ;;; ("keywordsMeltTo" nil ; parser only
505 ;;; (80000 antlr-read-value
506 ;;; "Change non-matching keywords to token type: "))
508 ;; rule options ----------------------------------------------------------
509 (("testLiterals" nil ; lexer only
510 (20600 antlr-read-boolean
511 "Test this token against literals table? "))
512 ("defaultErrorHandler" nil ; not for lexer
513 (20600 antlr-read-boolean
514 "Generate default exception handler for this rule? "))
515 ("ignore" nil ; lexer only
516 (20600 antlr-read-value
517 "In this rule, ignore tokens of type: " nil
518 antlr-grammar-tokens))
519 ("paraphrase" nil ; lexer only
520 (20600 antlr-read-value
521 "In messages, replace name of this token by: " t))
523 ;; subrule options -------------------------------------------------------
524 (("warnWhenFollowAmbig" nil
525 (20600 antlr-read-boolean
526 "Display warnings for ambiguities with FOLLOW? "))
527 ("generateAmbigWarnings" nil
528 (20600 antlr-read-boolean
529 "Display warnings for ambiguities? "))
531 (20700 antlr-read-boolean
532 "Make this optional/loop subrule greedy? "))
534 "Definitions for Antlr's options of all four different kinds.
536 The value looks like \(FILE GRAMMAR RULE SUBRULE) where each FILE,
537 GRAMMAR, RULE, and SUBRULE is a list of option definitions of the
538 corresponding kind, i.e., looks like \(OPTION-DEF...).
540 Each OPTION-DEF looks like \(OPTION-NAME EXTRA-FN VALUE-SPEC...) which
541 defines a file/grammar/rule/subrule option with name OPTION-NAME. The
542 OPTION-NAMEs are used for the creation of the \"Insert XXX Option\"
543 submenus, see `antlr-options-use-submenus', and to allow to insert the
544 option name with completion when using \\[antlr-insert-option].
546 If EXTRA-FN is a function, it is called at different phases of the
547 insertion with arguments \(PHASE OPTION-NAME). PHASE can have the
548 values `before-input' or `after-insertion', additional phases might be
549 defined in future versions of this mode. The phase `before-input'
550 occurs before the user is asked to insert a value. The phase
551 `after-insertion' occurs after the option value has been inserted.
552 EXTRA-FN might be called with additional arguments in future versions of
555 Each specification VALUE-SPEC looks like \(VERSION READ-FN ARG...). The
556 last VALUE-SPEC in an OPTION-DEF whose VERSION is smaller or equal to
557 `antlr-tool-version' specifies how the user is asked for the value of
560 If READ-FN is nil, the only ARG is a string which is printed at the echo
561 area to guide the user what to insert at point. Otherwise, READ-FN is
562 called with arguments \(INIT-VALUE ARG...) to get the new value of the
563 option. INIT-VALUE is the old value of the option or nil.
565 The standard value contains the following functions as READ-FN:
566 `antlr-read-value' with ARGs = \(PROMPT AS-STRING TABLE) which reads a
567 general value, or `antlr-read-boolean' with ARGs = \(PROMPT TABLE) which
568 reads a boolean value or a member of TABLE. PROMPT is the prompt when
569 asking for a new value. If non-nil, TABLE is a table for completion or
570 a function evaluating to such a table. The return value is quoted iff
571 AS-STRING is non-nil and is either t or a symbol which is a member of
572 `antlr-options-style'.")
575 ;;;===========================================================================
576 ;;; Run tool, create Makefile dependencies
577 ;;;===========================================================================
579 (defcustom antlr-tool-command "java antlr.Tool"
580 "*Command used in \\[antlr-run-tool] to run the Antlr tool.
581 This variable should include all options passed to Antlr except the
582 option \"-glib\" which is automatically suggested if necessary."
586 (defcustom antlr-ask-about-save t
587 "*If not nil, \\[antlr-run-tool] asks which buffers to save.
588 Otherwise, it saves all modified buffers before running without asking."
592 (defcustom antlr-makefile-specification
593 '("\n" ("GENS" "GENS%d" " \\\n\t") "$(ANTLR)")
594 "*Variable to specify the appearance of the generated makefile rules.
595 This variable influences the output of \\[antlr-show-makefile-rules].
596 It looks like \(RULE-SEP GEN-VAR-SPEC COMMAND).
598 RULE-SEP is the string to separate different makefile rules. COMMAND is
599 a string with the command which runs the Antlr tool, it should include
600 all options except the option \"-glib\" which is automatically added
603 If GEN-VAR-SPEC is nil, each target directly consists of a list of
604 files. If GEN-VAR-SPEC looks like \(GEN-VAR GEN-VAR-FORMAT GEN-SEP), a
605 Makefile variable is created for each rule target.
607 Then, GEN-VAR is a string with the name of the variable which contains
608 the file names of all makefile rules. GEN-VAR-FORMAT is a format string
609 producing the variable of each target with substitution COUNT/%d where
610 COUNT starts with 1. GEN-SEP is used to separate long variable values."
612 :type '(list (string :tag "Rule separator")
614 (const :tag "Direct targets" nil)
615 (list :tag "Variables for targets"
616 (string :tag "Variable for all targets")
617 (string :tag "Format for each target variable")
618 (string :tag "Variable separator")))
619 (string :tag "ANTLR command")))
621 (defvar antlr-file-formats-alist
622 '((java-mode ("%sTokenTypes.java") ("%s.java"))
623 (c++-mode ("%sTokenTypes.hpp") ("%s.cpp" "%s.hpp")))
624 "Language dependent formats which specify generated files.
625 Each element in this list looks looks like
626 \(MAJOR-MODE (VOCAB-FILE-FORMAT...) (CLASS-FILE-FORMAT...)).
628 The element whose MAJOR-MODE is equal to `antlr-language' is used to
629 specify the generated files which are language dependent. See variable
630 `antlr-special-file-formats' for language independent files.
632 VOCAB-FILE-FORMAT is a format string, it specifies with substitution
633 VOCAB/%s the generated file for each export vocabulary VOCAB.
634 CLASS-FILE-FORMAT is a format string, it specifies with substitution
635 CLASS/%s the generated file for each grammar class CLASS.")
637 (defvar antlr-special-file-formats '("%sTokenTypes.txt" "expanded%s.g")
638 "Language independent formats which specify generated files.
639 The value looks like \(VOCAB-FILE-FORMAT EXPANDED-GRAMMAR-FORMAT).
641 VOCAB-FILE-FORMAT is a format string, it specifies with substitution
642 VOCAB/%s the generated or input file for each export or import
643 vocabulary VOCAB, respectively. EXPANDED-GRAMMAR-FORMAT is a format
644 string, it specifies with substitution GRAMMAR/%s the constructed
645 grammar file if the file GRAMMAR.g contains a grammar class which
646 extends a class other than \"Lexer\", \"Parser\" or \"TreeParser\".
648 See variable `antlr-file-formats-alist' for language dependent
651 (defvar antlr-unknown-file-formats '("?%s?.g" "?%s?")
652 "*Formats which specify the names of unknown files.
653 The value looks like \(SUPER-GRAMMAR-FILE-FORMAT SUPER-EVOCAB-FORMAT).
655 SUPER-GRAMMAR-FORMAT is a format string, it specifies with substitution
656 SUPER/%s the name of a grammar file for Antlr's option \"-glib\" if no
657 grammar file in the current directory defines the class SUPER or if it
658 is defined more than once. SUPER-EVOCAB-FORMAT is a format string, it
659 specifies with substitution SUPER/%s the name for the export vocabulary
660 of above mentioned class SUPER.")
662 (defvar antlr-help-unknown-file-text
663 "## The following rules contain filenames of the form
664 ## \"?SUPERCLASS?.g\" (and \"?SUPERCLASS?TokenTypes.txt\")
665 ## where SUPERCLASS is not found to be defined in any grammar file of
666 ## the current directory or is defined more than once. Please replace
667 ## these filenames by the grammar files (and their exportVocab).\n\n"
668 "String indicating the existence of unknown files in the Makefile.
669 See \\[antlr-show-makefile-rules] and `antlr-unknown-file-formats'.")
671 (defvar antlr-help-rules-intro
672 "The following Makefile rules define the dependencies for all (non-
673 expanded) grammars in directory \"%s\".\n
674 They are stored in the kill-ring, i.e., you can insert them with C-y
675 into your Makefile. You can also invoke M-x antlr-show-makefile-rules
676 from within a Makefile to insert them directly.\n\n\n"
677 "Introduction to use with \\[antlr-show-makefile-rules].
678 It is a format string and used with substitution DIRECTORY/%s where
679 DIRECTORY is the name of the current directory.")
682 ;;;===========================================================================
684 ;;;===========================================================================
686 (defcustom antlr-imenu-name t ; (featurep 'xemacs) ; TODO: Emacs-21 bug?
687 "*Non-nil, if a \"Index\" menu should be added to the menubar.
688 If it is a string, it is used instead \"Index\". Requires package
691 :type '(choice (const :tag "No menu" nil)
692 (const :tag "Index menu" t)
693 (string :tag "Other menu name")))
695 (defvar antlr-mode-map
696 (let ((map (make-sparse-keymap)))
697 (define-key map "\t" 'antlr-indent-command)
698 (define-key map "\e\C-a" 'antlr-beginning-of-rule)
699 (define-key map "\e\C-e" 'antlr-end-of-rule)
700 (define-key map "\C-c\C-a" 'antlr-beginning-of-body)
701 (define-key map "\C-c\C-e" 'antlr-end-of-body)
702 (define-key map "\C-c\C-f" 'c-forward-into-nomenclature)
703 (define-key map "\C-c\C-b" 'c-backward-into-nomenclature)
704 (define-key map "\C-c\C-c" 'comment-region)
705 (define-key map "\C-c\C-v" 'antlr-hide-actions)
706 (define-key map "\C-c\C-r" 'antlr-run-tool)
707 (define-key map "\C-c\C-o" 'antlr-insert-option)
708 ;; I'm too lazy to define my own:
709 (define-key map "\ea" 'c-beginning-of-statement)
710 (define-key map "\ee" 'c-end-of-statement)
712 (define-key map ":" 'antlr-electric-character)
713 (define-key map ";" 'antlr-electric-character)
714 (define-key map "|" 'antlr-electric-character)
715 (define-key map "&" 'antlr-electric-character)
716 (define-key map "(" 'antlr-electric-character)
717 (define-key map ")" 'antlr-electric-character)
718 (define-key map "{" 'antlr-electric-character)
719 (define-key map "}" 'antlr-electric-character)
721 "Keymap used in `antlr-mode' buffers.")
723 (easy-menu-define antlr-mode-menu antlr-mode-map
726 ,@(if (cond-emacs-xemacs
727 :EMACS (and antlr-options-use-submenus
728 (>= emacs-major-version 21))
729 :XEMACS antlr-options-use-submenus)
730 `(("Insert File Option"
731 :filter ,(lambda (x) (antlr-options-menu-filter 1 x)))
732 ("Insert Grammar Option"
733 :filter ,(lambda (x) (antlr-options-menu-filter 2 x)))
734 ("Insert Rule Option"
735 :filter ,(lambda (x) (antlr-options-menu-filter 3 x)))
736 ("Insert Subrule Option"
737 :filter ,(lambda (x) (antlr-options-menu-filter 4 x)))
739 '(["Insert Option" antlr-insert-option
740 :active (not buffer-read-only)]))
742 ["Backward Rule" antlr-beginning-of-rule t]
743 ["Forward Rule" antlr-end-of-rule t]
744 ["Start of Rule Body" antlr-beginning-of-body
745 :active (antlr-inside-rule-p)]
746 ["End of Rule Body" antlr-end-of-body
747 :active (antlr-inside-rule-p)]
749 ["Backward Statement" c-beginning-of-statement t]
750 ["Forward Statement" c-end-of-statement t]
751 ["Backward Into Nomencl." c-backward-into-nomenclature t]
752 ["Forward Into Nomencl." c-forward-into-nomenclature t])
753 ["Indent Region" indent-region
754 :active (and (not buffer-read-only) (c-region-is-active-p))]
755 ["Comment Out Region" comment-region
756 :active (and (not buffer-read-only) (c-region-is-active-p))]
758 (comment-region (region-beginning) (region-end) '(4))
759 :active (and (not buffer-read-only) (c-region-is-active-p))]
761 ["Hide Actions (incl. Args)" antlr-hide-actions t]
762 ["Hide Actions (excl. Args)" (antlr-hide-actions 2) t]
763 ["Unhide All Actions" (antlr-hide-actions 0) t]
765 ["Run Tool on Grammar" antlr-run-tool t]
766 ["Show Makefile Rules" antlr-show-makefile-rules t]
768 ["Customize Antlr" (customize-group 'antlr) t]))
771 ;;;===========================================================================
773 ;;;===========================================================================
775 (defcustom antlr-font-lock-maximum-decoration 'inherit
776 "*The maximum decoration level for fontifying actions.
777 Value `none' means, do not fontify actions, just normal grammar code
778 according to `antlr-font-lock-additional-keywords'. Value `inherit'
779 means, use value of `font-lock-maximum-decoration'. Any other value is
780 interpreted as in `font-lock-maximum-decoration' with no level-0
781 fontification, see `antlr-font-lock-keywords-alist'.
783 While calculating the decoration level for actions, `major-mode' is
784 bound to `antlr-language'. For example, with value
785 \((java-mode \. 2) (c++-mode \. 0))
786 Java actions are fontified with level 2 and C++ actions are not
789 :type '(choice (const :tag "None" none)
790 (const :tag "Inherit" inherit)
791 (const :tag "Default" nil)
792 (const :tag "Maximum" t)
793 (integer :tag "Level" 1)
794 (repeat :menu-tag "Mode specific" :tag "Mode specific"
796 (cons :tag "Instance"
799 (symbol :tag "Name"))
800 (radio :tag "Decoration"
801 (const :tag "Default" nil)
802 (const :tag "Maximum" t)
803 (integer :tag "Level" 1))))))
805 (defconst antlr-no-action-keywords nil
806 ;; Using nil directly won't work (would use highest level, see
807 ;; `font-lock-choose-keywords'), but a non-symbol, i.e., (list), at `car'
808 ;; would break Emacs-21.0:
809 "Empty font-lock keywords for actions.
810 Do not change the value of this constant.")
812 (defvar antlr-font-lock-keywords-alist
814 antlr-no-action-keywords
815 java-font-lock-keywords-1 java-font-lock-keywords-2
816 java-font-lock-keywords-3)
818 antlr-no-action-keywords
819 c++-font-lock-keywords-1 c++-font-lock-keywords-2
820 c++-font-lock-keywords-3))
821 "List of font-lock keywords for actions in the grammar.
822 Each element in this list looks like
823 \(MAJOR-MODE KEYWORD...)
825 If `antlr-language' is equal to MAJOR-MODE, the KEYWORDs are the
826 font-lock keywords according to `font-lock-defaults' used for the code
827 in the grammar's actions and semantic predicates, see
828 `antlr-font-lock-maximum-decoration'.")
830 (defvar antlr-default-face 'antlr-default)
831 (defface antlr-default
832 "Face to prevent strings from language dependent highlighting.
835 ;; backward-compatibility alias
836 (put 'antlr-font-lock-default-face 'face-alias 'antlr-default)
838 (defvar antlr-keyword-face 'antlr-keyword)
839 (defface antlr-keyword
841 '((((class color) (background light))
842 (:foreground "black" :EMACS :weight bold :XEMACS :bold t))))
845 ;; backward-compatibility alias
846 (put 'antlr-font-lock-keyword-face 'face-alias 'antlr-keyword)
848 (defvar antlr-syntax-face 'antlr-keyword)
849 (defface antlr-syntax
851 '((((class color) (background light))
852 (:foreground "black" :EMACS :weight bold :XEMACS :bold t))))
853 "ANTLR syntax symbols like :, |, (, ), ...."
855 ;; backward-compatibility alias
856 (put 'antlr-font-lock-syntax-face 'face-alias 'antlr-syntax)
858 (defvar antlr-ruledef-face 'antlr-ruledef)
859 (defface antlr-ruledef
861 '((((class color) (background light))
862 (:foreground "blue" :EMACS :weight bold :XEMACS :bold t))))
863 "ANTLR rule references (definition)."
865 ;; backward-compatibility alias
866 (put 'antlr-font-lock-ruledef-face 'face-alias 'antlr-ruledef)
868 (defvar antlr-tokendef-face 'antlr-tokendef)
869 (defface antlr-tokendef
871 '((((class color) (background light))
872 (:foreground "blue" :EMACS :weight bold :XEMACS :bold t))))
873 "ANTLR token references (definition)."
875 ;; backward-compatibility alias
876 (put 'antlr-font-lock-tokendef-face 'face-alias 'antlr-tokendef)
878 (defvar antlr-ruleref-face 'antlr-ruleref)
879 (defface antlr-ruleref
880 '((((class color) (background light)) (:foreground "blue4")))
881 "ANTLR rule references (usage)."
883 ;; backward-compatibility alias
884 (put 'antlr-font-lock-ruleref-face 'face-alias 'antlr-ruleref)
886 (defvar antlr-tokenref-face 'antlr-tokenref)
887 (defface antlr-tokenref
888 '((((class color) (background light)) (:foreground "orange4")))
889 "ANTLR token references (usage)."
891 ;; backward-compatibility alias
892 (put 'antlr-font-lock-tokenref-face 'face-alias 'antlr-tokenref)
894 (defvar antlr-literal-face 'antlr-literal)
895 (defface antlr-literal
897 '((((class color) (background light))
898 (:foreground "brown4" :EMACS :weight bold :XEMACS :bold t))))
899 "ANTLR special literal tokens.
900 It is used to highlight strings matched by the first regexp group of
901 `antlr-font-lock-literal-regexp'."
903 ;; backward-compatibility alias
904 (put 'antlr-font-lock-literal-face 'face-alias 'antlr-literal)
906 (defcustom antlr-font-lock-literal-regexp "\"\\(\\sw\\(\\sw\\|-\\)*\\)\""
907 "Regexp matching literals with special syntax highlighting, or nil.
908 If nil, there is no special syntax highlighting for some literals.
909 Otherwise, it should be a regular expression which must contain a regexp
910 group. The string matched by the first group is highlighted with
911 `antlr-font-lock-literal-face'."
913 :type '(choice (const :tag "None" nil) regexp))
915 (defvar antlr-class-header-regexp
916 "\\(class\\)[ \t]+\\([A-Za-z\300-\326\330-\337]\\sw*\\)[ \t]+\\(extends\\)[ \t]+\\([A-Za-z\300-\326\330-\337]\\sw*\\)[ \t]*;"
917 "Regexp matching class headers.")
919 (defvar antlr-font-lock-additional-keywords
921 `((antlr-invalidate-context-cache)
922 ("\\$setType[ \t]*(\\([A-Za-z\300-\326\330-\337]\\sw*\\))"
923 (1 antlr-tokendef-face))
924 ("\\$\\sw+" (0 keyword-face))
925 ;; the tokens are already fontified as string/docstrings:
927 (if antlr-literal-regexp
928 (antlr-re-search-forward antlr-font-lock-literal-regexp limit)))
929 (1 antlr-literal-face t)
930 :XEMACS (0 nil)) ; XEmacs bug workaround
932 (antlr-re-search-forward antlr-class-header-regexp limit))
933 (1 antlr-keyword-face)
934 (2 antlr-ruledef-face)
935 (3 antlr-keyword-face)
936 (4 (if (member (match-string 4) '("Lexer" "Parser" "TreeParser"))
940 (antlr-re-search-forward
941 "\\<\\(header\\|options\\|tokens\\|exception\\|catch\\|returns\\)\\>"
943 (1 antlr-keyword-face))
945 (antlr-re-search-forward
946 "^\\(private\\|public\\|protected\\)\\>[ \t]*\\(\\(\\sw+[ \t]*\\(:\\)?\\)\\)?"
948 (1 font-lock-type-face) ; not XEmacs' java level-3 fruit salad
949 (3 (if (antlr-upcase-p (char-after (match-beginning 3)))
951 antlr-ruledef-face) nil t)
952 (4 antlr-syntax-face nil t))
954 (antlr-re-search-forward "^\\(\\sw+\\)[ \t]*\\(:\\)?" limit))
955 (1 (if (antlr-upcase-p (char-after (match-beginning 0)))
957 antlr-ruledef-face) nil t)
958 (2 antlr-syntax-face nil t))
960 ;; v:ruleref and v:"literal" is allowed...
961 (antlr-re-search-forward "\\(\\sw+\\)[ \t]*\\([=:]\\)?" limit))
962 (1 (if (match-beginning 2)
963 (if (eq (char-after (match-beginning 2)) ?=)
965 font-lock-variable-name-face)
966 (if (antlr-upcase-p (char-after (match-beginning 1)))
968 antlr-ruleref-face)))
969 (2 antlr-default-face nil t))
971 (antlr-re-search-forward "[|&:;(~]\\|)\\([*+?]\\|=>\\)?" limit))
972 (0 antlr-syntax-face))))
973 "Font-lock keywords for ANTLR's normal grammar code.
974 See `antlr-font-lock-keywords-alist' for the keywords of actions.")
976 (defvar antlr-font-lock-defaults
977 '(antlr-font-lock-keywords
978 nil nil ((?_ . "w") (?\( . ".") (?\) . ".")) beginning-of-defun)
979 "Font-lock defaults used for ANTLR syntax highlighting.
980 The SYNTAX-ALIST element is also used to initialize
981 `antlr-action-syntax-table'.")
984 ;;;===========================================================================
985 ;;; Internal variables
986 ;;;===========================================================================
988 (defvar antlr-mode-hook nil
989 "Hook called by `antlr-mode'.")
991 (defvar antlr-mode-syntax-table nil
992 "Syntax table used in `antlr-mode' buffers.
993 If non-nil, it will be initialized in `antlr-mode'.")
995 ;; used for "in Java/C++ code" = syntactic-depth>0
996 (defvar antlr-action-syntax-table nil
997 "Syntax table used for ANTLR action parsing.
998 Initialized by `antlr-mode-syntax-table', changed by SYNTAX-ALIST in
999 `antlr-font-lock-defaults'. This table should be selected if you use
1000 `buffer-syntactic-context' and `buffer-syntactic-context-depth' in order
1001 not to confuse their context_cache.")
1003 (defvar antlr-mode-abbrev-table nil
1004 "Abbreviation table used in `antlr-mode' buffers.")
1005 (define-abbrev-table 'antlr-mode-abbrev-table ())
1007 (defvar antlr-slow-cache-enabling-symbol 'loudly
1008 ;; Emacs' font-lock changes buffer's tick counter, therefore this value should
1009 ;; be a parameter of a font-lock function, but not any other variable of
1010 ;; functions which call `antlr-slow-syntactic-context'.
1011 "If value is a bound symbol, cache will be used even with text changes.
1012 This is no user option. Used for `antlr-slow-syntactic-context'.")
1014 (defvar antlr-slow-cache-diff-threshold 5000
1015 "Maximum distance between `point' and cache position for cache use.
1016 Used for `antlr-slow-syntactic-context'.")
1019 ;;;;##########################################################################
1021 ;;;;##########################################################################
1025 ;;;===========================================================================
1026 ;;; Syntax functions -- Emacs vs XEmacs dependent, part 1
1027 ;;;===========================================================================
1029 ;; From help.el (XEmacs-21.1), without `copy-syntax-table'
1030 (defmacro antlr-with-syntax-table (syntab &rest body)
1031 "Evaluate BODY with the syntax table SYNTAB."
1032 `(let ((stab (syntax-table)))
1034 (progn (set-syntax-table ,syntab) ,@body)
1035 (set-syntax-table stab))))
1036 (put 'antlr-with-syntax-table 'lisp-indent-function 1)
1037 (put 'antlr-with-syntax-table 'edebug-form-spec '(form body))
1039 (defunx antlr-default-directory ()
1040 :xemacs-and-try default-directory
1041 "Return `default-directory'."
1044 ;; Check Emacs-21.1 simple.el, `shell-command'.
1045 (defunx antlr-read-shell-command (prompt &optional initial-input history)
1046 :xemacs-and-try read-shell-command
1047 "Read a string from the minibuffer, using `shell-command-history'."
1048 (read-from-minibuffer prompt initial-input nil nil
1049 (or history 'shell-command-history)))
1051 (defunx antlr-with-displaying-help-buffer (thunk &optional name)
1052 :xemacs-and-try with-displaying-help-buffer
1053 "Make a help buffer and call `thunk' there."
1054 (with-output-to-temp-buffer "*Help*"
1055 (save-excursion (funcall thunk))))
1058 ;;;===========================================================================
1060 ;;;===========================================================================
1062 (defvar antlr-slow-context-cache nil "Internal.")
1064 ;;;(defvar antlr-statistics-full-neg 0)
1065 ;;;(defvar antlr-statistics-full-diff 0)
1066 ;;;(defvar antlr-statistics-full-other 0)
1067 ;;;(defvar antlr-statistics-cache 0)
1068 ;;;(defvar antlr-statistics-inval 0)
1070 (defunx antlr-invalidate-context-cache (&rest dummies)
1071 ;; checkdoc-params: (dummies)
1072 "Invalidate context cache for syntactical context information."
1073 :XEMACS ; XEmacs bug workaround
1075 (set-buffer (get-buffer-create " ANTLR XEmacs bug workaround"))
1076 (buffer-syntactic-context-depth)
1079 ;;; (incf antlr-statistics-inval)
1080 (setq antlr-slow-context-cache nil))
1082 (defunx antlr-syntactic-context ()
1083 "Return some syntactic context information.
1084 Return `string' if point is within a string, `block-comment' or
1085 `comment' is point is within a comment or the depth within all
1086 parenthesis-syntax delimiters at point otherwise.
1087 WARNING: this may alter `match-data'."
1089 (or (buffer-syntactic-context) (buffer-syntactic-context-depth))
1091 (let ((orig (point)) diff state
1092 ;; Arg, Emacs' (buffer-modified-tick) changes with font-lock. Use
1093 ;; hack that `loudly' is bound during font-locking => cache use will
1094 ;; increase from 7% to 99.99% during font-locking.
1095 (tick (or (boundp antlr-slow-cache-enabling-symbol)
1096 (buffer-modified-tick))))
1097 (if (and (cdr antlr-slow-context-cache)
1098 (>= (setq diff (- orig (cadr antlr-slow-context-cache))) 0)
1099 (< diff antlr-slow-cache-diff-threshold)
1100 (eq (current-buffer) (caar antlr-slow-context-cache))
1101 (eq tick (cdar antlr-slow-context-cache)))
1102 ;; (setq antlr-statistics-cache (1+ antlr-statistics-cache) ...)
1103 (setq state (parse-partial-sexp (cadr antlr-slow-context-cache) orig
1105 (cddr antlr-slow-context-cache)))
1106 (if (>= orig antlr-slow-cache-diff-threshold)
1107 (beginning-of-defun)
1108 (goto-char (point-min)))
1109 ;;; (cond ((and diff (< diff 0)) (incf antlr-statistics-full-neg))
1110 ;;; ((and diff (>= diff 3000)) (incf antlr-statistics-full-diff))
1111 ;;; (t (incf antlr-statistics-full-other)))
1112 (setq state (parse-partial-sexp (point) orig)))
1114 (if antlr-slow-context-cache
1115 (setcdr antlr-slow-context-cache (cons orig state))
1116 (setq antlr-slow-context-cache
1117 (cons (cons (current-buffer) tick)
1118 (cons orig state))))
1119 (cond ((nth 3 state) 'string)
1120 ((nth 4 state) 'comment) ; block-comment? -- we don't care
1123 ;;; (incf (aref antlr-statistics 2))
1124 ;;; (unless (and (eq (current-buffer)
1125 ;;; (caar antlr-slow-context-cache))
1126 ;;; (eq (buffer-modified-tick)
1127 ;;; (cdar antlr-slow-context-cache)))
1128 ;;; (incf (aref antlr-statistics 1))
1129 ;;; (setq antlr-slow-context-cache nil))
1130 ;;; (let* ((orig (point))
1131 ;;; (base (cadr antlr-slow-context-cache))
1132 ;;; (curr (cddr antlr-slow-context-cache))
1133 ;;; (state (cond ((eq orig (car curr)) (cdr curr))
1134 ;;; ((eq orig (car base)) (cdr base))))
1137 ;;; (incf (aref antlr-statistics 3))
1139 ;;; (if (< (setq diff (abs (- orig (car curr))))
1140 ;;; (setq diff2 (abs (- orig (car base)))))
1141 ;;; (setq state curr)
1142 ;;; (setq state base
1144 ;;; (if (or (>= (1+ diff) (point)) (>= diff 3000))
1145 ;;; (setq state nil))) ; start from bod/bob
1148 ;;; (parse-partial-sexp (car state) orig nil nil (cdr state)))
1149 ;;; (if (>= orig 3000) (beginning-of-defun) (goto-char (point-min)))
1150 ;;; (incf (aref antlr-statistics 4))
1151 ;;; (setq cw (list orig (point) base curr))
1152 ;;; (setq state (parse-partial-sexp (point) orig)))
1153 ;;; (goto-char orig)
1154 ;;; (if antlr-slow-context-cache
1155 ;;; (setcdr (cdr antlr-slow-context-cache) (cons orig state))
1156 ;;; (setq antlr-slow-context-cache
1157 ;;; (cons (cons (current-buffer) (buffer-modified-tick))
1158 ;;; (cons (cons orig state) (cons orig state))))))
1159 ;;; (cond ((nth 3 state) 'string)
1160 ;;; ((nth 4 state) 'comment) ; block-comment? -- we don't care
1161 ;;; (t (car state)))))
1163 ;;; (beginning-of-defun)
1164 ;;; (let ((state (parse-partial-sexp (point) orig)))
1165 ;;; (goto-char orig)
1166 ;;; (cond ((nth 3 state) 'string)
1167 ;;; ((nth 4 state) 'comment) ; block-comment? -- we don't care
1168 ;;; (t (car state))))))
1171 ;;;===========================================================================
1172 ;;; Miscellaneous functions
1173 ;;;===========================================================================
1175 (defun antlr-upcase-p (char)
1176 "Non-nil, if CHAR is an uppercase character (if CHAR was a char)."
1177 ;; in XEmacs, upcase only works for ASCII
1178 (or (and (<= ?A char) (<= char ?Z))
1179 (and (<= ?\300 char) (<= char ?\337)))) ; ?\327 is no letter
1181 (defun antlr-re-search-forward (regexp bound)
1182 "Search forward from point for regular expression REGEXP.
1183 Set point to the end of the occurrence found, and return point. Return
1184 nil if no occurrence was found. Do not search within comments, strings
1185 and actions/semantic predicates. BOUND bounds the search; it is a
1186 buffer position. See also the functions `match-beginning', `match-end'
1187 and `replace-match'."
1188 ;; WARNING: Should only be used with `antlr-action-syntax-table'!
1190 (while (and (re-search-forward regexp bound 'limit)
1192 (if (eq (antlr-syntactic-context) 0)
1195 (if continue nil (point))))
1197 (defun antlr-search-forward (string)
1198 "Search forward from point for STRING.
1199 Set point to the end of the occurrence found, and return point. Return
1200 nil if no occurrence was found. Do not search within comments, strings
1201 and actions/semantic predicates."
1202 ;; WARNING: Should only be used with `antlr-action-syntax-table'!
1204 (while (and (search-forward string nil 'limit)
1205 (if (eq (antlr-syntactic-context) 0) (setq continue nil) t)))
1206 (if continue nil (point))))
1208 (defun antlr-search-backward (string)
1209 "Search backward from point for STRING.
1210 Set point to the beginning of the occurrence found, and return point.
1211 Return nil if no occurrence was found. Do not search within comments,
1212 strings and actions/semantic predicates."
1213 ;; WARNING: Should only be used with `antlr-action-syntax-table'!
1215 (while (and (search-backward string nil 'limit)
1216 (if (eq (antlr-syntactic-context) 0) (setq continue nil) t)))
1217 (if continue nil (point))))
1219 (defsubst antlr-skip-sexps (count)
1220 "Skip the next COUNT balanced expressions and the comments after it.
1221 Return position before the comments after the last expression."
1222 (goto-char (or (ignore-errors-x (scan-sexps (point) count)) (point-max)))
1224 (antlr-c-forward-sws)))
1227 ;;;===========================================================================
1229 ;;;===========================================================================
1231 (defun antlr-font-lock-keywords ()
1232 "Return font-lock keywords for current buffer.
1233 See `antlr-font-lock-additional-keywords', `antlr-language' and
1234 `antlr-font-lock-maximum-decoration'."
1235 (if (eq antlr-font-lock-maximum-decoration 'none)
1236 antlr-font-lock-additional-keywords
1237 (append antlr-font-lock-additional-keywords
1238 (eval (let ((major-mode antlr-language)) ; dynamic
1239 (font-lock-choose-keywords
1240 (cdr (assq antlr-language
1241 antlr-font-lock-keywords-alist))
1242 (if (eq antlr-font-lock-maximum-decoration 'inherit)
1243 font-lock-maximum-decoration
1244 antlr-font-lock-maximum-decoration)))))))
1247 ;;;===========================================================================
1249 ;;;===========================================================================
1251 (defun antlr-grammar-tokens ()
1252 "Return alist for tokens defined in current buffer."
1253 (save-excursion (antlr-imenu-create-index-function t)))
1255 (defun antlr-imenu-create-index-function (&optional tokenrefs-only)
1256 "Return imenu index-alist for ANTLR grammar files.
1257 IF TOKENREFS-ONLY is non-nil, just return alist with tokenref names."
1261 ;; Using `imenu-progress-message' would require imenu for compilation, but
1262 ;; nobody is missing these messages. The generic imenu function searches
1263 ;; backward, which is slower and more likely not to work during editing.
1264 (antlr-with-syntax-table antlr-action-syntax-table
1265 (antlr-invalidate-context-cache)
1266 (goto-char (point-min))
1267 (antlr-skip-file-prelude t)
1269 (if (looking-at "{") (antlr-skip-sexps 1))
1270 (if (looking-at antlr-class-header-regexp)
1272 (push (cons (match-string 2)
1273 (if imenu-use-markers
1274 (copy-marker (match-beginning 2))
1275 (match-beginning 2)))
1277 (if (looking-at "p\\(ublic\\|rotected\\|rivate\\)")
1278 (antlr-skip-sexps 1))
1279 (when (looking-at "\\sw+")
1281 (if (antlr-upcase-p (char-after (point)))
1282 (push (list (match-string 0)) items))
1283 (push (cons (match-string 0)
1284 (if imenu-use-markers
1285 (copy-marker (match-beginning 0))
1286 (match-beginning 0)))
1288 (if (setq continue (antlr-search-forward ";"))
1289 (antlr-skip-exception-part t))))
1291 (cons (cons "Classes" (nreverse classes)) (nreverse items))
1295 ;;;===========================================================================
1296 ;;; Parse grammar files (internal functions)
1297 ;;;===========================================================================
1299 (defun antlr-skip-exception-part (skip-comment)
1300 "Skip exception part of current rule, i.e., everything after `;'.
1301 This also includes the options and tokens part of a grammar class
1302 header. If SKIP-COMMENT is non-nil, also skip the comment after that
1306 (antlr-c-forward-sws)
1307 (while (looking-at "options\\>\\|tokens\\>")
1309 (setq pos (antlr-skip-sexps 2)))
1311 ;; Problem: an action only belongs to a class def, not a normal rule.
1312 ;; But checking the current rule type is too expensive => only expect
1313 ;; an action if we have found an option or tokens part.
1314 (if (looking-at "{") (setq pos (antlr-skip-sexps 1)))
1315 (while (looking-at "exception\\>")
1316 (setq pos (antlr-skip-sexps 1))
1317 (when (looking-at "\\[")
1318 (setq pos (antlr-skip-sexps 1)))
1319 (while (looking-at "catch\\>")
1320 (setq pos (antlr-skip-sexps 3)))))
1321 (or skip-comment (goto-char pos))))
1323 (defun antlr-skip-file-prelude (skip-comment)
1324 "Skip the file prelude: the header and file options.
1325 If SKIP-COMMENT is non-nil, also skip the comment after that part.
1326 Return the start position of the file prelude.
1328 Hack: if SKIP-COMMENT is `header-only' only skip header and return
1329 position before the comment after the header."
1330 (let* ((pos (point))
1332 (antlr-c-forward-sws)
1333 (if skip-comment (setq pos0 (point)))
1334 (while (looking-at "header\\>[ \t]*\\(\"\\)?")
1335 (setq pos (antlr-skip-sexps (if (match-beginning 1) 3 2))))
1336 (if (eq skip-comment 'header-only) ; a hack...
1338 (when (looking-at "options\\>")
1339 (setq pos (antlr-skip-sexps 2)))
1340 (or skip-comment (goto-char pos))
1343 (defun antlr-next-rule (arg skip-comment)
1344 "Move forward to next end of rule. Do it ARG many times.
1345 A grammar class header and the file prelude are also considered as a
1346 rule. Negative argument ARG means move back to ARGth preceding end of
1347 rule. The behavior is not defined when ARG is zero. If SKIP-COMMENT
1348 is non-nil, move to beginning of the rule."
1349 ;; WARNING: Should only be used with `antlr-action-syntax-table'!
1353 ;; first look whether point is in exception part
1354 (if (antlr-search-backward ";")
1358 (antlr-skip-exception-part skip-comment))
1359 (antlr-skip-file-prelude skip-comment))
1361 (unless (and (< (point) pos) (zerop (incf arg)))
1362 ;; if we have moved backward, we already moved one defun backward
1363 (goto-char beg) ; rewind (to ";" / point)
1364 (while (and arg (<= (incf arg) 0))
1365 (if (antlr-search-backward ";")
1368 ;; try file prelude:
1369 (setq pos (antlr-skip-file-prelude skip-comment))
1371 (if (>= (point) beg)
1372 (goto-char (if (>= pos beg) (point-min) pos)))
1373 (goto-char (if (or (>= (point) beg) (= (point) pos))
1376 (when arg ; always found a ";"
1378 (antlr-skip-exception-part skip-comment)))
1379 (if (<= (point) pos) ; moved backward?
1380 (goto-char pos) ; rewind
1381 (decf arg)) ; already moved one defun forward
1383 (while (>= (decf arg) 0)
1384 (antlr-search-forward ";"))
1385 (antlr-skip-exception-part skip-comment)))))
1387 (defun antlr-outside-rule-p ()
1388 "Non-nil if point is outside a grammar rule.
1389 Move to the beginning of the current rule if point is inside a rule."
1390 ;; WARNING: Should only be used with `antlr-action-syntax-table'!
1391 (let ((pos (point)))
1392 (antlr-next-rule -1 nil)
1393 (let ((between (or (bobp) (< (point) pos))))
1394 (antlr-c-forward-sws)
1395 (and between (> (point) pos) (goto-char pos)))))
1398 ;;;===========================================================================
1399 ;;; Parse grammar files (commands)
1400 ;;;===========================================================================
1401 ;; No (interactive "_") in Emacs... use `zmacs-region-stays'.
1403 (defun antlr-inside-rule-p ()
1404 "Non-nil if point is inside a grammar rule.
1405 A grammar class header and the file prelude are also considered as a
1408 (antlr-with-syntax-table antlr-action-syntax-table
1409 (not (antlr-outside-rule-p)))))
1411 (defunx antlr-end-of-rule (&optional arg)
1412 "Move forward to next end of rule. Do it ARG [default: 1] many times.
1413 A grammar class header and the file prelude are also considered as a
1414 rule. Negative argument ARG means move back to ARGth preceding end of
1415 rule. If ARG is zero, run `antlr-end-of-body'."
1419 (antlr-with-syntax-table antlr-action-syntax-table
1420 (antlr-next-rule arg nil))))
1422 (defunx antlr-beginning-of-rule (&optional arg)
1423 "Move backward to preceding beginning of rule. Do it ARG many times.
1424 A grammar class header and the file prelude are also considered as a
1425 rule. Negative argument ARG means move forward to ARGth next beginning
1426 of rule. If ARG is zero, run `antlr-beginning-of-body'."
1429 (antlr-beginning-of-body)
1430 (antlr-with-syntax-table antlr-action-syntax-table
1431 (antlr-next-rule (- arg) t))))
1433 (defunx antlr-end-of-body (&optional msg)
1434 "Move to position after the `;' of the current rule.
1435 A grammar class header is also considered as a rule. With optional
1436 prefix arg MSG, move to `:'."
1438 (antlr-with-syntax-table antlr-action-syntax-table
1439 (let ((orig (point)))
1440 (if (antlr-outside-rule-p)
1441 (error "Outside an ANTLR rule"))
1442 (let ((bor (point)))
1443 (when (< (antlr-skip-file-prelude t) (point))
1444 ;; Yes, we are in the file prelude
1446 (error (or msg "The file prelude is without `;'")))
1447 (antlr-search-forward ";")
1450 (progn (goto-char bor)
1451 (or (antlr-search-forward ":") (point-max))))
1454 (antlr-c-forward-sws))))))
1456 (defunx antlr-beginning-of-body ()
1457 "Move to the first element after the `:' of the current rule."
1459 (antlr-end-of-body "Class headers and the file prelude are without `:'"))
1462 ;;;===========================================================================
1463 ;;; Literal normalization, Hide Actions
1464 ;;;===========================================================================
1466 (defun antlr-downcase-literals (&optional transform)
1467 "Convert all literals in buffer to lower case.
1468 If non-nil, TRANSFORM is used on literals instead of `downcase-region'."
1470 (or transform (setq transform 'downcase-region))
1473 (goto-char (point-min))
1474 (antlr-with-syntax-table antlr-action-syntax-table
1475 (antlr-invalidate-context-cache)
1476 (while (antlr-re-search-forward "\"\\(\\sw\\(\\sw\\|-\\)*\\)\"" nil)
1477 (funcall transform (match-beginning 0) (match-end 0))
1479 (message "Transformed %d literals" literals)))
1481 (defun antlr-upcase-literals ()
1482 "Convert all literals in buffer to upper case."
1484 (antlr-downcase-literals 'upcase-region))
1486 (defun antlr-hide-actions (arg &optional silent)
1487 "Hide or unhide all actions in buffer.
1488 Hide all actions including arguments in brackets if ARG is 1 or if
1489 called interactively without prefix argument. Hide all actions
1490 excluding arguments in brackets if ARG is 2 or higher. Unhide all
1491 actions if ARG is 0 or negative. See `antlr-action-visibility'.
1493 Display a message unless optional argument SILENT is non-nil."
1495 (save-buffer-state-x
1497 (let ((regexp (if (= arg 1) "[]}]" "}"))
1498 (diff (and antlr-action-visibility
1499 (+ (max antlr-action-visibility 0) 2))))
1500 (antlr-hide-actions 0 t)
1502 (goto-char (point-min))
1503 (antlr-with-syntax-table antlr-action-syntax-table
1504 (antlr-invalidate-context-cache)
1505 (while (antlr-re-search-forward regexp nil)
1506 (let ((beg (ignore-errors-x (scan-sexps (point) -1))))
1508 (if diff ; braces are visible
1509 (if (> (point) (+ beg diff))
1510 (add-text-properties (1+ beg) (1- (point))
1511 '(invisible t intangible t)))
1512 ;; if actions is on line(s) of its own, hide WS
1513 (and (looking-at "[ \t]*$")
1516 (skip-chars-backward " \t")
1517 (and (bolp) (setq beg (point))))
1518 (beginning-of-line 2)) ; beginning of next line
1519 (add-text-properties beg (point)
1520 '(invisible t intangible t))))))))
1522 (message "Hide all actions (%s arguments)...done"
1523 (if (= arg 1) "including" "excluding"))))
1524 (remove-text-properties (point-min) (point-max)
1525 '(invisible nil intangible nil))
1527 (message "Unhide all actions (including arguments)...done")))))
1530 ;;;===========================================================================
1531 ;;; Insert option: command
1532 ;;;===========================================================================
1534 (defun antlr-insert-option (level option &optional location)
1535 "Insert file/grammar/rule/subrule option near point.
1536 LEVEL determines option kind to insert: 1=file, 2=grammar, 3=rule,
1537 4=subrule. OPTION is a string with the name of the option to insert.
1538 LOCATION can be specified for not calling `antlr-option-kind' twice.
1540 Inserting an option with this command works as follows:
1542 1. When called interactively, LEVEL is determined by the prefix
1543 argument or automatically deduced without prefix argument.
1544 2. Signal an error if no option of that level could be inserted, e.g.,
1545 if the buffer is read-only, the option area is outside the visible
1546 part of the buffer or a subrule/rule option should be inserted with
1547 point outside a subrule/rule.
1548 3. When called interactively, OPTION is read from the minibuffer with
1549 completion over the known options of the given LEVEL.
1550 4. Ask user for confirmation if the given OPTION does not seem to be a
1551 valid option to insert into the current file.
1552 5. Find a correct position to insert the option.
1553 6. Depending on the option, insert it the following way \(inserting an
1554 option also means inserting the option section if necessary\):
1555 - Insert the option and let user insert the value at point.
1556 - Read a value (with completion) from the minibuffer, using a
1557 previous value as initial contents, and insert option with value.
1558 7. Final action depending on the option. For example, set the language
1559 according to a newly inserted language option.
1561 The name of all options with a specification for their values are stored
1562 in `antlr-options-alists'. The used specification also depends on the
1563 value of `antlr-tool-version', i.e., step 4 will warn you if you use an
1564 option that has been introduced in newer version of ANTLR, and step 5
1565 will offer completion using version-correct values.
1567 If the option already exists inside the visible part of the buffer, this
1568 command can be used to change the value of that option. Otherwise, find
1569 a correct position where the option can be inserted near point.
1571 The search for a correct position is as follows:
1573 * If search is within an area where options can be inserted, use the
1574 position of point. Inside the options section and if point is in
1575 the middle of a option definition, skip the rest of it.
1576 * If an options section already exists, insert the options at the end.
1577 If only the beginning of the area is visible, insert at the
1579 * Otherwise, find the position where an options section can be
1580 inserted and insert a new section before any comments. If the
1581 position before the comments is not visible, insert the new section
1584 This function also inserts \"options {...}\" and the \":\" if necessary,
1585 see `antlr-options-auto-colon'. See also `antlr-options-assign-string'.
1587 This command might also set the mark like \\[set-mark-command] does, see
1588 `antlr-options-push-mark'."
1589 (interactive (antlr-insert-option-interactive current-prefix-arg))
1590 (barf-if-buffer-read-only)
1591 (or location (setq location (cdr (antlr-option-kind level))))
1593 (error "Cannot deduce what kind of option to insert"))
1595 (error "Cannot insert any %s options around here"
1596 (elt antlr-options-headings (1- level)))))
1597 (let ((area (car location))
1598 (place (cdr location)))
1599 (cond ((null place) ; invisible
1601 "Invisible %s options, use %s to make them visible"
1602 "Invisible area for %s options, use %s to make it visible")
1603 (elt antlr-options-headings (1- level))
1604 (substitute-command-keys "\\[widen]")))
1605 ((null area) ; without option part
1606 (antlr-insert-option-do level option nil
1609 ((save-excursion ; with option part, option visible
1610 (goto-char (max (point-min) (car area)))
1611 (re-search-forward (concat "\\(^\\|;\\)[ \t]*\\(\\<"
1612 (regexp-quote option)
1613 "\\>\\)[ \t\n]*\\(\\(=[ \t]?\\)[ \t]*\\(\\(\\sw\\|\\s_\\)+\\|\"\\([^\n\"\\]\\|[\\][^\n]\\)*\"\\)?\\)?")
1614 ;; 2=name, 3=4+5, 4="=", 5=value
1615 (min (point-max) (cdr area))
1617 (antlr-insert-option-do level option
1618 (cons (or (match-beginning 5)
1619 (match-beginning 3))
1621 (and (null (cdr place)) area)
1622 (or (match-beginning 5)
1625 (t ; with option part, option not yet
1626 (antlr-insert-option-do level option t
1627 (and (null (cdr place)) area)
1630 (defun antlr-insert-option-interactive (arg)
1631 "Interactive specification for `antlr-insert-option'.
1632 Return \(LEVEL OPTION LOCATION)."
1633 (barf-if-buffer-read-only)
1634 (if arg (setq arg (prefix-numeric-value arg)))
1635 (unless (memq arg '(nil 1 2 3 4))
1636 (error "Valid prefix args: no=auto, 1=file, 2=grammar, 3=rule, 4=subrule"))
1637 (let* ((kind (antlr-option-kind arg))
1639 (if (atom (cdr kind))
1640 (list level nil (cdr kind))
1641 (let* ((table (elt antlr-options-alists (1- level)))
1642 (completion-ignore-case t) ;dynamic
1643 (input (completing-read (format "Insert %s option: "
1644 (elt antlr-options-headings
1647 (list level input (cdr kind))))))
1649 (defun antlr-options-menu-filter (level menu-items)
1650 "Return items for options submenu of level LEVEL."
1651 ;; checkdoc-params: (menu-items)
1652 (let ((active (if buffer-read-only
1654 (consp (cdr-safe (cdr (antlr-option-kind level)))))))
1655 (mapcar (lambda (option)
1657 (list 'antlr-insert-option level option)
1659 (sort (mapcar 'car (elt antlr-options-alists (1- level)))
1663 ;;;===========================================================================
1664 ;;; Insert option: determine section-kind
1665 ;;;===========================================================================
1667 (defun antlr-option-kind (requested)
1668 "Return level and location for option to insert near point.
1669 Call function `antlr-option-level' with argument REQUESTED. If the
1670 result is nil, return \(REQUESTED \. error). If the result has the
1671 non-nil value LEVEL, return \(LEVEL \. LOCATION) where LOCATION looks
1672 like \(AREA \. PLACE), see `antlr-option-location'."
1675 (let ((min0 (point-min)) ; before `widen'!
1678 (level (antlr-option-level requested)) ; calls `widen'!
1681 (setq level requested))
1682 ((eq level 1) ; file options
1683 (goto-char (point-min))
1684 (setq pos (antlr-skip-file-prelude 'header-only)))
1685 ((not (eq level 3)) ; grammar or subrule options
1687 (antlr-c-forward-sws))
1688 ((looking-at "^\\(private[ \t\n]\\|public[ \t\n]\\|protected[ \t\n]\\)?[ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)[ \t\n]*\\(!\\)?[ \t\n]*\\(\\[\\)?")
1689 ;; rule options, with complete rule header
1690 (goto-char (or (match-end 4) (match-end 3)))
1691 (setq pos (antlr-skip-sexps (if (match-end 5) 1 0)))
1692 (when (looking-at "returns[ \t\n]*\\[")
1693 (goto-char (1- (match-end 0)))
1694 (setq pos (antlr-skip-sexps 1)))))
1696 (cond ((null pos) 'error)
1697 ((looking-at "options[ \t\n]*{")
1698 (goto-char (match-end 0))
1699 (setq pos (ignore-errors-x (scan-lists (point) 1 1)))
1700 (antlr-option-location orig min0 max0
1702 (if pos (1- pos) (point-max))
1705 (antlr-option-location orig min0 max0
1709 (defun antlr-option-level (requested)
1710 "Return level for option to insert near point.
1711 Remove any restrictions from current buffer and return level for the
1712 option to insert near point, i.e., 1, 2, 3, 4, or nil if no such option
1713 can be inserted. If REQUESTED is non-nil, it is the only possible value
1714 to return except nil. If REQUESTED is nil, return level for the nearest
1715 option kind, i.e., the highest number possible.
1717 If the result is 2, point is at the beginning of the class after the
1718 class definition. If the result is 3 or 4, point is at the beginning of
1719 the rule/subrule after the init action. Otherwise, the point position
1722 (if (eq requested 1)
1724 (antlr-with-syntax-table antlr-action-syntax-table
1725 (antlr-invalidate-context-cache)
1726 (let* ((orig (point))
1727 (outsidep (antlr-outside-rule-p))
1729 (if (eq (char-after) ?\{) (antlr-skip-sexps 1))
1730 (setq bor (point)) ; beginning of rule (after init action)
1731 (cond ((eq requested 2) ; grammar options required?
1732 (let (boc) ; beginning of class
1733 (goto-char (point-min))
1734 (while (and (<= (point) bor)
1735 (antlr-re-search-forward antlr-class-header-regexp
1737 (if (<= (match-beginning 0) bor)
1738 (setq boc (match-end 0))))
1742 ((save-excursion ; in region of file options?
1743 (goto-char (point-min))
1744 (antlr-skip-file-prelude t) ; ws/comment after: OK
1746 (and (null requested) 1))
1747 (outsidep ; outside rule not OK
1749 ((looking-at antlr-class-header-regexp) ; rule = class def?
1750 (goto-char (match-end 0))
1751 (and (null requested) 2))
1752 ((eq requested 3) ; rule options required?
1755 ((setq depth (antlr-syntactic-grammar-depth orig bor))
1756 (if (> depth 0) ; move out of actions
1757 (goto-char (scan-lists (point) -1 depth)))
1758 (set-syntax-table antlr-mode-syntax-table)
1759 (antlr-invalidate-context-cache)
1760 (if (eq (antlr-syntactic-context) 0) ; not in subrule?
1761 (unless (eq requested 4)
1764 (goto-char (1+ (scan-lists (point) -1 1)))
1767 (defun antlr-option-location (orig min-vis max-vis min-area max-area withp)
1768 "Return location for the options area.
1769 ORIG is the original position of `point', MIN-VIS is `point-min' and
1770 MAX-VIS is `point-max'. If WITHP is non-nil, there exists an option
1771 specification and it starts after the brace at MIN-AREA and stops at
1772 MAX-AREA. If WITHP is nil, there is no area and the region where it
1773 could be inserted starts at MIN-AREA and stops at MAX-AREA.
1775 The result has the form (AREA . PLACE). AREA is (MIN-AREA . MAX-AREA)
1776 if WITHP is non-nil, and nil otherwise. PLACE is nil if the area is
1777 invisible, (ORIG) if ORIG is inside the area, (MIN-AREA . beginning) for
1778 a visible start position and (MAX-AREA . end) for a visible end position
1779 where the beginning is preferred if WITHP is nil and the end if WITHP is
1781 (cons (and withp (cons min-area max-area))
1782 (cond ((and (<= min-area orig) (<= orig max-area)
1785 (not (memq (antlr-syntactic-context)
1786 '(comment block-comment)))))
1787 ;; point in options area and not in comment
1789 ((and (null withp) (<= min-vis min-area) (<= min-area max-vis))
1790 ;; use start of options area (only if not `withp')
1791 (cons min-area 'beginning))
1792 ((and (<= min-vis max-area) (<= max-area max-vis))
1793 ;; use end of options area
1794 (cons max-area 'end))
1795 ((and withp (<= min-vis min-area) (<= min-area max-vis))
1796 ;; use start of options area (only if `withp')
1797 (cons min-area 'beginning)))))
1799 (defun antlr-syntactic-grammar-depth (pos beg)
1800 "Return syntactic context depth at POS.
1801 Move to POS and from there on to the beginning of the string or comment
1802 if POS is inside such a construct. Then, return the syntactic context
1803 depth at point if the point position is smaller than BEG.
1804 WARNING: this may alter `match-data'."
1806 (let ((context (or (antlr-syntactic-context) 0)))
1807 (while (and context (not (integerp context)))
1808 (cond ((eq context 'string)
1810 (and (search-backward "\"" nil t)
1812 (or (antlr-syntactic-context) 0))))
1813 ((memq context '(comment block-comment))
1815 (and (re-search-backward "/[/*]" nil t)
1817 (or (antlr-syntactic-context) 0))))))
1821 ;;;===========================================================================
1822 ;;; Insert options: do the insertion
1823 ;;;===========================================================================
1825 (defun antlr-insert-option-do (level option old area pos)
1826 "Insert option into buffer at position POS.
1827 Insert option of level LEVEL and name OPTION. If OLD is non-nil, an
1828 options area is already exists. If OLD looks like \(BEG \. END), the
1829 option already exists. Then, BEG is the start position of the option
1830 value, the position of the `=' or nil, and END is the end position of
1831 the option value or nil.
1833 If the original point position was outside an options area, AREA is nil.
1834 Otherwise, and if an option specification already exists, AREA is a cons
1835 cell where the two values determine the area inside the braces."
1836 (let* ((spec (cdr (assoc option (elt antlr-options-alists (1- level)))))
1837 (value (antlr-option-spec level option (cdr spec) (consp old))))
1838 (if (fboundp (car spec)) (funcall (car spec) 'before-input option))
1839 ;; set mark (unless point was inside options area before)
1840 (if (cond (area (eq antlr-options-push-mark t))
1841 ((numberp antlr-options-push-mark)
1842 (> (count-lines (min (point) pos) (max (point) pos))
1843 antlr-options-push-mark))
1844 (antlr-options-push-mark))
1846 ;; read option value -----------------------------------------------------
1849 ;; no option specification found
1850 (if (y-or-n-p (format "Insert unknown %s option %s? "
1851 (elt antlr-options-headings (1- level))
1853 (message "Insert value for %s option %s"
1854 (elt antlr-options-headings (1- level))
1856 (error "Didn't insert unknown %s option %s"
1857 (elt antlr-options-headings (1- level))
1859 ;; option specification found
1860 (setq value (cdr value))
1862 (let ((initial (and (consp old) (cdr old)
1863 (buffer-substring (car old) (cdr old)))))
1864 (setq value (apply (car value)
1866 (if (eq (aref initial 0) ?\")
1870 (message (cadr value))
1872 ;; insert value ----------------------------------------------------------
1874 (antlr-insert-option-existing old value)
1876 ;; Move outside string/comment if point is inside option spec
1877 (antlr-syntactic-grammar-depth (point) (car area)))
1878 (antlr-insert-option-space area old)
1879 (or old (antlr-insert-option-area level))
1880 (insert option " = ;")
1882 (if value (insert value)))
1883 ;; final -----------------------------------------------------------------
1884 (if (fboundp (car spec)) (funcall (car spec) 'after-insertion option))))
1886 (defun antlr-option-spec (level option specs existsp)
1887 "Return version correct option value specification.
1888 Return specification for option OPTION of kind level LEVEL. SPECS
1889 should correspond to the VALUE-SPEC... in `antlr-option-alists'.
1890 EXISTSP determines whether the option already exists."
1892 (while (and specs (>= antlr-tool-version (caar specs)))
1893 (setq value (pop specs)))
1894 (cond (value) ; found correct spec
1895 ((null specs) nil) ; didn't find any specs
1896 (existsp (car specs)) ; wrong version, but already present
1897 ((y-or-n-p (format "Insert v%s %s option %s in v%s? "
1898 (antlr-version-string (caar specs))
1899 (elt antlr-options-headings (1- level))
1901 (antlr-version-string antlr-tool-version)))
1904 (error "Didn't insert v%s %s option %s in v%s"
1905 (antlr-version-string (caar specs))
1906 (elt antlr-options-headings (1- level))
1908 (antlr-version-string antlr-tool-version))))))
1910 (defun antlr-version-string (version)
1911 "Format the Antlr version number VERSION, see `antlr-tool-version'."
1912 (let ((version100 (/ version 100)))
1914 (/ version100 100) (mod version100 100) (mod version 100))))
1917 ;;;===========================================================================
1918 ;;; Insert options: the details (used by `antlr-insert-option-do')
1919 ;;;===========================================================================
1921 (defun antlr-insert-option-existing (old value)
1922 "Insert option value VALUE at point for existing option.
1923 For OLD, see `antlr-insert-option-do'."
1925 (unless (car old) (insert antlr-options-assign-string))
1926 ;; with user input => insert if necessary
1928 (if (cdr old) ; with value
1929 (if (string-equal value (buffer-substring (car old) (cdr old)))
1930 (goto-char (cdr old))
1931 (delete-region (car old) (cdr old))
1934 (unless (looking-at "\\([^\n=;{}/'\"]\\|'\\([^\n'\\]\\|\\\\.\\)*'\\|\"\\([^\n\"\\]\\|\\\\.\\)*\"\\)*;")
1935 ;; stuff (no =, {, } or /) at point is not followed by ";"
1939 (defun antlr-insert-option-space (area old)
1940 "Find appropriate place to insert option, insert newlines/spaces.
1941 For AREA and OLD, see `antlr-insert-option-do'."
1942 (let ((orig (point))
1944 (skip-chars-backward " \t")
1946 (let ((before (char-after (1- (point)))))
1948 (and old ; with existing options area
1949 (consp area) ; if point inside existing area
1950 (not (eq before ?\;)) ; if not at beginning of option
1951 ; => skip to end of option
1952 (if (and (search-forward ";" (cdr area) t)
1953 (let ((context (antlr-syntactic-context)))
1954 (or (null context) (numberp context))))
1957 (skip-chars-forward " \t")
1959 (if (looking-at "$\\|//")
1960 ;; just comment after point => skip (+ lines w/ same col comment)
1961 (let ((same (if (> (match-end 0) (match-beginning 0))
1963 (beginning-of-line 2)
1964 (or (bolp) (insert "\n"))
1965 (when (and same (null area)) ; or (consp area)?
1966 (while (and (looking-at "[ \t]*\\(//\\)")
1967 (goto-char (match-beginning 1))
1968 (= (current-column) same))
1969 (beginning-of-line 2)
1970 (or (bolp) (insert "\n")))))
1973 (progn (insert "\n") (antlr-indent-line))
1974 (unless (eq (char-after (1- (point))) ?\ )
1976 (unless (eq (char-after (point)) ?\ )
1981 (beginning-of-line 1)
1984 (antlr-indent-line))))
1986 (defun antlr-insert-option-area (level)
1987 "Insert new options area for options of level LEVEL.
1988 Used by `antlr-insert-option-do'."
1989 (insert "options {\n\n}")
1990 (when (and antlr-options-auto-colon
1993 (antlr-c-forward-sws)
1994 (if (eq (char-after (point)) ?\{) (antlr-skip-sexps 1))
1995 (not (eq (char-after (point)) ?\:))))
2001 (beginning-of-line 0)
2002 (antlr-indent-line))
2005 ;;;===========================================================================
2006 ;;; Insert options: in `antlr-options-alists'
2007 ;;;===========================================================================
2009 (defun antlr-read-value (initial-contents prompt
2010 &optional as-string table table-x)
2011 "Read a string from the minibuffer, possibly with completion.
2012 If INITIAL-CONTENTS is non-nil, insert it in the minibuffer initially.
2013 PROMPT is a string to prompt with, normally it ends in a colon and a
2014 space. If AS-STRING is t or is a member \(comparison done with `eq') of
2015 `antlr-options-style', return printed representation of the user input,
2016 otherwise return the user input directly.
2018 If TABLE or TABLE-X is non-nil, read with completion. The completion
2019 table is the resulting alist of TABLE-X concatenated with TABLE where
2020 TABLE can also be a function evaluation to an alist.
2022 Used inside `antlr-options-alists'."
2023 (let* ((completion-ignore-case t) ; dynamic
2024 (table0 (and (or table table-x)
2026 (if (functionp table) (funcall table) table))))
2028 (completing-read prompt table0 nil nil initial-contents)
2029 (read-from-minibuffer prompt initial-contents))))
2031 (or (eq as-string t)
2032 (cdr (assq as-string antlr-options-style))))
2036 (defun antlr-read-boolean (initial-contents prompt &optional table)
2037 "Read a boolean value from the minibuffer, with completion.
2038 If INITIAL-CONTENTS is non-nil, insert it in the minibuffer initially.
2039 PROMPT is a string to prompt with, normally it ends in a question mark
2040 and a space. \"(true or false) \" is appended if TABLE is nil.
2042 Read with completion over \"true\", \"false\" and the keys in TABLE, see
2043 also `antlr-read-value'.
2045 Used inside `antlr-options-alists'."
2046 (antlr-read-value initial-contents
2047 (if table prompt (concat prompt "(true or false) "))
2049 table '(("false") ("true"))))
2051 (defun antlr-language-option-extra (phase &rest dummies)
2052 ;; checkdoc-params: (dummies)
2053 "Change language according to the new value of the \"language\" option.
2054 Call `antlr-mode' if the new language would be different from the value
2055 of `antlr-language', keeping the value of variable `font-lock-mode'.
2057 Called in PHASE `after-insertion', see `antlr-options-alists'."
2058 (when (eq phase 'after-insertion)
2059 (let ((new-language (antlr-language-option t)))
2060 (or (null new-language)
2061 (eq new-language antlr-language)
2062 (let ((font-lock (and (boundp 'font-lock-mode) font-lock-mode)))
2063 (if font-lock (font-lock-mode 0))
2065 (and font-lock (null font-lock-mode) (font-lock-mode 1)))))))
2067 (defun antlr-c++-mode-extra (phase option &rest dummies)
2068 ;; checkdoc-params: (option dummies)
2069 "Warn if C++ option is used with the wrong language.
2070 Ask user \(\"y or n\"), if a C++ only option is going to be inserted but
2071 `antlr-language' has not the value `c++-mode'.
2073 Called in PHASE `before-input', see `antlr-options-alists'."
2074 (and (eq phase 'before-input)
2075 (not (eq antlr-language 'c++-mode))
2076 (not (y-or-n-p (format "Insert C++ %s option? " option)))
2077 (error "Didn't insert C++ %s option with language %s"
2078 option (cadr (assq antlr-language antlr-language-alist)))))
2081 ;;;===========================================================================
2082 ;;; Compute dependencies
2083 ;;;===========================================================================
2085 (defun antlr-file-dependencies ()
2086 "Return dependencies for grammar in current buffer.
2087 The result looks like \(FILE \(CLASSES \. SUPERS) VOCABS \. LANGUAGE)
2088 where CLASSES = ((CLASS . CLASS-EVOCAB) ...),
2089 SUPERS = ((SUPER . USE-EVOCAB-P) ...), and
2090 VOCABS = ((EVOCAB ...) . (IVOCAB ...))
2092 FILE is the current buffer's file-name without directory part and
2093 LANGUAGE is the value of `antlr-language' in the current buffer. Each
2094 EVOCAB is an export vocabulary and each IVOCAB is an import vocabulary.
2096 Each CLASS is a grammar class with its export vocabulary CLASS-EVOCAB.
2097 Each SUPER is a super-grammar class where USE-EVOCAB-P indicates whether
2098 its export vocabulary is used as an import vocabulary."
2099 (unless buffer-file-name
2100 (error "Grammar buffer does not visit a file"))
2101 (let (classes export-vocabs import-vocabs superclasses default-vocab)
2102 (antlr-with-syntax-table antlr-action-syntax-table
2103 (goto-char (point-min))
2104 (while (antlr-re-search-forward antlr-class-header-regexp nil)
2105 ;; parse class definition --------------------------------------------
2106 (let* ((class (match-string 2))
2107 (sclass (match-string 4))
2108 ;; export vocab defaults to class name (first grammar in file)
2109 ;; or to the export vocab of the first grammar in file:
2110 (evocab (or default-vocab class))
2112 (goto-char (match-end 0))
2113 (antlr-c-forward-sws)
2114 (while (looking-at "options\\>\\|\\(tokens\\)\\>")
2115 (if (match-beginning 1)
2116 (antlr-skip-sexps 2)
2117 (goto-char (match-end 0))
2118 (antlr-c-forward-sws)
2119 ;; parse grammar option sections -------------------------------
2120 (when (eq (char-after (point)) ?\{)
2121 (let* ((beg (1+ (point)))
2122 (end (1- (antlr-skip-sexps 1)))
2125 (if (re-search-forward "\\<exportVocab[ \t]*=[ \t]*\\([A-Za-z\300-\326\330-\337]\\sw*\\)" end t)
2126 (setq evocab (match-string 1)))
2128 (if (re-search-forward "\\<importVocab[ \t]*=[ \t]*\\([A-Za-z\300-\326\330-\337]\\sw*\\)" end t)
2129 (setq ivocab (match-string 1)))
2130 (goto-char cont)))))
2131 (unless (member sclass '("Parser" "Lexer" "TreeParser"))
2132 (let ((super (assoc sclass superclasses)))
2134 (or ivocab (setcdr super t))
2135 (push (cons sclass (null ivocab)) superclasses))))
2136 ;; remember class with export vocabulary:
2137 (push (cons class evocab) classes)
2138 ;; default export vocab is export vocab of first grammar in file:
2139 (or default-vocab (setq default-vocab evocab))
2140 (or (member evocab export-vocabs) (push evocab export-vocabs))
2142 (member ivocab import-vocabs) (push ivocab import-vocabs)))))
2144 (list* (file-name-nondirectory buffer-file-name)
2145 (cons (nreverse classes) (nreverse superclasses))
2146 (cons (nreverse export-vocabs) (nreverse import-vocabs))
2149 (defun antlr-directory-dependencies (dirname)
2150 "Return dependencies for all grammar files in directory DIRNAME.
2151 The result looks like \((CLASS-SPEC ...) \. \(FILE-DEP ...))
2152 where CLASS-SPEC = (CLASS (FILE \. EVOCAB) ...).
2154 FILE-DEP are the dependencies for each grammar file in DIRNAME, see
2155 `antlr-file-dependencies'. For each grammar class CLASS, FILE is a
2156 grammar file in which CLASS is defined and EVOCAB is the name of the
2157 export vocabulary specified in that file."
2158 (let ((grammar (directory-files dirname t "\\.g\\'")))
2160 (let ((temp-buffer (get-buffer-create
2161 (generate-new-buffer-name " *temp*")))
2162 (antlr-imenu-name nil) ; dynamic-let: no imenu
2163 (expanded-regexp (concat (format (regexp-quote
2164 (cadr antlr-special-file-formats))
2167 classes dependencies)
2170 (set-buffer temp-buffer)
2171 (widen) ; just in case...
2172 (dolist (file grammar)
2173 (when (and (file-regular-p file)
2174 (null (string-match expanded-regexp file)))
2175 (insert-file-contents file t nil nil t)
2176 (normal-mode t) ; necessary for major-mode, syntax
2177 ; table and `antlr-language'
2178 (when (eq major-mode 'antlr-mode)
2179 (let* ((file-deps (antlr-file-dependencies))
2180 (file (car file-deps)))
2182 (dolist (class-def (caadr file-deps))
2183 (let ((file-evocab (cons file (cdr class-def)))
2184 (class-spec (assoc (car class-def) classes)))
2186 (nconc (cdr class-spec) (list file-evocab))
2187 (push (list (car class-def) file-evocab)
2189 (push file-deps dependencies)))))))
2190 (kill-buffer temp-buffer))
2191 (cons (nreverse classes) (nreverse dependencies))))))
2194 ;;;===========================================================================
2195 ;;; Compilation: run ANTLR tool
2196 ;;;===========================================================================
2198 (defun antlr-superclasses-glibs (supers classes)
2199 "Compute the grammar lib option for the super grammars SUPERS.
2200 Look in CLASSES for the right grammar lib files for SUPERS. SUPERS is
2201 part SUPER in the result of `antlr-file-dependencies'. CLASSES is the
2202 part \(CLASS-SPEC ...) in the result of `antlr-directory-dependencies'.
2204 The result looks like \(OPTION WITH-UNKNOWN GLIB ...). OPTION is the
2205 complete \"-glib\" option. WITH-UNKNOWN has value t iff there is none
2206 or more than one grammar file for at least one super grammar.
2208 Each GLIB looks like \(GRAMMAR-FILE \. EVOCAB). GRAMMAR-FILE is a file
2209 in which a super-grammar is defined. EVOCAB is the value of the export
2210 vocabulary of the super-grammar or nil if it is not needed."
2211 ;; If the superclass is defined in the same file, that file will be included
2212 ;; with -glib again. This will lead to a redefinition. But defining a
2213 ;; analyzer of the same class twice in a file will lead to an error anyway...
2214 (let (glibs unknown)
2216 (let* ((super (pop supers))
2217 (sup-files (cdr (assoc (car super) classes)))
2218 (file (and sup-files (null (cdr sup-files)) (car sup-files))))
2219 (or file (setq unknown t)) ; not exactly one file
2220 (push (cons (or (car file)
2221 (format (car antlr-unknown-file-formats)
2225 (format (cadr antlr-unknown-file-formats)
2228 (cons (if glibs (concat " -glib " (mapconcat 'car glibs ";")) "")
2229 (cons unknown glibs))))
2231 (defun antlr-run-tool (command file &optional saved)
2232 "Run Antlr took COMMAND on grammar FILE.
2233 When called interactively, COMMAND is read from the minibuffer and
2234 defaults to `antlr-tool-command' with a computed \"-glib\" option if
2237 Save all buffers first unless optional value SAVED is non-nil. When
2238 called interactively, the buffers are always saved, see also variable
2239 `antlr-ask-about-save'."
2240 (interactive (antlr-run-tool-interactive))
2241 (or saved (save-some-buffers (not antlr-ask-about-save)))
2242 (let ((default-directory (file-name-directory file)))
2243 (require 'compile) ; only `compile' autoload
2244 (compile-internal (concat command " " (file-name-nondirectory file))
2245 "No more errors" "Antlr-Run")))
2247 (defun antlr-run-tool-interactive ()
2248 ;; code in `interactive' is not compiled
2249 "Interactive specification for `antlr-run-tool'.
2250 Use prefix argument ARG to return \(COMMAND FILE SAVED)."
2251 (let* ((supers (cdadr (save-excursion
2254 (antlr-file-dependencies)))))
2257 (save-some-buffers (not antlr-ask-about-save) nil)
2258 (setq glibs (car (antlr-superclasses-glibs
2260 (car (antlr-directory-dependencies
2261 (antlr-default-directory)))))))
2262 (list (antlr-read-shell-command "Run Antlr on current file with: "
2263 (concat antlr-tool-command glibs " "))
2268 ;;;===========================================================================
2269 ;;; Makefile creation
2270 ;;;===========================================================================
2272 (defun antlr-makefile-insert-variable (number pre post)
2273 "Insert Makefile variable numbered NUMBER according to specification.
2274 Also insert strings PRE and POST before and after the variable."
2275 (let ((spec (cadr antlr-makefile-specification)))
2278 (if number (format (cadr spec) number) (car spec))
2281 (defun antlr-insert-makefile-rules (&optional in-makefile)
2282 "Insert Makefile rules in the current buffer at point.
2283 IN-MAKEFILE is non-nil, if the current buffer is the Makefile. See
2284 command `antlr-show-makefile-rules' for detail."
2285 (let* ((dirname (antlr-default-directory))
2286 (deps0 (antlr-directory-dependencies dirname))
2287 (classes (car deps0)) ; CLASS -> (FILE . EVOCAB) ...
2288 (deps (cdr deps0)) ; FILE -> (c . s) (ev . iv) . LANGUAGE
2290 (gen-sep (or (caddr (cadr antlr-makefile-specification)) " "))
2291 (n (and (cdr deps) (cadr antlr-makefile-specification) 0)))
2292 (or in-makefile (set-buffer standard-output))
2294 (let ((supers (cdadr dep))
2295 (lang (cdr (assoc (cdddr dep) antlr-file-formats-alist))))
2297 (antlr-makefile-insert-variable n "" " =")
2300 (format (cadr antlr-special-file-formats)
2301 (file-name-sans-extension (car dep)))))
2302 (dolist (class-def (caadr dep))
2303 (let ((sep gen-sep))
2304 (dolist (class-file (cadr lang))
2305 (insert sep (format class-file (car class-def)))
2307 (dolist (evocab (caaddr dep))
2308 (let ((sep gen-sep))
2309 (dolist (vocab-file (cons (car antlr-special-file-formats)
2311 (insert sep (format vocab-file evocab))
2313 (antlr-makefile-insert-variable n "\n$(" ")")
2314 (insert ": " (car dep))
2315 (dolist (ivocab (cdaddr dep))
2316 (insert " " (format (car antlr-special-file-formats) ivocab)))
2317 (let ((glibs (antlr-superclasses-glibs supers classes)))
2318 (if (cadr glibs) (setq with-error t))
2319 (dolist (super (cddr glibs))
2320 (insert " " (car super))
2322 (insert " " (format (car antlr-special-file-formats)
2325 (caddr antlr-makefile-specification)
2328 (car antlr-makefile-specification)))))
2331 (antlr-makefile-insert-variable nil "" " =")
2332 (while (<= (incf i) n)
2333 (antlr-makefile-insert-variable i " $(" ")"))
2334 (insert "\n" (car antlr-makefile-specification))))
2335 (if (string-equal (car antlr-makefile-specification) "\n")
2336 (backward-delete-char 1))
2338 (goto-char (point-min))
2339 (insert antlr-help-unknown-file-text))
2341 (copy-region-as-kill (point-min) (point-max))
2342 (goto-char (point-min))
2343 (insert (format antlr-help-rules-intro dirname)))))
2346 (defun antlr-show-makefile-rules ()
2347 "Show Makefile rules for all grammar files in the current directory.
2348 If the `major-mode' of the current buffer has the value `makefile-mode',
2349 the rules are directory inserted at point. Otherwise, a *Help* buffer
2350 is shown with the rules which are also put into the `kill-ring' for
2353 This command considers import/export vocabularies and grammar
2354 inheritance and provides a value for the \"-glib\" option if necessary.
2355 Customize variable `antlr-makefile-specification' for the appearance of
2358 If the file for a super-grammar cannot be determined, special file names
2359 are used according to variable `antlr-unknown-file-formats' and a
2360 commentary with value `antlr-help-unknown-file-text' is added. The
2361 *Help* buffer always starts with the text in `antlr-help-rules-intro'."
2363 (if (null (eq major-mode 'makefile-mode))
2364 (antlr-with-displaying-help-buffer 'antlr-insert-makefile-rules)
2366 (antlr-insert-makefile-rules t)))
2369 ;;;===========================================================================
2371 ;;;===========================================================================
2373 (defun antlr-indent-line ()
2374 "Indent the current line as ANTLR grammar code.
2375 The indentation of grammar lines are calculated by `c-basic-offset',
2377 - the level of the paren/brace/bracket depth,
2378 - plus 0/2/1, depending on the position inside the rule: header, body,
2380 - minus 1 if `antlr-indent-item-regexp' matches the beginning of the
2381 line starting from the first non-whitespace.
2383 Lines inside block comments are indented by `c-indent-line' according to
2384 `antlr-indent-comment'.
2386 Lines in actions except top-level actions in a header part or an option
2387 area are indented by `c-indent-line'.
2389 Lines in header actions are indented at column 0 if `antlr-language'
2390 equals to a key in `antlr-indent-at-bol-alist' and the line starting at
2391 the first non-whitespace is matched by the corresponding value.
2393 For the initialization of `c-basic-offset', see `antlr-indent-style' and,
2394 to a lesser extent, `antlr-tab-offset-alist'."
2396 (let ((orig (point))
2398 bol boi indent syntax cc-syntax)
2403 (error "Beginning of current line not visible"))
2404 (skip-chars-forward " \t")
2406 ;; check syntax at beginning of indentation ----------------------------
2407 (antlr-with-syntax-table antlr-action-syntax-table
2408 (antlr-invalidate-context-cache)
2409 (setq syntax (antlr-syntactic-context))
2410 (cond ((symbolp syntax)
2411 (setq indent nil)) ; block-comments, strings, (comments)
2413 (antlr-next-rule -1 t)
2414 (if (antlr-search-forward ":") (< boi (1- (point))) t))
2415 (setq indent 0)) ; in rule header
2416 ((if (antlr-search-forward ";") (< boi (point)) t)
2417 (setq indent 2)) ; in rule body
2420 (antlr-skip-exception-part nil)
2421 (setq indent (if (> (point) boi) 1 0))))) ; in exception part?
2422 ;; check whether to use indentation engine of cc-mode ------------------
2423 (antlr-invalidate-context-cache)
2425 (when (and indent (> syntax 0))
2426 (cond ((> syntax 1) ; block in action => use cc-mode
2429 (assq antlr-language antlr-indent-at-bol-alist)
2430 (looking-at (cdr (assq antlr-language
2431 antlr-indent-at-bol-alist))))
2433 ((setq cc-syntax (c-guess-basic-syntax))
2434 (let ((cc cc-syntax) symbol)
2435 (while (setq symbol (pop cc))
2437 (or (memq (car symbol)
2438 antlr-disabling-cc-syntactic-symbols)
2441 ;;; ((= indent 1) ; exception part => use cc-mode
2442 ;;; (setq indent nil))
2443 ;;; ((save-restriction ; not in option part => cc-mode
2444 ;;; (goto-char (scan-lists (point) -1 1))
2445 ;;; (skip-chars-backward " \t\n")
2446 ;;; (narrow-to-region (point-min) (point))
2447 ;;; (not (re-search-backward "\\<options\\'" nil t)))
2448 ;;; (setq indent nil)))))
2449 ;; compute the corresponding indentation and indent --------------------
2451 ;; Use the indentation engine of cc-mode
2454 (if (or (numberp syntax)
2455 (if (eq syntax 'string) nil (eq antlr-indent-comment t)))
2456 (c-indent-line cc-syntax)))
2459 (unless (symbolp syntax) ; direct indentation
2460 ;;(antlr-invalidate-context-cache)
2461 (incf indent (antlr-syntactic-context))
2462 (and (> indent 0) (looking-at antlr-indent-item-regexp) (decf indent))
2463 (setq indent (* indent c-basic-offset)))
2464 ;; the usual major-mode indent stuff ---------------------------------
2465 (setq orig (- (point-max) orig))
2466 (unless (= (current-column) indent)
2467 (delete-region bol boi)
2470 ;; If initial point was within line's indentation,
2471 ;; position after the indentation. Else stay at same point in text.
2472 (if (> (- (point-max) orig) (point))
2473 (goto-char (- (point-max) orig)))))))
2475 (defun antlr-indent-command (&optional arg)
2476 "Indent the current line or insert tabs/spaces.
2477 With optional prefix argument ARG or if the previous command was this
2478 command, insert ARG tabs or spaces according to `indent-tabs-mode'.
2479 Otherwise, indent the current line with `antlr-indent-line'."
2481 (if (or arg (eq last-command 'antlr-indent-command))
2483 (let ((antlr-indent-comment (and antlr-indent-comment t))) ; dynamic
2484 (antlr-indent-line))))
2486 (defun antlr-electric-character (&optional arg)
2487 "Insert the character you type and indent the current line.
2488 Insert the character like `self-insert-command' and indent the current
2489 line as `antlr-indent-command' does. Do not indent the line if
2491 * this command is called with a prefix argument ARG,
2492 * there are characters except whitespaces between point and the
2493 beginning of the line, or
2494 * point is not inside a normal grammar code, { and } are also OK in
2497 This command is useful for a character which has some special meaning in
2498 ANTLR's syntax and influences the auto indentation, see
2499 `antlr-indent-item-regexp'."
2502 (save-excursion (skip-chars-backward " \t") (not (bolp)))
2503 (antlr-with-syntax-table antlr-action-syntax-table
2504 (antlr-invalidate-context-cache)
2505 (let ((context (antlr-syntactic-context)))
2506 (not (and (numberp context)
2508 (memq last-command-char '(?\{ ?\}))))))))
2509 (self-insert-command (prefix-numeric-value arg))
2510 (self-insert-command (prefix-numeric-value arg))
2511 (antlr-indent-line)))
2514 ;;;===========================================================================
2516 ;;;===========================================================================
2518 (defun antlr-c-init-language-vars ()
2519 "Like `c-init-language-vars-for' when using cc-mode before v5.29."
2520 (let ((settings ; (cdr '(setq...)) will be optimized
2521 (if (eq antlr-language 'c++-mode)
2522 (cdr '(setq ;' from `c++-mode' v5.20, v5.28
2523 c-keywords (c-identifier-re c-C++-keywords)
2524 c-conditional-key c-C++-conditional-key
2525 c-comment-start-regexp c-C++-comment-start-regexp
2526 c-class-key c-C++-class-key
2527 c-extra-toplevel-key c-C++-extra-toplevel-key
2528 c-access-key c-C++-access-key
2529 c-recognize-knr-p nil
2530 c-bitfield-key c-C-bitfield-key ; v5.28
2532 (cdr '(setq ; from `java-mode' v5.20, v5.28
2533 c-keywords (c-identifier-re c-Java-keywords)
2534 c-conditional-key c-Java-conditional-key
2535 c-comment-start-regexp c-Java-comment-start-regexp
2536 c-class-key c-Java-class-key
2539 c-recognize-knr-p nil
2540 c-access-key c-Java-access-key ; v5.20
2541 c-inexpr-class-key c-Java-inexpr-class-key ; v5.28
2544 (when (boundp (car settings))
2546 (set (car settings) (eval (cadr settings)))))
2547 (setq settings (cddr settings)))))
2549 (defun antlr-language-option (search)
2550 "Find language in `antlr-language-alist' for language option.
2551 If SEARCH is non-nil, find element for language option. Otherwise, find
2552 the default language."
2553 (let ((value (and search
2555 (goto-char (point-min))
2556 (re-search-forward (cdr antlr-language-limit-n-regexp)
2557 (car antlr-language-limit-n-regexp)
2560 (seq antlr-language-alist)
2562 ;; Like (find VALUE antlr-language-alist :key 'cddr :test 'member)
2565 (if (member value (cddr r))
2566 (setq seq nil) ; stop
2567 (setq r nil))) ; no result yet
2571 (defun antlr-mode ()
2572 "Major mode for editing ANTLR grammar files.
2575 (kill-all-local-variables)
2576 (c-initialize-cc-mode) ; cc-mode is required
2577 (unless (fboundp 'c-forward-sws) ; see above
2578 (fset 'antlr-c-forward-sws 'c-forward-syntactic-ws))
2579 ;; ANTLR specific ----------------------------------------------------------
2580 (setq major-mode 'antlr-mode
2582 (setq local-abbrev-table antlr-mode-abbrev-table)
2583 (unless antlr-mode-syntax-table
2584 (setq antlr-mode-syntax-table (make-syntax-table))
2585 (c-populate-syntax-table antlr-mode-syntax-table))
2586 (set-syntax-table antlr-mode-syntax-table)
2587 (unless antlr-action-syntax-table
2588 (let ((slist (nth 3 antlr-font-lock-defaults)))
2589 (setq antlr-action-syntax-table
2590 (copy-syntax-table antlr-mode-syntax-table))
2592 (modify-syntax-entry (caar slist) (cdar slist)
2593 antlr-action-syntax-table)
2594 (setq slist (cdr slist)))))
2595 (use-local-map antlr-mode-map)
2596 (make-local-variable 'antlr-language)
2597 (unless antlr-language
2598 (setq antlr-language
2599 (or (antlr-language-option t) (antlr-language-option nil))))
2600 (if (stringp (cadr (assq antlr-language antlr-language-alist)))
2603 (cadr (assq antlr-language antlr-language-alist)))))
2604 ;; indentation, for the C engine -------------------------------------------
2605 (setq c-buffer-is-cc-mode antlr-language)
2606 (cond ((fboundp 'c-init-language-vars-for) ; cc-mode 5.30.5+
2607 (c-init-language-vars-for antlr-language))
2608 ((fboundp 'c-init-c-language-vars) ; cc-mode 5.30 to 5.30.4
2609 (c-init-c-language-vars) ; not perfect, but OK
2610 (setq c-recognize-knr-p nil))
2611 ((fboundp 'c-init-language-vars) ; cc-mode 5.29
2612 (let ((init-fn 'c-init-language-vars))
2613 (funcall init-fn))) ; is a function in v5.29
2614 (t ; cc-mode upto 5.28
2615 (antlr-c-init-language-vars))) ; do it myself
2616 (c-basic-common-init antlr-language (or antlr-indent-style "gnu"))
2617 (make-local-variable 'outline-regexp)
2618 (make-local-variable 'outline-level)
2619 (make-local-variable 'require-final-newline)
2620 (make-local-variable 'indent-line-function)
2621 (make-local-variable 'indent-region-function)
2622 (setq outline-regexp "[^#\n\^M]"
2623 outline-level 'c-outline-level) ; TODO: define own
2624 (setq require-final-newline mode-require-final-newline)
2625 (setq indent-line-function 'antlr-indent-line
2626 indent-region-function nil) ; too lazy
2627 (setq comment-start "// "
2629 comment-start-skip "/\\*+ *\\|// *")
2630 ;; various -----------------------------------------------------------------
2631 (make-local-variable 'font-lock-defaults)
2632 (setq font-lock-defaults antlr-font-lock-defaults)
2633 (easy-menu-add antlr-mode-menu)
2634 (make-local-variable 'imenu-create-index-function)
2635 (setq imenu-create-index-function 'antlr-imenu-create-index-function)
2636 (make-local-variable 'imenu-generic-expression)
2637 (setq imenu-generic-expression t) ; fool stupid test
2638 (and antlr-imenu-name ; there should be a global variable...
2639 (fboundp 'imenu-add-to-menubar)
2640 (imenu-add-to-menubar
2641 (if (stringp antlr-imenu-name) antlr-imenu-name "Index")))
2643 (run-mode-hooks 'antlr-mode-hook))
2645 ;; A smarter version of `group-buffers-menu-by-mode-then-alphabetically' (in
2646 ;; XEmacs) could use the following property. The header of the submenu would
2647 ;; be "Antlr" instead of "Antlr.C++" or (not and!) "Antlr.Java".
2648 (put 'antlr-mode 'mode-name "Antlr")
2651 (defun antlr-set-tabs ()
2652 "Use ANTLR's convention for TABs according to `antlr-tab-offset-alist'.
2653 Used in `antlr-mode'. Also a useful function in `java-mode-hook'."
2654 (if buffer-file-name
2655 (let ((alist antlr-tab-offset-alist) elem)
2657 (setq elem (pop alist))
2658 (and (or (null (car elem)) (eq (car elem) major-mode))
2659 (or (null (cadr elem))
2660 (string-match (cadr elem) buffer-file-name))
2661 (setq tab-width (caddr elem)
2662 indent-tabs-mode (cadddr elem)
2665 ;;; Local IspellPersDict: .ispell_antlr
2667 ;;; arch-tag: 5de2be79-3d13-4560-8fbc-f7d0234dcb5c
2668 ;;; antlr-mode.el ends here