forked from imakado/perl-completion
-
Notifications
You must be signed in to change notification settings - Fork 0
/
perl-completion.el
2380 lines (2070 loc) · 95.6 KB
/
perl-completion.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
;;; perl-completion.el - minor mode provides useful features for editing perl codes
;; Copyright (c) 2009 by KAYAC Inc.
;; Author: IMAKADO <[email protected]>
;; Keywords: perl
;; This file 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, or (at your option)
;; any later version.
;; This file 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; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;; Prefix: plcmp-
;;; Commentary:
;; Tested on Emacs 22
;;
;; Thanks to rubikitch for integration with anything-show-completion.
;;; Commands:
;;
;; Below are complete command list:
;;
;; -Completion Commands-
;;
;; [C-c C-c a] `plcmp-cmd-complete-all'
;; invoke anything with all completion sources.
;; difference between this command and `plcmp-cmd-smart-complete'
;; is this command doesn't sort candidates smartly.
;; [C-RET] `plcmp-cmd-smart-complete'
;; [<C-return>] `plcmp-cmd-smart-complete'
;; [M-TAB] `plcmp-cmd-smart-complete'
;; complete all completion sources.
;; completions are smartly sorted.
;; e.x,
;; when invoke command context like: (cursor is `!!')
;; use LWP::UserAgent;
;; my $ua = LWP::UserAgent->new;
;; $ua->`!!'
;; LWP::UserAgent's methods are appered at top of candidates.
;; this is the main command of perl-completion.el!!.
;; [C-c v] `plcmp-cmd-complete-variables'
;; invoke anything with only variables completion source.
;; [C-c a] `plcmp-cmd-complete-arrays'
;; invoke anything with only array completion source.
;; [C-c h] `plcmp-cmd-complete-hashes'
;; invoke anything with only hash completion source.
;; [C-c f] `plcmp-cmd-complete-functions'
;; invoke anything with only function completion source.
;; [C-c m] `plcmp-cmd-complete-methods'
;; invoke anything with only using module's methods completion source.
;; [C-c i] `plcmp-cmd-complete-modules'
;; invoke anything with only installed modules completion source.
;; -Documents support commands-
;; [C-c d] `plcmp-cmd-show-doc'
;; invoke anything with installed modules and man pages about perl.
;; default action is "Show doc" that open selected condidate's document.
;; e.x,
;; [module]
;; If selected DBIx::Class::ResultSet, open perldoc.
;; [manpage]
;; If selected perlop, open manpage using `woman'
;; press TAB to select other Actions.
;; [C-c s] `plcmp-cmd-show-doc-at-point'
;; same as `plcmp-cmd-show-doc'.
;; only difference, word at point is used as initial-pattern.
;; -Other Commands-
;; [C-c c] `plcmp-cmd-clear-all-caches'
;; remove all caches
;; rebuild installed modules list asynchronously. as soon as called this command.
;; caches are,
;; - installed modules
;; - methods
;; - perl buffers last modified time. (used detect buffer is changed since last completion command is invoked
;; other-perl-buffer-source doesn't try to get completions non modified buffer).
;; this command usually used, when you install new module from something like CPAN after once perl-completion-mode is on.
;; Internally, this command sets these variables to `nil'.
;; -`plcmp-other-perl-buffers-cache-hash'
;; -`plcmp-module-methods-alist'
;; -`plcmp-installed-modules'
;; [C-c C-c s] `plcmp-cmd-show-environment'
;; print infomations to *perl-completion show environment* buffer
;; environment,
;; perl-completion's customize variables,
;; perl-completion's commands and where bound to and value of environment PERL5LIB.
;; this command is good for debugging.
;; [C-c M] `plcmp-cmd-menu'
;; show perl-completion's menu.
;; this quite useful when before you remember perl-completion's keybinds.
;; -Commands support perl programing-
;; `plcmp-cmd-eval-buffer'
;; Run current buffer string as Perl code asynchronously.
;; when finished, popup result buffer.
;; the result buffer is named *perl output*.
;; `plcmp-cmd-eval-on-region'
;; Run selected region as Perl code asynchronously.
;; when finished, popup result buffer.
;; the result buffer is named *perl output*.
;; If run perl process is exit with nonzero status, using `switch-to-buffer' instead of `pop-to-buffer'
;; Customize Variables
;; `plcmp-lib-directory-re'
;; regexp to detect directory that automatically added to PERL5LIB when build completions.
;; e.x,
;; If you are editting file at "~/dev/SomeModule/lib/SomeModule/Hoge.pm",
;; "~/dev/SomeModule/lib/" is added to PERL5LIB when invoke completion commands.
;; default value is "lib/"
;; `plcmp-use-keymap'
;; If this value is nil,
;; perl-completion-mode doesn't use own key-map.
;; it is useful if you want to use own keybind,
;; or don't like default keybinds.
;; Note, keymap is defined at library loading phase.
;; so this variables's value should be set before `require'.
;; e.x,
;; ;; ok, dont use default keybinds.
;; (setq plcmp-use-keymap nil)
;; (require 'perl-completion)
;; ;; NG when `plcmp-use-keymap' is set, plcmp-mode-map is defined already.
;; (require 'perl-completion)
;; (setq plcmp-use-keymap nil)
;; `plcmp-extra-using-modules'
;; list of String or Alist
;; If value is String(module name),
;; module name is always appear in candidates.
;; If value is Alist ("module-name" . "extra-module-name"),
;; and module-name is using in current buffer,
;; extra-module-name's methods are appear in candidates.
;; e.x,
;; (setq plcmp-extra-using-modules '("DBIx::Class::ResultSet"))
;; (setq plcmp-extra-using-modules '(("LWP::UserAgent" . "HTTP::Response")))
;; ;; also can both of them
;; (setq plcmp-extra-using-modules '("DBIx::Class::ResultSet" ("LWP::UserAgent" . "HTTP::Response")))
;; `plcmp-perl-buffer-re'
;; Regexp
;; To Detect buffer is perl buffer or not.
;; default value is "\\.[pP][lmLM]$"
;; `plcmp-other-perl-buffer-limit-number'
;; Number
;; how many buffers get buffer words `plcmp-get-sources-other-perl-buffers-words'. Fixme
;; default value is 30
;; `plcmp-module-filter-list'
;; list of String(module name)
;; module is not appear in method completion list.
;; default value is '("strict" "warning")
;; `plcmp-additional-PERL5LIB-directories'
;; list of String(directory)
;; directory is added to PERL5LIB when invoke completion commands.
;; `plcmp-coding-system'
;; If this value is not nil,
;; value is bind to `coding-system-for-read' and `coding-system-for-write' temporary around these commands:
;; `plcmp-cmd-eval-buffer'
;; `plcmp-cmd-eval-buffer-and-go'
;; `plcmp-cmd-eval-on-region'
;; To customize
;; M-x customize-group RET perl-completion RET
;; Version 1.12
;; remove current directory in @INC.
;; fixed functions are,
;; `plcmp--installed-modules-asynchronously'
;; `plcmp--installed-modules-synchronously'
;; Note, Version 1.11 is not work correctly.
;; Version 1.11
;; fix `plcmp-get-installed-modules'
;;;code:
(require 'cl)
(require 'anything) ; perl-completion.el uses `anything-aif' macro.
(require 'cperl-mode)
(require 'dabbrev)
(require 'rx)
(require 'regexp-opt)
(require 'ffap)
;;; customize-variables
(defgroup perl-completion nil
""
:group 'perl-completion)
(defcustom plcmp-lib-directory-re "lib/"
"regexp to detect directory that automatically added to PERL5LIB when build completions.
e.x,
If you are editting file at \"~/dev/SomeModule/lib/SomeModule/Hoge.pm\",
\"~/dev/SomeModule/lib/\" is added to PERL5LIB when invoke completion commands.
default value is \"lib/\""
:type 'regexp
:group 'perl-completion)
(defcustom plcmp-use-keymap t
"If this value is nil,
perl-completion-mode doesn't use own key-map.
it is useful if you want to use own keybind,
or don't like default keybinds.
Note, keymap is defined at library loading phase.
so this variables's value should be set before `require'.
e.x,
;; ok, dont use default keybinds.
(setq plcmp-use-keymap nil)
(require 'perl-completion)
;; NG when `plcmp-use-keymap' is set, plcmp-mode-map is defined already.
(require 'perl-completion)
(setq plcmp-use-keymap nil)"
:group 'perl-completion)
(defcustom plcmp-extra-using-modules nil
"list of String or Alist
If value is String(module name),
module name is always appear in candidates.
If value is Alist (\"module-name\" . \"extra-module-name\"),
and module-name is using in current buffer,
extra-module-name's methods are appear in candidates.
e.x,
(setq plcmp-extra-using-modules '(\"DBIx::Class::ResultSet\"))
(setq plcmp-extra-using-modules '((\"LWP::UserAgent\" . \"HTTP::Response\")))
;; also can both of them
(setq plcmp-extra-using-modules '(\"DBIx::Class::ResultSet\" (\"LWP::UserAgent\" . \"HTTP::Response\")))"
:group 'perl-completion)
(defcustom plcmp-method-inspecter nil
"Detect how to get methods.
variable is one of the following values:
'class-inspector
'scrape
'class-inspector, use Class::Inspector
'scrape, open module, then scrape subs. this way is slow.
otherwise, try both"
:group 'perl-completion)
(defcustom plcmp-perl-buffer-re "\\.[pP][lmLM]$"
"Regexp
To Detect buffer is perl buffer or not.
default value is \"\\.[pP][lmLM]$\""
:type 'regexp
:group 'perl-completion)
(defcustom plcmp-other-perl-buffer-limit-number 30
"Number
how many buffers get buffer words `plcmp-get-sources-other-perl-buffers-words'. Fixme
default value is 30"
:type 'number
:group 'perl-completion)
(defcustom plcmp-module-filter-list '("strict" "warning")
"list of String(module name)
module is not appear in method completion list.
default value is '(\"strict\" \"warning\")"
:type '(repeat (string :tag "Module name"))
:group 'perl-completion)
(defcustom plcmp-additional-PERL5LIB-directories nil
"list of String(directory)
directory is added to PERL5LIB when invoke completion commands."
:type '(repeat (string :tag "perl lib directory"))
:group 'perl-completion)
;;; log util
(defvar plcmp-debug nil)
(defvar plcmp-log-buf-name "*plcmp debug*")
(defun plcmp-log-buf ()
(get-buffer-create plcmp-log-buf-name))
(defsubst plcmp-log (&rest messages)
(ignore-errors
(when plcmp-debug
(require 'pp)
(let* ((str (or (ignore-errors (apply 'format messages))
(pp-to-string (car messages))))
(strn (concat str "\n")))
(with-current-buffer (plcmp-log-buf)
(goto-char (point-max))
(insert strn))
str))))
(defun plcmp-message (&rest args)
(when plcmp-debug
(prog1 (apply 'message args)
(apply 'plcmp-log args))))
;;; variables
(defvar plcmp-version 1.11)
(defvar plcmp-default-lighter " PLCompletion")
(defvar plcmp-perl-ident-re "[a-zA-Z_][a-zA-Z_0-9]*")
(defvar plcmp-sub-re (rx-to-string `(and "sub"
(+ space)
(group
(regexp ,plcmp-perl-ident-re)))))
(defvar plcmp-perl-package-re "[a-zA-Z_][a-zA-Z0-9_:]*")
(defvar plcmp-builtin-functions
'("abs" "exec" "glob" "order" "seek" "symlink" "accept" "exists" "gmtime"
"our" "seekdir" "syscall" "alarm" "exit" "goto" "pack" "select" "sysopen"
"atan" "exp" "grep" "package" "semctl" "sysread" "bind" "fcntl" "hex"
"pipe" "semget" "sysseek" "binmode" "fileno" "import" "pop" "semop"
"system" "bless" "flags" "index" "pos" "send" "syswrite" "caller" "flock"
"int" "precision" "setgrent" "tell" "chdir" "fork" "ioctl" "print" "sethostent"
"telldir" "chmod" "format" "join" "printf" "setnetent" "tie" "chomp" "formline"
"keys" "prototype" "setpgrp" "tied" "chop" "getc" "kill" "push" "setpriority"
"time" "chown" "getgrent" "last" "q" "setprotoent" "times" "chr" "getgrgid"
"lc" "qq" "setpwent" "tr" "chroot" "getgrnam" "lcfirst" "qr" "setservent"
"truncate" "close" "gethostbyaddr" "length" "quotemeta" "setsockopt" "uc"
"closedir" "gethostbyname" "link" "qw" "shift" "ucfirst" "connect" "gethostent"
"listen" "qx" "shmctl" "umask" "continue" "getlogin" "local" "rand" "shmget"
"undef" "cos" "getnetbyaddr" "localtime" "read" "shmread" "unlink" "crypt"
"getnetbyname" "lock" "readdir" "shmwrite" "unpack" "dbmclose" "getnetent"
"log" "readline" "shutdown" "unshift" "dbmopen" "getpeername" "lstat" "readlink"
"sin" "untie" "defined" "getpgrp" "m" "readpipe" "size" "use" "delete" "getppid"
"map" "recv" "sleep" "utime" "die" "getpriority" "mkdir" "redo" "socket" "values"
"do" "getprotobyname" "msgctl" "ref" "socketpair" "vec" "dump" "getprotobynumber"
"msgget" "rename" "sort" "vector" "each" "getprotoent" "msgrcv" "require" "splice"
"wait" "endgrent" "getpwent" "msgsnd" "reset" "split" "waitpid" "endhostent"
"getpwnam" "my" "return" "sprintf" "wantarray" "endnetent" "getpwuid" "next"
"reverse" "sqrt" "warn" "endprotoent" "getservbyname" "no" "rewinddir" "srand"
"write" "endpwent" "getservbyport" "oct" "rindex" "stat" "y" "endservent" "getservent"
"open" "rmdir" "study" "eof" "getsockname" "opendir" "s" "sub" "eval" "getsockopt"
"ord" "scalar" "substr"))
(defvar plcmp-builtin-variables
'("$SIG{expr}" "%SIG" "$ENV{expr}" "%ENV" "%INC" "@_" "@INC" "@F" "ARGVOUT"
"@ARGV" "$ARGV" "ARGV" "$^X" "$EXECUTABLE_NAME" "${^WARNING_BITS}" "$^W"
"$WARNING" "$^V" "$PERL_VERSION" "${^UTF8LOCALE}" "${^UNICODE}" "${^TAINT}"
"$^T" "$BASETIME" "$^S" "$EXCEPTIONS_BEING_CAUGHT" "$^R"
"$LAST_REGEXP_CODE_RESULT" "$^P" "$PERLDB" "${^OPEN}" "$^O" "$OSNAME" "$^M" "$^I" "$INPLACE_EDIT"
"%^H" "$^H" "$^F" "$SYSTEM_FD_MAX" "$^D" "$DEBUGGING" "$^C" "$COMPILING" "$]"
"$[" "$0" "$PROGRAM_NAME" "$)" "$EGID" "$EFFECTIVE_GROUP_ID" "$(" "$GID" "$REAL_GROUP_ID"
"$>" "$EUID" "$EFFECTIVE_USER_ID" "$<" "$UID" "$REAL_USER_ID" "$$" "$PID" "$PROCESS_ID"
"$@" "$EVAL_ERROR" "$^E" "$EXTENDED_OS_ERROR" "%!" "$!" "$ERRNO" "$OS_ERROR" "${^ENCODING}"
"$?" "$CHILD_ERROR" "$^A" "$ACCUMULATOR" "$^L" "$FORMAT_FORMFEED" "IO::Handle->format_formfeed" "$:"
"$FORMAT_LINE_BREAK_CHARACTERS" "IO::Handle->format_line_break_characters" "$^"
"$FORMAT_TOP_NAME" "HANDLE->format_top_name(EXPR)" "$~"
"$FORMAT_NAME" "HANDLE->format_name(EXPR)" "@-" "@LAST_MATCH_START"
"$-" "$FORMAT_LINES_LEFT" "HANDLE->format_lines_left(EXPR)" "$="
"$FORMAT_LINES_PER_PAGE" "HANDLE->format_lines_per_page(EXPR)" "$%"
"$FORMAT_PAGE_NUMBER" "HANDLE->format_page_number(EXPR)" "$#" "$;"
"$SUBSEP" "$SUBSCRIPT_SEPARATOR" "$\"" "$LIST_SEPARATOR" "$\\" "$ORS"
"$OUTPUT_RECORD_SEPARATOR" "IO::Handle->output_record_separator" "$," "$OFS"
"$OUTPUT_FIELD_SEPARATOR" "IO::Handle->output_field_separator" "$|"
"$OUTPUT_AUTOFLUSH" "HANDLE->autoflush(EXPR)" "$/" "$RS"
"$INPUT_RECORD_SEPARATOR" "IO::Handle->input_record_separator(EXPR)" "$."
"$NR" "$INPUT_LINE_NUMBER" "HANDLE->input_line_number(EXPR)" "$*" "@+"
"@LAST_MATCH_END" "$^N" "$+" "$LAST_PAREN_MATCH" "$'" "$POSTMATCH" "$`"
"$PREMATCH" "$&" "$MATCH" "$<digits>" "$b" "$a" "$_" "$ARG"))
(defvar plcmp--command-cleanup-hook nil "hook run when completion command finished")
(defvar plcmp--cached-variables nil "list of cached variable. each variable is cleared by function `plcmp-cmd-clear-all-caches'")
(defvar plcmp-clear-all-caches-hook nil
"hook run when invoke `plcmp-cmd-clear-all-caches'")
;;; keymap
(defvar plcmp-mode-map
(let ((map (make-sparse-keymap)))
(when plcmp-use-keymap
;; completion
(define-key map (kbd "C-RET") 'plcmp-cmd-smart-complete)
(define-key map (kbd "C-<return>") 'plcmp-cmd-smart-complete)
(define-key map (kbd "C-M-i") 'plcmp-cmd-smart-complete)
(define-key map (kbd "C-c a") 'plcmp-cmd-complete-arrays)
(define-key map (kbd "C-c i") 'plcmp-cmd-complete-modules)
(define-key map (kbd "C-c v") 'plcmp-cmd-complete-variables)
(define-key map (kbd "C-c f") 'plcmp-cmd-complete-functions)
(define-key map (kbd "C-c h") 'plcmp-cmd-complete-hashes)
(define-key map (kbd "C-c m") 'plcmp-cmd-complete-methods)
(define-key map (kbd "C-c C-c a") 'plcmp-cmd-complete-all)
;; doc
(define-key map (kbd "C-c d") 'plcmp-cmd-show-doc)
(define-key map (kbd "C-c s") 'plcmp-cmd-show-doc-at-point)
(define-key map (kbd "C-c M") 'plcmp-cmd-menu)
;; other
(define-key map (kbd "C-c c") 'plcmp-cmd-clear-all-caches)
(define-key map (kbd "C-c C-f") 'plcmp-cmd-project-files)
(define-key map (kbd "C-c C-c s") 'plcmp-cmd-show-environment)
(define-key map (kbd "C-c C-c u") 'plcmp-cmd-update-check)
(define-key map (kbd "C-c C-c d") 'plcmp-cmd-set-additional-lib-directory))
map))
(defvar plcmp-anything-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "O") 'plcmp-acmd-occur)
(define-key map (kbd "D") 'plcmp-acmd-show-doc)
(define-key map (kbd "F") 'plcmp-acmd-open-related-file)
(define-key map (kbd "G") 'plcmp-acmd-goto-looking-point)
(define-key map (kbd "J") 'scroll-other-window)
(define-key map (kbd "K") 'scroll-other-window-down)
(define-key map (kbd "L") 'plcmp-acmd-persistent-look)
(set-keymap-parent map anything-map)
map))
;;; macros
;; perl5 lib
;; idea: http://svn.coderepos.org/share/lang/elisp/set-perl5lib/set-perl5lib.el
;; http://d.hatena.ne.jp/sun-basix/20080117/1200528765 (Japanese)
(defvar plcmp--PERL5LIB-directories nil
"list of String(directory)
directory is added to PERL5LIB when invoke completion command.
this variable is Internal.
so should not change this variable.")
(defun plcmp--get-lib-path ()
"return string(additional library path)"
(let ((dir (plcmp-get-current-directory))
(lib-re (rx-to-string `(and (group
bol
(* not-newline)
,plcmp-lib-directory-re)))))
(when (string-match lib-re dir)
(let ((lib-dir (match-string 1 dir)))
(and (stringp lib-dir)
(file-exists-p lib-dir)
(directory-file-name lib-dir))))))
(defun* plcmp--get-lib-path-list-liberal (&optional (dir (plcmp-get-current-directory))
(libdir-names '("extlib" "lib")))
"return list of string"
(flet ((aux (libdir-name updirs)
(loop for updir in updirs
for dir = (expand-file-name
(concat updir libdir-name))
when (and (file-exists-p dir)
(file-directory-p dir))
collect dir)))
(let* ((updirs (loop for updir in '("../" "../../" "../../../")
collect (concat dir updir)))
(updirs (mapcar 'expand-file-name updirs))
(updirs (mapcar 'file-name-directory updirs)))
(loop for libdir-name in libdir-names
append (aux libdir-name updirs)))))
(defmacro plcmp-with-set-perl5-lib (&rest body)
"Set each path that value of `plcmp--get-lib-path' to PERL5LIB.
then execute BODY"
`(let ((process-environment (copy-sequence process-environment)))
(require 'env)
(let* ((additional-lib-list (append (ignore-errors (mapcar 'expand-file-name plcmp-additional-PERL5LIB-directories))
plcmp--PERL5LIB-directories
(when (plcmp--get-lib-path)
(list (plcmp--get-lib-path)))))
(old-perl5lib (or (getenv "PERL5LIB") "")))
(when additional-lib-list
(let* ((additional-lib-str (mapconcat 'identity additional-lib-list path-separator))
(current-perl5lib (concat additional-lib-str path-separator old-perl5lib))
(current-perl5lib (replace-regexp-in-string ":$" "" current-perl5lib)))
(when (and (stringp current-perl5lib)
(not (equal "" current-perl5lib)))
(setenv "PERL5LIB" current-perl5lib)
(plcmp-log "plcmp-with-set-perl5-lib PERL5LIB: %s" current-perl5lib)))))
(progn
,@body)))
(defmacro define-plcmp-command (command-name-with-no-prefix args &rest body)
(let* ((prefix "plcmp-cmd-")
(command-str (symbol-name command-name-with-no-prefix))
(command-name (concat prefix command-str)))
`(defun* ,(intern command-name) ,args
(interactive)
(unwind-protect
(let ((anything-map plcmp-anything-map))
(plcmp-with-set-perl5-lib
(progn (plcmp-initialize-variables)
,@body)))
(plcmp-cleanup)))))
(put 'define-plcmp-command 'lisp-indent-function 'defun)
(def-edebug-spec define-plcmp-command defun*)
(defmacro plcmp-ignore-errors (&rest body)
`(condition-case e (progn ,@body)
(error (plcmp-log "Error plcmp-ignore-errors : %s" (error-message-string e)))))
(def-edebug-spec plcmp-ignore-errors ignore-errors)
;;; Util functions
(defsubst plcmp-trim (s)
"strip space and newline"
(replace-regexp-in-string
"[ \t\n]*$" "" (replace-regexp-in-string "^[ \t\n]*" "" s)))
(defsubst plcmp-bit-regexp-p (s)
(string-match "^[/:$@&%(),.?<>+!|^*';\"\\]+$" s))
(defsubst plcmp-module-p (s)
(string-match (format "^%s$" plcmp-perl-package-re) s))
(defsubst plcmp-perl-identifier-p (s)
(string-match (concat "^" plcmp-perl-ident-re "$") s))
(defsubst plcmp-notfound-p (s)
(anything-aif (string-match "^Can't locate [^ \t]+ in" s)
(prog1 it
(plcmp-log "module notfound errmsg: %s" s))))
(defsubst plcmp-tramp-p ()
(when (and (featurep 'tramp)
(fboundp 'tramp-tramp-file-p))
(let* ((dir (plcmp-get-current-directory))
(tramp? (tramp-tramp-file-p dir)))
(when tramp?
(prog1 tramp?
(plcmp-log "plcmp-tramp-p return non-nil: %s" dir))))))
(defsubst plcmp-insert-each-line (los)
(insert (mapconcat 'identity los "\n")))
(defun plcmp-get-current-directory ()
(file-name-directory
(expand-file-name
(or (buffer-file-name)
default-directory))))
;; TODO: need test.
(defsubst plcmp--re-match-sources1 (regexps source)
(when source
(let ((source (if (listp source) source (symbol-value source))))
(some (lambda (re)
(string-match re (assoc-default 'name source 'eq)))
regexps))))
(defun plcmp-re-sort-sources (regexps sources &optional reverse)
(condition-case e
(let* ((regexps (if (stringp regexps) (list regexps) regexps))
(match-sources)
(unmatch-sources)
(sorted-sources
(loop for source in sources
if (plcmp--re-match-sources1 regexps source)
collect source into match-sources
else
collect source into unmatch-sources
finally return (if reverse
(nconc unmatch-sources match-sources)
(nconc match-sources unmatch-sources)))))
sorted-sources)
(error (plcmp-log "Error: plcmp-re-sort-sources\nregexps: %s\nsources: %s"
regexps
sources)
sources)))
(defsubst* plcmp-collect-matches
(re &optional (count 0) (match-string-fn 'match-string)
(point-min (point-min)) (point-max (point-max)))
(save-excursion
(loop initially (goto-char point-min)
while (re-search-forward re point-max t)
collect (funcall match-string-fn count))))
(defun plcmp-get-occur-fn ()
"return `occur-by-moccur if installed color-moccur.el otherwise return `occur"
(if (require 'color-moccur nil t)
'occur-by-moccur
'occur))
(defun plcmp-update-lighter (str)
(when (and (boundp 'perl-completion-mode)
(assq 'perl-completion-mode minor-mode-alist))
(setcar (cdr (assq 'perl-completion-mode minor-mode-alist)) str)))
;;; initial-input
(defvar plcmp-initial-input "")
(defvar plcmp-real-initial-input "real initial-input if required `anything-match-plugin' initial-input is not real initial-input")
(defun plcmp--fullname ()
(save-excursion
(let ((start (point)))
(skip-chars-backward "a-zA-Z0-9_")
(let ((str (plcmp-preceding-string 2)))
(when (string-equal str "::")
(buffer-substring-no-properties start (point)))))))
(defun plcmp-get-initial-real-input-list ()
"return list (initial-input real-initial-input)"
(save-excursion
(let* ((start (point))
(real-initial-input
(cond
((plcmp--fullname))
(t
(skip-syntax-backward "w_")
(let* ((preceding-string (char-to-string (preceding-char)))
(end (condition-case e
(cond
((some (lambda (s) (string-equal s preceding-string)) '("$" "@" "%" "&"))
(backward-char)
(point))
(t
(point)))
(error (point)))))
(buffer-substring-no-properties start end)))))
(initial-input
(regexp-quote
(concat real-initial-input
(if (and (featurep 'anything-match-plugin)
(not (string-equal real-initial-input "")))
" "
"")))))
(prog1 (values initial-input real-initial-input)
(plcmp-log "plcmp-get-initial-real-input-list:\ninitial-input: %s\nreal-initial-input: %s"
initial-input
real-initial-input)))))
;;; installed modules
(defvar plcmp-installed-modules nil)
(add-to-list 'plcmp--cached-variables 'plcmp-installed-modules)
(defun plcmp-get-installed-modules ()
(unless (plcmp-tramp-p)
(prog1 plcmp-installed-modules
(or plcmp-installed-modules
(plcmp--installed-modules-asynchronously)))))
(defun plcmp--installed-modules-synchronously ()
(message "fetching installed modules...")
(let* ((modules-str (shell-command-to-string
(concat
"find `perl -e 'print join(q{ }, grep(!/^\.$/, @INC));'`"
" -name '*.pm' -type f "
"| xargs egrep -h -o 'package [a-zA-Z0-9:]+;' "
"| perl -nle 's/package\s+(.+);/$1/; print' "
"| sort "
"| uniq "
)))
(modules (split-string modules-str "\n")))
(message "done")
(remove-if (lambda (module)
(string-match "No such file or directory$" module))
modules)))
(defvar plcmp-installed-modules-buffer-name " *perl-completion installed modules*")
(defun plcmp--installed-modules-set-cache (process event)
"process-sentinel"
(when (string-equal "finished\n" event)
(with-current-buffer plcmp-installed-modules-buffer-name
(unless (zerop (buffer-size))
(setq plcmp-installed-modules (plcmp-collect-matches plcmp-perl-package-re))
;; (message "finished getting installed modules asynchronously.")
(plcmp-update-lighter plcmp-default-lighter)
(plcmp-log "cached installed modules %s" plcmp-installed-modules)))))
(defun plcmp--installed-modules-asynchronously ()
"start process, set sentinel, return process."
(let ((proc-run?
(lambda ()
(eq 'run
(let ((proc (get-buffer-process plcmp-installed-modules-buffer-name)))
(when (processp proc)
(process-status proc)))))))
(unless (or (plcmp-tramp-p)
(funcall proc-run?))
;; (message "fetching installed modules...")
(plcmp-update-lighter (format "%s[getting modules]" plcmp-default-lighter))
(with-current-buffer (get-buffer-create plcmp-installed-modules-buffer-name)
(erase-buffer))
(let* ((command "find")
(args (concat "`perl -e 'print join(q{ }, grep(!/^\.$/, @INC));'`"
" -name '*.pm' -type f "
"| xargs grep -E -h -o 'package [a-zA-Z0-9:]+;' "
"| perl -nle 's/package\s+(.+);/$1/; print' "
"| sort "
"| uniq "))
(proc (start-process-shell-command "installed perl modules"
plcmp-installed-modules-buffer-name
command
args)))
(set-process-sentinel proc 'plcmp--installed-modules-set-cache)
;; return process
proc))))
;;; current package
(defvar plcmp-current-package-name "")
(defun plcmp-get-current-package-name ()
"nil or string"
(let ((re (rx-to-string `(and bol
(* space)
"package"
(* space)
(group
(regexp ,plcmp-perl-package-re))
(* not-newline)
";"))))
(save-excursion
(goto-char (point-min))
(when (re-search-forward re nil t)
(match-string-no-properties 1)))))
;;; using-modules
(defvar plcmp-using-modules nil)
(defun plcmp-get-using-modules ()
"return modules"
(let* ((modules (plcmp--get-using-modules-uses-and-requires))
(modules (plcmp--using-modules-marge-extra-modules modules))
(modules (plcmp--using-modules-filter modules)))
modules))
(defun plcmp--get-using-modules-uses-and-requires ()
"list of string"
(let ((re (rx-to-string ` (and bol
(* space)
"use"
(+ space)
(group ;1 package
(regexp ,plcmp-perl-package-re))
(* not-newline)
";")))
(require-re (rx-to-string `(and "require"
(+ space)
(group
(regexp ,plcmp-perl-package-re))))))
(nunion (plcmp-collect-matches re 1 'match-string-no-properties)
(delete-if-not (lambda (s)
(member s plcmp-installed-modules))
(plcmp-collect-matches require-re 1 'match-string-no-properties))
:test 'string-equal)))
(defun plcmp--using-modules-marge-extra-modules (modules)
(condition-case err
(dolist (ext-module plcmp-extra-using-modules modules)
(cond
((stringp ext-module)
(add-to-list 'modules ext-module))
((consp ext-module) ; alist ("module-name" . "extra-module-name")
(when (and (stringp (car ext-module))
(stringp (cdr ext-module))
(member (car ext-module) modules))
(add-to-list 'modules (cdr ext-module))))))
(error (prog1 modules
(plcmp-log "Error in plcmp-get-using-modules %s"
(error-message-string err))))))
(defun plcmp--using-modules-filter (modules)
(set-difference modules
plcmp-module-filter-list
:test 'string-equal))
;;; methods
(defvar plcmp-obj-instance-of-module-maybe-alist nil)
(defun plcmp-get-obj-instance-of-module-maybe-alist (using-modules)
(let* ((using-module-re (regexp-opt using-modules))
(re (rx-to-string `(and (group "$" ;1 var name
(regexp ,plcmp-perl-ident-re))
(* space)
"="
(* space)
(group ;2 module-name
(regexp ,using-module-re))))))
(save-excursion
(loop initially (goto-char (point-min))
while (re-search-forward re nil t)
collect `(,(match-string-no-properties 1) . ,(match-string-no-properties 2))))))
(defsubst plcmp--make-los (str)
(with-temp-buffer
(insert str)
(plcmp-collect-matches plcmp-perl-ident-re)))
(defsubst plcmp--inspect-module-class-inspector (module-name)
"Inspect module for getting methods.
this function returns alist (module-name . list of methods)
If MODULE-NAME is not valid, returns `nil'"
(when (plcmp-module-p module-name)
(let ((modules-str
(shell-command-to-string
(concat "perl -MClass::Inspector -e'use "
module-name
"; print join \"\n\"=>@{Class::Inspector->methods("
module-name
")} '"))))
(when (and (not (plcmp-notfound-p modules-str))
(stringp modules-str))
(let ((modules (plcmp--make-los modules-str)))
`(,module-name . ,modules))))))
(defsubst plcmp-get-buffer-subs ()
(plcmp-collect-matches plcmp-sub-re 1 'match-string-no-properties))
(defun plcmp-get-module-file-path (module-name)
(plcmp-with-set-perl5-lib
(let* ((path (shell-command-to-string (concat "perldoc -ml " (shell-quote-argument module-name))))
(path (plcmp-trim path)))
(and (stringp path)
(file-exists-p path)
(expand-file-name path)))))
(defun plcmp--inspect-module-scrape (module-name)
(when (and (stringp module-name)
(plcmp-module-p module-name))
(let* ((path (plcmp-get-module-file-path module-name)))
(when (and (stringp path)
(file-exists-p path)
(file-readable-p path))
(let ((modules (with-temp-buffer
(insert-file-contents path)
(plcmp-get-buffer-subs))))
`(,module-name . ,modules))))))
(defsubst plcmp--inspect-module (module-name)
(message "getting methods %s ..." module-name)
(funcall (plcmp--get-inspect-fn) module-name))
(defun plcmp--get-inspect-fn ()
(case plcmp-method-inspecter
(class-inspector 'plcmp--inspect-module-class-inspector)
(scrape 'plcmp--inspect-module-scrape)
(otherwise (lambda (module-name)
(or (plcmp--inspect-module-class-inspector module-name)
(plcmp--inspect-module-scrape module-name))))))
(defvar plcmp-module-methods-alist nil
"alist, (module-name . (list of methods))")
(add-to-list 'plcmp--cached-variables 'plcmp-module-methods-alist)
(defun plcmp-get-module-methods-alist (using-modules)
(dolist (module-name using-modules plcmp-module-methods-alist)
(unless (assoc module-name plcmp-module-methods-alist)
(add-to-list 'plcmp-module-methods-alist
(plcmp--inspect-module module-name)))))
;; module-name -> source
(defvar plcmp--mk-module-source-name " Methods")
(defsubst plcmp--mk-module-source (module-name)
(anything-aif (assoc-default module-name plcmp-module-methods-alist)
`((name . ,(concat module-name plcmp--mk-module-source-name))
(action . (("Insert" . plcmp-insert)
("Show doc" .
(lambda (candidate)
(let* ((module (plcmp-get-current-module-name))
(buf (plcmp-get-man-buffer module 'module)))
(save-selected-window
(pop-to-buffer buf)))))
("Show doc and go" .
(lambda (candidate)
(let* ((module (plcmp-get-current-module-name))
(buf (plcmp-get-man-buffer module 'module)))
(pop-to-buffer buf))))
("Open module file" .
(lambda (method)
(let ((module (plcmp-get-current-module-name)))
(plcmp-open-module-file module))))
("Open module file other window" .
(lambda (method)
(let ((module-name (plcmp-get-current-module-name)))
(plcmp-open-module-file module-name 'pop-to-buffer))))
("Open module file other frame" .
(lambda (candidate)
(let ((module-name (plcmp-get-current-module-name)))
(plcmp-open-module-file module-name
'switch-to-buffer-other-frame))))
("Occur module file" .
(lambda (candidate)
(let ((module-name (plcmp-get-current-module-name)))
(plcmp-open-module-file module-name
'switch-to-buffer)
(funcall (plcmp-get-occur-fn)
candidate
nil))))
("Add to kill-ring" . kill-new)
("Insert source name" .
(lambda (candidate)
(let ((name (plcmp-anything-get-current-source-name)))
(and (stringp name)
(insert name)))))
))
(init . (lambda ()
(with-current-buffer (anything-candidate-buffer 'global)
(plcmp-insert-each-line ',it))))
(candidates-in-buffer)
(persistent-action . (lambda (candidate)
(let ((module-name (plcmp-get-current-module-name)))
(plcmp-open-doc module-name)
(plcmp-re-search-forward-fontify (regexp-quote candidate))))))))
;; plcmp-using-modules -> sources
(defun plcmp-get-sources-methods (using-modules)
(loop for module-name in using-modules
collect (plcmp--mk-module-source module-name)))
;;; dabbrev
(defvar plcmp-buffer-dabbrevs-re
(rx (>= 4 (or (syntax word)
(syntax symbol)))))
(defsubst* plcmp-get-buffer-dabbrevs ()
(plcmp-collect-matches plcmp-buffer-dabbrevs-re 0 'match-string-no-properties))
;;; current buffer words
(defsubst* plcmp--check-face (face-names &optional (point (point)))
(let* ((face (get-text-property point 'face))
(faces (if (listp face) face (list face))))
(some (lambda (face-sym)