1 ;;; info-look.el --- major-mode-sensitive Info index lookup facility.
2 ;; An older version of this was known as libc.el.
4 ;; Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
6 ;; Author: Ralph Schleicher <rs@purple.UL.BaWue.DE>
7 ;; Keywords: help languages
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
33 (defmacro defgroup
(&rest arg
)
35 (defmacro defcustom
(symbol value doc
&rest arg
)
36 `(defvar ,symbol
,value
,doc
,@arg
)))))
38 (defgroup info-lookup nil
39 "Major mode sensitive help agent."
40 :group
'help
:group
'languages
)
42 (defvar info-lookup-mode nil
43 "Symbol of the current buffer's help mode.
44 Help is provided according to the buffer's major mode if value is nil.
45 Automatically becomes buffer local when set in any fashion.")
46 (make-variable-buffer-local 'info-lookup-mode
)
48 (defcustom info-lookup-other-window-flag t
49 "Non-nil means pop up the Info buffer in another window."
50 :group
'info-lookup
:type
'boolean
)
52 (defcustom info-lookup-highlight-face
'highlight
53 "Face for highlighting looked up help items.
54 Setting this variable to nil disables highlighting."
55 :group
'info-lookup
:type
'face
)
57 (defvar info-lookup-highlight-overlay nil
58 "Overlay object used for highlighting.")
60 (defvar info-lookup-history nil
61 "History of previous input lines.")
63 (defvar info-lookup-alist nil
64 "Alist of known help topics.
65 Cons cells are of the form
67 (HELP-TOPIC . HELP-DATA)
69 HELP-TOPIC is the symbol of a help topic.
70 HELP-DATA is a HELP-TOPIC's public data set.
71 Value is an alist with elements of the form
73 (HELP-MODE REGEXP IGNORE-CASE DOC-SPEC PARSE-RULE OTHER-MODES)
75 HELP-MODE is a mode's symbol.
76 REGEXP is a regular expression matching those help items whose
77 documentation can be looked up via DOC-SPEC.
78 IGNORE-CASE is non-nil if help items are case insensitive.
79 DOC-SPEC is a list of documentation specifications of the form
81 (INFO-NODE TRANS-FUNC PREFIX SUFFIX)
83 INFO-NODE is the name (including file name part) of an Info index.
84 TRANS-FUNC is a function translating index entries into help items;
85 nil means add only those index entries matching REGEXP, a string
86 means prepend string to the first word of all index entries.
87 PREFIX and SUFFIX are parts of a regular expression. If one of
88 them is non-nil then search the help item's Info node for the
89 first occurrence of the regular expression `PREFIX ITEM SUFFIX'.
90 ITEM will be highlighted with `info-lookup-highlight-face' if this
92 PARSE-RULE is either the symbol name of a function or a regular
93 expression for guessing the default help item at point. Fuzzy
94 regular expressions like \"[_a-zA-Z0-9]+\" do a better job if
95 there are no clear delimiters; do not try to write too complex
96 expressions. PARSE-RULE defaults to REGEXP.
97 OTHER-MODES is a list of cross references to other help modes.")
99 (defsubst info-lookup-
>topic-value
(topic)
100 (cdr (assoc topic info-lookup-alist
)))
102 (defsubst info-lookup-
>mode-value
(topic mode
)
103 (assoc mode
(info-lookup->topic-value topic
)))
105 (defsubst info-lookup-
>regexp
(topic mode
)
106 (nth 1 (info-lookup->mode-value topic mode
)))
108 (defsubst info-lookup-
>ignore-case
(topic mode
)
109 (nth 2 (info-lookup->mode-value topic mode
)))
111 (defsubst info-lookup-
>doc-spec
(topic mode
)
112 (nth 3 (info-lookup->mode-value topic mode
)))
114 (defsubst info-lookup-
>parse-rule
(topic mode
)
115 (nth 4 (info-lookup->mode-value topic mode
)))
117 (defsubst info-lookup-
>other-modes
(topic mode
)
118 (nth 5 (info-lookup->mode-value topic mode
)))
121 (mapcar (lambda (keyword)
123 (set keyword keyword
)))
124 '(:topic
:mode
:regexp
:ignore-case
125 :doc-spec
:parse-rule
:other-modes
)))
127 (defun info-lookup-add-help (&rest arg
)
128 "Add or update a help specification.
129 Function arguments are one or more options of the form
133 KEYWORD is either `:topic', `:mode', `:regexp', `:ignore-case',
134 `:doc-spec', `:parse-rule', or `:other-modes'.
135 ARGUMENT has a value as explained in the documentation of the
136 variable `info-lookup-alist'.
138 If no topic or mode option has been specified, then the help topic defaults
139 to `symbol', and the help mode defaults to the current major mode."
140 (apply 'info-lookup-add-help
* nil arg
))
142 (defun info-lookup-maybe-add-help (&rest arg
)
143 "Add a help specification iff no one is defined.
144 See the documentation of the function `info-lookup-add-help'
146 (apply 'info-lookup-add-help
* t arg
))
148 (defun info-lookup-add-help* (maybe &rest arg
)
149 (let (topic mode regexp ignore-case doc-spec
150 parse-rule other-modes keyword value
)
155 (setq keyword
(car arg
))
156 (or (symbolp keyword
)
157 (error "Junk in argument list \"%S\"" arg
))
160 (error "Keyword \"%S\" is missing an argument" keyword
))
161 (setq value
(car arg
)
163 (cond ((eq keyword
:topic
)
167 ((eq keyword
:regexp
)
169 ((eq keyword
:ignore-case
)
170 (setq ignore-case value
))
171 ((eq keyword
:doc-spec
)
172 (setq doc-spec value
))
173 ((eq keyword
:parse-rule
)
174 (setq parse-rule value
))
175 ((eq keyword
:other-modes
)
176 (setq other-modes value
))
178 (error "Unknown keyword \"%S\"" keyword
))))
179 (or (and maybe
(info-lookup->mode-value topic mode
))
180 (let* ((data (list regexp ignore-case doc-spec parse-rule other-modes
))
181 (topic-cell (or (assoc topic info-lookup-alist
)
182 (car (setq info-lookup-alist
183 (cons (cons topic nil
)
184 info-lookup-alist
)))))
185 (mode-cell (assoc mode topic-cell
)))
187 (setcdr topic-cell
(cons (cons mode data
) (cdr topic-cell
)))
188 (setcdr mode-cell data
))))
191 (defvar info-lookup-cache nil
192 "Cache storing data maintained automatically by the program.
193 Value is an alist with cons cell of the form
195 (HELP-TOPIC . ((HELP-MODE INITIALIZED COMPLETIONS REFER-MODES) ...))
197 HELP-TOPIC is the symbol of a help topic.
198 HELP-MODE is a mode's symbol.
199 INITIALIZED is nil if HELP-MODE is uninitialized, t if
200 HELP-MODE is initialized, and `0' means HELP-MODE is
201 initialized but void.
202 COMPLETIONS is an alist of documented help items.
203 REFER-MODES is a list of other help modes to use.")
205 (defsubst info-lookup-
>cache
(topic)
206 (or (assoc topic info-lookup-cache
)
207 (car (setq info-lookup-cache
208 (cons (cons topic nil
)
209 info-lookup-cache
)))))
211 (defsubst info-lookup-
>topic-cache
(topic)
212 (cdr (info-lookup->cache topic
)))
214 (defsubst info-lookup-
>mode-cache
(topic mode
)
215 (assoc mode
(info-lookup->topic-cache topic
)))
217 (defsubst info-lookup-
>initialized
(topic mode
)
218 (nth 1 (info-lookup->mode-cache topic mode
)))
220 (defsubst info-lookup-
>completions
(topic mode
)
221 (or (info-lookup->initialized topic mode
)
222 (info-lookup-setup-mode topic mode
))
223 (nth 2 (info-lookup->mode-cache topic mode
)))
225 (defsubst info-lookup-
>refer-modes
(topic mode
)
226 (or (info-lookup->initialized topic mode
)
227 (info-lookup-setup-mode topic mode
))
228 (nth 3 (info-lookup->mode-cache topic mode
)))
230 (defsubst info-lookup-
>all-modes
(topic mode
)
231 (cons mode
(info-lookup->refer-modes topic mode
)))
233 (defvar info-lookup-file-alist
235 "[_a-zA-Z0-9./+-]+" nil
236 (("(libc)File Index"))))
237 "*Alist of help specifications for file names.
238 See the documentation of the variable `info-lookup-alist' for more details.")
241 (defun info-lookup-reset ()
242 "Throw away all cached data.
243 This command is useful if the user wants to start at the beginning without
244 quitting Emacs, for example, after some Info documents were updated on the
247 (setq info-lookup-cache nil
))
250 (defun info-lookup-symbol (symbol &optional mode
)
251 "Display the documentation of a symbol.
252 If called interactively, SYMBOL will be read from the mini-buffer.
253 Prefix argument means unconditionally insert the default symbol name
254 into the mini-buffer so that it can be edited.
255 The default symbol is the one found at point."
257 (info-lookup-interactive-arguments 'symbol
))
258 (info-lookup 'symbol symbol mode
))
261 (defun info-lookup-file (file &optional mode
)
262 "Display the documentation of a file.
263 If called interactively, FILE will be read from the mini-buffer.
264 Prefix argument means unconditionally insert the default file name
265 into the mini-buffer so that it can be edited.
266 The default file name is the one found at point."
268 (info-lookup-interactive-arguments 'file
))
269 (info-lookup 'file file mode
))
271 (defun info-lookup-interactive-arguments (topic)
272 "Return default value and help mode for help topic TOPIC."
273 (let* ((mode (if (info-lookup->mode-value
274 topic
(or info-lookup-mode major-mode
))
275 (or info-lookup-mode major-mode
)
276 (info-lookup-change-mode topic
)))
277 (completions (info-lookup->completions topic mode
))
278 (default (info-lookup-guess-default topic mode
))
279 (input (if (or current-prefix-arg
(not (assoc default completions
)))
281 (completion-ignore-case (info-lookup->ignore-case topic mode
))
282 (enable-recursive-minibuffers t
)
283 (value (completing-read
284 (if (and default
(not input
))
285 (format "Describe %s (default %s): " topic default
)
286 (format "Describe %s: " topic
))
287 completions nil nil input
'info-lookup-history
)))
288 (list (if (equal value
"") default value
) mode
)))
290 (defun info-lookup-change-mode (topic)
291 (let* ((completions (mapcar (lambda (arg)
292 (cons (symbol-name (car arg
)) (car arg
)))
293 (info-lookup->topic-value topic
)))
294 (mode (completing-read
295 (format "Use %s help mode: " topic
)
296 completions nil t nil
'info-lookup-history
)))
297 (or (setq mode
(cdr (assoc mode completions
)))
298 (error "No %s help available" topic
))
299 (or (info-lookup->mode-value topic mode
)
300 (error "No %s help available for `%s'" topic mode
))
301 (setq info-lookup-mode mode
)))
303 (defun info-lookup (topic item mode
)
304 "Display the documentation of a help item."
306 (setq mode
(or info-lookup-mode major-mode
)))
307 (or (info-lookup->mode-value topic mode
)
308 (error "No %s help available for `%s'" topic mode
))
309 (let ((entry (or (assoc (if (info-lookup->ignore-case topic mode
)
310 (downcase item
) item
)
311 (info-lookup->completions topic mode
))
312 (error "Not documented as a %s: %s" topic
(or item
""))))
313 (modes (info-lookup->all-modes topic mode
))
314 (window (selected-window))
315 found doc-spec node prefix suffix doc-found
)
316 (if (not info-lookup-other-window-flag
)
318 (save-window-excursion (info))
319 (switch-to-buffer-other-window "*info*"))
320 (while (and (not found
) modes
)
321 (setq doc-spec
(info-lookup->doc-spec topic
(car modes
)))
322 (while (and (not found
) doc-spec
)
323 (setq node
(nth 0 (car doc-spec
))
324 prefix
(nth 2 (car doc-spec
))
325 suffix
(nth 3 (car doc-spec
)))
326 (when (condition-case error-data
328 (Info-goto-node node
)
331 (message "Cannot access Info node %s" node
)
336 (Info-menu (or (cdr entry
) item
))
338 (if (or prefix suffix
)
339 (let ((case-fold-search
340 (info-lookup->ignore-case topic
(car modes
)))
341 (buffer-read-only nil
))
342 (goto-char (point-min))
344 (concat prefix
(regexp-quote item
) suffix
))
345 (goto-char (match-beginning 0))
346 (and window-system info-lookup-highlight-face
347 ;; Search again for ITEM so that the first
348 ;; occurence of ITEM will be highlighted.
349 (re-search-forward (regexp-quote item
))
350 (let ((start (match-beginning 0))
352 (if (overlayp info-lookup-highlight-overlay
)
353 (move-overlay info-lookup-highlight-overlay
354 start end
(current-buffer))
355 (setq info-lookup-highlight-overlay
356 (make-overlay start end
))))
357 (overlay-put info-lookup-highlight-overlay
358 'face info-lookup-highlight-face
)))))
360 (setq doc-spec
(cdr doc-spec
)))
361 (setq modes
(cdr modes
)))
363 (error "Info documentation for lookup was not found"))
364 ;; Don't leave the Info buffer if the help item couldn't be looked up.
365 (if (and info-lookup-other-window-flag found
)
366 (select-window window
))))
368 (defun info-lookup-setup-mode (topic mode
)
369 "Initialize the internal data structure."
370 (or (info-lookup->initialized topic mode
)
371 (let (cell data
(initialized 0) completions refer-modes
)
372 (if (not (info-lookup->mode-value topic mode
))
373 (message "No %s help available for `%s'" topic mode
)
374 ;; Recursively setup cross references.
375 ;; But refer only to non-void modes.
376 (mapcar (lambda (arg)
377 (or (info-lookup->initialized topic arg
)
378 (info-lookup-setup-mode topic arg
))
379 (and (eq (info-lookup->initialized topic arg
) t
)
380 (setq refer-modes
(cons arg refer-modes
))))
381 (info-lookup->other-modes topic mode
))
382 (setq refer-modes
(nreverse refer-modes
))
383 ;; Build the full completion alist.
385 (nconc (info-lookup-make-completions topic mode
)
387 (mapcar (lambda (arg)
388 (info-lookup->completions topic arg
))
390 (setq initialized t
))
391 ;; Update `info-lookup-cache'.
392 (setq cell
(info-lookup->mode-cache topic mode
)
393 data
(list initialized completions refer-modes
))
395 (setcdr (info-lookup->cache topic
)
396 (cons (cons mode data
) (info-lookup->topic-cache topic
)))
400 (defun info-lookup-make-completions (topic mode
)
401 "Create a unique alist from all index entries."
402 (let ((doc-spec (info-lookup->doc-spec topic mode
))
403 (regexp (concat "^\\(" (info-lookup->regexp topic mode
)
404 "\\)\\([ \t].*\\)?$"))
405 node trans entry item prefix result doc-found
406 (buffer (get-buffer-create " temp-info-look")))
407 (with-current-buffer buffer
410 (setq node
(nth 0 (car doc-spec
))
411 trans
(cond ((eq (nth 1 (car doc-spec
)) nil
)
413 (if (string-match regexp arg
)
414 (match-string 1 arg
))))
415 ((stringp (nth 1 (car doc-spec
)))
416 (setq prefix
(nth 1 (car doc-spec
)))
418 (if (string-match "^\\([^: \t\n]+\\)" arg
)
419 (concat prefix
(match-string 1 arg
)))))
420 (t (nth 1 (car doc-spec
)))))
421 (with-current-buffer buffer
422 (message "Processing Info node `%s'..." node
)
423 (when (condition-case error-data
425 (Info-goto-node node
)
428 (message "Cannot access Info node `%s'" node
)
433 (goto-char (point-min))
434 (and (search-forward "\n* Menu:" nil t
)
435 (while (re-search-forward "\n\\* \\([^:\t\n]*\\):" nil t
)
436 (setq entry
(match-string 1)
437 item
(funcall trans entry
))
438 (and (info-lookup->ignore-case topic mode
)
439 (setq item
(downcase item
)))
440 (and (string-equal entry item
)
442 (or (assoc item result
)
443 (setq result
(cons (cons item entry
) result
))))))
445 (message "Processing Info node `%s'...done" node
)
446 (setq doc-spec
(cdr doc-spec
)))
448 (error "Info documentation for lookup was not found"))
451 (defun info-lookup-guess-default (topic mode
)
452 "Pick up default item at point (with favor to look back).
453 Return nil if there is nothing appropriate."
454 (let ((modes (info-lookup->all-modes topic mode
))
455 (start (point)) guess whitespace
)
456 (while (and (not guess
) modes
)
457 (setq guess
(info-lookup-guess-default* topic
(car modes
))
460 ;; Collapse whitespace characters.
461 (and guess
(concat (delete nil
(mapcar (lambda (ch)
462 (if (or (char-equal ch ?
)
466 (setq whitespace ?
))
467 (setq whitespace nil
) ch
))
470 (defun info-lookup-guess-default* (topic mode
)
471 (let ((case-fold-search (info-lookup->ignore-case topic mode
))
472 (rule (or (info-lookup->parse-rule topic mode
)
473 (info-lookup->regexp topic mode
)))
474 (start (point)) end regexp subexp result
)
476 (setq result
(funcall rule
))
478 (setq regexp
(car rule
)
482 (skip-chars-backward " \t\n") (setq end
(point))
483 (while (and (re-search-backward regexp nil t
)
485 (>= (match-end 0) end
))
486 (setq result
(match-string subexp
)))
490 (skip-chars-forward " \t\n")
491 (and (looking-at regexp
)
492 (setq result
(match-string subexp
))))))
495 (defun info-lookup-guess-c-symbol ()
496 "Get the C symbol at point."
500 (let ((start (point)) prefix name
)
501 ;; Test for a leading `struct', `union', or `enum' keyword
502 ;; but ignore names like `foo_struct'.
503 (setq prefix
(and (< (skip-chars-backward " \t\n") 0)
504 (< (skip-chars-backward "_a-zA-Z0-9") 0)
505 (looking-at "\\(struct\\|union\\|enum\\)\\s ")
506 (concat (match-string 1) " ")))
508 (and (looking-at "[_a-zA-Z][_a-zA-Z0-9]*")
509 (setq name
(match-string 0)))
510 ;; Caveat! Look forward if point is at `struct' etc.
512 (or (string-equal name
"struct")
513 (string-equal name
"union")
514 (string-equal name
"enum"))
515 (looking-at "[a-z]+\\s +\\([_a-zA-Z][_a-zA-Z0-9]*\\)")
516 (setq prefix
(concat name
" ")
517 name
(match-string 1)))
518 (and (or prefix name
)
519 (concat prefix name
))))
523 (defun info-complete-symbol (&optional mode
)
524 "Perform completion on symbol preceding point."
526 (info-complete 'symbol
528 (if (info-lookup->mode-value
529 'symbol
(or info-lookup-mode major-mode
))
530 (or info-lookup-mode major-mode
)
531 (info-lookup-change-mode 'symbol
)))))
534 (defun info-complete-file (&optional mode
)
535 "Perform completion on file preceding point."
537 (list (if (info-lookup->mode-value
538 'file
(or info-lookup-mode major-mode
))
539 (or info-lookup-mode major-mode
)
540 (info-lookup-change-mode 'file
))))
541 (info-complete 'file mode
))
543 (defun info-complete (topic mode
)
544 "Try to complete a help item."
545 (barf-if-buffer-read-only)
547 (setq mode
(or info-lookup-mode major-mode
)))
548 (or (info-lookup->mode-value topic mode
)
549 (error "No %s completion available for `%s'" topic mode
))
550 (let ((modes (info-lookup->all-modes topic mode
))
551 (completions (info-lookup->completions topic mode
))
552 (completion-ignore-case (info-lookup->ignore-case topic mode
))
553 (start (point)) try completion
)
554 (while (and (not try
) modes
)
555 (setq mode
(car modes
)
557 try
(info-lookup-guess-default* topic mode
))
560 (error "Found no %S to complete" topic
))
561 (setq completion
(try-completion try completions
))
562 (cond ((not completion
)
564 (message "No match"))
565 ((stringp completion
)
566 (or (assoc completion completions
)
567 (setq completion
(completing-read
568 (format "Complete %S: " topic
)
569 completions nil t completion
570 info-lookup-history
)))
571 (delete-region (- start
(length try
)) start
)
574 (message "%s is complete" (capitalize (prin1-to-string topic
)))))))
577 ;;; Info-lookup minor mode.
579 (defvar info-lookup-minor-mode nil
580 "Non-`nil' enables Info-lookup mode.")
581 (make-variable-buffer-local 'info-lookup-minor-mode
)
583 (defvar info-lookup-minor-mode-string
" Info"
584 "Indicator included in the mode line when in Info-lookup mode.")
586 (or (assq 'info-lookup-minor-mode minor-mode-alist
)
587 (setq minor-mode-alist
(cons '(info-lookup-minor-mode
588 info-lookup-minor-mode-string
)
591 (defvar info-lookup-minor-mode-map
(make-sparse-keymap)
592 "Minor mode map for Info-lookup mode.")
594 (or (assq 'info-lookup-minor-mode minor-mode-map-alist
)
595 (setq minor-mode-map-alist
(cons (cons 'info-lookup-minor-mode
596 info-lookup-minor-mode-map
)
597 minor-mode-map-alist
)))
600 (defun info-lookup-minor-mode (&optional arg
)
601 "Minor mode for looking up the documentation of a symbol or file.
604 \\{info-lookup-minor-mode-map}"
606 (setq info-lookup-minor-mode
(if (null arg
)
607 (not info-lookup-minor-mode
)
608 (> (prefix-numeric-value arg
) 0)))
609 (set-buffer-modified-p (buffer-modified-p)))
611 (define-key info-lookup-minor-mode-map
612 "\C-c\C-hf" 'info-lookup-symbol
) ; Describe function.
613 (define-key info-lookup-minor-mode-map
614 "\C-c\C-hv" 'info-lookup-symbol
) ; Describe variable.
615 (define-key info-lookup-minor-mode-map
616 "\C-c\C-ht" 'info-lookup-symbol
) ; Describe type.
617 (define-key info-lookup-minor-mode-map
618 "\C-c\C-hp" 'info-lookup-file
) ; Describe program.
619 (define-key info-lookup-minor-mode-map
620 "\C-c\C-if" 'info-complete-symbol
) ; Complete function.
621 (define-key info-lookup-minor-mode-map
622 "\C-c\C-iv" 'info-complete-symbol
) ; Complete variable.
623 (define-key info-lookup-minor-mode-map
624 "\C-c\C-it" 'info-complete-symbol
) ; Complete type.
625 (define-key info-lookup-minor-mode-map
626 "\C-c\C-ip" 'info-complete-file
) ; Complete program.
629 (defun turn-on-info-lookup ()
630 "Unconditionally turn on Info-lookup mode."
631 (info-lookup-minor-mode 1))
634 ;;; Initialize some common modes.
636 (info-lookup-maybe-add-help
637 :mode
'c-mode
:topic
'symbol
638 :regexp
"\\(struct \\|union \\|enum \\)?[_a-zA-Z][_a-zA-Z0-9]*"
639 :doc-spec
'(("(libc)Function Index" nil
640 "^[ \t]+- \\(Function\\|Macro\\): .*\\<" "\\>")
641 ("(libc)Variable Index" nil
642 "^[ \t]+- \\(Variable\\|Macro\\): .*\\<" "\\>")
643 ("(libc)Type Index" nil
644 "^[ \t]+- Data Type: \\<" "\\>")
645 ("(termcap)Var Index" nil
647 :parse-rule
'info-lookup-guess-c-symbol
)
649 (info-lookup-maybe-add-help
650 :mode
'c-mode
:topic
'file
651 :regexp
"[_a-zA-Z0-9./+-]+"
652 :doc-spec
'(("(libc)File Index")))
654 (info-lookup-maybe-add-help
656 :regexp
"[:;|]\\|%\\([%{}]\\|[_a-z]+\\)\\|YY[_A-Z]+\\|yy[_a-z]+"
657 :doc-spec
'(("(bison)Index" nil
659 :parse-rule
"[:;|]\\|%\\([%{}]\\|[_a-zA-Z][_a-zA-Z0-9]*\\)"
660 :other-modes
'(c-mode))
662 (info-lookup-maybe-add-help
664 :regexp
"\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z][_a-zA-Z0-9-]*"
665 :doc-spec
'(("(make)Name Index" nil
667 :parse-rule
"\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z0-9-]+")
669 (info-lookup-maybe-add-help
671 :regexp
"@\\([a-zA-Z]+\\|[^a-zA-Z]\\)"
672 :doc-spec
'(("(texinfo)Command and Variable Index"
673 ;; Ignore Emacs commands and prepend a `@'.
675 (if (string-match "^\\([a-zA-Z]+\\|[^a-zA-Z]\\)\\( .*\\)?$" item
)
676 (concat "@" (match-string 1 item
))))
679 (info-lookup-maybe-add-help
681 :regexp
"[_a-zA-Z][_a-zA-Z0-9]*"
682 :doc-spec
'(("(m4)Macro index"))
683 :parse-rule
"[_a-zA-Z0-9]+")
685 (info-lookup-maybe-add-help
687 :regexp
"A[CM]_[_A-Z0-9]+"
688 :doc-spec
'(("(autoconf)Macro Index" "AC_"
689 "^[ \t]+- \\(Macro\\|Variable\\): .*\\<" "\\>")
690 ("(automake)Index" nil
692 ;; Autoconf symbols are M4 macros. Thus use M4's parser.
694 :other-modes
'(m4-mode))
696 (info-lookup-maybe-add-help
699 :doc-spec
'(("(gawk)Index"
701 (let ((case-fold-search nil
))
703 ;; `BEGIN' and `END'.
704 ((string-match "^\\([A-Z]+\\) special pattern\\b" item
)
705 (match-string 1 item
))
706 ;; `if', `while', `do', ...
707 ((string-match "^\\([a-z]+\\) statement\\b" item
)
708 (if (not (string-equal (match-string 1 item
) "control"))
709 (match-string 1 item
)))
711 ((string-match "^[A-Z]+$" item
)
713 ;; Built-in functions (matches to many entries).
714 ((string-match "^[a-z]+$" item
)
716 "`" "\\([ \t]*([^)]*)\\)?'")))
718 (info-lookup-maybe-add-help
720 :regexp
"[$@%][^a-zA-Z]\\|\\$\\^[A-Z]\\|[$@%]?[a-zA-Z][_a-zA-Z0-9]*"
721 :doc-spec
'(("(perl5)Function Index"
723 (if (string-match "^\\([a-zA-Z0-9]+\\)" item
)
724 (match-string 1 item
)))
726 ("(perl5)Variable Index"
728 ;; Work around bad formatted array variables.
729 (let ((sym (cond ((or (string-match "^\\$\\(.\\|@@\\)$" item
)
730 (string-match "^\\$\\^[A-Z]$" item
))
733 "^\\([$%@]\\|@@\\)?[_a-zA-Z0-9]+" item
)
734 (match-string 0 item
))
736 (if (string-match "@@" sym
)
737 (setq sym
(concat (substring sym
0 (match-beginning 0))
738 (substring sym
(1- (match-end 0))))))
739 (if (string-equal sym
"") nil sym
)))
741 :parse-rule
"[$@%]?\\([_a-zA-Z0-9]+\\|[^a-zA-Z]\\)")
743 (info-lookup-maybe-add-help
745 :regexp
"\\\\\\([a-zA-Z]+\\|[^a-zA-Z]\\)"
746 :doc-spec
'(("(latex2e)Command Index" nil
747 "`" "\\({[^}]*}\\)?'")))
749 (info-lookup-maybe-add-help
750 :mode
'emacs-lisp-mode
751 :regexp
"[^()' \t\n]+"
752 :doc-spec
'(("(emacs)Command Index")
753 ("(emacs)Variable Index")))
755 (info-lookup-maybe-add-help
756 :mode
'lisp-interaction-mode
757 :regexp
"[^()' \t\n]+"
759 :other-modes
'(emacs-lisp-mode))
764 ;;; info-look.el ends here