forked from efairbanks/cybin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcybin-mode.el
1984 lines (1705 loc) · 78.4 KB
/
cybin-mode.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
;; ___ ___
;; / /\ ___ _____ ___ /__/\
;; / /:/ /__/| / /::\ / /\ \ \:\
;; / /:/ | |:| / /:/\:\ / /:/ \ \:\
;; / /:/ ___ | |:| / /:/~/::\ /__/::\ _____\__\:\
;; /__/:/ / /\ __|__|:| /__/:/ /:/\:| \__\/\:\__ /__/::::::::\
;; \ \:\ / /:/ /__/::::\ \ \:\/:/~/:/ \ \:\/\ \ \:\~~\~~\/
;; \ \:\ /:/ ~\~~\:\ \ \::/ /:/ \__\::/ \ \:\ ~~~
;; \ \:\/:/ \ \:\ \ \:\/:/ /__/:/ \ \:\
;; \ \::/ \__\/ \ \::/ \__\/ \ \:\
;; \__\/ \__\/ \__\/
;;
;; cybin-mode.el is a version of cybin-mode.el modified to play nicely
;; with Cybin. The license for cybin-mode.el is included unmofified.
;;
;; 2018 Eric Fairbanks <[email protected]>
;; URL: https://github.com/efairbanks/Cybin
;;; cybin-mode.el --- a major-mode for editing Cybin scripts
;; Author: 2011-2013 immerrr <[email protected]>
;; 2010-2011 Reuben Thomas <[email protected]>
;; 2006 Juergen Hoetzel <[email protected]>
;; 2004 various (support for Cybin 5 and byte compilation)
;; 2001 Christian Vogler <[email protected]>
;; 1997 Bret Mogilefsky <[email protected]> starting from
;; tcl-mode by Gregor Schmid <[email protected]>
;; with tons of assistance from
;; Paul Du Bois <[email protected]> and
;; Aaron Smith <[email protected]>.
;;
;; URL: http://immerrr.github.com/cybin-mode
;; Version: 20151025
;;
;; This file is NOT part of 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., 51 Franklin Street, Fifth Floor, Boston,
;; MA 02110-1301, USA.
;; Keywords: languages, processes, tools
;; This field is expanded to commit SHA, date & associated heads/tags during
;; archive creation.
;; Revision: $Format:%h (%cD %d)$
;;
;;; Commentary:
;; cybin-mode provides support for editing Cybin, including automatical
;; indentation, syntactical font-locking, running interactive shell,
;; interacting with `hs-minor-mode' and online documentation lookup.
;; The following variables are available for customization (see more via
;; `M-x customize-group cybin`):
;; - Var `cybin-indent-level':
;; indentation offset in spaces
;; - Var `cybin-indent-string-contents':
;; set to `t` if you like to have contents of multiline strings to be
;; indented like comments
;; - Var `cybin-mode-hook':
;; list of functions to execute when cybin-mode is initialized
;; - Var `cybin-documentation-url':
;; base URL for documentation lookup
;; - Var `cybin-documentation-function': function used to
;; show documentation (`eww` is a viable alternative for Emacs 25)
;; These are variables/commands that operate on the Cybin process:
;; - Var `cybin-default-application':
;; command to start the Cybin process (REPL)
;; - Var `cybin-default-command-switches':
;; arguments to pass to the Cybin process on startup (make sure `-i` is there
;; if you expect working with Cybin shell interactively)
;; - Cmd `cybin-start-process': start new REPL process, usually happens automatically
;; - Cmd `cybin-kill-process': kill current REPL process
;; These are variables/commands for interaction with the Cybin process:
;; - Cmd `cybin-show-process-buffer': switch to REPL buffer
;; - Cmd `cybin-hide-process-buffer': hide window showing REPL buffer
;; - Var `cybin-always-show': show REPL buffer after sending something
;; - Cmd `cybin-send-file' : send the whole file
;; - Cmd `cybin-send-buffer': send whole buffer
;; - Cmd `cybin-send-current-line': send current line
;; - Cmd `cybin-send-defun': send current top-level function
;; - Cmd `cybin-send-region': send active region
;; - Cmd `cybin-send-paragraph': send paragraph under cursor
;; - Cmd `cybin-restart-with-whole-file': restart REPL and send whole buffer
;; See "M-x apropos-command ^cybin-" for a list of commands.
;; See "M-x customize-group cybin" for a list of customizable variables.
;;; Code:
(eval-when-compile
(require 'cl))
(require 'comint)
(require 'newcomment)
(require 'rx)
;; rx-wrappers for Cybin
(eval-when-compile
;; Silence compilation warning about `compilation-error-regexp-alist' defined
;; in compile.el.
(require 'compile))
(eval-and-compile
(defvar cybin-rx-constituents)
(defvar rx-parent)
(defun cybin-rx-to-string (form &optional no-group)
"Cybin-specific replacement for `rx-to-string'.
See `rx-to-string' documentation for more information FORM and
NO-GROUP arguments."
(let ((rx-constituents cybin-rx-constituents))
(rx-to-string form no-group)))
(defmacro cybin-rx (&rest regexps)
"Cybin-specific replacement for `rx'.
See `rx' documentation for more information about REGEXPS param."
(cond ((null regexps)
(error "No regexp"))
((cdr regexps)
(cybin-rx-to-string `(and ,@regexps) t))
(t
(cybin-rx-to-string (car regexps) t))))
(defun cybin--new-rx-form (form)
"Add FORM definition to `cybin-rx' macro.
FORM is a cons (NAME . DEFN), see more in `rx-constituents' doc.
This function enables specifying new definitions using old ones:
if DEFN is a list that starts with `:rx' symbol its second
element is itself expanded with `cybin-rx-to-string'. "
(let ((name (car form))
(form-definition (cdr form)))
(when (and (listp form-definition) (eq ':rx (car form-definition)))
(setcdr form (cybin-rx-to-string (cadr form-definition) 'nogroup)))
(push form cybin-rx-constituents)))
(defun cybin--rx-symbol (form)
;; form is a list (symbol XXX ...)
;; Skip initial 'symbol
(setq form (cdr form))
;; If there's only one element, take it from the list, otherwise wrap the
;; whole list into `(or XXX ...)' form.
(setq form (if (eq 1 (length form))
(car form)
(append '(or) form)))
(rx-form `(seq symbol-start ,form symbol-end) rx-parent))
(setq cybin-rx-constituents (copy-sequence rx-constituents))
(mapc #'cybin--new-rx-form
`((symbol cybin--rx-symbol 1 nil)
(ws . "[ \t]*") (ws+ . "[ \t]+")
(cybin-name :rx (symbol (regexp "[[:alpha:]_]+[[:alnum:]_]*")))
(cybin-funcname
:rx (seq cybin-name (* ws "." ws cybin-name)
(opt ws ":" ws cybin-name)))
(cybin-funcheader
;; Outer (seq ...) is here to shy-group the definition
:rx (seq (or (seq (symbol "function") ws (group-n 1 cybin-funcname))
(seq (group-n 1 cybin-funcname) ws "=" ws
(symbol "function")))))
(cybin-number
:rx (seq (or (seq (+ digit) (opt ".") (* digit))
(seq (* digit) (opt ".") (+ digit)))
(opt (regexp "[eE][+-]?[0-9]+"))))
(cybin-assignment-op
:rx (seq "=" (or buffer-end (not (any "=")))))
(cybin-token
:rx (or "+" "-" "*" "/" "%" "^" "#" "==" "~=" "<=" ">=" "<"
">" "=" ";" ":" "," "." ".." "..."))
(cybin-keyword
:rx (symbol "and" "break" "do" "else" "elseif" "end" "for" "function"
"goto" "if" "in" "local" "not" "or" "repeat" "return"
"then" "until" "while")))
))
;; Local variables
(defgroup cybin nil
"Major mode for editing Cybin code."
:prefix "cybin-"
:group 'languages)
(defcustom cybin-indent-level 2
"Amount by which Cybin subexpressions are indented."
:type 'integer
:group 'cybin
:safe #'integerp)
(defcustom cybin-comment-start "-- "
"Default value of `comment-start'."
:type 'string
:group 'cybin)
(defcustom cybin-comment-start-skip "---*[ \t]*"
"Default value of `comment-start-skip'."
:type 'string
:group 'cybin)
(defcustom cybin-default-application "cybin"
"Default application to run in Cybin process."
:type '(choice (string)
(cons string integer))
:group 'cybin)
(defcustom cybin-jack-autoconnect t
"If true, will automatically connect Cybin to JACK."
:type 'boolean
:group 'cybin)
(defcustom cybin-default-boot-file ""
"Specify default Cybin boot file."
:type 'string
:group 'cybin)
(defcustom cybin-default-command-switches (list)
"Command switches for `cybin-default-application'.
Should be a list of strings."
:type '(repeat string)
:group 'cybin)
(make-variable-buffer-local 'cybin-default-command-switches)
(defcustom cybin-always-show t
"*Non-nil means display cybin-process-buffer after sending a command."
:type 'boolean
:group 'cybin)
(defcustom cybin-documentation-function 'browse-url
"Function used to fetch the Cybin reference manual."
:type `(radio (function-item browse-url)
,@(when (fboundp 'eww) '((function-item eww)))
,@(when (fboundp 'w3m-browse-url) '((function-item w3m-browse-url)))
(function :tag "Other function"))
:group 'cybin)
(defcustom cybin-documentation-url
(or (and (file-readable-p "/usr/share/doc/cybin/manual.html")
"file:///usr/share/doc/cybin/manual.html")
"http://www.lua.org/manual/5.1/manual.html")
"URL pointing to the Cybin reference manual."
:type 'string
:group 'cybin)
(defvar cybin-process nil
"The active Cybin process")
(defvar cybin-process-buffer nil
"Buffer used for communication with the Cybin process")
(defun cybin--customize-set-prefix-key (prefix-key-sym prefix-key-val)
(cl-assert (eq prefix-key-sym 'cybin-prefix-key))
(set prefix-key-sym (if (and prefix-key-val (> (length prefix-key-val) 0))
;; read-kbd-macro returns a string or a vector
;; in both cases (elt x 0) is ok
(elt (read-kbd-macro prefix-key-val) 0)))
(if (fboundp 'cybin-prefix-key-update-bindings)
(cybin-prefix-key-update-bindings)))
(defcustom cybin-prefix-key "\C-c"
"Prefix for all cybin-mode commands."
:type 'string
:group 'cybin
:set 'cybin--customize-set-prefix-key
:get '(lambda (sym)
(let ((val (eval sym))) (if val (single-key-description (eval sym)) ""))))
(defvar cybin-mode-menu (make-sparse-keymap "Cybin")
"Keymap for cybin-mode's menu.")
(defvar cybin-prefix-mode-map
(eval-when-compile
(let ((result-map (make-sparse-keymap)))
(mapc (lambda (key_defn)
(define-key result-map (read-kbd-macro (car key_defn)) (cdr key_defn)))
'(("C-b" . cybin-send-buffer)
("C-d" . cybin-send-file)
("C-e" . cybin-send-paragraph)
("C-c" . cybin-send-current-line)
("C-f" . cybin-search-documentation)))
result-map))
"Keymap that is used to define keys accessible by `cybin-prefix-key'.
If the latter is nil, the keymap translates into `cybin-mode-map' verbatim.")
(defvar cybin--electric-indent-chars
(mapcar #'string-to-char '("}" "]" ")")))
(defvar cybin-mode-map
(let ((result-map (make-sparse-keymap))
prefix-key)
(unless (boundp 'electric-indent-chars)
(mapc (lambda (electric-char)
(define-key result-map
(read-kbd-macro
(char-to-string electric-char))
#'cybin-electric-match))
cybin--electric-indent-chars))
(define-key result-map [menu-bar cybin-mode] (cons "Cybin" cybin-mode-menu))
;; FIXME: see if the declared logic actually works
;; handle prefix-keyed bindings:
;; * if no prefix, set prefix-map as parent, i.e.
;; if key is not defined look it up in prefix-map
;; * if prefix is set, bind the prefix-map to that key
(if (boundp 'cybin-prefix-key)
(define-key result-map (vector cybin-prefix-key) cybin-prefix-mode-map)
(set-keymap-parent result-map cybin-prefix-mode-map))
result-map)
"Keymap used in cybin-mode buffers.")
(defvar cybin-electric-flag t
"If t, electric actions (like automatic reindentation) will happen when an electric
key like `{' is pressed")
(make-variable-buffer-local 'cybin-electric-flag)
(defcustom cybin-prompt-regexp "[^\n]*\\(>[\t ]+\\)+$"
"Regexp which matches the Cybin program's prompt."
:type 'regexp
:group 'cybin)
(defcustom cybin-traceback-line-re
;; This regexp skips prompt and meaningless "stdin:N:" prefix when looking
;; for actual file-line locations.
"^\\(?:[\t ]*\\|.*>[\t ]+\\)\\(?:[^\n\t ]+:[0-9]+:[\t ]*\\)*\\(?:\\([^\n\t ]+\\):\\([0-9]+\\):\\)"
"Regular expression that describes tracebacks and errors."
:type 'regexp
:group 'cybin)
(defvar cybin--repl-buffer-p nil
"Buffer-local flag saying if this is a Cybin REPL buffer.")
(make-variable-buffer-local 'cybin--repl-buffer-p)
(defadvice compilation-find-file (around cybin--repl-find-file
(marker filename directory &rest formats)
activate)
"Return Cybin REPL buffer when looking for \"stdin\" file in it."
(if (and
cybin--repl-buffer-p
(string-equal filename "stdin")
;; NOTE: this doesn't traverse `compilation-search-path' when
;; looking for filename.
(not (file-exists-p (expand-file-name
filename
(when directory (expand-file-name directory))))))
(setq ad-return-value (current-buffer))
ad-do-it))
(defadvice compilation-goto-locus (around cybin--repl-goto-locus
(msg mk end-mk)
activate)
"When message points to Cybin REPL buffer, go to the message itself.
Usually, stdin:XX line number points to nowhere."
(let ((errmsg-buf (marker-buffer msg))
(error-buf (marker-buffer mk)))
(if (and (with-current-buffer errmsg-buf cybin--repl-buffer-p)
(eq error-buf errmsg-buf))
(progn
(compilation-set-window (display-buffer (marker-buffer msg)) msg)
(goto-char msg))
ad-do-it)))
(defcustom cybin-indent-string-contents nil
"If non-nil, contents of multiline string will be indented.
Otherwise leading amount of whitespace on each line is preserved."
:group 'cybin
:type 'boolean)
(defcustom cybin-jump-on-traceback t
"*Jump to innermost traceback location in *cybin* buffer. When this
variable is non-nil and a traceback occurs when running Cybin code in a
process, jump immediately to the source code of the innermost
traceback location."
:type 'boolean
:group 'cybin)
(defcustom cybin-mode-hook nil
"Hooks called when Cybin mode fires up."
:type 'hook
:group 'cybin)
(defvar cybin-region-start (make-marker)
"Start of special region for Cybin communication.")
(defvar cybin-region-end (make-marker)
"End of special region for Cybin communication.")
(defvar cybin-emacs-menu
'(["Restart With Whole File" cybin-restart-with-whole-file t]
["Kill Process" cybin-kill-process t]
["Hide Process Buffer" cybin-hide-process-buffer t]
["Show Process Buffer" cybin-show-process-buffer t]
["Beginning Of Proc" cybin-beginning-of-proc t]
["End Of Proc" cybin-end-of-proc t]
["Set Cybin-Region Start" cybin-set-cybin-region-start t]
["Set Cybin-Region End" cybin-set-cybin-region-end t]
["Send Cybin-Region" cybin-send-cybin-region t]
["Send Current Line" cybin-send-current-line t]
["Send Region" cybin-send-region t]
["Send Paragraph" cybin-send-paragraph t]
["Send Proc" cybin-send-proc t]
["Send Buffer" cybin-send-buffer t]
["Search Documentation" cybin-search-documentation t])
"Emacs menu for Cybin mode.")
;; the whole defconst is inside eval-when-compile, because it's later referenced
;; inside another eval-and-compile block
(eval-and-compile
(defconst
cybin--builtins
(let*
((modules
'("_G" "_VERSION" "assert" "collectgarbage" "dofile" "error" "getfenv"
"getmetatable" "ipairs" "load" "loadfile" "loadstring" "module"
"next" "pairs" "pcall" "print" "rawequal" "rawget" "rawlen" "rawset"
"require" "select" "setfenv" "setmetatable" "tonumber" "tostring"
"type" "unpack" "xpcall" "self"
("bit32" . ("arshift" "band" "bnot" "bor" "btest" "bxor" "extract"
"lrotate" "lshift" "replace" "rrotate" "rshift"))
("coroutine" . ("create" "isyieldable" "resume" "running" "status"
"wrap" "yield"))
("debug" . ("debug" "getfenv" "gethook" "getinfo" "getlocal"
"getmetatable" "getregistry" "getupvalue" "getuservalue"
"setfenv" "sethook" "setlocal" "setmetatable"
"setupvalue" "setuservalue" "traceback" "upvalueid"
"upvaluejoin"))
("io" . ("close" "flush" "input" "lines" "open" "output" "popen"
"read" "stderr" "stdin" "stdout" "tmpfile" "type" "write"))
("math" . ("abs" "acos" "asin" "atan" "atan2" "ceil" "cos" "cosh"
"deg" "exp" "floor" "fmod" "frexp" "huge" "ldexp" "log"
"log10" "max" "maxinteger" "min" "mininteger" "modf" "pi"
"pow" "rad" "random" "randomseed" "sin" "sinh" "sqrt"
"tan" "tanh" "tointeger" "type" "ult"))
("os" . ("clock" "date" "difftime" "execute" "exit" "getenv"
"remove" "rename" "setlocale" "time" "tmpname"))
("package" . ("config" "cpath" "loaded" "loaders" "loadlib" "path"
"preload" "searchers" "searchpath" "seeall"))
("string" . ("byte" "char" "dump" "find" "format" "gmatch" "gsub"
"len" "lower" "match" "pack" "packsize" "rep" "reverse"
"sub" "unpack" "upper"))
("table" . ("concat" "insert" "maxn" "move" "pack" "remove" "sort"
"unpack"))
("utf8" . ("char" "charpattern" "codepoint" "codes" "len"
"offset")))))
(cl-labels
((module-name-re (x)
(concat "\\(?1:\\_<"
(if (listp x) (car x) x)
"\\_>\\)"))
(module-members-re (x) (if (listp x)
(concat "\\(?:[ \t]*\\.[ \t]*"
"\\_<\\(?2:"
(regexp-opt (cdr x))
"\\)\\_>\\)?")
"")))
(concat
;; common prefix:
;; - beginning-of-line
;; - or neither of [ '.', ':' ] to exclude "foo.string.rep"
;; - or concatenation operator ".."
"\\(?:^\\|[^:. \t]\\|[.][.]\\)"
;; optional whitespace
"[ \t]*"
"\\(?:"
;; any of modules/functions
(mapconcat (lambda (x) (concat (module-name-re x)
(module-members-re x)))
modules
"\\|")
"\\)"))))
"A regexp that matches Cybin builtin functions & variables.
This is a compilation of 5.1, 5.2 and 5.3 builtins taken from the
index of respective Cybin reference manuals.")
(eval-and-compile
(defun cybin-make-delimited-matcher (elt-regexp sep-regexp end-regexp)
"Construct matcher function for `font-lock-keywords' to match a sequence.
It's supposed to match sequences with following EBNF:
ELT-REGEXP { SEP-REGEXP ELT-REGEXP } END-REGEXP
The sequence is parsed one token at a time. If non-nil is
returned, `match-data' will have one or more of the following
groups set according to next matched token:
1. matched element token
2. unmatched garbage characters
3. misplaced token (i.e. SEP-REGEXP when ELT-REGEXP is expected)
4. matched separator token
5. matched end token
Blanks & comments between tokens are silently skipped.
Groups 6-9 can be used in any of argument regexps."
(lexical-let*
((delimited-matcher-re-template
"\\=\\(?2:.*?\\)\\(?:\\(?%s:\\(?4:%s\\)\\|\\(?5:%s\\)\\)\\|\\(?%s:\\(?1:%s\\)\\)\\)")
;; There's some magic to this regexp. It works as follows:
;;
;; A. start at (point)
;; B. non-greedy match of garbage-characters (?2:)
;; C. try matching separator (?4:) or end-token (?5:)
;; D. try matching element (?1:)
;;
;; Simple, but there's a trick: pt.C and pt.D are embraced by one more
;; group whose purpose is determined only after the template is
;; formatted (?%s:):
;;
;; - if element is expected, then D's parent group becomes "shy" and C's
;; parent becomes group 3 (aka misplaced token), so if D matches when
;; an element is expected, it'll be marked with warning face.
;;
;; - if separator-or-end-token is expected, then it's the opposite:
;; C's parent becomes shy and D's will be matched as misplaced token.
(elt-expected-re (format delimited-matcher-re-template
3 sep-regexp end-regexp "" elt-regexp))
(sep-or-end-expected-re (format delimited-matcher-re-template
"" sep-regexp end-regexp 3 elt-regexp)))
(lambda (end)
(let* ((prev-elt-p (match-beginning 1))
(prev-sep-p (match-beginning 4))
(prev-end-p (match-beginning 5))
(regexp (if prev-elt-p sep-or-end-expected-re elt-expected-re))
(comment-start (cybin-comment-start-pos (syntax-ppss)))
(parse-stop end))
;; If token starts inside comment, or end-token was encountered, stop.
(when (and (not comment-start)
(not prev-end-p))
;; Skip all comments & whitespace. forward-comment doesn't have boundary
;; argument, so make sure point isn't beyond parse-stop afterwards.
(while (and (< (point) end)
(forward-comment 1)))
(goto-char (min (point) parse-stop))
;; Reuse comment-start variable to store beginning of comment that is
;; placed before line-end-position so as to make sure token search doesn't
;; enter that comment.
(setq comment-start
(cybin-comment-start-pos
(save-excursion
(parse-partial-sexp (point) parse-stop
nil nil nil 'stop-inside-comment)))
parse-stop (or comment-start parse-stop))
;; Now, let's match stuff. If regular matcher fails, declare a span of
;; non-blanks 'garbage', and the next iteration will start from where the
;; garbage ends. If couldn't match any garbage, move point to the end
;; and return nil.
(or (re-search-forward regexp parse-stop t)
(re-search-forward "\\(?1:\\(?2:[^ \t]+\\)\\)" parse-stop 'skip)
(prog1 nil (goto-char end)))))))))
(defvar cybin-font-lock-keywords
`(;; highlight the hash-bang line "#!/foo/bar/cybin" as comment
("^#!.*$" . font-lock-comment-face)
;; Builtin constants
(,(cybin-rx (symbol "true" "false" "nil"))
. font-lock-constant-face)
;; Keywords
(,(cybin-rx cybin-keyword)
. font-lock-keyword-face)
;; Labels used by the "goto" statement
;; Highlights the following syntax: ::label::
(,(cybin-rx "::" ws cybin-name ws "::")
. font-lock-constant-face)
;; Hightlights the name of the label in the "goto" statement like
;; "goto label"
(,(cybin-rx (symbol (seq "goto" ws+ (group-n 1 cybin-name))))
(1 font-lock-constant-face))
;; Highlight Cybin builtin functions and variables
(,cybin--builtins
(1 font-lock-builtin-face) (2 font-lock-builtin-face nil noerror))
("^[ \t]*\\_<for\\_>"
(,(cybin-make-delimited-matcher (cybin-rx cybin-name) ","
(cybin-rx (or (symbol "in") cybin-assignment-op)))
nil nil
(1 font-lock-variable-name-face nil noerror)
(2 font-lock-warning-face t noerror)
(3 font-lock-warning-face t noerror)))
;; Handle local variable/function names
;; local blalba, xyzzy =
;; ^^^^^^ ^^^^^
;;
;; local function foobar(x,y,z)
;; ^^^^^^
;; local foobar = function(x,y,z)
;; ^^^^^^
("^[ \t]*\\_<local\\_>"
(0 font-lock-keyword-face)
;; (* nonl) at the end is to consume trailing characters or otherwise they
;; delimited matcher would attempt to parse them afterwards and wrongly
;; highlight parentheses as incorrect variable name characters.
(,(cybin-rx point ws cybin-funcheader (* nonl))
nil nil
(1 font-lock-function-name-face nil noerror))
(,(cybin-make-delimited-matcher (cybin-rx cybin-name) ","
(cybin-rx cybin-assignment-op))
nil nil
(1 font-lock-variable-name-face nil noerror)
(2 font-lock-warning-face t noerror)
(3 font-lock-warning-face t noerror)))
(,(cybin-rx (or bol ";") ws cybin-funcheader)
(1 font-lock-function-name-face))
(,(cybin-rx (or (group-n 1
"@" (symbol "author" "copyright" "field" "release"
"return" "see" "usage" "description"))
(seq (group-n 1 "@" (symbol "param" "class" "name")) ws+
(group-n 2 cybin-name))))
(1 font-lock-keyword-face t)
(2 font-lock-variable-name-face t noerror)))
"Default expressions to highlight in Cybin mode.")
(defvar cybin-imenu-generic-expression
`((nil ,(cybin-rx (or bol ";") ws (opt (seq (symbol "local") ws)) cybin-funcheader) 1))
"Imenu generic expression for cybin-mode. See `imenu-generic-expression'.")
(defvar cybin-sexp-alist '(("then" . "end")
("function" . "end")
("do" . "end")
("repeat" . "until")))
(defvar cybin-mode-abbrev-table nil
"Abbreviation table used in cybin-mode buffers.")
(define-abbrev-table 'cybin-mode-abbrev-table
'(("end" "end" cybin-indent-line :system t)
("else" "else" cybin-indent-line :system t)
("elseif" "elseif" cybin-indent-line :system t)))
(defvar cybin-mode-syntax-table
(with-syntax-table (copy-syntax-table)
;; main comment syntax: begins with "--", ends with "\n"
(modify-syntax-entry ?- ". 12")
(modify-syntax-entry ?\n ">")
;; main string syntax: bounded by ' or "
(modify-syntax-entry ?\' "\"")
(modify-syntax-entry ?\" "\"")
;; single-character binary operators: punctuation
(modify-syntax-entry ?+ ".")
(modify-syntax-entry ?* ".")
(modify-syntax-entry ?/ ".")
(modify-syntax-entry ?^ ".")
(modify-syntax-entry ?% ".")
(modify-syntax-entry ?> ".")
(modify-syntax-entry ?< ".")
(modify-syntax-entry ?= ".")
(modify-syntax-entry ?~ ".")
(syntax-table))
"`cybin-mode' syntax table.")
;;;###autoload
(define-derived-mode cybin-mode prog-mode "Cybin"
"Major mode for editing Cybin code."
:abbrev-table cybin-mode-abbrev-table
:syntax-table cybin-mode-syntax-table
:group 'cybin
(setq comint-prompt-regexp cybin-prompt-regexp)
(setq-local font-lock-defaults '(cybin-font-lock-keywords ;; keywords
nil ;; keywords-only
nil ;; case-fold
nil ;; syntax-alist
nil ;; syntax-begin
))
(setq-local syntax-propertize-function
'cybin--propertize-multiline-bounds)
(setq-local parse-sexp-lookup-properties t)
(setq-local indent-line-function 'cybin-indent-line)
(setq-local beginning-of-defun-function 'cybin-beginning-of-proc)
(setq-local end-of-defun-function 'cybin-end-of-proc)
(setq-local comment-start cybin-comment-start)
(setq-local comment-start-skip cybin-comment-start-skip)
(setq-local comment-use-syntax t)
(setq-local fill-paragraph-function #'cybin--fill-paragraph)
(with-no-warnings
(setq-local comment-use-global-state t))
(setq-local imenu-generic-expression cybin-imenu-generic-expression)
(when (boundp 'electric-indent-chars)
;; If electric-indent-chars is not defined, electric indentation is done
;; via `cybin-mode-map'.
(setq-local electric-indent-chars
(append electric-indent-chars cybin--electric-indent-chars)))
;; setup menu bar entry (XEmacs style)
(if (and (featurep 'menubar)
(boundp 'current-menubar)
(fboundp 'set-buffer-menubar)
(fboundp 'add-menu)
(not (assoc "Cybin" current-menubar)))
(progn
(set-buffer-menubar (copy-sequence current-menubar))
(add-menu nil "Cybin" cybin-emacs-menu)))
;; Append Cybin menu to popup menu for Emacs.
(if (boundp 'mode-popup-menu)
(setq mode-popup-menu
(cons (concat mode-name " Mode Commands") cybin-emacs-menu)))
;; hideshow setup
(unless (assq 'cybin-mode hs-special-modes-alist)
(add-to-list 'hs-special-modes-alist
`(cybin-mode
,(regexp-opt (mapcar 'car cybin-sexp-alist) 'words) ;start
,(regexp-opt (mapcar 'cdr cybin-sexp-alist) 'words) ;end
nil cybin-forward-sexp))))
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.cybin\\'" . cybin-mode))
;;;###autoload
(add-to-list 'interpreter-mode-alist '("cybin" . cybin-mode))
(defun cybin-electric-match (arg)
"Insert character and adjust indentation."
(interactive "P")
(let (blink-paren-function)
(self-insert-command (prefix-numeric-value arg)))
(if cybin-electric-flag
(cybin-indent-line))
(blink-matching-open))
;; private functions
(defun cybin--fill-paragraph (&optional justify region)
;; Implementation of forward-paragraph for filling.
;;
;; This function works around a corner case in the following situations:
;;
;; <>
;; -- some very long comment ....
;; some_code_right_after_the_comment
;;
;; If point is at the beginning of the comment line, fill paragraph code
;; would have gone for comment-based filling and done the right thing, but it
;; does not find a comment at the beginning of the empty line before the
;; comment and falls back to text-based filling ignoring comment-start and
;; spilling the comment into the code.
(save-excursion
(while (and (not (eobp))
(progn (move-to-left-margin)
(looking-at paragraph-separate)))
(forward-line 1))
(let ((fill-paragraph-handle-comment t))
(fill-paragraph justify region))))
(defun cybin-prefix-key-update-bindings ()
(let (old-cons)
(if (eq cybin-prefix-mode-map (keymap-parent cybin-mode-map))
;; if prefix-map is a parent, delete the parent
(set-keymap-parent cybin-mode-map nil)
;; otherwise, look for it among children
(if (setq old-cons (rassoc cybin-prefix-mode-map cybin-mode-map))
(delq old-cons cybin-mode-map)))
(if (null cybin-prefix-key)
(set-keymap-parent cybin-mode-map cybin-prefix-mode-map)
(define-key cybin-mode-map (vector cybin-prefix-key) cybin-prefix-mode-map))))
(defun cybin-set-prefix-key (new-key-str)
"Changes `cybin-prefix-key' properly and updates keymaps
This function replaces previous prefix-key binding with a new one."
(interactive "sNew prefix key (empty string means no key): ")
(cybin--customize-set-prefix-key 'cybin-prefix-key new-key-str)
(message "Prefix key set to %S" (single-key-description cybin-prefix-key))
(cybin-prefix-key-update-bindings))
(defun cybin-string-p (&optional pos)
"Returns true if the point is in a string."
(save-excursion (elt (syntax-ppss pos) 3)))
(defun cybin-comment-start-pos (parsing-state)
"Return position of comment containing current point.
If point is not inside a comment, return nil."
(and parsing-state (nth 4 parsing-state) (nth 8 parsing-state)))
(defun cybin-comment-or-string-p (&optional pos)
"Returns true if the point is in a comment or string."
(save-excursion (let ((parse-result (syntax-ppss pos)))
(or (elt parse-result 3) (elt parse-result 4)))))
(defun cybin-comment-or-string-start-pos (&optional pos)
"Returns start position of string or comment which contains point.
If point is not inside string or comment, return nil."
(save-excursion (elt (syntax-ppss pos) 8)))
;; They're propertized as follows:
;; 1. generic-comment
;; 2. generic-string
;; 3. equals signs
(defconst cybin-ml-begin-regexp
"\\(?:\\(?1:-\\)-\\[\\|\\(?2:\\[\\)\\)\\(?3:=*\\)\\[")
(defun cybin-try-match-multiline-end (end)
"Try to match close-bracket for multiline literal around point.
Basically, detect form of close bracket from syntactic
information provided at point and re-search-forward to it."
(let ((comment-or-string-start-pos (cybin-comment-or-string-start-pos)))
;; Is there a literal around point?
(and comment-or-string-start-pos
;; It is, check if the literal is a multiline open-bracket
(save-excursion
(goto-char comment-or-string-start-pos)
(looking-at cybin-ml-begin-regexp))
;; Yes it is, look for it matching close-bracket. Close-bracket's
;; match group is determined by match-group of open-bracket.
(re-search-forward
(format "]%s\\(?%s:]\\)"
(match-string-no-properties 3)
(if (match-beginning 1) 1 2))
end 'noerror))))
(defun cybin-try-match-multiline-begin (limit)
"Try to match multiline open-brackets.
Find next opening long bracket outside of any string/comment.
If none can be found before reaching LIMIT, return nil."
(let (last-search-matched)
(while
;; This loop will iterate skipping all multiline-begin tokens that are
;; inside strings or comments ending either at EOL or at valid token.
(and (setq last-search-matched
(re-search-forward cybin-ml-begin-regexp limit 'noerror))
;; Handle triple-hyphen '---[[' situation in which the multiline
;; opener should be skipped.
;;
;; In HYPHEN1-HYPHEN2-BRACKET1-BRACKET2 situation (match-beginning
;; 0) points to HYPHEN1, but if there's another hyphen before
;; HYPHEN1, standard syntax table will only detect comment-start
;; at HYPHEN2.
;;
;; We could check for comment-start at HYPHEN2, but then we'd have
;; to flush syntax-ppss cache to remove the result saying that at
;; HYPHEN2 there's no comment or string, because under some
;; circumstances that would hide the fact that we put a
;; comment-start property at HYPHEN1.
(or (cybin-comment-or-string-start-pos (match-beginning 0))
(and (eq ?- (char-after (match-beginning 0)))
(eq ?- (char-before (match-beginning 0)))))))
last-search-matched))
(defun cybin-match-multiline-literal-bounds (limit)
;; First, close any multiline literal spanning from previous block. This will
;; move the point accordingly so as to avoid double traversal.
(or (cybin-try-match-multiline-end limit)
(cybin-try-match-multiline-begin limit)))
(defun cybin--propertize-multiline-bounds (start end)
"Put text properties on beginnings and ends of multiline literals.
Intended to be used as a `syntax-propertize-function'."
(save-excursion
(goto-char start)
(while (cybin-match-multiline-literal-bounds end)
(when (match-beginning 1)
(put-text-property (match-beginning 1) (match-end 1)
'syntax-table (string-to-syntax "!")))
(when (match-beginning 2)
(put-text-property (match-beginning 2) (match-end 2)
'syntax-table (string-to-syntax "|"))))))
(defun cybin-indent-line ()
"Indent current line for Cybin mode.
Return the amount the indentation changed by."
(let (indent
(case-fold-search nil)
;; save point as a distance to eob - it's invariant w.r.t indentation
(pos (- (point-max) (point))))
(back-to-indentation)
(if (cybin-comment-or-string-p)
(setq indent (cybin-calculate-string-or-comment-indentation)) ;; just restore point position
(setq indent (max 0 (cybin-calculate-indentation nil))))
(when (not (equal indent (current-column)))
(delete-region (line-beginning-position) (point))
(indent-to indent))
;; If initial point was within line's indentation,
;; position after the indentation. Else stay at same point in text.
(if (> (- (point-max) pos) (point))
(goto-char (- (point-max) pos)))
indent))
(defun cybin-calculate-string-or-comment-indentation ()
"This function should be run when point at (current-indentation) is inside string"
(if (and (cybin-string-p) (not cybin-indent-string-contents))
;; if inside string and strings aren't to be indented, return current indentation
(current-indentation)
;; At this point, we know that we're inside comment, so make sure
;; close-bracket is unindented like a block that starts after
;; left-shifter.
(let ((left-shifter-p (looking-at "\\s *\\(?:--\\)?\\]\\(?1:=*\\)\\]")))
(save-excursion
(goto-char (cybin-comment-or-string-start-pos))
(+ (current-indentation)
(if (and left-shifter-p
(looking-at (format "--\\[%s\\["
(match-string-no-properties 1))))
0
cybin-indent-level))))))
(defun cybin-find-regexp (direction regexp &optional limit ignore-p)
"Searches for a regular expression in the direction specified.
Direction is one of 'forward and 'backward.
By default, matches in comments and strings are ignored, but what to ignore is
configurable by specifying ignore-p. If the regexp is found, returns point
position, nil otherwise.
ignore-p returns true if the match at the current point position should be
ignored, nil otherwise."
(let ((ignore-func (or ignore-p 'cybin-comment-or-string-p))
(search-func (if (eq direction 'forward)
're-search-forward 're-search-backward))
(case-fold-search nil))
(catch 'found
(while (funcall search-func regexp limit t)
(if (and (not (funcall ignore-func (match-beginning 0)))
(not (funcall ignore-func (match-end 0))))
(throw 'found (point)))))))
(defconst cybin-block-regexp
(eval-when-compile
(concat
"\\(\\_<"
(regexp-opt '("do" "function" "repeat" "then"
"else" "elseif" "end" "until") t)
"\\_>\\)\\|"
(regexp-opt '("{" "(" "[" "]" ")" "}") t))))
(defconst cybin-block-token-alist
'(("do" "\\_<end\\_>" "\\_<for\\|while\\_>" middle-or-open)
("function" "\\_<end\\_>" nil open)
("repeat" "\\_<until\\_>" nil open)
("then" "\\_<\\(e\\(lse\\(if\\)?\\|nd\\)\\)\\_>" "\\_<\\(else\\)?if\\_>" middle)