/
info-look.el
1057 lines (952 loc) · 39.7 KB
/
info-look.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; info-look.el --- major-mode-sensitive Info index lookup facility -*- lexical-binding: t -*-
;; An older version of this was known as libc.el.
;; Copyright (C) 1995-1999, 2001-2017 Free Software Foundation, Inc.
;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
;; (did not show signs of life (Nov 2001) -stef)
;; Keywords: help languages
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Really cool code to lookup info indexes.
;; Try especially info-lookup-symbol (aka C-h S).
;; Some additional sources of (Tex)info files for non-GNU packages:
;;
;; Scheme: <URL:http://groups.csail.mit.edu/mac/ftpdir/scm/r5rs.info.tar.gz>
;; LaTeX:
;; <URL:ftp://ctan.tug.org/tex-archive/info/latex2e-help-texinfo/latex2e.texi>
;; (or CTAN mirrors)
;; Perl: <URL:ftp://ftp.cpan.org/pub/CPAN/doc/manual/texinfo/> (or CPAN mirrors)
;; Traditionally, makeinfo quoted `like this', but version 5 and later
;; quotes 'like this' or ‘like this’. Doc specs with patterns
;; therefore match open and close quotes with ['`‘] and ['’],
;; respectively.
;;; Code:
(require 'info)
(defgroup info-lookup nil
"Major mode sensitive help agent."
:group 'help :group 'languages)
(defvar info-lookup-mode nil
"Symbol of the current buffer's help mode.
Help is provided according to the buffer's major mode if value is nil.
Automatically becomes buffer local when set in any fashion.")
(make-variable-buffer-local 'info-lookup-mode)
(defcustom info-lookup-other-window-flag t
"Non-nil means pop up the Info buffer in another window."
:group 'info-lookup :type 'boolean)
(defcustom info-lookup-highlight-face 'match
"Face for highlighting looked up help items.
Setting this variable to nil disables highlighting."
:group 'info-lookup :type 'face)
(defvar info-lookup-highlight-overlay nil
"Overlay object used for highlighting.")
(defcustom info-lookup-file-name-alist
'(("\\`ac\\(local\\|site\\|include\\)\\.m4\\'" . autoconf-mode))
"Alist of file names handled specially.
List elements are cons cells of the form
(REGEXP . MODE)
If a file name matches REGEXP, then use help mode MODE instead of the
buffer's major mode."
:group 'info-lookup :type '(repeat (cons (string :tag "Regexp")
(symbol :tag "Mode"))))
(defvar info-lookup-history nil
"History of previous input lines.")
(defvar info-lookup-alist nil
"Alist of known help topics.
Cons cells are of the form
(HELP-TOPIC . HELP-DATA)
HELP-TOPIC is the symbol of a help topic.
HELP-DATA is a HELP-TOPIC's public data set.
Value is an alist with elements of the form
(HELP-MODE REGEXP IGNORE-CASE DOC-SPEC PARSE-RULE OTHER-MODES)
HELP-MODE is a mode's symbol.
REGEXP is a regular expression matching those help items whose
documentation can be looked up via DOC-SPEC.
IGNORE-CASE is non-nil if help items are case insensitive.
DOC-SPEC is a list of documentation specifications of the form
(INFO-NODE TRANS-FUNC PREFIX SUFFIX)
INFO-NODE is the name (including file name part) of an Info index.
TRANS-FUNC is a function translating index entries into help items;
nil means add only those index entries matching REGEXP, a string
means prepend string to the first word of all index entries.
PREFIX and SUFFIX are parts of a regular expression. If one of
them is non-nil then search the help item's Info node for the
first occurrence of the regular expression `PREFIX ITEM SUFFIX'.
ITEM will be highlighted with `info-lookup-highlight-face' if this
variable is not nil.
PARSE-RULE is either the symbol name of a function or a regular
expression for guessing the default help item at point. Fuzzy
regular expressions like \"[_a-zA-Z0-9]+\" do a better job if
there are no clear delimiters; do not try to write too complex
expressions. PARSE-RULE defaults to REGEXP.
OTHER-MODES is a list of cross references to other help modes.")
(defsubst info-lookup->topic-value (topic)
(cdr (assoc topic info-lookup-alist)))
(defsubst info-lookup->mode-value (topic mode)
(assoc mode (info-lookup->topic-value topic)))
(defsubst info-lookup->regexp (topic mode)
(nth 1 (info-lookup->mode-value topic mode)))
(defsubst info-lookup->ignore-case (topic mode)
(nth 2 (info-lookup->mode-value topic mode)))
(defsubst info-lookup->doc-spec (topic mode)
(nth 3 (info-lookup->mode-value topic mode)))
(defsubst info-lookup->parse-rule (topic mode)
(nth 4 (info-lookup->mode-value topic mode)))
(defsubst info-lookup->other-modes (topic mode)
(nth 5 (info-lookup->mode-value topic mode)))
(defun info-lookup-add-help (&rest arg)
"Add or update a help specification.
Function arguments are specified as keyword/argument pairs:
(KEYWORD . ARGUMENT)
KEYWORD is either `:topic', `:mode', `:regexp', `:ignore-case',
`:doc-spec', `:parse-rule', or `:other-modes'.
ARGUMENT has a value as explained in the documentation of the
variable `info-lookup-alist'.
If no topic or mode option has been specified, then the help topic defaults
to `symbol', and the help mode defaults to the current major mode."
(apply 'info-lookup-add-help* nil arg))
(defun info-lookup-maybe-add-help (&rest arg)
"Add a help specification if none is defined.
See the documentation of the function `info-lookup-add-help'
for more details."
(apply 'info-lookup-add-help* t arg))
(defun info-lookup-add-help* (maybe &rest arg)
(let (topic mode regexp ignore-case doc-spec
parse-rule other-modes keyword value)
(setq topic 'symbol
mode major-mode
regexp "\\w+")
(while arg
(setq keyword (car arg))
(or (symbolp keyword)
(error "Junk in argument list \"%S\"" arg))
(setq arg (cdr arg))
(and (null arg)
(error "Keyword \"%S\" is missing an argument" keyword))
(setq value (car arg)
arg (cdr arg))
(cond ((eq keyword :topic)
(setq topic value))
((eq keyword :mode)
(setq mode value))
((eq keyword :regexp)
(setq regexp value))
((eq keyword :ignore-case)
(setq ignore-case value))
((eq keyword :doc-spec)
(setq doc-spec value))
((eq keyword :parse-rule)
(setq parse-rule value))
((eq keyword :other-modes)
(setq other-modes value))
(t
(error "Unknown keyword \"%S\"" keyword))))
(or (and maybe (info-lookup->mode-value topic mode))
(let* ((data (list regexp ignore-case doc-spec parse-rule other-modes))
(topic-cell (or (assoc topic info-lookup-alist)
(car (setq info-lookup-alist
(cons (cons topic nil)
info-lookup-alist)))))
(mode-cell (assoc mode topic-cell)))
(if (null mode-cell)
(setcdr topic-cell (cons (cons mode data) (cdr topic-cell)))
(setcdr mode-cell data))))
nil))
(defvar info-lookup-cache nil
"Cache storing data maintained automatically by the program.
Value is an alist with cons cell of the form
(HELP-TOPIC . ((HELP-MODE INITIALIZED COMPLETIONS REFER-MODES) ...))
HELP-TOPIC is the symbol of a help topic.
HELP-MODE is a mode's symbol.
INITIALIZED is nil if HELP-MODE is uninitialized, t if
HELP-MODE is initialized, and `0' means HELP-MODE is
initialized but void.
COMPLETIONS is an alist of documented help items.
REFER-MODES is a list of other help modes to use.")
(defsubst info-lookup->cache (topic)
(or (assoc topic info-lookup-cache)
(car (setq info-lookup-cache
(cons (cons topic nil)
info-lookup-cache)))))
(defun info-lookup->topic-cache (topic)
(cdr (info-lookup->cache topic)))
(defun info-lookup->mode-cache (topic mode)
(assoc mode (info-lookup->topic-cache topic)))
(defun info-lookup->initialized (topic mode)
(nth 1 (info-lookup->mode-cache topic mode)))
(defun info-lookup->completions (topic mode)
(or (info-lookup->initialized topic mode)
(info-lookup-setup-mode topic mode))
(nth 2 (info-lookup->mode-cache topic mode)))
(defun info-lookup->refer-modes (topic mode)
(or (info-lookup->initialized topic mode)
(info-lookup-setup-mode topic mode))
(nth 3 (info-lookup->mode-cache topic mode)))
(defun info-lookup->all-modes (topic mode)
(cons mode (info-lookup->refer-modes topic mode)))
(defun info-lookup-quick-all-modes (topic mode)
(cons mode (info-lookup->other-modes topic mode)))
;;;###autoload
(defun info-lookup-reset ()
"Throw away all cached data.
This command is useful if the user wants to start at the beginning without
quitting Emacs, for example, after some Info documents were updated on the
system."
(interactive)
(setq info-lookup-cache nil))
;;;###autoload (put 'info-lookup-symbol 'info-file "emacs")
;;;###autoload
(defun info-lookup-symbol (symbol &optional mode)
"Display the definition of SYMBOL, as found in the relevant manual.
When this command is called interactively, it reads SYMBOL from the
minibuffer. In the minibuffer, use M-n to yank the default argument
value into the minibuffer so you can edit it. The default symbol is the
one found at point.
With prefix arg MODE a query for the symbol help mode is offered."
(interactive
(info-lookup-interactive-arguments 'symbol current-prefix-arg))
(info-lookup 'symbol symbol mode))
;;;###autoload (put 'info-lookup-file 'info-file "emacs")
;;;###autoload
(defun info-lookup-file (file &optional mode)
"Display the documentation of a file.
When this command is called interactively, it reads FILE from the minibuffer.
In the minibuffer, use M-n to yank the default file name
into the minibuffer so you can edit it.
The default file name is the one found at point.
With prefix arg MODE a query for the file help mode is offered."
(interactive
(info-lookup-interactive-arguments 'file current-prefix-arg))
(info-lookup 'file file mode))
(defun info-lookup-interactive-arguments (topic &optional query)
"Read and return argument value (and help mode) for help topic TOPIC.
If optional argument QUERY is non-nil, query for the help mode."
(let* ((mode (cond (query
(info-lookup-change-mode topic))
((info-lookup->mode-value topic (info-lookup-select-mode))
info-lookup-mode)
((info-lookup-change-mode topic))))
(completions (info-lookup->completions topic mode))
(default (info-lookup-guess-default topic mode))
(completion-ignore-case (info-lookup->ignore-case topic mode))
(enable-recursive-minibuffers t)
(value (completing-read
(if default
(format "Describe %s (default %s): " topic default)
(format "Describe %s: " topic))
completions nil nil nil 'info-lookup-history default)))
(list (if (equal value "") default value) mode)))
(defun info-lookup-select-mode ()
(when (and (not info-lookup-mode) (buffer-file-name))
(let ((file-name (file-name-nondirectory (buffer-file-name)))
(file-name-alist info-lookup-file-name-alist))
(while (and (not info-lookup-mode) file-name-alist)
(when (string-match (caar file-name-alist) file-name)
(setq info-lookup-mode (cdar file-name-alist)))
(setq file-name-alist (cdr file-name-alist)))))
;; If major-mode has no setups in info-lookup-alist, under any topic, then
;; search up through derived-mode-parent to find a parent mode which does
;; have some setups. This means that a `define-derived-mode' with no
;; setups of its own will select its parent mode for lookups, if one of
;; its parents has some setups. Good for example on `makefile-gmake-mode'
;; and similar derivatives of `makefile-mode'.
;;
(let ((mode major-mode)) ;; Look for `mode' with some setups.
(while (and mode (not info-lookup-mode))
(dolist (topic-cell info-lookup-alist) ;; Usually only two topics here.
(if (info-lookup->mode-value (car topic-cell) mode)
(setq info-lookup-mode mode)))
(setq mode (get mode 'derived-mode-parent))))
(or info-lookup-mode (setq info-lookup-mode major-mode)))
(defun info-lookup-change-mode (topic)
(let* ((completions (mapcar (lambda (arg)
(cons (symbol-name (car arg)) (car arg)))
(info-lookup->topic-value topic)))
(mode (completing-read
(format "Use %s help mode: " topic)
completions nil t nil 'info-lookup-history)))
(or (setq mode (cdr (assoc mode completions)))
(error "No %s help available" topic))
(or (info-lookup->mode-value topic mode)
(error "No %s help available for `%s'" topic mode))
(setq info-lookup-mode mode)))
(defun info-lookup (topic item mode)
"Display the documentation of a help item."
(or mode (setq mode (info-lookup-select-mode)))
(or (info-lookup->mode-value topic mode)
(error "No %s help available for `%s'" topic mode))
(let* ((completions (info-lookup->completions topic mode))
(ignore-case (info-lookup->ignore-case topic mode))
(entry (or (assoc (if ignore-case (downcase item) item) completions)
(assoc-string item completions t)
(error "Not documented as a %s: %s" topic (or item ""))))
(modes (info-lookup->all-modes topic mode))
(window (selected-window))
(new-Info-history
;; Avoid clobbering Info-history with nodes searched during
;; lookup. If lookup succeeds set `Info-history' to
;; `new-Info-history'.
(when (get-buffer "*info*")
(with-current-buffer "*info*"
(cons (list Info-current-file Info-current-node (point))
Info-history))))
found doc-spec node prefix suffix doc-found)
(unless (eq major-mode 'Info-mode)
(if (not info-lookup-other-window-flag)
(info)
(save-window-excursion (info))
(let* ((info-window (get-buffer-window "*info*" t))
(info-frame (and info-window (window-frame info-window))))
(if (and info-frame
(not (eq info-frame (selected-frame)))
(display-multi-frame-p)
(memq info-frame (frames-on-display-list)))
;; *info* is visible in another frame on same display.
;; Raise that frame and select the window.
(progn
(select-window info-window)
(raise-frame info-frame))
;; In any other case, switch to *info* in another window.
(switch-to-buffer-other-window "*info*")))))
(while (and (not found) modes)
(setq doc-spec (info-lookup->doc-spec topic (car modes)))
(while (and (not found) doc-spec)
(setq node (nth 0 (car doc-spec))
prefix (nth 2 (car doc-spec))
suffix (nth 3 (car doc-spec)))
(when (condition-case nil
(progn
;; Don't need Index menu fontifications here, and
;; they slow down the lookup.
(let (Info-fontify-maximum-menu-size
Info-history-list)
(Info-goto-node node)
(setq doc-found t)))
(error
(message "Cannot access Info node %s" node)
(sit-for 1)
nil))
(condition-case nil
(progn
;; Don't use Info-menu, it forces case-fold-search to t
(let ((case-fold-search nil))
(re-search-forward
(concat "^\\* " (regexp-quote (or (cdr entry) (car entry)))
":")))
(Info-follow-nearest-node)
(setq found t)
(if (or prefix suffix)
(let ((case-fold-search
(info-lookup->ignore-case topic (car modes)))
(buffer-read-only nil))
(goto-char (point-min))
(re-search-forward
(concat prefix (regexp-quote (car entry)) suffix))
(goto-char (match-beginning 0))
(and (display-color-p) info-lookup-highlight-face
;; Search again for ITEM so that the first
;; occurrence of ITEM will be highlighted.
(re-search-forward (regexp-quote (car entry)))
(let ((start (match-beginning 0))
(end (match-end 0)))
(if (overlayp info-lookup-highlight-overlay)
(move-overlay info-lookup-highlight-overlay
start end (current-buffer))
(setq info-lookup-highlight-overlay
(make-overlay start end))))
(overlay-put info-lookup-highlight-overlay
'face info-lookup-highlight-face)))))
(error nil)))
(setq doc-spec (cdr doc-spec)))
(setq modes (cdr modes)))
;; Alert the user if case was munged, and do this after bringing up the
;; info buffer since that can print messages
(unless (or ignore-case
(string-equal item (car entry)))
(message "Found in different case: %s" (car entry)))
(when found
(setq Info-history new-Info-history))
(or doc-found
(error "Info documentation for lookup was not found"))
;; Don't leave the Info buffer if the help item couldn't be looked up.
(if (and info-lookup-other-window-flag found)
(select-window window))))
(defun info-lookup-setup-mode (topic mode)
"Initialize the internal data structure."
(or (info-lookup->initialized topic mode)
(let ((initialized 0)
cell data completions refer-modes Info-history-list)
(if (not (info-lookup->mode-value topic mode))
(message "No %s help available for `%s'" topic mode)
;; Recursively setup cross references.
;; But refer only to non-void modes.
(dolist (arg (info-lookup->other-modes topic mode))
(or (info-lookup->initialized topic arg)
(info-lookup-setup-mode topic arg))
(and (eq (info-lookup->initialized topic arg) t)
(setq refer-modes (cons arg refer-modes))))
(setq refer-modes (nreverse refer-modes))
;; Build the full completion alist.
(setq completions
(nconc (condition-case nil
(info-lookup-make-completions topic mode)
(error nil))
(apply 'append
(mapcar (lambda (arg)
(info-lookup->completions topic arg))
refer-modes))))
(setq initialized t))
;; Update `info-lookup-cache'.
(setq cell (info-lookup->mode-cache topic mode)
data (list initialized completions refer-modes))
(if (not cell)
(setcdr (info-lookup->cache topic)
(cons (cons mode data) (info-lookup->topic-cache topic)))
(setcdr cell data))
initialized)))
(defun info-lookup-make-completions (topic mode)
"Create a unique alist from all index entries."
(let ((doc-spec (info-lookup->doc-spec topic mode))
(regexp (concat "^\\(" (info-lookup->regexp topic mode)
"\\)\\([ \t].*\\)?$"))
Info-history-list Info-fontify-maximum-menu-size
node trans entry item prefix result doc-found
(buffer (get-buffer-create " temp-info-look")))
(with-current-buffer buffer
(Info-mode))
(while doc-spec
(setq node (nth 0 (car doc-spec))
trans (cond ((eq (nth 1 (car doc-spec)) nil)
(lambda (arg)
(if (string-match regexp arg)
(match-string 1 arg))))
((stringp (nth 1 (car doc-spec)))
(setq prefix (nth 1 (car doc-spec)))
(lambda (arg)
(if (string-match "^\\([^: \t\n]+\\)" arg)
(concat prefix (match-string 1 arg)))))
(t (nth 1 (car doc-spec)))))
(with-current-buffer buffer
(message "Processing Info node `%s'..." node)
(when (condition-case nil
(progn
(Info-goto-node node)
(setq doc-found t))
(error
(message "Cannot access Info node `%s'" node)
(sit-for 1)
nil))
(condition-case nil
(progn
(goto-char (point-min))
(and (search-forward "\n* Menu:" nil t)
(while (re-search-forward "\n\\* \\(.*\\): " nil t)
(setq entry (match-string 1)
item (funcall trans entry))
;; `trans' can return nil if the regexp doesn't match.
(when (and item
;; Sometimes there's more than one Menu:
(not (string= entry "Menu")))
(and (info-lookup->ignore-case topic mode)
(setq item (downcase item)))
(and (string-equal entry item)
(setq entry nil))
(and (or (assoc item result)
(setq result (cons (cons item entry)
result))))))))
(error nil))))
(message "Processing Info node `%s'...done" node)
(setq doc-spec (cdr doc-spec)))
(or doc-found
(error "Info documentation for lookup was not found"))
result))
(defun info-lookup-guess-default (topic mode)
"Return a guess for a symbol to look up, based on text around point.
Try all related modes applicable to TOPIC and MODE.
Return nil if there is nothing appropriate in the buffer near point."
(let ((modes (info-lookup->all-modes topic mode))
guess)
(while (and (not guess) modes)
(setq guess (info-lookup-guess-default* topic (car modes))
modes (cdr modes)))
;; Collapse whitespace characters.
(when guess
(let ((pos 0))
(while (string-match "[ \t\n]+" guess pos)
(setq pos (1+ (match-beginning 0)))
(setq guess (replace-match " " t t guess)))))
guess))
(defun info-lookup-guess-default* (topic mode)
(let ((case-fold-search (info-lookup->ignore-case topic mode))
(rule (or (info-lookup->parse-rule topic mode)
(info-lookup->regexp topic mode)))
(start (point)) end regexp subexp result)
(save-excursion
(if (symbolp rule)
(setq result (funcall rule))
(if (consp rule)
(setq regexp (car rule)
subexp (cdr rule))
(setq regexp rule
subexp 0))
;; If at start of symbol, don't go back to end of previous one.
(if (save-match-data
(looking-at "[ \t\n]"))
(skip-chars-backward " \t\n"))
(setq end (point))
(while (and (re-search-backward regexp nil t)
(looking-at regexp)
(>= (match-end 0) end))
(setq result (match-string subexp)))
(if (not result)
(progn
(goto-char start)
(skip-chars-forward " \t\n")
(and (looking-at regexp)
(setq result (match-string subexp)))))))
result))
(defun info-lookup-guess-c-symbol ()
"Get the C symbol at point."
(condition-case nil
(progn
(skip-syntax-backward "w_")
(let ((start (point)) prefix name)
;; Test for a leading `struct', `union', or `enum' keyword
;; but ignore names like `foo_struct'.
(setq prefix (and (< (skip-chars-backward " \t\n") 0)
(< (skip-chars-backward "_a-zA-Z0-9") 0)
(looking-at "\\(struct\\|union\\|enum\\)\\s ")
(concat (match-string 1) " ")))
(goto-char start)
(and (looking-at "[_a-zA-Z][_a-zA-Z0-9]*")
(setq name (match-string 0)))
;; Caveat! Look forward if point is at `struct' etc.
(and (not prefix)
(or (string-equal name "struct")
(string-equal name "union")
(string-equal name "enum"))
(looking-at "[a-z]+\\s +\\([_a-zA-Z][_a-zA-Z0-9]*\\)")
(setq prefix (concat name " ")
name (match-string 1)))
(and (or prefix name)
(concat prefix name))))
(error nil)))
(defun info-lookup-guess-custom-symbol ()
"Get symbol at point in custom buffers."
(condition-case nil
(save-excursion
(let ((case-fold-search t)
(ignored-chars "][()`'‘’,:.\" \t\n")
(significant-chars "^][()`'‘’,:.\" \t\n")
beg end)
(cond
((and (memq (get-char-property (point) 'face)
'(custom-variable-tag custom-variable-tag-face))
(setq beg (previous-single-char-property-change
(point) 'face nil (line-beginning-position)))
(setq end (next-single-char-property-change
(point) 'face nil (line-end-position)))
(> end beg))
(subst-char-in-string
?\s ?\- (buffer-substring-no-properties beg end)))
((or (and (looking-at (concat "[" significant-chars "]"))
(save-excursion
(skip-chars-backward significant-chars)
(setq beg (point)))
(skip-chars-forward significant-chars)
(setq end (point))
(> end beg))
(and (looking-at "[ \t\n]")
(looking-back (concat "[" significant-chars "]")
(1- (point)))
(setq end (point))
(skip-chars-backward significant-chars)
(setq beg (point))
(> end beg))
(and (skip-chars-forward ignored-chars)
(setq beg (point))
(skip-chars-forward significant-chars)
(setq end (point))
(> end beg)))
(buffer-substring-no-properties beg end)))))
(error nil)))
;;;###autoload
(defun info-complete-symbol (&optional mode)
"Perform completion on symbol preceding point."
(interactive)
(info-complete 'symbol
(or mode
(if (info-lookup->mode-value
'symbol (info-lookup-select-mode))
info-lookup-mode
(info-lookup-change-mode 'symbol)))))
;;;###autoload
(defun info-complete-file (&optional mode)
"Perform completion on file preceding point."
(interactive)
(info-complete 'file
(or mode
(if (info-lookup->mode-value
'file (info-lookup-select-mode))
info-lookup-mode
(info-lookup-change-mode 'file)))))
(defun info-lookup-completions-at-point (topic mode)
"Try to complete a help item."
(or mode (setq mode (info-lookup-select-mode)))
(when (info-lookup->mode-value topic mode)
(let ((modes (info-lookup-quick-all-modes topic mode))
(start (point))
try)
(while (and (not try) modes)
(setq mode (car modes)
modes (cdr modes)
try (info-lookup-guess-default* topic mode))
(goto-char start))
(when try
(let ((completions (info-lookup->completions topic mode)))
(when completions
(when (info-lookup->ignore-case topic mode)
(setq completions
(lambda (string pred action)
(let ((completion-ignore-case t))
(complete-with-action
action completions string pred)))))
(save-excursion
;; Find the original symbol and zap it.
(end-of-line)
(while (and (search-backward try nil t)
(< start (point))))
(list (match-beginning 0) (match-end 0) completions
:exclusive 'no))))))))
(defun info-complete (topic mode)
"Try to complete a help item."
(barf-if-buffer-read-only)
(let ((data (info-lookup-completions-at-point topic mode)))
(if (null data)
(error "No %s completion available for `%s' at point" topic mode)
(completion-in-region (nth 0 data) (nth 1 data) (nth 2 data)))))
;;; Initialize some common modes.
(info-lookup-maybe-add-help
:mode 'c-mode :topic 'symbol
:regexp "\\(struct \\|union \\|enum \\)?[_a-zA-Z][_a-zA-Z0-9]*"
:doc-spec '(("(libc)Function Index" nil
"^[ \t]+-+ \\(Function\\|Macro\\): .*\\<" "\\>")
;; prefix/suffix has to match things like
;; " -- Macro: int F_DUPFD"
;; " -- Variable: char * tzname [2]"
;; "`DBL_MAX'" (texinfo @table)
;; suffix "\\>" is not used because that sends DBL_MAX to
;; DBL_MAX_EXP ("_" is a non-word char)
("(libc)Variable Index" nil
"^\\([ \t]+-+ \\(Variable\\|Macro\\): .*\\<\\|['`‘]\\)"
"\\( \\|['’]?$\\)")
("(libc)Type Index" nil
"^[ \t]+-+ Data Type: \\<" "\\>")
("(termcap)Var Index" nil
"^[ \t]*['`‘]" "['’]"))
:parse-rule 'info-lookup-guess-c-symbol)
(info-lookup-maybe-add-help
:mode 'c-mode :topic 'file
:regexp "[_a-zA-Z0-9./+-]+"
:doc-spec '(("(libc)File Index")))
(info-lookup-maybe-add-help
:mode 'bison-mode
:regexp "[:;|]\\|%\\([%{}]\\|[_a-z]+\\)\\|YY[_A-Z]+\\|yy[_a-z]+"
:doc-spec '(("(bison)Index" nil
"['`‘]" "['’]"))
:parse-rule "[:;|]\\|%\\([%{}]\\|[_a-zA-Z][_a-zA-Z0-9]*\\)"
:other-modes '(c-mode))
(info-lookup-maybe-add-help
:mode 'makefile-mode
:regexp "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z][_a-zA-Z0-9-]*"
:doc-spec '(("(make)Name Index" nil
"^[ \t]*['`‘]" "['’]"))
:parse-rule "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z0-9-]+")
(info-lookup-maybe-add-help
:topic 'symbol
:mode 'makefile-automake-mode
;; similar regexp/parse-rule as makefile-mode, but also the following
;; (which have index entries),
;; "##" special automake comment
;; "+=" append operator, separate from the GNU make one
:regexp "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z][_a-zA-Z0-9-]*\\|##\\|\\+="
:parse-rule "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z0-9-]+\\|##\\|\\+="
:doc-spec '(
;; "(automake)Macro Index" is autoconf macros used in
;; configure.ac, not Makefile.am, so don't have that here.
("(automake)Variable Index" nil "^[ \t]*['`‘]" "['’]")
;; In automake 1.4 macros and variables were a combined node.
("(automake)Macro and Variable Index" nil "^[ \t]*['`‘]"
"['’]")
;; Directives like "if" are in the "General Index".
;; Prefix "`" since the text for say `+=' isn't always an
;; @item etc and so not always at the start of a line.
("(automake)General Index" nil "['`‘]" "['’]")
;; In automake 1.3 there was just a single "Index" node.
("(automake)Index" nil "['`‘]" "['’]"))
:other-modes '(makefile-mode))
(info-lookup-maybe-add-help
:mode 'texinfo-mode
:regexp "@\\([a-zA-Z]+\\|[^a-zA-Z]\\)"
:doc-spec '(("(texinfo)Command and Variable Index"
;; Ignore Emacs commands and prepend a `@'.
(lambda (item)
(if (string-match "^\\([a-zA-Z]+\\|[^a-zA-Z]\\)\\( .*\\)?$" item)
(concat "@" (match-string 1 item))))
"['`‘]" "['’ ]")))
(info-lookup-maybe-add-help
:mode 'm4-mode
:regexp "[_a-zA-Z][_a-zA-Z0-9]*"
:doc-spec '(("(m4)Macro index"))
:parse-rule "[_a-zA-Z0-9]+")
(info-lookup-maybe-add-help
:mode 'autoconf-mode
:regexp "A[CM]_[_A-Z0-9]+"
:doc-spec '(;; Autoconf Macro Index entries are without an "AC_" prefix,
;; but with "AH_" or "AU_" for those. So add "AC_" if there
;; isn't already an "A._".
("(autoconf)Autoconf Macro Index"
(lambda (item)
(if (string-match "^A._" item) item (concat "AC_" item)))
"^[ \t]+-+ \\(Macro\\|Variable\\): .*\\<" "\\>")
;; M4 Macro Index entries are without "AS_" prefixes, and
;; mostly without "m4_" prefixes. "dnl" is an exception, not
;; wanting any prefix. So AS_ is added back to upper-case
;; names (if needed), m4_ to others which don't already an m4_.
("(autoconf)M4 Macro Index"
(lambda (item)
(let ((case-fold-search nil))
(cond ((or (string-equal item "dnl")
(string-match "^m4_" item)
;; Autoconf 2.62 index includes some macros
;; (e.g., AS_HELP_STRING), so avoid prefixing.
(string-match "^AS_" item))
item)
((string-match "^[A-Z0-9_]+$" item)
(concat "AS_" item))
(t
(concat "m4_" item)))))
"^[ \t]+-+ Macro: .*\\<" "\\>")
;; Autotest Macro Index entries are without "AT_".
("(autoconf)Autotest Macro Index" "AT_"
"^[ \t]+-+ Macro: .*\\<" "\\>")
;; This is for older versions (probably pre autoconf 2.5x):
("(autoconf)Macro Index" "AC_"
"^[ \t]+-+ \\(Macro\\|Variable\\): .*\\<" "\\>")
;; Automake has index entries for its notes on various autoconf
;; macros (eg. AC_PROG_CC). Ensure this is after the autoconf
;; index, so as to prefer the autoconf docs.
("(automake)Macro and Variable Index" nil
"^[ \t]*['`‘]" "['’]"))
;; Autoconf symbols are M4 macros. Thus use M4's parser.
:parse-rule 'ignore
:other-modes '(m4-mode))
(info-lookup-maybe-add-help
:mode 'awk-mode
:regexp "[_a-zA-Z]+"
:doc-spec '(("(gawk)Index"
(lambda (item)
(let ((case-fold-search nil))
(cond
;; `BEGIN' and `END'.
((string-match "^\\([A-Z]+\\) special pattern\\b" item)
(match-string 1 item))
;; `if', `while', `do', ...
((string-match "^\\([a-z]+\\) statement\\b" item)
(if (not (string-equal (match-string 1 item) "control"))
(match-string 1 item)))
;; `NR', `NF', ...
((string-match "^[A-Z]+$" item)
item)
;; Built-in functions (matches to many entries).
((string-match "^[a-z]+$" item)
item))))
"['`‘]" "\\([ \t]*([^)]*)\\)?['’]")))
(info-lookup-maybe-add-help
:mode 'perl-mode
:regexp "[$@%][^a-zA-Z]\\|\\$\\^[A-Z]\\|[$@%]?[a-zA-Z][_a-zA-Z0-9]*"
:doc-spec '(("(perl5)Function Index"
(lambda (item)
(if (string-match "^\\([a-zA-Z0-9]+\\)" item)
(match-string 1 item)))
"^" "\\b")
("(perl5)Variable Index"
(lambda (item)
;; Work around bad formatted array variables.
(let ((sym (cond ((or (string-match "^\\$\\(.\\|@@\\)$" item)
(string-match "^\\$\\^[A-Z]$" item))
item)
((string-match
"^\\([$%@]\\|@@\\)?[_a-zA-Z0-9]+" item)
(match-string 0 item))
(t ""))))
(if (string-match "@@" sym)
(setq sym (concat (substring sym 0 (match-beginning 0))
(substring sym (1- (match-end 0))))))
(if (string-equal sym "") nil sym)))
"^" "\\b"))
:parse-rule "[$@%]?\\([_a-zA-Z0-9]+\\|[^a-zA-Z]\\)")
(info-lookup-maybe-add-help
:mode 'cperl-mode
:regexp "[$@%][^a-zA-Z]\\|\\$\\^[A-Z]\\|[$@%]?[a-zA-Z][_a-zA-Z0-9]*"
:other-modes '(perl-mode))
(info-lookup-maybe-add-help
:mode 'latex-mode
:regexp "\\\\\\([a-zA-Z]+\\|[^a-zA-Z]\\)"
:doc-spec `((,(if (Info-find-file "latex2e" t)
;; From http://home.gna.org/latexrefman
"(latex2e)Command Index"
"(latex)Command Index")
;; \frac{NUM}{DEN} etc can have more than one {xx} argument.
;; \sqrt[ROOT]{num} and others can have square brackets.
nil "[`'‘]" "\\({[^}]*}|\\[[^]]*\\]\\)*['’]")))
(info-lookup-maybe-add-help
:mode 'emacs-lisp-mode
:regexp "[^][()`'‘’,\" \t\n]+"
:doc-spec '(;; Commands with key sequences appear in nodes as `foo' and
;; those without as `M-x foo'.
("(emacs)Command Index" nil "['`‘]\\(M-x[ \t\n]+\\)?" "['’]")
;; Variables normally appear in nodes as just `foo'.
("(emacs)Variable Index" nil "['`‘]" "['’]")
;; Almost all functions, variables, etc appear in nodes as
;; " -- Function: foo" etc. A small number of aliases and
;; symbols appear only as `foo', and will miss out on exact
;; positions. Allowing `foo' would hit too many false matches
;; for things that should go to Function: etc, and those latter
;; are much more important. Perhaps this could change if some
;; sort of fallback match scheme existed.
("(elisp)Index" nil "^ -+ .*: " "\\( \\|$\\)")
("(cl)Function Index" nil "^ -+ .*: " "\\( \\|$\\)")
("(cl)Variable Index" nil "^ -+ .*: " "\\( \\|$\\)")))
;; docstrings talk about elisp, so have apropos-mode follow emacs-lisp-mode
(info-lookup-maybe-add-help
:mode 'apropos-mode
:regexp "[^][()`'‘’,\" \t\n]+" ;; same as emacs-lisp-mode above
:other-modes '(emacs-lisp-mode))
(info-lookup-maybe-add-help
:mode 'lisp-interaction-mode
:regexp "[^][()`'‘’,\" \t\n]+"
:parse-rule 'ignore
:other-modes '(emacs-lisp-mode))
(info-lookup-maybe-add-help
:mode 'lisp-mode
:regexp "[^()`'‘’,\" \t\n]+"
:parse-rule 'ignore
:other-modes '(emacs-lisp-mode))
(info-lookup-maybe-add-help
:mode 'scheme-mode
:regexp "[^()`'‘’,\" \t\n]+"
:ignore-case t
;; Aubrey Jaffer's rendition from <URL:ftp://ftp-swiss.ai.mit.edu/pub/scm>
:doc-spec '(("(r5rs)Index" nil
"^[ \t]+-+ [^:]+:[ \t]*" "\\b")))
(info-lookup-maybe-add-help
:mode 'octave-mode
:regexp "[_a-zA-Z0-9]+\\|\\s.+\\|[-!=^|*/.\\,><~&+]\\{1,3\\}\\|[][();,\"']"
:doc-spec '(("(octave)Function Index" nil
"^ -+ [^:]+:[ ]+\\(\\[[^=]*=[ ]+\\)?" nil)
("(octave)Variable Index" nil "^ -+ [^:]+:[ ]+" nil)
("(octave)Operator Index" nil nil nil)
;; Catch lines of the form "xyz statement"
("(octave)Concept Index"
(lambda (item)
(cond
((string-match "^\\([A-Z]+\\) statement\\b" item)
(match-string 1 item))
(t nil)))
nil; "^ -+ [^:]+:[ ]+" don't think this prefix is useful here.
nil)))
(info-lookup-maybe-add-help
:mode 'maxima-mode
:ignore-case t
:regexp "[a-zA-Z0-9_%]+"
:doc-spec '( ("(maxima)Function and Variable Index" nil
"^ -+ [^:]+:[ ]+\\(\\[[^=]*=[ ]+\\)?" nil)))
(info-lookup-maybe-add-help
:mode 'inferior-maxima-mode
:regexp "[a-zA-Z0-9_%]+"
:other-modes '(maxima-mode))
;; coreutils and bash builtins overlap in places, eg. printf, so there's a
;; question which should come first. Some of the coreutils descriptions are
;; more detailed, but if bash is usually /bin/sh on a GNU system then the
;; builtins will be what's normally run.
;;
;; Maybe special variables like $? should be matched as $?, not just ?.
;; This would avoid a clash between variable $! and negation !, or variable
;; $# and comment # (though comment # is not currently indexed in bash).
;; Unfortunately if $? etc is the symbol, then we wouldn't be taken to the
;; exact spot in the relevant node, since the bash manual has just `?' etc
;; there. Maybe an extension to the prefix/suffix scheme could help this.
(info-lookup-maybe-add-help
:mode 'sh-mode :topic 'symbol
;; bash has "." and ":" in its index, but those chars will probably never
;; work in info, so don't bother matching them in the regexp.
:regexp "\\([a-zA-Z0-9_-]+\\|[!{}@*#?$]\\|\\[\\[?\\|]]?\\)"
:doc-spec '(("(bash)Builtin Index" nil "^['`‘]" "[ .'’]")
("(bash)Reserved Word Index" nil "^['`‘]" "[ .'’]")
("(bash)Variable Index" nil "^['`‘]" "[ .'’]")
;; coreutils (version 4.5.10) doesn't have a separate program
;; index, so exclude extraneous stuff (most of it) by demanding
;; "[a-z]+" in the trans-func.
;; coreutils version 8.1 has node "Concept Index" and past
;; versions have node "Index", look for both, whichever is
;; absent is quietly ignored