-
Notifications
You must be signed in to change notification settings - Fork 0
/
taglist.el
1295 lines (1061 loc) · 47.1 KB
/
taglist.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
;;; taglist.el --- Taglist provides an overview of the structure of the programming language files.
;; Copyright (C) 2015 Galen Liu
;; Author: Galen Liu <galen.gang.liu at gmail.com>
;; This file is *NOT* part of GNU Emacs.
;; This program 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 2 of
;; the License, or (at your option) any later version.
;; This program 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 this program; if not, write to the Free
;; Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
;; MA 02111-1307 USA
;; Version: 1.0
;; Compatibility: Emacs 24
;;; Commentary:
;; The "Tag List" plugin is a source code browser plugin for Emacs and provides
;; an overview of the structure of the programming language files and allows you
;; to efficiently browse through source code files for different programming
;; languages.
;; It contains some useful functions features for developers:
;; 1) Tag navigation.
;;
;; When taglist-list-tags called, a new buffer is shown, containing list of
;; different type tags. You can select the tag moving to its line and press
;; ENTER to jump to the tag. You also can type a string in the buffer and tag
;; list will be reduced to those which contain the string as a substring.
;; Nice highlight is implemented.
;; 2) Header <-> Body file switch.
;;
;; You can easily switch between body (c, cpp, cc...) and its corresponding
;; header file (h, hpp...) using taglist-switch-h-cpp. The counterpart file
;; is first searched in opened buffers and if there is no match the file is
;; searched in the same directory. You can adjust body to header
;; correspondence customizing taglist-header-switches variable.
;; Taglist uses ctags as backend (https://ctags.io/ or http://ctags.sourceforge.net/)
;;; Usage:
;; 1) Install ctags(exuberant-ctags) package
;; 2) Add convenient keymaps for fast taglist calls in prog-mode
;;
;; (defun my-c-mode-common-hook ()
;; (define-key c-mode-base-map (kbd "M-o") 'taglist-switch-h-cpp)
;; (define-key c-mode-base-map (kbd "M-m") 'taglist-list-tags))
;; (add-hook 'c-mode-common-hook 'my-c-mode-common-hook)
;;
;; (defun my-python-mode-hook ()
;; (define-key python-mode-map (kbd "M-m") 'taglist-list-tags))
;; (add-hook 'python-mode-hook 'my-python-mode-hook)
;;
;; (define-key lisp-mode-shared-map (kbd "M-m") 'taglist-list-tags)
;;
;; 3) Open any programming file, press M-m. Try to type any tag name.
;;
;; 4) Open any .cpp file. Press M-o. If there is .h or .hpp file in the
;; same folder, it will be opened.
;;; Changelog:
;; 03 Nov 2015 -- v1.0 Initial version created.
;;; TODO:
;;; Code:
(require 'cl)
(require 'imenu-list)
;; ================================== My STRING utils ========================
(defun taglist-string-without-last (string n)
"This function truncates from the STRING last N characters."
(substring string 0 (max 0(- (length string) n))))
(defun taglist-string-ends-with (string end)
"Check whether STRING ends with END substring."
(string= end (substring string (- (length end)))))
;; ================================== My STRING utils end ====================
;; ================================== CPP-H switch ===========================
;;;###autoload
(defvar taglist-header-switches '(("h" . ("cpp" "cc" "c"))
("hpp" . ("cpp" "cc"))
("cpp" . ("h" "hpp"))
("c" . ("h"))
("C" . ("H"))
("H" . ("C" "CPP" "CC"))
("cc" . ("h" "hpp")))
"This variable defines possible switches for `taglist-switch-h-cpp' function.
Its format is list of (from . (to1 to2 to3...)) elements. From and toN are
strings which are extentions of the files.")
(defvar tag-list--last-location nil
"Location from which last `tag-list-update' was done.
Used to avoid updating if the point didn't move.")
;;;###autoload
(defun taglist-switch-h-cpp ()
"Switch header and body file according to `taglist-header-switches' var.
The current buffer's file name extention is searched in
`taglist-header-switches' variable to find out extention for file's counterpart,
for example *.hpp <--> *.cpp."
(interactive)
(let* ((ext (file-name-extension (buffer-file-name)))
(base-name (taglist-string-without-last (buffer-name) (length ext)))
(base-path (taglist-string-without-last (buffer-file-name) (length ext)))
(count-ext (cdr (find-if (lambda (i) (string= (car i) ext)) taglist-header-switches))))
(cond
(count-ext
(unless
(or
(loop for b in (mapcar (lambda (i) (concat base-name i)) count-ext)
when (bufferp (get-buffer b)) return (switch-to-buffer b))
(loop for c in (mapcar (lambda (count-ext) (concat base-path count-ext)) count-ext)
when (file-exists-p c) return (find-file c)))
(message "There is no corresponding pair (header or body) file.")))
(t
(message "It is not a header or body file! See taglist-header-switches variable.")))))
;; ================================== CPP-H switch end =========================
;; ================================== Tag navigator =========================
(defvar taglist-source-code-buffer nil
"Source code buffer")
(defvar taglist-all-tags nil
"Collection of tags used when searching for current selection.")
(defvar taglist-tmp-file nil
"save current buffer to a temp file. fix ctags can't open a gz
files, example: ido.el.gz")
(defvar taglist-actual-tags nil
"Collection of actual tags used when searching for current selection.")
(defvar taglist-search-string nil
"The current search string during a search.")
;; overlays, use hightlight tags
(defvar taglist-overlays nil
"List of active overlays.")
(defvar taglist-current-language nil
"current programming language.")
(defvar taglist-current-line nil
"current line")
(defvar taglist-current-major-mode nil
"current major mode")
(defface taglist-tag-type
'((((class color))
(:foreground "blue" :height 1.0))
;; (t (:weight bold))
)
"Regexp matching the text identifying the file in `taglist-mode'."
:group 'taglist)
(defvar taglist-tag-type-face 'taglist-tag-type)
(defvar taglist-tag-type-re
(concat "^\\w.*$")
"Regexp matching the text identifying a tag type name.")
(defvar taglist-font-lock-keywords
;; We use `eval' so as to use the buffer-local value of taglist-tag-type-re if
;; applicable.
'((eval . `(,taglist-tag-type-re . taglist-tag-type-face))))
(defconst taglist-font-lock-defaults
'(taglist-font-lock-keywords t nil nil nil))
;; TODO: maintain the list by ctags --list-maps and
;; https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
;; format: (<file name pattern> <detected language>)
(defvar taglist-filename-to-language-alist
'(
("\\.lua\\'" . "lua")
("\\.i\\'" . "c")
("\\.lex\\'" . "c")
("\\.[ch]\\'" . "c")
("\\.x[bp]m\\'" . "c")
("\\.xs\\'" . "c")
("\\.h$" . "c++")
("\\.ii\\'" . "c++")
("\\.\\(CC?\\|HH?\\)\\'" . "c++")
("\\.[ch]\\(pp\\|xx\\|\\+\\+\\)\\'" . "c++")
("\\.\\(cc\\|hh\\)\\'" . "c++")
("\\.y\\(acc\\)?\\'" . "yacc")
("\\.vim\\(rc\\)?$" . "vim")
("\\.vim\\(rc\\|peratorrc\\)?$" . "vim")
("\\.exrc\\'" . "vim")
("[._]?g?vimrc\\'" . "vim")
("\\.vim\\'" . "vim")
("\\.go\\'" . "go")
("\\.l\\'" . "lisp")
("\\.li?sp\\'" . "lisp")
("\\.ml\\'" . "lisp")
("\\.asd\\'" . "lisp")
("\\.el\\'" . "lisp")
("Project\\.ede\\'" . "lisp")
("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . "lisp")
("\\`\\..*emacs\\'" . "lisp")
("[:/]_emacs\\'" . "lisp")
("\\.[tT]e[xX]\\'" . "tex")
("\\.ins\\'" . "tex")
("\\.sty\\'" . "tex")
("\\.cl[so]\\'" . "tex")
("\\.bbl\\'" . "tex")
("\\.ltx\\'" . "tex")
("\\.html?\\'" . "html")
("\\.djhtml\\'" . "html")
("\\.phtml\\'" . "html")
("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . "html")
("\\.as[cp]x\\'" . "asp")
("\\.asp\\'" . "asp")
("\\.php\\'" . "php")
("/crontab\\.X*[0-9]+\\'" . "sh")
("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . "sh")
("\\.bash\\'" . "sh")
("\\(/\\|\\`\\)\\.\\(bash_\\(profile\\|history\\|log\\(in\\|out\\)\\)\\|z?log\\(in\\|out\\)\\)\\'" . "sh")
("\\(/\\|\\`\\)\\.\\(shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . "sh")
("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . "sh")
("\\.m?spec\\'" . "sh")
("\\(?:\\.rb\\|ru\\|rake\\|thor\\|jbuilder\\|gemspec\\|podspec\\|/\\(?:Gem\\|Rake\\|Cap\\|Thor\\|Vagrant\\|Guard\\|Pod\\)file\\)\\'" . "ruby")
("\\.py\\'" . "python")
("\\.awk\\'" . "awk")
("\\.java\\'" . "java")
("\\.m\\'" . "objc")
("\\.\\(bat\\|cmd\\)\\'" . "dosbatch")
("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . "scheme")
("\\.scm\\.[0-9]*\\'" . "scheme")
("\\.oak\\'" . "scheme")
("\\.[fF]\\'" . "fortran")
("\\.for\\'" . "fortran")
("\\.f9[05]\\'" . "fortran")
("\\.f0[38]\\'" . "fortran")
("\\.p\\'" . "pascal")
("\\.pas\\'" . "pascal")
("\\.ad[abs]\\'" . "ada")
("\\.ad[bs].dg\\'" . "ada")
("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . "perl")
("\\.mk\\'" . "make")
("\\.make\\'" . "make")
("[Mm]akefile\\'" . "make")
("\\.[sS]\\'" . "asm")
("\\.asm\\'" . "asm")
("/\\.[a-z0-9-]*gdbinit" . "gdb-script")
("-gdb\\.gdb" . "gdb-script")
("\\.sql\\'" . "sql")
("\\.m[4c]\\'" . "m4")
("\\.i?tcl\\'" . "tcl")
("\\.exp\\'" . "tcl")
("\\.itk\\'" . "tcl")
("\\.svgz?\\'" . "xml")
("\\.x[ms]l\\'" . "xml")
("\\.dbk\\'" . "xml")
("\\.js\\'" . "javascript")
("\\.json\\'" . "javascript")
("\\.[ds]?vh?\\'" . "verilog")
("\\.vhdl?\\'" . "vhdl")
("\\.re?st\\'" . "reStructuredText")
)
)
;; major mode name map to language
;; (add-to-list 'taglist-major-to-language-alist '("<lang>-mode" "<lang>"))
;; format: (<major mode> <detected language>)
(defvar taglist-major-to-language-alist
`(
("lua-mode" "lua")
("emacs-lisp-mode" "lisp")
("lisp-mode" "lisp")
("c-mode" "c")
("c++-mode" "c++")
;; rust is support at https://github.com/universal-ctags
("rst-mode" "rst")
;; https://github.com/dominikh/go-mode.el.git
("go-mode" "go")
("java-mode" "java")
("python-mode" "python")
("ruby-mode" "ruby")
("js-mode" "javascript")
("objc-mode" "objectivec")
("asm-mode" "asm")
("sh-mode" "sh")
("shell-script-mode" "sh")
("sql-mode" "sql")
("tcl-mode" "tcl")
("fortran-mode" "fortran")
("f90-mode" "fortran")
("scheme-mode" "scheme")
("pascal-mode" "pascal")
("perl-mode" "perl")
("verilog-mode" "verilog")
("vhdl-mode" "vhdl")
("awk-mode" "awk")
("html-mode" "html")
("latex-mode" "tex")
("makefile-gmake-mode" "make")
;; https://github.com/mcandre/vimrc-mode.git
("vimrc-mode" "vim")
("bat-mode" "dosbatch")
("rst-mode" "reStructuredText")
))
;; TODO: maintain the list by ctags --list-kinds
;; format: (<detected language> <ctags language>;<short-kind:full-kind>....)
(defvar taglist-language-to-ctags-alist
`(
;; Ant language
("ant" "Ant;p:projects;t:targets")
;; assembly language
("asm" "Asm;d:define;l:label;m:macro;t:type")
;; aspperl language
("aspperl" "Asp;c:constants;v:variable;f:function;s:subroutine")
;; aspvbs language
("aspvbs" "Asp;c:constants;v:variable;f:function;s:subroutine")
;; awk language
("awk" "Awk;f:function")
;; basic language
("basic" "Basic;c:constant;l:label;g:enum;v:variable;t:type;f:function")
;; beta language
("beta" "BETA;f:fragment;s:slot;v:pattern")
;; c language
("c" "C;c:classes;d:macro definitions;g:enumeration names;\
n:namespaces;s:structure names;t:typedefs;\
u:union names;v:variable definitions;f:function definitions;p:function prototype")
;; c++ language
("c++" "C++;n:namespace;v:variable;d:macro;t:typedef;\
c:class;g:enum;s:struct;u:union;f:function;p:function prototype")
;; c# language
("cs" "C#;d:macro;t:typedef;n:namespace;c:class;E:event;\
g:enum;s:struct;i:interface;p:properties;m:method")
;; cobol language
("cobol" "Cobol;d:data;f:file;g:group;p:paragraph;\
P:program;s:section")
;; D programming language
("d" "C++;n:namespace;v:variable;t:typedef;c:class;\
g:enum;s:struct;u:union;f:function")
;; Dosbatch
("dosbatch" "DosBatch;l:labels;v:variables")
;; eiffel language
("eiffel" "Eiffel;c:class;f:feature")
;; erlang language
("erlang" "Erlang;d:macro;r:record;m:module;f:function")
;; expect (same as tcl) language
("expect" "Tcl;c:class;f:method;p:procedure")
;; flex
("flex" "Flex;v:global;c:classes;p:properties;m:methods;f:functions;x:mxtags")
;; fortran language
("Fortran" "fortran;p:program;b:block data;c:common;e:entry;\
i:interface;k:type;l:label;m:module;n:namelist;t:derived;v:variable;\
f:function;s:subroutine")
;; GO language
("go" "Go;p:packages;c:constants;t:types;v:variables;s:structs;i:interfaces;m:struct members;f:functions")
("objectivec" "ObjectiveC;i:class interface;I:class implementation;P:Protocol;m:Object's method;\
c:Class' method;v:Global variable;F:Object field;f:A function;p:A property;t:A type alias;\
s:A type structure;e:An enumeration;MA preprocessor macro")
;; HTML language
("html" "HTML;a:anchor;f:function")
;; java language
("java" "Java;p:package;c:class;i:interface;g:enum;f:field;m:method")
;; javascript language
("javascript" "JavaScript;c:class;m:method;v:global;f:function;p:properties;C:constants")
;; lisp language
("lisp" "Lisp;v:variable;f:function;c:custom")
;; lua language
("lua" "Lua;f:function")
;; makefiles
("make" "Make;m:macro;t:targets")
;; Matlab
("matlab" "MatLab;f:function")
;; Ocamal
("ocamal" "OCaml;M:module;v:global;t:type;c:class;\
f:function;m:method;C:constructor;e:exception")
;; pascal language
("pascal" "Pascal;f:function;p:procedure")
;; perl language
("perl" "Perl;f:formats;c:constant;l:label;p:package;s:subroutine")
;; Perl6
("perl6" "Perl6;c:classes;g:grammars;m:methods;o:modules;p:packages;r:roles;u:rules;b:submethods;s:subroutines:t:tokens")
;; php language
("php" "PHP;c:classes;d:constant definitions;i:interfaces;n:namespaces;t:traits;v:variables;f:functions")
;; python language
("python" "Python;i:imports;c:classes;m:class members;v:variables;f:functions;")
;; cython language
("pyrex" "Python;c:classe;m:memder;f:function")
;; rexx language
("rexx" "REXX;s:subroutine")
;; ruby language
("ruby" "Ruby;c:class;f:method;F:function;m:singleton method")
;; scheme language
("Scheme" "scheme;s:set;f:function")
;; shell language
("sh" "Sh;f:function")
;; C shell language
("csh" "Sh;f:function")
;; Z shell language
("zsh" "Sh;f:function")
;; slang language
("slang" "SLang;n:namespace;f:function")
;; sml language
("sml" "SML;e:exception;c:functor;s:signature;r:structure;\
t:type;v:value;c:functor;f:function")
;; sql language
("sql" "SQL;f:functions;P:packages;p:procedures;t:tables;T:triggers;\
v:variables;e:events;U:publications;R:services;D:domains;x:MLTableScripts;\
y:MLConnScripts;z:MLProperties;i:indexes;c:cursors;V:views;d:prototypes;\
l:local variables;F:record fields;L:block label;r:records;s:subtypes")
;; tcl language
("tcl" "Tcl;c:class;f:method;m:method;p:procedure")
;; Tex
("tex" "Tex;c:chapters;s:sections;u:subsections;b:subsubsections;\
p:parts;P:paragraphs;G:subparagraphs")
;; vera language
("vera" "Vera;c:class;d:macro;e:enumerator;f:function;g:enum;m:member;\
p:program;P:prototype;t:task;T:typedef;v:variable;x:externvar")
;; verilog language
("verilog" "Verilog;c:constants;e:events;m:modules;n:net data types;p:ports;r:register data types;t:tasks;b:blocks;f:functions")
;; VHDL
("vhdl" "VHDL;c:constant;t:type;T:subtype;r:record;e:entity;\
f:function;p:procedure;P:package")
;; vim language
("vim" "Vim;v:variable;a:autocmds;c:commands;m:map;n:vimball filename;f:function")
;; yacc language
("yacc" "YACC;l:label")
("zephir" "Zephir;c:classes;d:constant;i:interfaces;n:namespaces;t:traits;v:variables;f:functions")
("windres" "WindRes;d:dialogs;m:menus;i:icons;b:bitmaps;c:cursors;f:fonts;v:versions;a:accelerators")
("systemverilog" "SystemVerilog;c:constants;e:events;m:modules;n:net data types;p:ports;\
r:register data types;t:tasks;b:blocks;A:assertions;C:classes;V:covergroups;I:interfaces;M:modports;\
K:packages;P:programs;R:properties;T:type declarations;f:functions" )
("rust" "Rust;n:module;s:structural type;i:trait interface;c:implementation;g:Enum;t:Type Alias;\
v:Global variable;M:Macro Definition;m:A struct field;e:An enum variant;F:A method;f:Function")
("reStructuredText" "reStructuredText;c:chapters;s:sections;S:subsections;t:subsubsections")
("r" "R;l:libraries;s:sources;g:global variables;v:function variables;f:functions")
("json" "JSON;o:objects;a:arrays;n:numbers;s:strings;b:booleans;z:nulls")
;; ("gdb-script" "gdbinit;d:definition;t:toplevelVariable") ;; disabled
;; ("m4" "m4;d:definition;u:undefinition;") ;; disabled
))
(defun taglist-goto-line (N)
"goto specified line <N>"
(goto-char (point-min))
(forward-line (1- N)))
(defun taglist-detect-language-by-major-mode ()
"detect language by modeline"
(let ((language nil)
(i 0))
(while (and
(not language)
(< i (length taglist-major-to-language-alist)))
(if (string= taglist-current-major-mode (car (elt taglist-major-to-language-alist i)))
(setq language (nth 1 (elt taglist-major-to-language-alist i))))
(setq i (1+ i)))
;; (message "detect language by major mode = %s" language)
language))
;; TODO, for vim
(defun taglist-detect-language-by-modeline ()
"detect language by modeline"
(let ((language nil))
;; (setq language nil)
language))
;; TODO
(defun taglist-detect-language-by-shebang ()
"detect language by shebang"
(let ((language nil))
;; (setq language nil)
language))
(defun taglist-detect-language-by-filename ()
"detect language by filename"
(let ((detected-language nil)
(language nil)
(filename (buffer-file-name taglist-source-code-buffer)))
;; Next compare the filename against the entries in taglist-filename-to-language-alist.
(if filename
(let ((name filename)
(remote-id (file-remote-p filename)))
;; Remove backup-suffixes from file name.
(setq name (file-name-sans-versions name))
;; Remove remote file name identification.
(when (and (stringp remote-id)
(string-match (regexp-quote remote-id) name))
(setq name (substring name (match-end 0))))
(while name
;; Find first matching alist entry.
(setq language
(if (memq system-type '(windows-nt cygwin))
;; System is case-insensitive.
(let ((case-fold-search t))
(assoc-default name taglist-filename-to-language-alist
'string-match))
;; System is case-sensitive.
(or
;; First match case-sensitively.
(let ((case-fold-search nil))
(assoc-default name taglist-filename-to-language-alist
'string-match))
;; Fallback to case-insensitive match.
(and auto-mode-case-fold
(let ((case-fold-search t))
(assoc-default name taglist-filename-to-language-alist
'string-match))))))
(if (and language
(consp language)
(cadr language))
(setq language (car language)
name (substring name 0 (match-beginning 0)))
(setq name nil))
(when language
(setq detected-language language))
)
)
)
detected-language))
;; TODO
(defun taglist-detect-language-by-heuristics ()
"detect language by heuristics"
(let ((language nil))
;; (setq language nil)
language))
(defun taglist-detect-language ()
"return programming language of the file"
(let ((language (taglist-detect-language-by-major-mode)))
;;(let ((language nil)) ;; for test
(if (not language)
(setq language (taglist-detect-language-by-modeline)))
(if (not language)
(setq language (taglist-detect-language-by-shebang)))
(if (not language)
(setq language (taglist-detect-language-by-filename)))
(if (not language)
(setq language (taglist-detect-language-by-heuristics)))
;; (message "last language = %s" language)
language))
(defun taglist-get-ctags-language-config (detected-language)
"get ctags language config"
(let ((language-config nil)
(i 0))
(while (and
(not language-config)
(< i (length taglist-language-to-ctags-alist)))
(if (string= detected-language (car (elt taglist-language-to-ctags-alist i)))
(progn
(setq language-config (nth 1 (elt taglist-language-to-ctags-alist i)))))
(setq i (1+ i)))
(if (not language-config)
(error "Unsupported language: %s" detected-language))
language-config))
(defun taglist-get-ctags-language-name (detected-language)
"get ctags-language by detected-language e.g.
\"C;d:macro;g:enum;s:struct;u:union;t:typedef;v:variable;f:function\"
return \"C\""
(let ((ctags-language-config (taglist-get-ctags-language-config detected-language))
(ctags-language nil))
(setq ctags-language (car (split-string ctags-language-config ";" t)))
ctags-language))
(defsubst taglist-filter-unsupport-kinds (ctags-language expect-ctags-kinds)
"Return the supported kinds of current version `ctags'."
(let ((all-kinds nil)
(ctags-config nil)
(actual-ctags-kinds expect-ctags-kinds)
)
(setq all-kinds
(mapcar (lambda (line) (substring line 0 1) )
(split-string
(apply
#'taglist-ctags-process-string
"ctags" (append
(list (concat "--list-kinds=" ctags-language)))) "\n" t)))
(let ((found nil)
(element nil)
(i 0))
(dolist (kind expect-ctags-kinds)
(setq found nil)
(setq i 0)
(while (and (not found)
(< i (length all-kinds)))
(setq element (elt all-kinds i))
(if (string= (substring kind 0 1) element)
(setq found t))
(setq i (1+ i)))
(if (not found)
(progn
(setq actual-ctags-kinds (remove kind actual-ctags-kinds))))))
actual-ctags-kinds))
(defun taglist-get-ctags-language-full-kinds (detected-language)
"Get full ctags language kinds by detected-language. e.g.
\"C;d:macro;g:enum;s:struct;u:union;t:typedef;v:variable;f:function\"
return a list (\"d:macro\" \"g:enum\" \"s:struct\" \"u:union\"
\"t:typedef\" \"v:variable\" \"f:function\")"
(let* ((ctags-language-config-string (taglist-get-ctags-language-config detected-language))
(ctags-language-config (split-string ctags-language-config-string ";" t))
(ctags-language-kinds nil))
(setq ctags-language-kinds (taglist-filter-unsupport-kinds
(car ctags-language-config)
(cdr ctags-language-config)))
ctags-language-kinds))
(defun taglist-get-ctags-language-short-kinds (detected-language)
"get kinds by detected-language.
e.g.
\"C;d:macro;g:enum;s:struct;u:union;t:typedef;v:variable;f:function\"
return \"dgsutvf\""
(let ((kinds ""))
(dolist (element (taglist-get-ctags-language-full-kinds detected-language))
(setq kinds (concat kinds (substring element 0 1))))
kinds))
(defun taglist-get-tag-lines ()
"Return all tags of current buffer;"
(let* ((detected-language (taglist-detect-language))
(ctags-language (taglist-get-ctags-language-name detected-language))
(ctags-lang-kinds (taglist-get-ctags-language-short-kinds detected-language))
(file (buffer-file-name taglist-source-code-buffer)))
(setq taglist-current-language detected-language)
(if file
(split-string
(apply #'taglist-ctags-process-string
"ctags"
(append (list "-f" "-"
"--format=2"
"--excmd=number"
"--fields=nks"
"--sort=no"
(concat "--language-force=" ctags-language)
(concat "--" ctags-language "-kinds=" ctags-lang-kinds)
(if (or (equal ctags-language "C")
(equal ctags-language "C++"))
(concat "--" ctags-language "-kinds=+px")
"")
taglist-tmp-file
)))
"\n" t)
(insert (concat "Warnning: " (buffer-name taglist-source-code-buffer) " doesn't exist on your disk, you should save it first!\n"))
nil)))
;; e.g. tagline = main /path/to/src/ip46.c 38;" f line:38
(defun taglist-convert-to-elements (tagline)
"Convert tagline to a tag(tag-name tag-line tag-type) "
(let ((elements (split-string tagline "\t" t)))
(list (car elements) (string-to-number (nth 2 elements)) (nth 3 elements))))
(defun taglist-jump-to-tag-by-event (event)
"Jump to a tag, corresponding the current line in tag buffer.
When called standing on a line of tag list, it closes the list
buffer and sets the point to a tag, corresponding the line."
(interactive "e")
(switch-to-buffer (get-buffer tag-list-buffer-name) t)
(let ((tag-record (nth (1- (line-number-at-pos (posn-point (event-end event)))) taglist-actual-tags)))
(if (and tag-record (= 0 (taglist-line tag-record)))
(setq tag-record (nth (line-number-at-pos (posn-point (event-end event))) taglist-actual-tags)))
(if (and tag-record (taglist-line tag-record))
(progn
;; (kill-buffer (current-buffer))
(switch-to-buffer taglist-source-code-buffer t)
(taglist-goto-line (taglist-line tag-record))
(recenter)
(with-current-buffer (current-buffer)
(set-buffer (get-buffer tag-list-buffer-name))
(unless (eq taglist-search-string "")
;; (with-selected-window (get-buffer-window (get-buffer tag-list-buffer-name))
(setq taglist-search-string "")
(taglist-search-string-updated)
(taglist-highlight-current-tag)
))
)
(message "The line does not contain tag description!"))))
(defun taglist-jump-to-tag-preview()
(interactive)
(taglist-jump-to-tag t)
)
(defun taglist-jump-to-tag (&optional preview)
"Jump to a tag, corresponding the current line in tag buffer.
When called standing on a line of tag list, it closes the list
buffer and sets the point to a tag, corresponding the line."
(interactive)
(let ((tag-record (nth (1- (line-number-at-pos)) taglist-actual-tags)))
(if (and tag-record (= 0 (taglist-line tag-record)))
(setq tag-record (nth (line-number-at-pos) taglist-actual-tags)))
(if (and tag-record (taglist-line tag-record))
(progn
;; (kill-buffer (current-buffer))
(switch-to-buffer taglist-source-code-buffer t)
(taglist-goto-line (taglist-line tag-record))
(recenter)
(with-current-buffer (current-buffer)
(set-buffer (get-buffer tag-list-buffer-name))
(unless (eq taglist-search-string "")
;; (with-selected-window (get-buffer-window (get-buffer tag-list-buffer-name))
(setq taglist-search-string "")
(taglist-search-string-updated)
(taglist-highlight-current-tag)
))
(if preview
(select-window (get-buffer-window (get-buffer tag-list-buffer-name)) t))
)
(message "The line does not contain tag description!"))))
(defun taglist-matches-all (string substrings)
"Return non-nil if STRING contain each of SUBSTRINGS as a substring."
(reduce (lambda (prev part) (and prev (string-match part string))) substrings :initial-value t))
(defstruct taglist
(tag) ;; tag name, e.g. main
(line) ;; line number of tag, e.g. 11
(type) ;; type of the tag: e.g. f
)
(defun taglist-gen-display-struct (types taglines)
"Return a list of three strings, representing type, parent and name of tag F."
;; (message "types = %s, taglines = %s" types taglines)
(let ((tags-struct nil))
;; loop for each tag type
(dolist (tag-type types)
(let* ((element (split-string tag-type ":" t))
(type-abbr (car element))
(type-name (nth 1 element))
(type-occur nil)
)
;; (message "%s %s" type-abbr type-name)
;; loop for all taglines
(dolist (tagline taglines)
;; tagline (main 38 f)
;; when current tag type matched
(when (string= type-abbr (nth 2 tagline))
(if type-occur ;; when current tag is not first time appear.
;; (message "%s" tagline)
(setq tags-struct (append tags-struct (list (make-taglist :tag (concat " " (car tagline)) :line (nth 1 tagline) :type (nth 2 tagline)))))
;; if current tag is first time appear, then display type name and current tag.
(setq tags-struct (append tags-struct (list (make-taglist :tag type-name :line 0 :type ""))))
(setq tags-struct (append tags-struct (list (make-taglist :tag (concat " " (car tagline)) :line (nth 1 tagline) :type (nth 2 tagline)))))
;; (message "%s" type-name)
;; (message "%s" tagline)
(setq type-occur t))))))
;; (message "tags-struct = %s" tags-struct)
;; return tags-struct
tags-struct)
)
(defun taglist-search-string-updated ()
"Update tag list according to search string."
(message taglist-search-string)
;; let s:tlist_def_c_settings = 'c;d:macro;g:enum;s:struct;u:union;t:typedef;v:variable;f:function'
;; (setq types (list "d:Macro" "g:Enum" "s:Struct" "u:Union" "t:Typedef" "v:Variable" "f:Function"))
(let ((types (taglist-get-ctags-language-full-kinds taglist-current-language))
(taglist-actual-tags-tmp
;; remove-if-not: Remove all items not satisfying search string.
(remove-if-not
(lambda (element)
(taglist-matches-all (car element) (split-string taglist-search-string)))
taglist-all-tags)))
;; ("DEBUG" 11 "d") ("main" 18 "f")
(setq taglist-actual-tags (taglist-gen-display-struct types taglist-actual-tags-tmp)))
;; (message "taglist-actual-tags = %S" taglist-actual-tags)
(erase-buffer)
(dolist (i taglist-overlays)
;; Delete the overlay from its buffer.
(delete-overlay i))
(setq taglist-overlays nil)
;; [cl-struct-taglist "main" 38 "f"]
(dolist (tag-record taglist-actual-tags)
(insert (concat (taglist-tag tag-record) "\n")))
(let ((offset 0)
(pos 0)
(line-pos nil)
(tag-record nil)
(output (buffer-string))
(search-strings (split-string taglist-search-string)))
(dolist (search-string search-strings)
(while (string-match search-string output offset)
(progn
(setq pos (match-beginning 0))
(setq offset (match-end 0))
;; match: start form 0, overlay: start from 1;
(setq tag-record (nth (1- (line-number-at-pos pos)) taglist-actual-tags))
(if (not (= 0 (taglist-line tag-record)))
(progn
(push (make-overlay (+ 1 pos) (+ 1 offset)) taglist-overlays)
(overlay-put (car taglist-overlays) 'face '(background-color . "yellow"))
(if (not line-pos)
(setq line-pos (line-number-at-pos pos)))
)))))
(if line-pos
(taglist-goto-line line-pos)
(taglist-goto-line (+ 1 (/ (count-lines (point-min) (point-max)) 2)))))
)
(defun taglist-key-pressed (key)
"Called when KEY is pressed."
(setq taglist-search-string (concat taglist-search-string (char-to-string key)))
(taglist-search-string-updated))
(defun taglist-backspace-pressed ()
"Called when Backspace is pressed."
(interactive)
(setq taglist-search-string (taglist-string-without-last taglist-search-string 1))
(taglist-search-string-updated))
(defun taglist-make-key-function (key)
"Return a function for KEY."
`(lambda () (interactive) (taglist-key-pressed ,key)))
(defun taglist-key-itself (map key)
"Maps in the MAP KEY to its function."
(define-key map (char-to-string key) (taglist-make-key-function key)))
(defun taglist-escape ()
"Kill tag list buffer."
(interactive)
(kill-buffer (current-buffer))
;; (delete-file taglist-tmp-file)
(switch-to-buffer taglist-source-code-buffer)
(tag-list-stop-timer))
(defvar taglist-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
(do ((k (string-to-char "a") (+ 1 k))) ((> k (string-to-char "z")))
(define-key
map
(read-kbd-macro (char-to-string k))
(taglist-make-key-function k)))
(do ((k (string-to-char "A") (+ 1 k))) ((> k (string-to-char "Z")))
(define-key
map
(read-kbd-macro (char-to-string k))
(taglist-make-key-function k)))
(do ((k (string-to-char "0") (+ 1 k))) ((> k (string-to-char "9")))
(define-key
map
(read-kbd-macro (char-to-string k))
(taglist-make-key-function k)))
(dolist (k (string-to-list "=><&!"))
(define-key
map
(read-kbd-macro (char-to-string k))
(taglist-make-key-function k)))
(taglist-key-itself map (string-to-char " "))
(taglist-key-itself map (string-to-char "_"))
(define-key map (kbd "<RET>") 'taglist-jump-to-tag)
(define-key map (kbd "<tab>") 'taglist-jump-to-tag-preview)
(define-key map [mouse-2] 'taglist-jump-to-tag-by-event)
(define-key map [mouse-3] 'taglist-jump-to-tag-by-event)
(define-key map (kbd "<backspace>") 'taglist-backspace-pressed)
;; Cause M-v doesn't work!!!
;; (define-key map (kbd "<ESC>") 'taglist-escape)
(define-key map (kbd "C-q") 'taglist-escape)
(define-key map (kbd "M-q") 'taglist-escape)
;; (define-key map "\C-v" 'scroll-up)