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
|
;;; semantic/bovine/el.el --- Semantic details for Emacs Lisp
;; Copyright (C) 1999-2005, 2007-2021 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; 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 <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; Use the Semantic Bovinator for Emacs Lisp
(require 'semantic)
(require 'semantic/bovine)
(require 'semantic/db-el)
(require 'find-func)
(require 'semantic/ctxt)
(require 'semantic/format)
(require 'thingatpt)
;;; Code:
;;; Lexer
;;
(define-lex semantic-emacs-lisp-lexer
"A simple lexical analyzer for Emacs Lisp.
This lexer ignores comments and whitespace, and will return
syntax as specified by the syntax table."
semantic-lex-ignore-whitespace
semantic-lex-ignore-newline
semantic-lex-number
semantic-lex-symbol-or-keyword
semantic-lex-charquote
semantic-lex-paren-or-list
semantic-lex-close-paren
semantic-lex-string
semantic-lex-ignore-comments
semantic-lex-punctuation
semantic-lex-default-action)
;;; Parser
;;
(defvar semantic--elisp-parse-table
`((bovine-toplevel
(semantic-list
,(lambda (vals start end)
(let ((tag (semantic-elisp-use-read (car vals))))
(cond
((and (listp tag) (semantic-tag-p (car tag)))
;; We got a list of tags back. This list is
;; returned here in the correct order, but this
;; list gets reversed later, putting the correctly ordered
;; items into reverse order later.
(nreverse tag))
((semantic--tag-expanded-p tag)
;; At this point, if `semantic-elisp-use-read' returned an
;; already expanded tag (from definitions parsed inside an
;; eval and compile wrapper), just pass it!
tag)
(t
;; We got the basics of a single tag.
(append tag (list start end))))))))
)
"Top level bovination table for elisp.")
(defun semantic-elisp-desymbolify (arglist)
"Convert symbols to strings for ARGLIST."
(let ((out nil))
(while arglist
(setq out
(cons
(if (symbolp (car arglist))
(symbol-name (car arglist))
(if (and (listp (car arglist))
(symbolp (car (car arglist))))
(symbol-name (car (car arglist)))
(format "%S" (car arglist))))
out)
arglist (cdr arglist)))
(nreverse out)))
(defun semantic-elisp-desymbolify-args (arglist)
"Convert symbols to strings for ARGLIST."
(let ((in (semantic-elisp-desymbolify arglist))
(out nil))
(dolist (T in)
(when (not (string-match "^&" T))
(push T out)))
(nreverse out)))
(defun semantic-elisp-clos-slot-property-string (slot property)
"For SLOT, a string representing PROPERTY."
(let ((p (member property slot)))
(if (not p)
nil
(setq p (cdr p))
(cond
((stringp (car p))
(car p))
((or (symbolp (car p))
(listp (car p))
(numberp (car p)))
(format "%S" (car p)))
(t nil)))))
(defun semantic-elisp-clos-args-to-semantic (partlist)
"Convert a list of CLOS class slot PARTLIST to `variable' tags."
(let (vars part v)
(while partlist
(setq part (car partlist)
partlist (cdr partlist)
v (semantic-tag-new-variable
(symbol-name (car part))
(semantic-elisp-clos-slot-property-string part :type)
(semantic-elisp-clos-slot-property-string part :initform)
;; Attributes
:protection (semantic-elisp-clos-slot-property-string
part :protection)
:static-flag (equal (semantic-elisp-clos-slot-property-string
part :allocation)
":class")
:documentation (semantic-elisp-clos-slot-property-string
part :documentation))
vars (cons v vars)))
(nreverse vars)))
(defun semantic-elisp-form-to-doc-string (form)
"After reading a form FORM, convert it to a doc string.
For Emacs Lisp, sometimes that string is non-existent.
Sometimes it is a form which is evaluated at compile time, permitting
compound strings."
(cond ((stringp form) form)
((and (listp form) (eq (car form) 'concat)
(stringp (nth 1 form)))
(nth 1 form))
(t nil)))
(defcustom semantic-elisp-store-documentation-in-tag nil
"When non-nil, store documentation strings in the created tags."
:type 'boolean
:group 'semantic)
(defun semantic-elisp-do-doc (str)
"Return STR as a documentation string IF they are enabled."
(when semantic-elisp-store-documentation-in-tag
(semantic-elisp-form-to-doc-string str)))
(defmacro semantic-elisp-setup-form-parser (parser &rest symbols)
"Install the function PARSER as the form parser for SYMBOLS.
SYMBOLS is a list of symbols identifying the forms to parse.
PARSER is called on every forms whose first element (car FORM) is
found in SYMBOLS. It is passed the parameters FORM, START, END,
where:
- FORM is an Elisp form read from the current buffer.
- START and END are the beginning and end location of the
corresponding data in the current buffer."
(let ((sym (make-symbol "sym")))
`(dolist (,sym ',symbols)
(put ,sym 'semantic-elisp-form-parser #',parser))))
(put 'semantic-elisp-setup-form-parser 'lisp-indent-function 1)
(defmacro semantic-elisp-reuse-form-parser (symbol &rest symbols)
"Reuse the form parser of SYMBOL for forms identified by SYMBOLS.
See also `semantic-elisp-setup-form-parser'."
(let ((parser (make-symbol "parser"))
(sym (make-symbol "sym")))
`(let ((,parser (get ',symbol 'semantic-elisp-form-parser)))
(or ,parser
(signal 'wrong-type-argument
'(semantic-elisp-form-parser ,symbol)))
(dolist (,sym ',symbols)
(put ,sym 'semantic-elisp-form-parser ,parser)))))
(defun semantic-elisp-use-read (sl)
"Use `read' on the semantic list SL.
Return a bovination list to use."
(let* ((start (car sl))
(end (cdr sl))
(form (read (buffer-substring-no-properties start end))))
(cond
;; If the first elt is a list, then it is some arbitrary code.
((listp (car form))
(semantic-tag-new-code "anonymous" nil)
)
;; A special form parser is provided, use it.
((and (car form) (symbolp (car form))
(get (car form) 'semantic-elisp-form-parser))
(funcall (get (car form) 'semantic-elisp-form-parser)
form start end))
;; Produce a generic code tag by default.
(t
(semantic-tag-new-code (format "%S" (car form)) nil)
))))
;;; Form parsers
;;
(semantic-elisp-setup-form-parser
(lambda (form start end)
(semantic-tag-new-function
(symbol-name (nth 2 form))
nil
'("form" "start" "end")
:form-parser t
))
semantic-elisp-setup-form-parser)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((tags
(condition-case foo
(semantic-parse-region start end nil 1)
(error (message "MUNGE: %S" foo)
nil))))
(if (semantic-tag-p (car-safe tags))
tags
(semantic-tag-new-code (format "%S" (car form)) nil))))
eval-and-compile
eval-when-compile
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(semantic-tag-new-function
(symbol-name (nth 1 form))
nil
(semantic-elisp-desymbolify-args (nth 2 form))
:user-visible-flag (eq (car-safe (nth 4 form)) 'interactive)
:documentation (semantic-elisp-do-doc (nth 3 form))
:overloadable (memq (car form) '(define-overload
define-overloadable-function))
))
defun
defun*
defsubst
defmacro
cl-defun
cl-defsubst
cl-defmacro
define-overload ;; @todo - remove after cleaning up semantic.
define-overloadable-function
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((doc (semantic-elisp-form-to-doc-string (nth 3 form))))
(semantic-tag-new-variable
(symbol-name (nth 1 form))
nil
(nth 2 form)
:user-visible-flag (and doc
(> (length doc) 0)
(= (aref doc 0) ?*))
:constant-flag (eq (car form) 'defconst)
:documentation (semantic-elisp-do-doc doc)
)))
defvar
defconst
defcustom
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((doc (semantic-elisp-form-to-doc-string (nth 3 form))))
(semantic-tag-new-variable
(symbol-name (nth 1 form))
"face"
(nth 2 form)
:user-visible-flag (and doc
(> (length doc) 0)
(= (aref doc 0) ?*))
:documentation (semantic-elisp-do-doc doc)
)))
defface
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((doc (semantic-elisp-form-to-doc-string (nth 3 form))))
(semantic-tag-new-variable
(symbol-name (nth 1 form))
"image"
(nth 2 form)
:user-visible-flag (and doc
(> (length doc) 0)
(= (aref doc 0) ?*))
:documentation (semantic-elisp-do-doc doc)
)))
defimage
defezimage
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((doc (semantic-elisp-form-to-doc-string (nth 3 form))))
(semantic-tag
(symbol-name (nth 1 form))
'customgroup
:value (nth 2 form)
:user-visible-flag t
:documentation (semantic-elisp-do-doc doc)
)))
defgroup
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(semantic-tag-new-function
(symbol-name (cadr (cadr form)))
nil nil
:user-visible-flag (and (nth 4 form)
(not (eq (nth 4 form) 'nil)))
:prototype-flag t
:documentation (semantic-elisp-do-doc (nth 3 form))))
autoload
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let* ((a2 (nth 2 form))
(a3 (nth 3 form))
(args (if (listp a2) a2 a3))
(doc (nth (if (listp a2) 3 4) form)))
(semantic-tag-new-function
(symbol-name (nth 1 form))
nil
(if (listp (car args))
(cons (symbol-name (caar args))
(semantic-elisp-desymbolify-args (cdr args)))
(semantic-elisp-desymbolify-args (cdr args)))
:parent (if (listp (car args)) (symbol-name (cadr (car args))) nil)
:documentation (semantic-elisp-do-doc doc)
)))
defmethod
defgeneric
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(semantic-tag-new-function
(symbol-name (nth 1 form))
nil
(semantic-elisp-desymbolify (nth 2 form))
))
defadvice
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((docpart (nthcdr 4 form)))
(semantic-tag-new-type
(symbol-name (nth 1 form))
"class"
(semantic-elisp-clos-args-to-semantic (nth 3 form))
(semantic-elisp-desymbolify (nth 2 form))
:typemodifiers (semantic-elisp-desymbolify
(unless (stringp (car docpart)) docpart))
:documentation (semantic-elisp-do-doc
(if (stringp (car docpart))
(car docpart)
(cadr (member :documentation docpart))))
)))
defclass
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((slots (nthcdr 2 form)))
;; Skip doc string if present.
(and (stringp (car slots))
(setq slots (cdr slots)))
(semantic-tag-new-type
(symbol-name (if (consp (nth 1 form))
(car (nth 1 form))
(nth 1 form)))
"struct"
(semantic-elisp-desymbolify slots)
(cons nil nil)
)))
defstruct
cl-defstruct
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(semantic-tag-new-function
(symbol-name (nth 1 form))
nil nil
:lexical-analyzer-flag t
:documentation (semantic-elisp-do-doc (nth 2 form))
))
define-lex
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((args (nth 3 form)))
(semantic-tag-new-function
(symbol-name (nth 1 form))
nil
(and (listp args) (semantic-elisp-desymbolify args))
:override-function-flag t
:parent (symbol-name (nth 2 form))
:documentation (semantic-elisp-do-doc (nth 4 form))
)))
define-mode-local-override
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(semantic-tag-new-variable
(symbol-name (nth 2 form))
nil
(nth 3 form) ; default value
:override-variable-flag t
:parent (symbol-name (nth 1 form))
:documentation (semantic-elisp-do-doc (nth 4 form))
))
defvar-mode-local
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((name (nth 1 form)))
(semantic-tag-new-include
(symbol-name (if (eq (car-safe name) 'quote)
(nth 1 name)
name))
nil
:directory (nth 2 form))))
require
)
(semantic-elisp-setup-form-parser
(lambda (form start end)
(let ((name (nth 1 form)))
(semantic-tag-new-package
(symbol-name (if (eq (car-safe name) 'quote)
(nth 1 name)
name))
(nth 3 form))))
provide
)
;;; Mode setup
;;
(define-mode-local-override semantic-dependency-tag-file
emacs-lisp-mode (tag)
"Find the file BUFFER depends on described by TAG."
(condition-case nil
(find-library-name (semantic-tag-name tag))
(error
(message "semantic: cannot find source file %s"
(semantic-tag-name tag)))))
;;; DOC Strings
;;
(defun semantic-emacs-lisp-overridable-doc (tag)
"Return the documentation string generated for overloadable functions.
Fetch the item for TAG. Only returns info about what symbols can be
used to perform the override."
(if (and (eq (semantic-tag-class tag) 'function)
(semantic-tag-get-attribute tag :overloadable))
;; Calc the doc to use for the overloadable symbols.
(mode-local--overload-docstring-extension
(intern (semantic-tag-name tag)))
""))
(defun semantic-emacs-lisp-obsoleted-doc (tag)
"Indicate that TAG is a new name that has obsoleted some old name.
Unfortunately, this requires that the tag in question has been loaded
into Emacs Lisp's memory."
(let ((obsoletethis (intern-soft (semantic-tag-name tag)))
(obsoleter nil))
;; This asks if our tag is available in the Emacs name space for querying.
(when obsoletethis
(mapatoms (lambda (a)
(let ((oi (get a 'byte-obsolete-info)))
(if (and oi (eq (car oi) obsoletethis))
(setq obsoleter a)))))
(if obsoleter
(format "\n@obsolete{%s,%s}" obsoleter (semantic-tag-name tag))
""))))
(define-mode-local-override semantic-documentation-for-tag
emacs-lisp-mode (tag &optional nosnarf)
"Return the documentation string for TAG.
Optional argument NOSNARF is ignored."
(let ((d (semantic-tag-docstring tag)))
(when (not d)
(cond ((semantic-tag-with-position-p tag)
;; Doc isn't in the tag itself. Let's pull it out of the
;; sources.
(let ((semantic-elisp-store-documentation-in-tag t))
(setq tag (with-current-buffer (semantic-tag-buffer tag)
(goto-char (semantic-tag-start tag))
(semantic-elisp-use-read
;; concoct a lexical token.
(cons (semantic-tag-start tag)
(semantic-tag-end tag))))
d (semantic-tag-docstring tag))))
;; The tag may be the result of a system search.
((intern-soft (semantic-tag-name tag))
(let ((sym (intern-soft (semantic-tag-name tag))))
;; Query into the global table o stuff.
(cond ((eq (semantic-tag-class tag) 'function)
(setq d (documentation sym)))
(t
(setq d (documentation-property
sym 'variable-documentation)))))
;; Label it as system doc. perhaps just for debugging
;; purposes.
(if d (setq d (concat "System Doc: \n" d)))
))
)
(when d
(concat
(substitute-command-keys
(if (and (> (length d) 0) (= (aref d 0) ?*))
(substring d 1)
d))
(semantic-emacs-lisp-overridable-doc tag)
(semantic-emacs-lisp-obsoleted-doc tag)))))
;;; Tag Features
;;
(define-mode-local-override semantic-tag-include-filename emacs-lisp-mode
(tag)
"Return the name of the tag with .el appended.
If there is a detail, prepend that directory."
(let ((name (semantic-tag-name tag))
(detail (semantic-tag-get-attribute tag :directory)))
(concat (expand-file-name name detail) ".el")))
(define-mode-local-override semantic-insert-foreign-tag
emacs-lisp-mode (tag)
"Insert TAG at point.
Attempts a simple prototype for calling or using TAG."
(cond ((semantic-tag-of-class-p tag 'function)
(insert "(" (semantic-tag-name tag) " )")
(forward-char -1))
(t
(insert (semantic-tag-name tag)))))
(define-mode-local-override semantic-tag-protection
emacs-lisp-mode (tag &optional parent)
"Return the protection of TAG in PARENT.
Override function for `semantic-tag-protection'."
(let ((prot (semantic-tag-get-attribute tag :protection)))
(cond
;; If a protection is not specified, AND there is a parent
;; data type, then it is public.
((and (not prot) parent) 'public)
((string= prot ":public") 'public)
((string= prot "public") 'public)
((string= prot ":private") 'private)
((string= prot "private") 'private)
((string= prot ":protected") 'protected)
((string= prot "protected") 'protected))))
(define-mode-local-override semantic-tag-static-p
emacs-lisp-mode (tag &optional parent)
"Return non-nil if TAG is static in PARENT class.
Overrides `semantic-nonterminal-static'."
;; This can only be true (theoretically) in a class where it is assigned.
(semantic-tag-get-attribute tag :static-flag))
;;; Context parsing
;;
;; Emacs lisp is very different from C,C++ which most context parsing
;; functions are written. Support them here.
(define-mode-local-override semantic-up-context emacs-lisp-mode
(&optional point bounds-type)
"Move up one context in an Emacs Lisp function.
A Context in many languages is a block with its own local variables.
In Emacs, we will move up lists and stop when one starts with one of
the following context specifiers:
`let', `let*', `defun', `with-slots'
Returns non-nil it is not possible to go up a context."
(let ((last-up (semantic-up-context-default)))
(while
(and (not (looking-at
"(\\(let\\*?\\|\\(?:cl-\\)?def\\(un\\|method\\|generic\\|\
define-mode-overload\\)\
\\|with-slots\\)"))
(not last-up))
(setq last-up (semantic-up-context-default)))
last-up))
(define-mode-local-override semantic-ctxt-current-function emacs-lisp-mode
(&optional point same-as-symbol-return)
"Return a string which is the current function being called."
(save-excursion
(if point (goto-char point) (setq point (point)))
;; (semantic-beginning-of-command)
(if (condition-case nil
(and (save-excursion
(up-list -2)
(looking-at "(("))
(save-excursion
(up-list -3)
(looking-at "(let")))
(error nil))
;; This is really a let statement, not a function.
nil
(let ((fun (condition-case nil
(save-excursion
(up-list -1)
(forward-char 1)
(buffer-substring-no-properties
(point) (progn (forward-sexp 1)
(point))))
(error nil))
))
(when fun
;; Do not return FUN IFF the cursor is on FUN.
;; Huh? That's because if cursor is on fun, it is
;; the current symbol, and not the current function.
(if (save-excursion
(condition-case nil
(progn (forward-sexp -1)
(and
(looking-at (regexp-quote fun))
(<= point (+ (point) (length fun))))
)
(error t)))
;; Go up and try again.
same-as-symbol-return
;; We are ok, so get it.
(list fun))
))
)))
(define-mode-local-override semantic-get-local-variables emacs-lisp-mode
(&optional point)
"Return a list of local variables for POINT.
Scan backwards from point at each successive function. For all occurrences
of `let' or `let*', grab those variable names."
(let* ((vars nil)
(fn nil))
(save-excursion
(while (setq fn (car (semantic-ctxt-current-function-emacs-lisp-mode
(point) (list t))))
(cond
((eq fn t)
nil)
((member fn '("let" "let*" "with-slots"))
;; Snarf variables
(up-list -1)
(forward-char 1)
(forward-symbol 1)
(skip-chars-forward "* \t\n")
(let ((varlst (read (buffer-substring-no-properties
(point)
(save-excursion
(forward-sexp 1)
(point))))))
(while varlst
(let* ((oneelt (car varlst))
(name (if (symbolp oneelt)
oneelt
(car oneelt))))
(setq vars (cons (semantic-tag-new-variable
(symbol-name name)
nil nil)
vars)))
(setq varlst (cdr varlst)))
))
((string= fn "lambda")
;; Snart args...
(up-list -1)
(forward-char 1)
(forward-word-strictly 1)
(skip-chars-forward "* \t\n")
(let ((arglst (read (buffer-substring-no-properties
(point)
(save-excursion
(forward-sexp 1)
(point))))))
(while arglst
(let* ((name (car arglst)))
(when (/= ?& (aref (symbol-name name) 0))
(setq vars (cons (semantic-tag-new-variable
(symbol-name name)
nil nil)
vars))))
(setq arglst (cdr arglst)))
))
)
(up-list -1)))
(nreverse vars)))
(define-mode-local-override semantic-end-of-command emacs-lisp-mode
()
"Move cursor to the end of the current command.
In Emacs Lisp this is easily defined by parenthesis bounding."
(condition-case nil
(up-list 1)
(error nil)))
(define-mode-local-override semantic-beginning-of-command emacs-lisp-mode
()
"Move cursor to the beginning of the current command.
In Emacs Lisp this is easily defined by parenthesis bounding."
(condition-case nil
(progn
(up-list -1)
(forward-char 1))
(error nil)))
(define-mode-local-override semantic-ctxt-current-symbol emacs-lisp-mode
(&optional point)
"List the symbol under point."
(save-excursion
(if point (goto-char point))
(require 'thingatpt)
(let ((sym (thing-at-point 'symbol)))
(if sym (list sym)))
))
(define-mode-local-override semantic-ctxt-current-assignment emacs-lisp-mode
(&optional point)
"What is the variable being assigned into at POINT?"
(save-excursion
(if point (goto-char point))
(let ((fn (semantic-ctxt-current-function point))
(point (point)))
;; We should never get lists from here.
(if fn (setq fn (car fn)))
(cond
;; SETQ
((and fn (or (string= fn "setq") (string= fn "set")))
(save-excursion
(condition-case nil
(let ((count 0)
(lastodd nil)
(start nil))
(up-list -1)
(down-list 1)
(forward-sexp 1)
;; Skip over sexp until we pass point.
(while (< (point) point)
(setq count (1+ count))
(forward-comment 1)
(setq start (point))
(forward-sexp 1)
(if (= (% count 2) 1)
(setq lastodd
(buffer-substring-no-properties start (point))))
)
(if lastodd (list lastodd))
)
(error nil))))
;; This obscure thing finds let statements.
((condition-case nil
(and
(save-excursion
(up-list -2)
(looking-at "(("))
(save-excursion
(up-list -3)
(looking-at "(let")))
(error nil))
(save-excursion
(semantic-beginning-of-command)
;; Use func finding code, since it is the same format.
(semantic-ctxt-current-symbol)))
;;
;; DEFAULT- nothing
(t nil))
)))
(define-mode-local-override semantic-ctxt-current-argument emacs-lisp-mode
(&optional point)
"Return the index into the argument the cursor is in, or nil."
(save-excursion
(if point (goto-char point))
(if (looking-at "\\<\\w")
(forward-char 1))
(let ((count 0))
(while (condition-case nil
(progn
(forward-sexp -1)
t)
(error nil))
(setq count (1+ count)))
(cond ((= count 0)
0)
(t (1- count))))
))
(define-mode-local-override semantic-ctxt-current-class-list emacs-lisp-mode
(&optional point)
"Return a list of tag classes allowed at POINT.
Emacs Lisp knows much more about the class of the tag needed to perform
completion than some languages. We distinctly know if we are to be a
function name, variable name, or any type of symbol. We could identify
fields and such to, but that is for some other day."
(save-excursion
(if point (goto-char point))
(setq point (point))
(condition-case nil
(let ((count 0))
(up-list -1)
(forward-char 1)
(while (< (point) point)
(setq count (1+ count))
(forward-sexp 1))
(if (= count 1)
'(function)
'(variable))
)
(error '(variable)))
))
;;; Formatting
;;
(define-mode-local-override semantic-format-tag-abbreviate emacs-lisp-mode
(tag &optional parent color)
"Return an abbreviated string describing tag."
(let ((class (semantic-tag-class tag))
(name (semantic-format-tag-name tag parent color))
)
(cond
((eq class 'function)
(concat "(" name ")"))
(t
(semantic-format-tag-abbreviate-default tag parent color)))))
(define-mode-local-override semantic-format-tag-prototype emacs-lisp-mode
(tag &optional parent color)
"Return a prototype string describing tag.
In Emacs Lisp, a prototype for something may start (autoload ...).
This is certainly not expected if this is used to display a summary.
Make up something else. When we go to write something that needs
a real Emacs Lisp prototype, we can fix it then."
(let ((class (semantic-tag-class tag))
(name (semantic-format-tag-name tag parent color))
)
(cond
((eq class 'function)
(let* ((args (semantic-tag-function-arguments tag))
(argstr (semantic--format-tag-arguments args
#'identity
color)))
(concat "(" name (if args " " "")
argstr
")")))
(t
(semantic-format-tag-prototype-default tag parent color)))))
(define-mode-local-override semantic-format-tag-concise-prototype emacs-lisp-mode
(tag &optional parent color)
"Return a concise prototype string describing tag.
See `semantic-format-tag-prototype' for Emacs Lisp for more details."
(semantic-format-tag-prototype tag parent color))
(define-mode-local-override semantic-format-tag-uml-prototype emacs-lisp-mode
(tag &optional parent color)
"Return a uml prototype string describing tag.
See `semantic-format-tag-prototype' for Emacs Lisp for more details."
(semantic-format-tag-prototype tag parent color))
;;; IA Commands
;;
(define-mode-local-override semantic-ia-insert-tag
emacs-lisp-mode (tag)
"Insert TAG into the current buffer based on completion."
;; This function by David <de_bb@...> is a tweaked version of the original.
(insert (semantic-tag-name tag))
(let ((tt (semantic-tag-class tag))
(args (semantic-tag-function-arguments tag)))
(cond ((eq tt 'function)
(if args
(insert " ")
(insert ")")))
(t nil))))
;;; Lexical features and setup
;;
(defvar-mode-local emacs-lisp-mode semantic-lex-analyzer
'semantic-emacs-lisp-lexer)
(defvar-mode-local emacs-lisp-mode semantic--parse-table
semantic--elisp-parse-table)
(defvar-mode-local emacs-lisp-mode semantic-function-argument-separator
" ")
(defvar-mode-local emacs-lisp-mode semantic-function-argument-separation-character
" ")
(defvar-mode-local emacs-lisp-mode semantic-symbol->name-assoc-list
'(
(type . "Types")
(variable . "Variables")
(function . "Defuns")
(include . "Requires")
(package . "Provides")
))
(defvar-mode-local emacs-lisp-mode imenu-create-index-function
'semantic-create-imenu-index)
(defvar-mode-local emacs-lisp-mode semantic-stickyfunc-sticky-classes
'(function type variable)
"Add variables.
ELisp variables can be pretty long, so track this one too.")
(with-suppressed-warnings ((obsolete define-child-mode))
;; FIXME: We should handle this some other way!
(define-child-mode lisp-mode emacs-lisp-mode
"Make `lisp-mode' inherit mode local behavior from `emacs-lisp-mode'."))
;;;###autoload
(defun semantic-default-elisp-setup ()
"Setup hook function for Emacs Lisp files and Semantic."
;; This is here mostly to get this file loaded when a .el file is
;; loaded into Emacs.
)
(add-hook 'emacs-lisp-mode-hook 'semantic-default-elisp-setup)
;;; LISP MODE
;;
;; @TODO: Lisp supports syntaxes that Emacs Lisp does not.
;; Write a Lisp only parser someday.
;;
;; See this syntax:
;; (defun foo () /#A)
;;
(add-hook 'lisp-mode-hook 'semantic-default-elisp-setup)
(eval-after-load "semantic/db"
'(require 'semantic/db-el)
)
(provide 'semantic/bovine/el)
;; Local variables:
;; generated-autoload-file: "../loaddefs.el"
;; generated-autoload-load-name: "semantic/bovine/el"
;; End:
;;; semantic/bovine/el.el ends here
|