1 6c5ab754 2021-11-07 op ;;; a68-mode.el --- Major mode for editing Algol 68 code -*- lexical-binding: t; -*-
  2 364d8905 2021-11-07 op 
  3 364d8905 2021-11-07 op ;; Copyright (C) 2011 Jose E. Marchesi
  4 364d8905 2021-11-07 op ;; Copyright (C) 2021 Omar Polo <op@omarpolo.com>
  5 364d8905 2021-11-07 op 
  6 364d8905 2021-11-07 op ;; Author: Jose E. Marchesi
  7 364d8905 2021-11-07 op ;;         Omar Polo <op@omarpolo.com>
  8 364d8905 2021-11-07 op ;; Maintainer: Omar Polo
  9 364d8905 2021-11-07 op ;; URL: https://git.omarpolo.com/a68-mode
 10 364d8905 2021-11-07 op ;; Keywords: languages
 11 364d8905 2021-11-07 op ;; Version: 0
 12 364d8905 2021-11-07 op ;; Package-Requires: ((emacs "24.3"))
 13 364d8905 2021-11-07 op 
 14 364d8905 2021-11-07 op ;; This file is NOT part of GNU Emacs.
 15 364d8905 2021-11-07 op 
 16 364d8905 2021-11-07 op ;; This program is free software; you can redistribute it and/or modify
 17 364d8905 2021-11-07 op ;; it under the terms of the GNU General Public License as published by
 18 364d8905 2021-11-07 op ;; the Free Software Foundation; either version 3, or (at your option)
 19 364d8905 2021-11-07 op ;; any later version.
 20 364d8905 2021-11-07 op 
 21 364d8905 2021-11-07 op ;; This program is distributed in the hope that it will be useful,
 22 364d8905 2021-11-07 op ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 23 364d8905 2021-11-07 op ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 24 364d8905 2021-11-07 op ;; GNU General Public License for more details.
 25 364d8905 2021-11-07 op 
 26 364d8905 2021-11-07 op ;; You should have received a copy of the GNU General Public License
 27 364d8905 2021-11-07 op ;; along with this program; see the file COPYING.  If not, write to the
 28 364d8905 2021-11-07 op ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 29 364d8905 2021-11-07 op ;; Boston, MA 02110-1301, USA.
 30 364d8905 2021-11-07 op 
 31 364d8905 2021-11-07 op ;;; Commentary:
 32 364d8905 2021-11-07 op 
 33 364d8905 2021-11-07 op ;; A major mode for editing Algol 68 code.
 34 364d8905 2021-11-07 op ;;
 35 bb4b3a62 2021-11-07 op ;; This is an improved and modernized version of the a68-mode written
 36 bb4b3a62 2021-11-07 op ;; by Jose E. Marchesi.  The original code was taken from
 37 bb4b3a62 2021-11-07 op ;;
 38 bb4b3a62 2021-11-07 op ;; https://github.com/lachrymology/me/blob/master/.emacs.d/extras/algol-mode.el
 39 bb4b3a62 2021-11-07 op ;;
 40 364d8905 2021-11-07 op ;; TODO: support quote and dot stropping.
 41 364d8905 2021-11-07 op 
 42 364d8905 2021-11-07 op ;;; Code:
 43 364d8905 2021-11-07 op 
 44 364d8905 2021-11-07 op (require 'font-lock)
 45 61b0b383 2021-11-08 op (require 'smie)
 46 61b0b383 2021-11-08 op (require 'syntax)
 47 364d8905 2021-11-07 op 
 48 364d8905 2021-11-07 op (eval-when-compile
 49 364d8905 2021-11-07 op   (require 'rx))
 50 364d8905 2021-11-07 op 
 51 caaad6ea 2021-11-07 op (defgroup a68 nil
 52 caaad6ea 2021-11-07 op   "Major mode for editing Algol68 code."
 53 caaad6ea 2021-11-07 op   :prefix "a68-"
 54 caaad6ea 2021-11-07 op   :group 'languages)
 55 364d8905 2021-11-07 op 
 56 caaad6ea 2021-11-07 op (defcustom a68-indent-level 3
 57 caaad6ea 2021-11-07 op   "Indentation step for Algol 68."
 58 caaad6ea 2021-11-07 op   :type 'integer
 59 caaad6ea 2021-11-07 op   :safe #'integerp)
 60 caaad6ea 2021-11-07 op 
 61 18be0e13 2021-11-07 op (defcustom a68-comment-style "#"
 62 29b924fd 2021-11-07 op   "Default comment style used by e.g. `comment-dwim'."
 63 18be0e13 2021-11-07 op   :type '(choice (const "#")
 64 18be0e13 2021-11-07 op                  (const "CO")
 65 18be0e13 2021-11-07 op                  (const "COMMENT"))
 66 29b924fd 2021-11-07 op   :safe #'consp)
 67 29b924fd 2021-11-07 op 
 68 364d8905 2021-11-07 op (defvar a68-mode-hook '()
 69 364d8905 2021-11-07 op   "Hook run when entering Algol68 mode.")
 70 364d8905 2021-11-07 op 
 71 364d8905 2021-11-07 op (defvar a68-mode-map
 72 8cd9fb9c 2021-11-07 op   (let ((map (make-sparse-keymap)))
 73 364d8905 2021-11-07 op     (define-key map (kbd "C-j") #'newline-and-indent)
 74 61b0b383 2021-11-08 op     ;; (define-key map (kbd "RET") #'a68-electric-terminate-line)
 75 364d8905 2021-11-07 op     map)
 76 364d8905 2021-11-07 op   "Keymap for Algol 68 major mode.")
 77 364d8905 2021-11-07 op 
 78 364d8905 2021-11-07 op (defconst a68-font-lock-keywords
 79 364d8905 2021-11-07 op   (list
 80 364d8905 2021-11-07 op    (cons (rx word-start
 81 364d8905 2021-11-07 op              (or "DECS" "PROGRAM" "CONTEXT" "USE" "FINISH" "KEEP"
 82 364d8905 2021-11-07 op                  "ALIEN"
 83 364d8905 2021-11-07 op                  "MODE" "OP" "PRIO" "PROC"
 84 364d8905 2021-11-07 op                  "OF" "AT" "IS" "ISNT" "EMPTY" "SKIP"
 85 364d8905 2021-11-07 op                  "PR" "PRAGMAT"
 86 364d8905 2021-11-07 op                  "CASE" "IN" "OUSE" "OUT" "ESAC"
 87 364d8905 2021-11-07 op                  "FOR" "FORALL" "FROM" "TO" "BY" "WHILE" "DO" "OD"
 88 364d8905 2021-11-07 op                  "IF" "THEN" "ELIF" "THEN" "ELSE" "FI"
 89 364d8905 2021-11-07 op                  "PAR" "BEGIN" "END" "GOTO" "EXIT"
 90 364d8905 2021-11-07 op                  "LWB" "UPB" "NOT" "ABS" "BIN" "REPR" "LENG"
 91 364d8905 2021-11-07 op                  "SHORTEN" "ODD" "SIGN" "ROUND" "ENTIER" "AND" "OR"
 92 364d8905 2021-11-07 op                  "DIV" "OVER" "MOD" "ELEM" "SHL" "SHR" "OVERAB" "DIVAB" "MODAB"
 93 364d8905 2021-11-07 op                  "REF")
 94 364d8905 2021-11-07 op              word-end)
 95 364d8905 2021-11-07 op          'font-lock-keyword-face)
 96 364d8905 2021-11-07 op    (cons (rx word-start
 97 364d8905 2021-11-07 op              (or "TRUE" "FALSE")
 98 364d8905 2021-11-07 op              word-end)
 99 364d8905 2021-11-07 op          'font-lock-constant-face)
100 364d8905 2021-11-07 op    ;; only valid for bold stropping
101 364d8905 2021-11-07 op    (cons (concat "\\<[A-Z]+\\>") 'font-lock-type-face)
102 364d8905 2021-11-07 op    (cons "\\('\\w*'\\)"
103 364d8905 2021-11-07 op          'font-lock-variable-name-face))
104 364d8905 2021-11-07 op   "Highlighting expressions for Algol 68 mode.")
105 364d8905 2021-11-07 op 
106 61b0b383 2021-11-08 op (defvar a68--keywords-regexp
107 b18a7d7e 2021-11-08 op   (regexp-opt '("+" "*" ";" ">" "<" ":=" "=" "," ":")))
108 364d8905 2021-11-07 op 
109 61b0b383 2021-11-08 op (defvar a68--smie-grammar
110 61b0b383 2021-11-08 op   (smie-prec2->grammar
111 61b0b383 2021-11-08 op    (smie-bnf->prec2 '((id)
112 d3cc027d 2021-11-08 op                       (expr ("-" expr)
113 d3cc027d 2021-11-08 op                             (expr "+" expr)
114 d3cc027d 2021-11-08 op                             (expr "*" expr)
115 d3cc027d 2021-11-08 op                             (expr "/" expr)
116 d3cc027d 2021-11-08 op                             (expr "=" expr)
117 d3cc027d 2021-11-08 op                             (expr "/=" expr)
118 d3cc027d 2021-11-08 op                             (expr ":=" expr)
119 d3cc027d 2021-11-08 op                             (expr ":=:" expr)
120 d3cc027d 2021-11-08 op                             (expr ":/=:" expr)
121 d3cc027d 2021-11-08 op                             ("BEGIN" exprs "END")
122 d3cc027d 2021-11-08 op                             ("(" exprs ")")
123 f6f819c9 2021-11-09 op                             ;; why all the repetitions?  copied from
124 f6f819c9 2021-11-09 op                             ;; sh-script.el
125 d3cc027d 2021-11-08 op                             ("IF" exprs "THEN" exprs "FI")
126 d3cc027d 2021-11-08 op                             ("IF" exprs "THEN" exprs "ELSE" exprs "FI")
127 f6f819c9 2021-11-09 op                             ("IF" exprs "THEN" exprs
128 f6f819c9 2021-11-09 op                              "ELIF" exprs "THEN" exprs "FI")
129 f6f819c9 2021-11-09 op                             ("IF" exprs "THEN" exprs
130 f6f819c9 2021-11-09 op                              "ELIF" exprs "THEN" exprs
131 f6f819c9 2021-11-09 op                              "ELSE" exprs "FI")
132 f6f819c9 2021-11-09 op                             ("IF" exprs "THEN" exprs
133 f6f819c9 2021-11-09 op                              "ELIF" exprs "THEN" exprs
134 f6f819c9 2021-11-09 op                              "ELIF" exprs "THEN" exprs
135 f6f819c9 2021-11-09 op                              "ELSE" exprs "FI")
136 d3cc027d 2021-11-08 op                             ("CASE" exprs "IN" exprs "ESAC")
137 d3cc027d 2021-11-08 op                             ("CASE" exprs "IN" exprs "OUT" exprs "ESAC"))
138 d3cc027d 2021-11-08 op                       (exprs (exprs "," exprs)
139 d3cc027d 2021-11-08 op                              (exprs ";" exprs)
140 b18a7d7e 2021-11-08 op                              (exprs ":" exprs)
141 6170a32c 2021-11-08 op                              (expr))
142 6170a32c 2021-11-08 op                       (loop ("FOR" exprs "FROM" exprs "TO" exprs
143 6170a32c 2021-11-08 op                              "BY" exprs "DO" exprs "OD")
144 6170a32c 2021-11-08 op                             ("FOR" exprs "FROM" exprs "TO" exprs
145 6170a32c 2021-11-08 op                              "DO" exprs "OD")
146 6170a32c 2021-11-08 op                             ("FOR" exprs "BY" exprs "TO" exprs
147 6170a32c 2021-11-08 op                              "DO" exprs "OD")
148 6170a32c 2021-11-08 op                             ;; ("TO" exprs "DO" exprs "OD")
149 6170a32c 2021-11-08 op                             ("WHILE" exprs "DO" exprs "OD")))
150 b18a7d7e 2021-11-08 op                     '((assoc ";" "," ":"))
151 d3cc027d 2021-11-08 op                     '((assoc "=" "/=" ":=" ":=:" ":/=:"
152 d3cc027d 2021-11-08 op                              "+" "-" "*" "/")))))
153 364d8905 2021-11-07 op 
154 61b0b383 2021-11-08 op (defun a68--smie-rules (kind token)
155 61b0b383 2021-11-08 op   (pcase (cons kind token)
156 61b0b383 2021-11-08 op     (`(:elem . basic) a68-indent-level)
157 61b0b383 2021-11-08 op     ;; (`(,_ . ",") (smie-rule-separator kind))
158 61b0b383 2021-11-08 op     (`(,_ . ",") (smie-rule-separator kind))
159 61b0b383 2021-11-08 op     (`(,_ . ";") (when (smie-rule-parent-p)
160 61b0b383 2021-11-08 op                    (smie-rule-parent)))
161 61b0b383 2021-11-08 op     (`(:after . ":=") a68-indent-level)
162 61b0b383 2021-11-08 op     (`(:after . "=") a68-indent-level)
163 61b0b383 2021-11-08 op     (`(:before . ,(or `"BEGIN" '"(")) (when (smie-rule-hanging-p)
164 61b0b383 2021-11-08 op                                         (smie-rule-parent)))
165 61b0b383 2021-11-08 op     (`(:before . "IF")
166 61b0b383 2021-11-08 op      (and (not (smie-rule-bolp))
167 61b0b383 2021-11-08 op           (smie-rule-prev-p "ELSE")
168 61b0b383 2021-11-08 op           (smie-rule-parent)))))
169 61b0b383 2021-11-08 op 
170 61b0b383 2021-11-08 op (defun a68--smie-forward-token ()
171 61b0b383 2021-11-08 op   (forward-comment (point-max))
172 61b0b383 2021-11-08 op   (cond
173 61b0b383 2021-11-08 op    ((looking-at a68--keywords-regexp)
174 61b0b383 2021-11-08 op     (goto-char (match-end 0))
175 61b0b383 2021-11-08 op     (match-string-no-properties 0))
176 61b0b383 2021-11-08 op    (t (buffer-substring-no-properties (point)
177 61b0b383 2021-11-08 op                                       (progn (skip-syntax-forward "w_")
178 61b0b383 2021-11-08 op                                              (point))))))
179 61b0b383 2021-11-08 op 
180 61b0b383 2021-11-08 op (defun a68--smie-backward-token ()
181 61b0b383 2021-11-08 op   (forward-comment (- (point)))
182 61b0b383 2021-11-08 op   (cond
183 61b0b383 2021-11-08 op    ((looking-back a68--keywords-regexp (- (point) 2) t)
184 61b0b383 2021-11-08 op     (goto-char (match-beginning 0))
185 61b0b383 2021-11-08 op     (match-string-no-properties 0))
186 61b0b383 2021-11-08 op    (t (buffer-substring-no-properties (point)
187 61b0b383 2021-11-08 op                                       (progn (skip-syntax-backward "w_")
188 61b0b383 2021-11-08 op                                              (point))))))
189 61b0b383 2021-11-08 op 
190 364d8905 2021-11-07 op (defvar a68-mode-syntax-table
191 364d8905 2021-11-07 op   (let ((st (make-syntax-table)))
192 364d8905 2021-11-07 op     (modify-syntax-entry ?# "<" st)
193 364d8905 2021-11-07 op     (modify-syntax-entry ?# ">" st)
194 364d8905 2021-11-07 op     (modify-syntax-entry ?\\ "." st)
195 0effda17 2021-11-08 op     (modify-syntax-entry ?, "." st)
196 b18a7d7e 2021-11-08 op     (modify-syntax-entry ?: "." st)
197 364d8905 2021-11-07 op     ;; define parentheses to match
198 364d8905 2021-11-07 op     (modify-syntax-entry ?\( "()" st)
199 364d8905 2021-11-07 op     (modify-syntax-entry ?\) ")(" st)
200 364d8905 2021-11-07 op     st))
201 364d8905 2021-11-07 op 
202 e9c672cf 2021-11-07 op (defvar a68-mode-abbrev-table nil
203 e9c672cf 2021-11-07 op   "Abbreviation table used in `a68-mode' buffers.")
204 e9c672cf 2021-11-07 op 
205 e9c672cf 2021-11-07 op (define-abbrev-table 'a68-mode-abbrev-table
206 e9c672cf 2021-11-07 op   '())
207 e9c672cf 2021-11-07 op 
208 364d8905 2021-11-07 op ;;;###autoload
209 364d8905 2021-11-07 op (define-derived-mode a68-mode prog-mode "Algol68"
210 364d8905 2021-11-07 op   "Major mode for editing Alogl68 files."
211 e9c672cf 2021-11-07 op   :abbrev-table a68-mode-abbrev-table
212 364d8905 2021-11-07 op   (setq-local font-lock-defaults '(a68-font-lock-keywords))
213 61b0b383 2021-11-08 op   (smie-setup a68--smie-grammar #'a68--smie-rules
214 61b0b383 2021-11-08 op               :forward-token #'a68--smie-forward-token
215 61b0b383 2021-11-08 op               :backward-token #'a68--smie-backward-token)
216 18be0e13 2021-11-07 op   (setq-local comment-start a68-comment-style)
217 18be0e13 2021-11-07 op   (setq-local comment-end a68-comment-style)
218 4fcb92ee 2021-11-07 op   (setq-local syntax-propertize-function
219 5881861e 2021-11-14 op               (syntax-propertize-rules
220 5881861e 2021-11-14 op                ((rx (group bow "COMMENT" eow)
221 5881861e 2021-11-14 op                     (group (*? anychar))
222 5881861e 2021-11-14 op                     (group bow "COMMENT" eow))
223 5881861e 2021-11-14 op                 (1 "<")
224 5881861e 2021-11-14 op                 (3 ">"))
225 5881861e 2021-11-14 op                ((rx (group bow "CO" eow)
226 5881861e 2021-11-14 op                     (group (*? anychar))
227 5881861e 2021-11-14 op                     (group bow "CO" eow))
228 5881861e 2021-11-14 op                 (1 "<")
229 5881861e 2021-11-14 op                 (3 ">"))
230 5881861e 2021-11-14 op                ;; ((rx (group "#\\[^!\\]")
231 5881861e 2021-11-14 op                ;;      (group (*? anychar))
232 5881861e 2021-11-14 op                ;;      (group "#"))
233 5881861e 2021-11-14 op                ;;  (1 "<")
234 5881861e 2021-11-14 op                ;;  (3 ">"))
235 5881861e 2021-11-14 op                )))
236 364d8905 2021-11-07 op 
237 364d8905 2021-11-07 op ;;;###autoload
238 364d8905 2021-11-07 op (add-to-list 'auto-mode-alist '("\\.a68\\'" . a68-mode))
239 364d8905 2021-11-07 op 
240 48415058 2021-11-07 op (provide 'a68-mode)
241 48415058 2021-11-07 op ;;; a68-mode.el ends here