/
pir-mode.el
1185 lines (1054 loc) · 40.5 KB
/
pir-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
;;; pir-mode.el --- pir-mode.el --- editing IMCC source files under Emacs
;;; $Id $
;;; Commentary:
;; This package provides Emacs support for PIR.
;; It defines PIR mode, a major mode for editing PIR code.
;; To begin using this mode for all `.pir' files that you edit,
;; put this file in your `load-path' and add the following lines
;; to your `.emacs' file:
;; (autoload 'pir-mode "pir-mode" nil t)
;; (add-to-list 'auto-mode-alist '("\\.pir\\'" . pir-mode))
;; If you have any problems with this, you're on your own,
;; You could always try asking on parrot-dev@lists.parrot.org.
;;; Code:
(require 'regexp-opt)
(require 'cl)
(unless (fboundp 'line-beginning-position)
(defalias 'line-beginning-position 'point-at-bol))
(unless (fboundp 'line-end-position)
(defalias 'line-end-position 'point-at-eol))
(defgroup pir nil
"Mode for editing PIR code."
:group 'languages)
(defcustom pir-mode-hook nil
"*Hook run when entering PIR mode."
:type 'hook
:group 'pir)
(defcustom pir-comment-char ?#
"*The `comment-start' character assumed by PIR mode."
:type 'character
:group 'pir)
(defcustom pir-comment-column comment-column
"*The default comment column for PIR code."
:type 'integer
:group 'pir)
(defcustom pir-block-comment-start
(concat (make-string 2 pir-comment-char) " ")
"String to insert to start a new PIR comment on an empty line."
:type 'string
:group 'pir)
(defcustom pir-auto-indent-flag nil
"*Non-nil means indent line after a semicolon or space in PIR mode."
:type 'boolean
:group 'pir)
(defcustom pir-auto-newline nil
"*Non-nil means automatically newline after a semicolon in PIR mode."
:type 'boolean
:group 'pir)
(defcustom pir-blink-matching-block t
"*Control the blinkin of matching PIR block keywords.
Non-nil means show matching begin of block when inserting a space,
newline or semicolon after an end keyword."
:type 'boolean
:group 'pir)
(defcustom pir-basic-indent 4
"*Extra indentation applied to statements in PIR block structures."
:type 'integer
:group 'pir)
(defvar pir-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-c;" 'pir-comment-region)
(define-key map "\C-c:" 'pir-uncomment-region)
(define-key map (kbd "C-j") 'newline-and-indent)
(define-key map " " 'pir-electric-space)
(define-key map (kbd ":") 'pir-electric-colon)
(define-key map (kbd "RET") 'pir-reindent-then-newline-and-indent)
(define-key map (kbd "TAB") 'indent-according-to-mode)
(define-key map "\e\t" 'pir-complete-symbol)
(define-key map "\M-\C-a" 'pir-beginning-of-defun)
(define-key map "\M-\C-e" 'pir-end-of-defun)
(define-key map "\M-\C-h" 'pir-end-of-defun)
(define-key map "\M-\C-q" 'pir-indent-defun)
(define-key map "\C-c\C-p" 'pir-previous-code-line)
(define-key map "\C-c\C-n" 'pir-next-code-line)
(define-key map "\C-c\C-a" 'pir-beginning-of-line)
(define-key map "\C-c\C-e" 'pir-end-of-line)
(define-key map "\C-c\M-\C-n" 'pir-forward-block)
(define-key map "\C-c\M-\C-p" 'pir-backward-block)
(define-key map "\C-c\M-\C-u" 'pir-backward-up-block)
(define-key map "\C-c\M-\C-d" 'pir-down-block)
(define-key map "\C-c\M-\C-h" 'pir-mark-block)
(define-key map "\C-c]" 'pir-close-block)
(define-key map "\C-c\C-f" 'pir-insert-defun)
map)
"Keymap for PIR major mode.")
(defvar pir-mode-menu
(list "PIR"
(list "Lines"
["Previous Code Line" pir-previous-code-line t]
["Next Code Line" pir-next-code-line t]
["Begin of Continuation" pir-beginning-of-line t]
["End of Continuation" pir-end-of-line t]
["Split Line at Point" pir-indent-new-comment-line t])
(list "Blocks"
["Next Block" pir-forward-block t]
["Previous Block" pir-backward-block t]
["Down Block" pir-down-block t]
["Up Block" pir-backward-up-block t]
["Mark Block" pir-mark-block t]
["Close Block" pir-close-block t])
(list "Functions"
["Begin of Function" pir-beginning-of-defun t]
["End of Function" pir-end-of-defun t]
["Mark Function" pir-mark-defun t]
["Indent Function" pir-indent-defun t]
["Insert Function" pir-insert-defun t])
"-"
["Indent Line" indent-according-to-mode t]
["Complete Symbol" pir-complete-symbol t]
"-"
["Toggle Abbrev Mode" abbrev-mode t]
"-"
["Describe PIR Mode" pir-describe-major-mode t])
"Menu for PIR mode.")
(defvar pir-mode-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?_ "w" st)
(modify-syntax-entry ?\\ "\\" st)
(modify-syntax-entry ?# "<" st)
(modify-syntax-entry ?\n ">" st)
(modify-syntax-entry ?$ "'" st)
(modify-syntax-entry ?, "." st)
(modify-syntax-entry ?. ". p" st)
st)
"Syntax table for PIR major mode.")
(defvar pir-PMC-keyword-symbols
'("AddrRegistry" "Array" "BigInt" "Boolean" "Bound_NCI" "Capture"
"Class" "Closure" "Compiler" "Complex" "Continuation" "Coroutine"
"Env" "Eval" "Exception" "ExceptionHandler"
"Exporter" "File" "FixedBooleanArray" "FixedFloatArray"
"FixedIntegerArray" "FixedPMCArray" "FixedStringArray" "Float"
"Hash" "Integer" "Iterator" "Key" "LexInfo" "LexPad"
"ManagedStruct" "MultiSub" "NCI" "NameSpace" "Null"
"OS" "Object" "OrderedHash" "PMCProxy" "ParrotClass"
"ParrotIO" "ParrotInterpreter" "ParrotLibrary" "ParrotObject"
"ParrotThread" "Pointer"
"ResizableBooleanArray" "ResizableFloatArray" "ResizableIntegerArray"
"ResizablePMCArray" "ResizableStringArray"
"Role" "Scalar" "String" "Sub" "Super"
"Timer" "UnManagedStruct" "Undef" "VtableCache"))
(defvar pir-ops
'("abs" "accept" "acos" "add" "addattribute" "addmethod" "addparent"
"addrole" "and" "asec" "asin" "assign" "atan"
"band" "bands" "bind" "bnot" "bnots" "bor" "bounds" "branch" "bsr"
"bxor" "bxors" "bytelength"
"callmethod" "callmethodcc" "can" "ceil" "charset" "charsetname" "chopn"
"chr" "class" "classname" "clear_eh" "cleari" "clearn"
"clearp" "clears" "clone" "close" "cmod" "cmp" "collect" "collectoff"
"collecton" "compile" "compose" "compreg" "concat" "connect" "cos" "cosh"
"debug" "dec" "decodelocaltime" "decodetime" "defined" "delete"
"delprop" "depth" "deref" "die" "div" "dlfunc" "dlvar" "does" "downcase"
"elements" "encoding" "encodingname" "entrytype" "eq"
"err" "errorsoff" "errorson" "escape" "exchange" "exists" "exit" "exp"
"fact" "fdiv" "fdopen" "find_cclass" "find_charset" "find_encoding"
"find_lex" "find_method" "find_not_cclass" "find_type" "floor" "freeze"
"gc_debug" "gcd" "ge" "get_addr" "get_class" "get_global" "get_hll_global"
"get_hll_namespace" "get_mro" "get_namespace" "get_params" "get_repr"
"get_results" "get_root_global" "get_root_namespace" "getattribute"
"get_class" "getinterp" "getprop" "getstderr" "getstdin"
"getstdout" "gmtime" "goto" "gt"
"hash"
"if" "if_null" "inc" "index" "infix" "inspect" "interpinfo" "invoke"
"invokecc" "is_cclass" "isa" "iseq" "isfalse" "isge" "isgt" "isle"
"islt" "isne" "isntsame" "isnull" "issame" "istrue"
"join" "jsr" "jump"
"lcm" "le" "length" "listen" "ln" "load_bytecode" "loadlib" "localtime"
"log10" "log2" "lookback" "lsr" "lt"
"find_multi" "add_multi" "mod" "mul"
"n_infix" "ne" "needs_destroy" "neg" "new" "new_callback" "newclass"
"newclosure" "nors" "not" "null"
"open" "or" "ord"
"peek" "pin" "poll" "pop" "popmark" "pow" "print" "printerr"
"profile" "prophash" "push" "push_eh" "pushaction" "pushmark"
"read" "readline" "recv" "register" "removeattribute" "removeparent"
"repeat" "restore" "result_info" "ret" "rethrow" "returncc"
"rot" "rotate_up" "runtinterp"
"save" "savec" "sec" "sech" "seek" "send" "set" "set_addr"
"set_args" "set_global" "set_hll_global" "set_returns" "set_root_global"
"setattribute" "seti_ind" "setn_ind" "setp_ind" "setprop" "setref"
"sets_ind" "setstderr" "shift" "shl" "shr" "sin" "sinh" "sizeof" "sleep"
"sockaddr" "socket" "spawnw" "split" "sprintf" "sqrt" "stat" "store_lex"
"stringinfo" "sub" "subclass" "substr" "sweep" "sweepoff" "sweepon" "sysinfo"
"tailcall" "tailcallmethod" "tan" "tanh" "tell" "thaw" "throw" "time"
"titlecase" "trace" "trans_charset" "trans_encoding" "typeof"
"unless" "unless_null" "unpin" "unregister" "unshift" "upcase"
"warningsoff" "warningson"
"xor"
"yield"))
(defvar pir-mode-abbrev-table nil
"Abbrev table used when in PIR mode.")
(defvar pir-completion-alist nil
"Completion table used for PIR mode.")
(defvar pir-type-keywords
'("int" "num" "pmc" "string"))
(defvar pir-register-regexp "[INPS]\\([12][0-9]\\|3[01]\\|[0-9]\\)")
(defvar pir-dollar-register-regexp "\\$[INPS][0-9]+")
(defvar pir-directives
'(":anon" ":flat" ":init" ":lex" ":subid" ":load" ":main" ":method" ":multi"
":named" ":opt_count" ":opt_flag" ":optional" ":outer" ":postcomp"
":slurpy" ":vtable" ":wrap"))
(defvar pir-dotted-directives
'(".HLL" ".arg" ".const" ".constant" ".emit" ".end" ".endm"
".endnamespace" ".eom" ".get_results" ".global" ".globalconst"
".include" ".invocant" ".lex" ".line" ".loadlib" ".macro"
".namespace" ".nci_call" ".pcc_begin" ".pcc_begin_return"
".pcc_begin_yield" ".pcc_call" ".pcc_end" ".pcc_end_return"
".pcc_end_yield" ".pcc_sub" ".result" ".return" ".sub"
".yield"))
(defvar pir-variable-declarations
'(".local" ".sym" ".param"))
(defvar pir-begin-keywords
'(".sub" ".emit" ".macro" ".begin_yield" ".begin_return"
".begin_call" ".namespace"))
(defvar pir-end-keywords
'(".end" ".eom" ".endm" ".end_yield" ".end_return"
".end_call" ".endnamespace"))
(defvar pir-block-match-alist
'((".sub" ".end" 1)
(".emit" ".eom" 1)
(".macro" ".endm" 1)
(".begin_yield" ".end_yield" 0)
(".begin_return" ".end_return" 0)
(".begin_call" ".end_call" 0)
(".namespace" ".endnamespace" 0))
"Alist of IMCC's matching block keywords.
Has IMCC's begin keywords as keys and a list of the matching end keywords as
associated values.")
(defvar pir-block-offset-alist
(mapcan (lambda (blockspec)
(let ((offset (caddr blockspec)))
`((,(car blockspec) . ,offset)
(,(cadr blockspec) . ,offset))))
pir-block-match-alist))
(defvar pir-open-directives
(mapcar #'car pir-block-match-alist))
(defvar pir-close-directives
(mapcar #'cadr pir-block-match-alist))
(defvar pir-block-begin-regexp
(regexp-opt pir-begin-keywords 'paren))
(defvar pir-block-end-regexp
(regexp-opt pir-end-keywords 'paren))
(defvar pir-block-begin-or-end-regexp
(concat "\\(?:" pir-block-begin-regexp "\\|"
pir-block-end-regexp "\\)"))
(defvar pir-function-header-regexp "\\.\\(.sub\\)\\s-+\\(\\sw+\\)"
"Regexp to match a PIR function header.")
(defvar pir-font-lock-keywords
`((,(concat "^\\s *\\(.sub\\)\\s +\\(\\sw+\\)"
"\\(\\s +" (regexp-opt pir-directives 'paren) "\\)?")
(1 font-lock-keyword-face)
(2 font-lock-function-name-face t t)
(4 font-lock-keyword-face t t))
(,(concat "\\s-*" (regexp-opt pir-variable-declarations 'paren)
"\\(?:\\s +" (regexp-opt pir-type-keywords 'paren)
"\\(?:\\s +\\(\\sw+\\)\\)?\\)?")
(1 font-lock-keyword-face)
(2 font-lock-type-face nil t)
(3 font-lock-variable-name-face nil t))
(,(concat "^\\s *\\(.const\\)\\s +"
(regexp-opt pir-type-keywords 'paren)
"\\(\\s +\\(\\sw+\\)\\)?")
(1 font-lock-keyword-face)
(2 font-lock-type-face nil t)
(4 font-lock-constant-face nil t))
(,pir-block-begin-or-end-regexp . font-lock-keyword-face)
(,pir-dollar-register-regexp . font-lock-variable-name-face)
(,pir-register-regexp . font-lock-variable-name-face)
(,(regexp-opt pir-dotted-directives 'paren) . font-lock-keyword-face)
(,(regexp-opt pir-ops 'words) . font-lock-keyword-face)
("\\s-*\\(\\sw+\\)\\s-*"
(1 font-lock-variable-name-face)))
"Expressions to highlight in PIR mode.")
(defvar pir-imenu-generic-expression
(list
(list nil pir-function-header-regexp 2))
"Imenu expression for PIR mode. See `imenu-generic-expression'.")
(defun pir-comment ()
"Convert an empty comment to a `larger' kind, or start a new one.
These are the known comment classes:
1 -- comment to the right of the code (at the `comment-column')
2 -- comment on its own line, indented like code
3 -- comment on its own line, beginning at the left-most column.
Suggested usage: while writing your code, trigger asm-comment
repeatedly until you are satisfied with the kind of comment."
(interactive)
(comment-normalize-vars)
(let (comempty comment)
(save-excursion
(beginning-of-line)
(setq comment (comment-search-forward (line-end-position) t))
(setq comempty (looking-at "[ \t]*$")))
(cond
;; Blank line, start comment at code indent level.
((save-excursion (beginning-of-line) (looking-at "^[ \t]*$"))
(indent-according-to-mode)
(insert pir-comment-char pir-comment-char ?\ ))
;; Nonblank line w/o comment => start a comment at comment-column
;; Also: point before the comment => jump inside.
((or (null comment) (< (point) comment))
(indent-for-comment))
;; Empty code-level comment => upgrade to next comment level.
((save-excursion (goto-char comment) (skip-chars-backward " \t") (bolp))
(goto-char comment)
(insert pir-comment-char)
(indent-for-comment))
;; Empty comment ends non-empty code line => new comment above.
(t
(goto-char comment)
(skip-chars-backward " \t")
(delete-region (point) (line-end-position))
(beginning-of-line) (insert "\n") (backward-char)
(pir-comment)))))
(defun pir-electric-colon ()
"Automatically indent labels as soon as the colon is added."
(interactive)
(let ((labelp nil))
(save-excursion
(skip-syntax-backward "w_")
(skip-syntax-backward " ")
(if (setq labelp (bolp)) (delete-horizontal-space)))
(call-interactively 'self-insert-command)
(when labelp
(delete-horizontal-space)
(tab-to-tab-stop))))
(defmacro setlocalq (sym val)
"Localize SYM and set it to the value of VAL."
`(set (make-local-variable (quote ,sym)) ,val))
(defun pir-mode ()
"Major mode for editing PIR files.
This mode makes it easier to write PIR code by helping with
indentation, doing some of the typing for you (with Abbrev mode) and by
showing keywords, comments, strings etc. in different faces (with Font
Lock mode on terminals that support it).
PIR (Parrot Intermediate Representation) is a friendlier way of
programming parrot than raw PASM (Parrot Assembly). In general,
compilers (and certainly humans) should code in PIR and let Parrot
handle register allocation and all that good stuff.
To find out more, hie thee to `http://www.parrot.org/'.
Type \\[list-abbrevs] to display the built in abbrevs for PIR
keywords. (When I've set them up.)
Keybindings
===========
\\{pir-mode-map}
Variables you can use to customize PIR mode
===========================================
pir-auto-indent
Non-nil means indent current line after a space.
Default is nil.
pir-blink-matching-block
Non-nil means show matching begin of block when inserting a space or
newline after the end of a block. Default is t.
pir-basic-indent
PIR mode's basic level of indentation. Default is 8.
Turning on PIR mode runs the hook `pir-mode-hook'.
To begin using this mode for all `.pir' files that you edit, add the
following lines to your `.emacs' file:
(autoload 'pir-mode \"pir-mode\" nil t)
(add-to-list 'auto-mode-alist '(\"\\\\.pir\\\\'\" . pir-mode))
If you have any problems with this, you're on your own. You could always
try asking on parrot-dev@lists.parrot.org."
(interactive)
(kill-all-local-variables)
(use-local-map pir-mode-map)
(setq major-mode 'pir-mode)
(setq mode-name "PIR")
(set-syntax-table pir-mode-syntax-table)
(setlocalq font-lock-defaults '(pir-font-lock-keywords))
(setlocalq indent-line-function 'pir-indent-line)
(setlocalq pir-basic-indent pir-basic-indent)
(setlocalq require-final-newline t)
(setlocalq comment-start "# ")
(setlocalq comment-end "")
(setlocalq comment-column pir-comment-column)
(setlocalq comment-start-skip "#+ *")
(setlocalq comment-indent-function 'pir-comment-indent)
(setlocalq parse-sexp-ignore-comments t)
(setlocalq paragraph-start (concat "\\s-*$\\|" page-delimiter))
(setlocalq paragraph-separate paragraph-start)
(setlocalq paragraph-ignore-fill-prefix t)
(setlocalq fill-paragraph-function 'pir-fill-paragraph)
(setlocalq adaptive-fill-regexp nil)
(setlocalq fill-column 72)
(setlocalq imenu-generic-expression pir-imenu-generic-expression)
(setq imenu-case-fold-search nil)
(setlocalq defun-prompt-regexp "^\\s_*\\.\\(sub\\|emit\\)\\s_+")
(pir-initialize-completions)
(pir-add-pir-menu)
(run-hooks 'pir-mode-hook))
(defun pir-describe-major-mode ()
"Describe the current major mode."
(interactive)
(describe-function major-mode))
(defsubst pir-in-comment-p ()
"Return t if point is inside a PIR comment, nil otherwise."
(interactive)
(save-excursion
(nth 4 (parse-partial-sexp (line-beginning-position) (point)))))
(defsubst pir-in-string-p ()
"Return t if point is inside a PIR string, nil otherwise."
(interactive)
(save-excursion
(nth 3 (parse-partial-sexp (line-beginning-position) (point)))))
(defsubst pir-not-in-string-or-comment-p ()
"Return t iff point is not inside a PIR string or comment."
(let ((pps (parse-partial-sexp (line-beginning-position) (point))))
(not (or (nth 3 pps) (nth 4 pps)))))
(defun pir-in-block-p ()
"Return t if point is inside a PIR block, nil otherwise.
The block is taken to start at the first letter of the begin keyword and
to end after the end keyword."
(let ((pos (point)))
(save-excursion
(condition-case nil
(progn
(skip-syntax-forward "w")
(pir-up-block -1)
(pir-forward-block)
t)
(error nil))
(< pos (point)))))
(defun pir-in-defun-p ()
"Return t iff point is inside a PIR function declaration.
The function is taken to start at the `.' of `.sub' and to end after
the `.end' keyword."
(let ((pos (point)))
(save-excursion
(or (and (looking-at "\\<.sub\\>")
(pir-not-in-string-or-comment-p))
(and (pir-beginning-of-defun)
(condition-case nil
(progn
(pir-forward-block)
t)
(error nil))
(< pos (point)))))))
;;; Comments
(defun pir-comment-region (beg end &optional arg)
"Comment or uncomment each line in the region as PIR code.
See `comment-region'."
(interactive "r\nP")
(let ((comment-start (char-to-string pir-comment-char)))
(comment-region beg end arg)))
(defun pir-uncomment-region (beg end &optional arg)
"Uncomment each line in the region as PIR code."
(interactive "r\nP")
(or arg (setq arg 1))
(pir-comment-region beg end (- arg)))
;;; Indentation
(defun calculate-pir-indent (&optional ignore-labelp)
"Calculate the correct indentation for a line of PIR code.
Optional argument IGNORE-LABELP if set, labels are ignored for the purposes of calculating the indent."
(let ((icol 0))
(save-excursion
(beginning-of-line)
(cond ((condition-case nil
(progn (up-list -1)
t)
(error nil))
(setq icol (1+ (current-column))))
((and (not ignore-labelp)
(looking-at "\\s-*\\sw+:"))
(setq icol 0))
((zerop (pir-previous-code-line))
(let ((labelp (looking-at "\\s-*\\sw+:")))
(pir-beginning-of-line)
(back-to-indentation)
(setq icol (current-column))
(let ((bot (point))
(eol (line-end-position)))
(while (< (point) eol)
(if (pir-not-in-string-or-comment-p)
(cond
((looking-at pir-block-begin-regexp)
(setq icol (+ icol
(pir-block-offset (match-string 1)))))
((looking-at pir-block-end-regexp)
(if (not (= bot (point)))
(setq icol (- icol
(pir-block-offset
(match-string 1))))))))
(forward-char))
(if (and labelp
(= 0 icol))
(setq icol (calculate-pir-indent 'ignore-label)))
)))))
(save-excursion
(back-to-indentation)
(cond
((and (looking-at pir-block-end-regexp)
(pir-not-in-string-or-comment-p))
(looking-at pir-block-end-regexp)
(setq icol (- icol (pir-block-offset (match-string 1)))))
((or (looking-at "\\s<\\s<\\s<\\S<")
(pir-before-magic-comment-p))
(setq icol (list 0 icol)))
((looking-at "\\s<\\S<")
(setq icol (list comment-column icol)))))
icol))
(defun pir-block-offset (string)
(* pir-basic-indent
(cdr (assoc string pir-block-offset-alist))))
(defun pir-before-magic-comment-p ()
"Return t if point is before the shebang."
(save-excursion
(beginning-of-line)
(and (bobp) (looking-at "\\s-*#!"))))
(defun pir-comment-indent ()
"Calculate the correct comment indent."
(if (or (looking-at "\\s<\\s<\\s<")
(pir-before-magic-comment-p))
0
(if (looking-at "\\<\\<")
(calculate-pir-indent)
(skip-syntax-backward " ")
(max (if (bolp) 0 (1+ (current-column)))
comment-column))))
(defun pir-indent-for-comment ()
"Maybe insert and indent a PIR comment.
If there is no comment already on this line, create a code-level comment
\(started by two comment characters) if the line is empty, or an in-line
comment (started by one comment character) otherwise.
Point is left after the start of the comment which is properly aligned."
(interactive)
(indent-for-comment)
(indent-according-to-mode))
(defun pir-indent-line (&optional arg)
"Indent current line as PIR code.
With optional ARG, use this as offset unless this line is a comment with
fixed goal column."
(interactive)
(or arg (setq arg 0))
(let ((icol (calculate-pir-indent))
(relpos (- (current-column) (current-indentation))))
(if (listp icol)
(setq icol (car icol))
(setq icol (+ icol arg)))
(if (< icol 0)
(error "Unmatched end keyword")
(indent-line-to icol)
(if (> relpos 0)
(move-to-column (+ icol relpos))))))
(defun pir-indent-new-comment-line ()
"Break PIR line at point, continuing comment if within one.
If within code, insert `pir-continuation-string' before breaking the
line. If within a string, signal an error.
The new line is properly indented."
(interactive)
(delete-horizontal-space)
(cond
((pir-in-comment-p)
(indent-new-comment-line))
(t
(error "Don't know how to split this code line"))))
(defun pir-indent-defun ()
"Properly indent the PIR function which contains point."
(interactive)
(save-excursion
(pir-mark-defun)
(message "Indenting function...")
(indent-region (point) (mark) nil))
(message "Indenting function...done."))
;;; Motion
(defun pir-next-code-line (&optional arg)
"Move ARG lines of PIR code forward (backward if ARG is negative).
Skips past all empty and comment lines. Default for ARG is 1.
On success, return 0. Otherwise, go as far as possible and return -1."
(interactive "p")
(or arg (setq arg 1))
(beginning-of-line)
(let ((n 0)
(inc (if (> arg 0) 1 -1)))
(while (and (/= arg 0) (= n 0))
(setq n (forward-line inc))
(while (and (= n 0)
(looking-at "\\s-*\\($\\|\\s<\\)"))
(setq n (forward-line inc)))
(setq arg (- arg inc)))
n))
(defun pir-previous-code-line (&optional arg)
"Move ARG lines of PIR code backward (forward if ARG is negative).
Skips past all empty and comment lines. Default for ARG is 1.
On success, return 0. Otherwise, go as far as possible and return -1."
(interactive "p")
(or arg (setq arg 1))
(pir-next-code-line (- arg)))
(defun pir-beginning-of-line ()
"Move point to beginning of current PIR line.
If on an empty or comment line, go to the beginning of that line."
(interactive)
(beginning-of-line)
(if (not (looking-at "\\s-*\\($\\|\\s<\\)"))
(while (or (condition-case nil
(progn
(up-list -1)
(beginning-of-line)
t)
(error nil))
(and (looking-at "\\s-*\\($\\|\\s<\\)")
(zerop (forward-line -1)))))))
(defun pir-end-of-line ()
"Move point to end of current PIR line.
If on an empty or comment line, go to the end of that line.
Otherwise, move forward to the end of the first PIR code line which
does not end in `...' or `\\' or is inside an open parenthesis list."
(interactive)
(end-of-line)
(if (save-excursion
(beginning-of-line)
(looking-at "\\s-*\\($\\|\\s<\\)"))
()
(while (or (condition-case nil
(progn
(up-list 1)
(end-of-line)
t)
(error nil))
(and (save-excursion
(beginning-of-line)
(looking-at "\\s-*\\($\\|\\s<\\)"))
(zerop (forward-line 1)))))
(end-of-line)))
(defun pir-scan-blocks (from count depth)
"Scan from character number FROM by COUNT PIR begin-end blocks.
Returns the character number of the position thus found.
If DEPTH is nonzero, block depth begins counting from that value.
Only places where the depth in blocks becomes zero are candidates for
stopping; COUNT such places are counted.
If the beginning or end of the buffer is reached and the depth is wrong,
an error is signaled."
(let ((min-depth (if (> depth 0) 0 depth))
(inc (if (> count 0) 1 -1)))
(save-excursion
(while (/= count 0)
(catch 'foo
(while (or (re-search-forward
pir-block-begin-or-end-regexp nil 'move inc)
(if (/= depth 0)
(error "Unbalanced block")))
(if (pir-not-in-string-or-comment-p)
(progn
(cond
((match-end 1)
(setq depth (+ depth inc)))
((match-end 2)
(setq depth (- depth inc))))
(if (< depth min-depth)
(error "Containing expression ends prematurely"))
(if (= depth 0)
(throw 'foo nil))))))
(setq count (- count inc)))
(point))))
(defun pir-forward-block (&optional arg)
"Move forward across one balanced PIR begin-end block.
With argument, do it that many times.
Negative arg -ARG means move backward across ARG blocks."
(interactive "p")
(or arg (setq arg 1))
(goto-char (or (pir-scan-blocks (point) arg 0) (buffer-end arg))))
(defun pir-backward-block (&optional arg)
"Move backward across one balanced PIR begin-end block.
With argument, do it that many times.
Negative arg -ARG means move forward across ARG blocks."
(interactive "p")
(or arg (setq arg 1))
(pir-forward-block (- arg)))
(defun pir-down-block (arg)
"Move forward down one begin-end block level of PIR code.
With ARG, do this that many times.
A negative ARG means move backward but still go down a level.
In Lisp programs, an argument is required."
(interactive "p")
(let ((inc (if (> arg 0) 1 -1)))
(while (/= arg 0)
(goto-char (or (pir-scan-blocks (point) inc -1)
(buffer-end arg)))
(setq arg (- arg inc)))))
(defun pir-backward-up-block (arg)
"Move backward out of one begin-end block level of PIR code.
With ARG, do this that many times.
A negative ARG means move forward but still to a less deep spot.
In Lisp programs, an argument is required."
(interactive "p")
(pir-up-block (- arg)))
(defun pir-up-block (arg)
"Move forward out of one begin-end block level of PIR code.
With ARG, do this that many times.
A negative ARG means move backward but still to a less deep spot.
In Lisp programs, an argument is required."
(interactive "p")
(let ((inc (if (> arg 0) 1 -1)))
(while (/= arg 0)
(goto-char (or (pir-scan-blocks (point) inc 1)
(buffer-end arg)))
(setq arg (- arg inc)))))
(defun pir-mark-block ()
"Put point at the beginning of this PIR block, mark at the end.
The block marked is the one that contains point or follows point."
(interactive)
(let ((pos (point)))
(if (or (and (pir-in-block-p)
(skip-syntax-forward "w"))
(condition-case nil
(progn
(pir-down-block 1)
(pir-in-block-p))
(error nil)))
(progn
(pir-up-block -1)
(push-mark (point))
(pir-forward-block)
(exchange-point-and-mark))
(goto-char pos)
(message "No block to mark found"))))
(defun pir-close-block ()
"Close the current PIR block on a separate line.
An error is signaled if no block to close is found."
(interactive)
(let (bb-keyword)
(condition-case nil
(progn
(save-excursion
(pir-backward-up-block 1)
(setq bb-keyword (buffer-substring-no-properties
(match-beginning 1) (match-end 1))))
(if (save-excursion
(beginning-of-line)
(looking-at "^\\s-*$"))
(indent-according-to-mode)
(pir-reindent-then-newline-and-indent))
(insert (cadr (assoc bb-keyword
pir-block-match-alist)))
(pir-reindent-then-newline-and-indent)
t)
(error (message "No block to close found")))))
(defun pir-blink-matching-block-open ()
"Blink the matching PIR begin block keyword.
If point is right after a PIR else or end type block keyword, move
cursor momentarily to the corresponding begin keyword.
Signal an error if the keywords are incompatible."
(interactive)
(let (bb-keyword bb-arg eb-keyword pos eol)
(if (and (pir-not-in-string-or-comment-p)
(looking-at "\\>")
(save-excursion
(skip-syntax-backward "w_.")
(looking-at pir-block-end-regexp)))
(save-excursion
(setq eb-keyword
(buffer-substring-no-properties
(match-beginning 1) (match-end 1)))
(pir-backward-block)
(setq pos (match-end 1)
bb-keyword
(buffer-substring-no-properties
(match-beginning 1) pos)
pos (+ pos 1)
eol (line-end-position))
(if (member eb-keyword
(cdr (assoc bb-keyword pir-block-match-alist)))
(progn
(message "Matches `.%s'" bb-keyword)
(if (pos-visible-in-window-p)
(sit-for blink-matching-delay)))
(error "Block keywords `%s' and `%s' do not match"
bb-keyword eb-keyword))))))
(defun pir-beginning-of-defun (&optional arg)
"Move backward to the beginning of a PIR function.
With positive ARG, do it that many times. Negative argument -N means
move forward to Nth following beginning of a function.
Returns t unless search stops at the beginning or end of the buffer."
(interactive "p")
(let* ((arg (or arg 1))
(inc (if (> arg 0) 1 -1))
(found))
(and (not (eobp))
(not (and (> arg 0) (looking-at "\\<function\\>")))
(skip-syntax-forward "w"))
(while (and (/= arg 0)
(setq found
(re-search-backward "\\<function\\>" nil 'move inc)))
(if (pir-not-in-string-or-comment-p)
(setq arg (- arg inc))))
(if found
(progn
(and (< inc 0) (goto-char (match-beginning 0)))
t))))
(defun pir-end-of-defun (&optional arg)
"Move forward to the end of a PIR function.
With positive ARG, do it that many times. Negative argument -N means
move back to Nth preceding end of a function.
An end of a function occurs right after the end keyword matching the
`function' keyword that starts the function."
(interactive "p")
(or arg (setq arg 1))
(and (< arg 0) (skip-syntax-backward "w"))
(and (> arg 0) (skip-syntax-forward "w"))
(if (pir-in-defun-p)
(setq arg (- arg 1)))
(if (= arg 0) (setq arg -1))
(if (pir-beginning-of-defun (- arg))
(pir-forward-block)))
(defun pir-mark-defun ()
"Put point at the beginning of this PIR function, mark at its end.
The function marked is the one containing point or following point."
(interactive)
(let ((pos (point)))
(if (or (pir-in-defun-p)
(and (pir-beginning-of-defun -1)
(pir-in-defun-p)))
(progn
(skip-syntax-forward "w")
(pir-beginning-of-defun)
(push-mark (point))
(pir-end-of-defun)
(exchange-point-and-mark))
(goto-char pos)
(message "No function to mark found"))))
;;; Filling
(defun pir-fill-paragraph (&optional arg)
"Fill paragraph of PIR code, handling PIR comments.
Optional argument ARG appears to be ignored. Um..."
(interactive "P")
(save-excursion
(let ((end (progn (forward-paragraph) (point)))
(beg (progn
(forward-paragraph -1)
(skip-chars-forward " \t\n")
(beginning-of-line)
(point)))
(cfc (current-fill-column))
(ind (calculate-pir-indent))
comment-prefix)
(save-restriction
(goto-char beg)
(narrow-to-region beg end)
(if (listp ind) (setq ind (nth 1 ind)))
(while (not (eobp))
(condition-case nil
(pir-indent-line ind)
(error nil))
(if (and (> ind 0)
(not
(save-excursion
(beginning-of-line)
(looking-at "^\\s-*\\($\\|\\s<+\\)"))))
(setq ind 0))
(move-to-column cfc)
;; First check whether we need to combine non-empty comment lines
(if (and (< (current-column) cfc)
(pir-in-comment-p)
(not (save-excursion
(beginning-of-line)
(looking-at "^\\s-*\\s<+\\s-*$"))))
;; This is a nonempty comment line which does not extend
;; past the fill column. If it is followed by a nonempty
;; comment line with the same comment prefix, try to
;; combine them, and repeat this until either we reach the
;; fill-column or there is nothing more to combine.
(progn
;; Get the comment prefix
(save-excursion
(beginning-of-line)
(while (and (re-search-forward "\\s<+")
(not (pir-in-comment-p))))
(setq comment-prefix (match-string 0)))
;; And keep combining ...
(while (and (< (current-column) cfc)
(save-excursion
(forward-line 1)
(and (looking-at
(concat "^\\s-*"
comment-prefix
"\\S<"))
(not (looking-at
(concat "^\\s-*"
comment-prefix
"\\s-*$"))))))
(delete-char 1)
(re-search-forward comment-prefix)
(delete-region (match-beginning 0) (match-end 0))
(fixup-whitespace)
(move-to-column cfc))))
;; We might also try to combine continued code lines> Perhaps
;; some other time ...