forked from jrockway/elisp
/
lua-mode.el
1338 lines (1145 loc) · 43.5 KB
/
lua-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
;;; lua-mode.el --- a major-mode for editing Lua scripts
;; Copyright (C) 1997, 2001, 2004, 2006, 2007 Free Software Foundation, Inc.
;; Author: 2006 Juergen Hoetzel <juergen@hoetzel.info>
;; 2004 various (support for Lua 5 and byte compilation)
;; 2001 Christian Vogler <cvogler@gradient.cis.upenn.edu>
;; 1997 Bret Mogilefsky <mogul-lua@gelatinous.com> starting from
;; tcl-mode by Gregor Schmid <schmid@fb3-s7.math.tu-berlin.de>
;; with tons of assistance from
;; Paul Du Bois <pld-lua@gelatinous.com> and
;; Aaron Smith <aaron-lua@gelatinous.com>.
;; URL: http://lua-mode.luaforge.net/
;; Version: 20070703
;; 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.
(defconst lua-version "20071122"
"Lua Mode version number.")
;; Keywords: languages, processes, tools
;;; Commentary:
;; Thanks to Tobias Polzin <polzin<at>gmx.de> for function indenting
;; patch: Indent "(" like "{"
;; Thanks to Fabien <fleutot<at>gmail.com> for imenu patches.
;; Special Thanks to Simon Marshall <simonm@mail.esrin.esa.it> for
;; font-lock patches.
;; Additional font-lock highlighting and indentation tweaks by
;; Adam D. Moss <adam@gimp.org> <aspirin@icculus.org>
;; This file was written with emacs using Jamie Lokier's folding mode
;; That's what the funny ;;{{{ ;;}}} marks are there for
;;{{{ INSTALLATION:
;; To install, just drop this file into a directory on your load-path (and
;; byte-compile it). To set up Emacs to automatically edit files ending in
;; ".lua" using lua-mode add the following to your ~/.emacs file (GNU
;; Emacs) or ~/.xemacs/init.el file (XEmacs):
;; (setq auto-mode-alist (cons '("\\.lua$" . lua-mode) auto-mode-alist))
;; (autoload 'lua-mode "lua-mode" "Lua editing mode." t)
;;}}}
;;{{{ Usage
;; Lua-mode supports c-mode style formatting and sending of
;; lines/regions/files to a Lua interpreter. An interpreter (see
;; variable `lua-default-application') will be started if you try to
;; send some code and none is running. You can use the process-buffer
;; (named after the application you chose) as if it were an
;; interactive shell. See the documentation for `comint.el' for
;; details.
;;}}}
;;{{{ Key-bindings
;; To see all the keybindings for Lua mode, look at `lua-setup-keymap'
;; or start `lua-mode' and type `\C-h m'.
;; The keybindings may seem strange, since I prefer to use them with
;; lua-prefix-key set to nil, but since those keybindings are already used
;; the default for `lua-prefix-key' is `\C-c', which is the conventional
;; prefix for major-mode commands.
;; You can customise the keybindings either by setting `lua-prefix-key'
;; or by putting the following in your .emacs
;; (setq lua-mode-map (make-sparse-keymap))
;; and
;; (define-key lua-mode-map <your-key> <function>)
;; for all the functions you need.
;;}}}
;;; Code:
(defconst lua-using-xemacs (string-match "XEmacs" emacs-version)
"Nil unless using XEmacs).")
;; We need that !
(require 'comint)
;;{{{ variables
;; Local variables
(defgroup lua nil
"Major mode for editing lua code."
:prefix "lua-"
:group 'languages)
(defcustom lua-default-application "lua"
"Default application to run in lua subprocess."
:type 'string
:group 'lua)
(defcustom lua-default-command-switches (list "-i")
"Command switches for `lua-default-application'.
Should be a list of strings."
:type '(repeat string)
:group 'lua)
(defcustom lua-always-show t
"*Non-nil means display lua-process-buffer after sending a command."
:type 'boolean
:group 'lua)
(defcustom lua-search-url-prefix "http://www.lua.org/manual/5.1/manual.html#pdf-"
"*URL at which to search for documentation on a word"
:type 'string
:group 'lua)
(defvar lua-process nil
"The active Lua subprocess")
(defvar lua-process-buffer nil
"Buffer used for communication with Lua subprocess")
(defvar lua-mode-map nil
"Keymap used with lua-mode.")
(defvar lua-electric-flag t
"If t, electric actions (like automatic reindentation) will happen when an electric
key like `{' is pressed")
(make-variable-buffer-local 'lua-electric-flag)
(defcustom lua-prefix-key "\C-c"
"Prefix for all lua-mode commands."
:type 'string
:group 'lua)
(defcustom lua-prompt-regexp "[^\n]*\\(>[\t ]+\\)+$"
"Regexp which matches the Lua program's prompt."
:group 'lua
:type 'regexp
)
(defcustom lua-traceback-line-re
"^\\(?:[\t ]*\\|.*>[\t ]+\\)\\([^\n\t ]+\\):\\([0-9]+\\):"
"Regular expression that describes tracebacks and errors."
:group 'lua
:type 'regexp
)
(defcustom lua-jump-on-traceback t
"*Jump to innermost traceback location in *lua* buffer. When this
variable is non-nil and a traceback occurs when running Lua code in a
subprocess, jump immediately to the source code of the innermost
traceback location."
:group 'lua
:type 'boolean
)
(defvar lua-mode-hook nil
"Hooks called when Lua mode fires up.")
(defvar lua-region-start (make-marker)
"Start of special region for Lua communication.")
(defvar lua-region-end (make-marker)
"End of special region for Lua communication.")
(defvar lua-indent-level 3
"Amount by which Lua subexpressions are indented.")
(defvar lua-mode-menu (make-sparse-keymap "Lua")
"Keymap for lua-mode's menu.")
(defvar lua-xemacs-menu
'(["Restart With Whole File" lua-restart-with-whole-file t]
["Kill Process" lua-kill-process t]
["Hide Process Buffer" lua-hide-process-buffer t]
["Show Process Buffer" lua-show-process-buffer t]
["Beginning Of Proc" lua-beginning-of-proc t]
["End Of Proc" lua-end-of-proc t]
["Set Lua-Region Start" lua-set-lua-region-start t]
["Set Lua-Region End" lua-set-lua-region-end t]
["Send Lua-Region" lua-send-lua-region t]
["Send Current Line" lua-send-current-line t]
["Send Region" lua-send-region t]
["Send Proc" lua-send-proc t]
["Send Buffer" lua-send-buffer t]
["Search Documentation" lua-search-documentation t])
"XEmacs menu for Lua mode.")
(defvar lua-font-lock-keywords
(eval-when-compile
(list
;;
;; Function name declarations.
'("^[ \t]*\\<\\(\\(local[ \t]+\\)?function\\)\\>[ \t]+\\(\\(\\sw:\\|\\sw\\.\\|\\sw_\\|\\sw\\)+\\)"
(1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
;; Handle function names in assignments
'("\\(\\(\\sw:\\|\\sw\\.\\|\\sw_\\|\\sw\\)+\\)[ \t]*=[ \t]*\\(function\\)\\>"
(1 font-lock-function-name-face nil t) (3 font-lock-keyword-face))
; Highlight multi-line comment blocks; since font-lock-mode doesn't
; claim to handle the highlighting of multi-line expressions elegantly
; this works best with lazy-lock-mode if your Emacs supports it, e.g.
; try (setq font-lock-support-mode 'lazy-lock-mode) in your ~/.emacs
;; Multi-line comment blocks.
`("\\(?:^\\|[^-]\\)\\(--\\[\\(=*\\)\\[\\(?:.\\|\n\\)*?\\]\\2\\]\\)"
(1 font-lock-comment-face t))
;;
;; Keywords.
;; (concat "\\<"
;; (regexp-opt '("and" "break" "do" "else" "elseif" "end" "false"
;; "for" "function" "if" "in" "local" "nil" "not"
;; "or" "repeat" "return" "then" "true" "until"
;; "while") t)
;; "\\>")
; Insert expanded regexp-opt here for the benefit of those who
; don't have regexp-opt available.
"\\<\\(and\\|break\\|do\\|e\\(lse\\(if\\)?\\|nd\\)\\|f\\(alse\\|or\\|unction\\)\\|i[fn]\\|local\\|n\\(il\\|ot\\)\\|or\\|re\\(peat\\|turn\\)\\|t\\(hen\\|rue\\)\\|until\\|while\\)\\>"
"Default expressions to highlight in Lua mode.")))
(defvar lua-imenu-generic-expression
'((nil "^[ \t]*\\(?:local[ \t]+\\)?function[ \t]+\\(\\(\\sw:\\|\\sw_\\|\\sw\\.\\|\\sw\\)+\\)" 1))
"Imenu generic expression for lua-mode. See `imenu-generic-expression'.")
(defvar lua-mode-abbrev-table nil
"Abbreviation table used in lua-mode buffers.")
(defvar lua-sexp-alist '(("then" . "end")
("function" . "end")
("do" . "end")))
(define-abbrev-table 'lua-mode-abbrev-table
'(
("end" "end" lua-indent-line 0)
("else" "else" lua-indent-line 0)
("elseif" "elseif" lua-indent-line 0)
))
(defconst lua-indent-whitespace " \t"
"Character set that constitutes whitespace for indentation in lua.")
;;}}}
;;{{{ lua-make-temp-file
(eval-and-compile
(defalias 'lua-make-temp-file
(if (fboundp 'make-temp-file)
'make-temp-file
(lambda (prefix &optional dir-flag) ;; Simple implementation
(expand-file-name
(make-temp-name prefix)
(if (fboundp 'temp-directory)
(temp-directory)
temporary-file-directory))))))
;;}}}
;;{{{ replace-in-string
(eval-and-compile
(if (not (fboundp 'replace-in-string)) ;GNU emacs doesn't have it
(defun replace-in-string (string regexp newtext &optional literal)
(replace-regexp-in-string regexp newtext string nil literal))))
;;}}}
;;{{{ lua-mode
;;;###autoload
(defun lua-mode ()
"Major mode for editing Lua code.
The following keys are bound:
\\{lua-mode-map}
"
(interactive)
(let ((switches nil)
s)
(kill-all-local-variables)
(setq major-mode 'lua-mode)
(setq mode-name "Lua")
(setq comint-prompt-regexp lua-prompt-regexp)
(make-local-variable 'lua-default-command-switches)
(set (make-local-variable 'indent-line-function) 'lua-indent-line)
(set (make-local-variable 'comment-start) "--")
(set (make-local-variable 'comment-start-skip) "--")
(set (make-local-variable 'font-lock-defaults)
'(lua-font-lock-keywords nil nil ((?_ . "w"))))
(set (make-local-variable 'imenu-generic-expression)
lua-imenu-generic-expression)
(setq local-abbrev-table lua-mode-abbrev-table)
(abbrev-mode 1)
(make-local-variable 'lua-default-eval)
(or lua-mode-map
(lua-setup-keymap))
(use-local-map lua-mode-map)
(set-syntax-table (copy-syntax-table))
(modify-syntax-entry ?+ ".")
(modify-syntax-entry ?- ". 12")
(modify-syntax-entry ?* ".")
(modify-syntax-entry ?/ ".")
(modify-syntax-entry ?^ ".")
;; This might be better as punctuation, as for C, but this way you
;; can treat table index as symbol.
(modify-syntax-entry ?. "_") ; e.g. `io.string'
(modify-syntax-entry ?> ".")
(modify-syntax-entry ?< ".")
(modify-syntax-entry ?= ".")
(modify-syntax-entry ?~ ".")
(modify-syntax-entry ?\n ">")
(modify-syntax-entry ?\' "\"")
(modify-syntax-entry ?\" "\"")
;; _ needs to be part of a word, or the regular expressions will
;; incorrectly regognize end_ to be matched by "\\<end\\>"!
(modify-syntax-entry ?_ "w")
(if (and lua-using-xemacs
(featurep 'menubar)
current-menubar
(not (assoc "Lua" current-menubar)))
(progn
(set-buffer-menubar (copy-sequence current-menubar))
(add-menu nil "Lua" lua-xemacs-menu)))
;; Append Lua menu to popup menu for XEmacs.
(if (and lua-using-xemacs (boundp 'mode-popup-menu))
(setq mode-popup-menu
(cons (concat mode-name " Mode Commands") lua-xemacs-menu)))
;; hideshow setup
(unless (assq 'lua-mode hs-special-modes-alist)
(add-to-list 'hs-special-modes-alist
`(lua-mode
,(regexp-opt (mapcar 'car lua-sexp-alist) 'words);start
,(regexp-opt (mapcar 'cdr lua-sexp-alist) 'words) ;end
nil lua-forward-sexp)))
(run-hooks 'lua-mode-hook)))
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.lua$" . lua-mode))
;;}}}
;;{{{ lua-setup-keymap
(defun lua-setup-keymap ()
"Set up keymap for Lua mode.
If the variable `lua-prefix-key' is nil, the bindings go directly
to `lua-mode-map', otherwise they are prefixed with `lua-prefix-key'."
(setq lua-mode-map (make-sparse-keymap))
(define-key lua-mode-map [menu-bar lua-mode]
(cons "Lua" lua-mode-menu))
(define-key lua-mode-map "}" 'lua-electric-match)
(define-key lua-mode-map "]" 'lua-electric-match)
(define-key lua-mode-map ")" 'lua-electric-match)
(let ((map (if lua-prefix-key
(make-sparse-keymap)
lua-mode-map)))
;; communication
(define-key map "\M-[" 'lua-beginning-of-proc)
(define-key map "\M-]" 'lua-end-of-proc)
(define-key map "\C-c" 'comment-region)
(define-key map "\C-l" 'lua-send-buffer)
(define-key map "\C-f" 'lua-search-documentation)
(if lua-prefix-key
(define-key lua-mode-map lua-prefix-key map))
))
;;}}}
;;{{{ lua-electric-match
(defun lua-electric-match (arg)
"Insert character and adjust indentation."
(interactive "P")
(insert-char last-command-char (prefix-numeric-value arg))
(if lua-electric-flag
(lua-indent-line))
(blink-matching-open))
;;}}}
;;{{{ private functions
(defun lua-syntax-status ()
"Returns the syntactic status of the character after the point."
(parse-partial-sexp (save-excursion (beginning-of-line) (point))
(point)))
(defun lua-string-p ()
"Returns true if the point is in a string."
(elt (lua-syntax-status) 3))
(defun lua-comment-p ()
"Returns true if the point is in a comment."
(elt (lua-syntax-status) 4))
(defun lua-comment-or-string-p ()
"Returns true if the point is in a comment or string."
(let ((parse-result (lua-syntax-status)))
(or (elt parse-result 3) (elt parse-result 4))))
;;}}}
;;{{{ lua-indent-line
(defun lua-indent-line ()
"Indent current line for Lua mode.
Return the amount the indentation changed by."
(let ((indent (max 0 (- (lua-calculate-indentation nil)
(lua-calculate-indentation-left-shift))))
beg shift-amt
(case-fold-search nil)
(pos (- (point-max) (point))))
(beginning-of-line)
(setq beg (point))
(skip-chars-forward lua-indent-whitespace)
(setq shift-amt (- indent (current-column)))
(when (not (zerop shift-amt))
(delete-region beg (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)))
shift-amt
indent))
;;}}}
;;{{{ lua-find-regexp
(defun lua-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 'lua-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 (not (funcall ignore-func))
(throw 'found (point)))))))
;;}}}
;;{{{ lua-backwards-to-block-begin-or-end
(defun lua-backwards-to-block-begin-or-end ()
"Move backwards to nearest block begin or end. Returns nil if not successful."
(interactive)
(lua-find-regexp 'backward lua-block-regexp))
;;}}}
;;{{{ var. constants
(defconst lua-block-regexp
(eval-when-compile
;; This is the code we used to generate the regexp:
(concat
"\\(\\<"
(regexp-opt '("do" "function" "repeat" "then"
"else" "elseif" "end" "until") t)
"\\>\\)\\|"
(regexp-opt '("{" "(" "[" "]" ")" "}") t))
))
(defconst lua-block-token-alist
;; The absence of "else" is deliberate. This construct in a way both
;; opens and closes a block. As a result, it is difficult to handle
;; cleanly. It is also ambiguous - if we are looking for the match
;; of "else", should we look backward for "then/elseif" or forward
;; for "end"?
;; Maybe later we will find a way to handle it.
'(("do" "\\<end\\>" open)
("function" "\\<end\\>" open)
("repeat" "\\<until\\>" open)
("then" "\\<\\(e\\(lseif\\|nd\\)\\)\\>" open)
("{" "}" open)
("[" "]" open)
("(" ")" open)
("elseif" "\\<then\\>" close)
("end" "\\<\\(do\\|function\\|then\\)\\>" close)
("until" "\\<repeat\\>" close)
("}" "{" close)
("]" "\\[" close)
(")" "(" close)))
(defconst lua-indentation-modifier-regexp
;; The absence of else is deliberate, since it does not modify the
;; indentation level per se. It only may cause the line, in which the
;; else is, to be shifted to the left.
;; This is the code we used to generate the regexp:
(concat
"\\(\\<"
; n.b. "local function" is a bit of a hack, allowing only a single space
(regexp-opt '("do" "local function" "function" "repeat" "then") t)
"\\>\\|"
(regexp-opt '("{" "(" "["))
"\\)\\|\\(\\<"
(regexp-opt '("elseif" "end" "until") t)
"\\>\\|"
(regexp-opt '("]" ")" "}"))
"\\)")
)
;;}}}
;;{{{ lua-find-matching-token-word
(defun lua-find-matching-token-word (token search-start)
(let* ((token-info (assoc token lua-block-token-alist))
(match (car (cdr token-info)))
(match-type (car (cdr (cdr token-info))))
(search-direction (if (eq match-type 'open) 'forward 'backward)))
;; if we are searching forward from the token at the current point
;; (i.e. for a closing token), need to step one character forward
;; first, or the regexp will match the opening token.
(if (eq match-type 'open) (forward-char 1))
(if search-start (goto-char search-start))
(catch 'found
(while (lua-find-regexp search-direction lua-indentation-modifier-regexp)
;; have we found a valid matching token?
(let ((found-token (match-string 0))
(found-pos (match-beginning 0)))
(if (string-match match found-token)
(throw 'found found-pos))
;; no - then there is a nested block. If we were looking for
;; a block begin token, found-token must be a block end
;; token; likewise, if we were looking for a block end token,
;; found-token must be a block begin token, otherwise there
;; is a grammatical error in the code.
(if (not (and
(eq (car (cdr (cdr (assoc found-token lua-block-token-alist))))
match-type)
(lua-find-matching-token-word found-token nil)))
(throw 'found nil)))))))
;;}}}
;;{{{ lua-goto-matching-block-token
(defun lua-goto-matching-block-token (&optional search-start parse-start)
"Find block begion/end token matching the one at the point.
This function moves the point to the token that matches the one
at the current point. Returns the point position of the first character of
the matching token if successful, nil otherwise."
(if parse-start (goto-char parse-start))
(let ((case-fold-search nil))
(if (looking-at lua-indentation-modifier-regexp)
(let ((position (lua-find-matching-token-word (match-string 0)
search-start)))
(and position
(goto-char position))))))
;; The following may be useful to speed up the search in the future.
; (let ((token-type (char-syntax (string-to-char token-to-match)))
; matching-pos)
; (cond ((eq token-type ?\()
; (setq matching-pos (scan-sexps (point) 1 (current-buffer) t))
; (when matching-pos (goto-char matching-pos)))
; ((eq token-type ?\))
; ;; need to move one char forward, because scan-sexps
; ;; expects the point to be one past the closing parenthesis
; (forward-char 1)
; (setq matching-pos (scan-sexps (point) -1 (current-buffer) t))
; (when matching-pos (goto-char matching-pos)))
; (t
; (lua-goto-matching-token-word token-to-match search-start)))))))
;;}}}
;;{{{ lua-goto-matching-block
(defun lua-goto-matching-block (&optional noreport)
"Go to the keyword balancing the one under the point.
If the point is on a keyword/brace that starts a block, go to the
matching keyword that ends the block, and vice versa."
(interactive)
;; search backward to the beginning of the keyword if necessary
(if (eq (char-syntax (following-char)) ?w)
(re-search-backward "\\<" nil t))
(let ((position (lua-goto-matching-block-token)))
(if (and (not position)
(not noreport))
(error "Not on a block control keyword or brace.")
position)))
;;}}}
;;{{{ lua-goto-nonblank-previous-line
(defun lua-goto-nonblank-previous-line ()
"Puts the point at the first previous line that is not blank.
Returns the point, or nil if it reached the beginning of the buffer"
(catch 'found
(beginning-of-line)
(while t
(if (bobp) (throw 'found nil))
(forward-char -1)
(beginning-of-line)
(if (not (looking-at "\\s *\\(--.*\\)?$")) (throw 'found (point))))))
;;}}}
;;{{{ lua-goto-nonblank-next-line
(defun lua-goto-nonblank-next-line ()
"Puts the point at the first next line that is not blank.
Returns the point, or nil if it reached the end of the buffer"
(catch 'found
(end-of-line)
(while t
(forward-line)
(if (eobp) (throw 'found nil))
(beginning-of-line)
(if (not (looking-at "\\s *\\(--.*\\)?$")) (throw 'found (point))))))
(eval-when-compile
(defconst lua-operator-class
"-+*/^.=<>~"))
;;}}}
;;{{{ var. constans
(defconst lua-cont-eol-regexp
(eval-when-compile
;; expression used to generate the regexp
(concat
"\\(\\<"
(regexp-opt '("and" "or" "not" "in" "for" "while"
"local" "function") t)
"\\>\\|"
"\\(^\\|[^" lua-operator-class "]\\)"
(regexp-opt '("+" "-" "*" "/" "^" ".." "==" "=" "<" ">" "<=" ">=" "~=") t)
"\\)"
"\\s *\\=")
))
(defconst lua-cont-bol-regexp
(eval-when-compile
;; expression used to generate the regexp
(concat
"\\=\\s *"
"\\(\\<"
(regexp-opt '("and" "or" "not") t)
"\\>\\|"
(regexp-opt '("+" "-" "*" "/" "^" ".." "==" "=" "<" ">" "<=" ">=" "~=") t)
"\\($\\|[^" lua-operator-class "]\\)"
"\\)")
))
;;}}}
;;{{{ lua-last-token-continues-p
(defun lua-last-token-continues-p ()
"Returns true if the last token on this line is a continuation token."
(let (line-begin
line-end)
(save-excursion
(beginning-of-line)
(setq line-begin (point))
(end-of-line)
(setq line-end (point))
;; we need to check whether the line ends in a comment and
;; skip that one.
(while (lua-find-regexp 'backward "-" line-begin 'lua-string-p)
(if (looking-at "--")
(setq line-end (point))))
(goto-char line-end)
(re-search-backward lua-cont-eol-regexp line-begin t))))
;;}}}
;;{{{ lua-first-token-continues-p
(defun lua-first-token-continues-p ()
"Returns true if the first token on this line is a continuation token."
(let (line-end)
(save-excursion
(end-of-line)
(setq line-end (point))
(beginning-of-line)
(re-search-forward lua-cont-bol-regexp line-end t))))
;;}}}
;;{{{ lua-is-continuing-statement-p
(defun lua-is-continuing-statement-p (&optional parse-start)
"Return nonnil if the line continues a statement.
More specifically, return the point in the line that is continued.
The criteria for a continuing statement are:
* the last token of the previous line is a continuing op,
OR the first token of the current line is a continuing op
"
(let ((prev-line nil))
(save-excursion
(if parse-start (goto-char parse-start))
(save-excursion (setq prev-line (lua-goto-nonblank-previous-line)))
(and prev-line
(or (lua-first-token-continues-p)
(and (goto-char prev-line)
;; check last token of previous nonblank line
(lua-last-token-continues-p)))))))
;;}}}
;;{{{ lua-make-indentation-info-pair
(defun lua-make-indentation-info-pair ()
"This is a helper function to lua-calculate-indentation-info. Don't
use standalone."
(cond ((string-equal found-token "function")
;; this is the location where we need to start searching for the
;; matching opening token, when we encounter the next closing token.
;; It is primarily an optimization to save some searchingt ime.
(cons 'absolute (+ (save-excursion (goto-char found-pos)
(current-column))
lua-indent-level)))
((or (string-equal found-token "{")
(string-equal found-token "("))
(save-excursion
;; expression follows -> indent at start of next expression
(if (and (not (search-forward-regexp "[[:space:]]--" (line-end-position) t))
(search-forward-regexp "[^[:space:]]" (line-end-position) t))
(cons 'absolute (1- (current-column)))
(cons 'relative lua-indent-level))))
;; closing tokens follow
((string-equal found-token "end")
(save-excursion
(lua-goto-matching-block-token nil found-pos)
(if (looking-at "\\<function\\>")
(cons 'absolute
(+ (current-indentation)
(lua-calculate-indentation-block-modifier
nil (point))))
(cons 'relative (- lua-indent-level)))))
((or (string-equal found-token ")")
(string-equal found-token "}"))
(save-excursion
(lua-goto-matching-block-token nil found-pos)
(cons 'absolute
(+ (current-indentation)
(lua-calculate-indentation-block-modifier
nil (point))))))
(t
(cons 'relative (if (nth 2 (match-data))
;; beginning of a block matched
lua-indent-level
;; end of a block matched
(- lua-indent-level))))))
;;}}}
;;{{{ lua-calculate-indentation-info
(defun lua-calculate-indentation-info (&optional parse-start parse-end)
"For each block token on the line, computes how it affects the indentation.
The effect of each token can be either a shift relative to the current
indentation level, or indentation to some absolute column. This information
is collected in a list of indentation info pairs, which denote absolute
and relative each, and the shift/column to indent to."
(let* ((line-end (save-excursion (end-of-line) (point)))
(search-stop (if parse-end (min parse-end line-end) line-end))
(indentation-info nil))
(if parse-start (goto-char parse-start))
(save-excursion
(beginning-of-line)
(while (lua-find-regexp 'forward lua-indentation-modifier-regexp
search-stop)
(let ((found-token (match-string 0))
(found-pos (match-beginning 0))
(found-end (match-end 0))
(data (match-data)))
(setq indentation-info
(cons (lua-make-indentation-info-pair) indentation-info)))))
indentation-info))
;;}}}
;;{{{ lua-accumulate-indentation-info
(defun lua-accumulate-indentation-info (info)
"Accumulates the indentation information previously calculated by
lua-calculate-indentation-info. Returns either the relative indentation
shift, or the absolute column to indent to."
(let ((info-list (reverse info))
(type 'relative)
(accu 0))
(mapcar (lambda (x)
(setq accu (if (eq 'absolute (car x))
(progn (setq type 'absolute)
(cdr x))
(+ accu (cdr x)))))
info-list)
(cons type accu)))
;;}}}
;;{{{ lua-calculate-indentation-block-modifier
(defun lua-calculate-indentation-block-modifier (&optional parse-start
parse-end)
"Return amount by which this line modifies the indentation.
Beginnings of blocks add lua-indent-level once each, and endings
of blocks subtract lua-indent-level once each. This function is used
to determine how the indentation of the following line relates to this
one."
(if parse-start (goto-char parse-start))
(let ((case-fold-search nil)
(indentation-info (lua-accumulate-indentation-info
(lua-calculate-indentation-info nil parse-end))))
(if (eq (car indentation-info) 'absolute)
(- (cdr indentation-info)
(current-indentation)
;; reduce indentation if this line also starts new continued statement
;; or next line cont. this line
;;This is for aesthetic reasons: the indentation should be
;;dosomething(d +
;; e + f + g)
;;not
;;dosomething(d +
;; e + f + g)"
(save-excursion
(or (and (lua-last-token-continues-p) lua-indent-level)
(and (lua-goto-nonblank-next-line) (lua-first-token-continues-p) lua-indent-level)
0)))
(+ (lua-calculate-indentation-left-shift)
(cdr indentation-info)
(if (lua-is-continuing-statement-p) (- lua-indent-level) 0)))))
;;}}}
;;{{{ constants
(defconst lua-left-shift-regexp-1
(concat "\\("
"\\(\\<" (regexp-opt '("else" "elseif" "until") t)
"\\>\\)\\($\\|\\s +\\)"
"\\)"))
(defconst lua-left-shift-regexp-2
(concat "\\(\\<"
(regexp-opt '("end") t)
"\\>\\)"))
(defconst lua-left-shift-regexp
;; This is the code we used to generate the regexp:
;; ("else", "elseif", "until" followed by whitespace, or "end"/closing
;; brackets followed by
;; whitespace, punctuation, or closing parentheses)
(concat lua-left-shift-regexp-1
"\\|\\(\\("
lua-left-shift-regexp-2
"\\|\\("
(regexp-opt '("]" "}" ")"))
"\\)\\)\\($\\|\\(\\s \\|\\s.\\)*\\)"
"\\)"))
(defconst lua-left-shift-pos-1
2)
(defconst lua-left-shift-pos-2
(+ 3 (regexp-opt-depth lua-left-shift-regexp-1)))
(defconst lua-left-shift-pos-3
(+ lua-left-shift-pos-2
(regexp-opt-depth lua-left-shift-regexp-2)))
;;}}}
;;{{{ lua-calculate-indentation-left-shift
(defun lua-calculate-indentation-left-shift (&optional parse-start)
"Return amount, by which this line should be shifted left.
Look for an uninterrupted sequence of block-closing tokens that starts
at the beginning of the line. For each of these tokens, shift indentation
to the left by the amount specified in lua-indent-level."
(let (line-begin
(indentation-modifier 0)
(case-fold-search nil)
(block-token nil))
(save-excursion
(if parse-start (goto-char parse-start))
(beginning-of-line)
(setq line-begin (point))
;; Look for the block-closing token sequence
(skip-chars-forward lua-indent-whitespace)
(catch 'stop
(while (and (looking-at lua-left-shift-regexp)
(not (lua-comment-or-string-p)))
(let ((last-token (or (match-string lua-left-shift-pos-1)
(match-string lua-left-shift-pos-2)
(match-string lua-left-shift-pos-3))))
(if (not block-token) (setq block-token last-token))
(if (not (string-equal block-token last-token)) (throw 'stop nil))
(setq indentation-modifier (+ indentation-modifier
lua-indent-level))
(forward-char (length (match-string 0))))))
indentation-modifier)))
;;}}}
;;{{{ lua-calculate-indentation
(defun lua-calculate-indentation (&optional parse-start)
"Return appropriate indentation for current line as Lua code.
In usual case returns an integer: the column to indent to."
(let ((pos (point))
shift-amt)
(save-excursion
(if parse-start (setq pos (goto-char parse-start)))
(beginning-of-line)
(setq shift-amt (if (lua-is-continuing-statement-p) lua-indent-level 0))
(if (bobp) ; If we're at the beginning of the buffer, no change.
(+ (current-indentation) shift-amt)
;; This code here searches backwards for a "block beginning/end"
;; It snarfs the indentation of that, plus whatever amount the
;; line was shifted left by, because of block end tokens. It
;; then adds the indentation modifier of that line to obtain the
;; final level of indentation.
;; Finally, if this line continues a statement from the
;; previous line, add another level of indentation.
(if (lua-backwards-to-block-begin-or-end)
;; now we're at the line with block beginning or end.
(max (+ (current-indentation)
(lua-calculate-indentation-block-modifier)
shift-amt)
0)
;; Failed to find a block begin/end.
;; Just use the previous line's indent.
(goto-char pos)
(beginning-of-line)
(forward-line -1)
(+ (current-indentation) shift-amt))))))
;;}}}
;;{{{ lua-beginning-of-proc
(defun lua-beginning-of-proc (&optional arg)
"Move backward to the beginning of a lua proc (or similar).
With argument, do it that many times. Negative arg -N
means move forward to Nth following beginning of proc.
Returns t unless search stops due to beginning or end of buffer."
(interactive "P")
(or arg
(setq arg 1))
(let ((found nil)
(ret t))
(if (and (< arg 0)
(looking-at "^function[ \t]"))
(forward-char 1))
(while (< arg 0)
(if (re-search-forward "^function[ \t]" nil t)
(setq arg (1+ arg)
found t)
(setq ret nil
arg 0)))
(if found
(beginning-of-line))
(while (> arg 0)
(if (re-search-backward "^function[ \t]" nil t)
(setq arg (1- arg))
(setq ret nil
arg 0)))
ret))
;;}}}
;;{{{ lua-end-of-proc
(defun lua-end-of-proc (&optional arg)
"Move forward to next end of lua proc (or similar).
With argument, do it that many times. Negative argument -N means move
back to Nth preceding end of proc.
This function just searches for a `end' at the beginning of a line."
(interactive "P")
(or arg
(setq arg 1))
(let ((found nil)
(ret t))
(if (and (< arg 0)
(not (bolp))
(save-excursion
(beginning-of-line)
(eq (following-char) ?})))