1 6c5ab754 2021-11-07 op ;;; a68-mode.el --- Major mode for editing Algol 68 code -*- lexical-binding: t; -*-
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>
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
12 364d8905 2021-11-07 op ;; Package-Requires: ((emacs "24.3"))
14 364d8905 2021-11-07 op ;; This file is NOT part of GNU Emacs.
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.
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.
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.
31 364d8905 2021-11-07 op ;;; Commentary:
33 364d8905 2021-11-07 op ;; A major mode for editing Algol 68 code.
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
38 bb4b3a62 2021-11-07 op ;; https://github.com/lachrymology/me/blob/master/.emacs.d/extras/algol-mode.el
40 364d8905 2021-11-07 op ;; TODO: support quote and dot stropping.
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)
48 364d8905 2021-11-07 op (eval-when-compile
49 364d8905 2021-11-07 op (require 'rx))
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)
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)
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 "#")
65 18be0e13 2021-11-07 op (const "COMMENT"))
66 29b924fd 2021-11-07 op :safe #'consp)
68 364d8905 2021-11-07 op (defvar a68-mode-hook '()
69 364d8905 2021-11-07 op "Hook run when entering Algol68 mode.")
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)
76 364d8905 2021-11-07 op "Keymap for Algol 68 major mode.")
78 364d8905 2021-11-07 op (defconst a68-font-lock-keywords
80 364d8905 2021-11-07 op (cons (rx word-start
81 364d8905 2021-11-07 op (or "DECS" "PROGRAM" "CONTEXT" "USE" "FINISH" "KEEP"
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"
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")
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.")
106 61b0b383 2021-11-08 op (defvar a68--keywords-regexp
107 b18a7d7e 2021-11-08 op (regexp-opt '("+" "*" ";" ">" "<" ":=" "=" "," ":")))
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 d3cc027d 2021-11-08 op ("IF" exprs "THEN" exprs "FI")
124 d3cc027d 2021-11-08 op ("IF" exprs "THEN" exprs "ELSE" exprs "FI")
125 d3cc027d 2021-11-08 op ("CASE" exprs "IN" exprs "ESAC")
126 d3cc027d 2021-11-08 op ("CASE" exprs "IN" exprs "OUT" exprs "ESAC"))
127 d3cc027d 2021-11-08 op (exprs (exprs "," exprs)
128 d3cc027d 2021-11-08 op (exprs ";" exprs)
129 b18a7d7e 2021-11-08 op (exprs ":" exprs)
131 6170a32c 2021-11-08 op (loop ("FOR" exprs "FROM" exprs "TO" exprs
132 6170a32c 2021-11-08 op "BY" exprs "DO" exprs "OD")
133 6170a32c 2021-11-08 op ("FOR" exprs "FROM" exprs "TO" exprs
134 6170a32c 2021-11-08 op "DO" exprs "OD")
135 6170a32c 2021-11-08 op ("FOR" exprs "BY" exprs "TO" exprs
136 6170a32c 2021-11-08 op "DO" exprs "OD")
137 6170a32c 2021-11-08 op ;; ("TO" exprs "DO" exprs "OD")
138 6170a32c 2021-11-08 op ("WHILE" exprs "DO" exprs "OD")))
139 b18a7d7e 2021-11-08 op '((assoc ";" "," ":"))
140 d3cc027d 2021-11-08 op '((assoc "=" "/=" ":=" ":=:" ":/=:"
141 d3cc027d 2021-11-08 op "+" "-" "*" "/")))))
143 61b0b383 2021-11-08 op (defun a68--smie-rules (kind token)
144 61b0b383 2021-11-08 op (pcase (cons kind token)
145 61b0b383 2021-11-08 op (`(:elem . basic) a68-indent-level)
146 61b0b383 2021-11-08 op ;; (`(,_ . ",") (smie-rule-separator kind))
147 61b0b383 2021-11-08 op (`(,_ . ",") (smie-rule-separator kind))
148 61b0b383 2021-11-08 op (`(,_ . ";") (when (smie-rule-parent-p)
149 61b0b383 2021-11-08 op (smie-rule-parent)))
150 61b0b383 2021-11-08 op (`(:after . ":=") a68-indent-level)
151 61b0b383 2021-11-08 op (`(:after . "=") a68-indent-level)
152 61b0b383 2021-11-08 op (`(:before . ,(or `"BEGIN" '"(")) (when (smie-rule-hanging-p)
153 61b0b383 2021-11-08 op (smie-rule-parent)))
154 61b0b383 2021-11-08 op (`(:before . "IF")
155 61b0b383 2021-11-08 op (and (not (smie-rule-bolp))
156 61b0b383 2021-11-08 op (smie-rule-prev-p "ELSE")
157 61b0b383 2021-11-08 op (smie-rule-parent)))))
159 61b0b383 2021-11-08 op (defun a68--smie-forward-token ()
160 61b0b383 2021-11-08 op (forward-comment (point-max))
162 61b0b383 2021-11-08 op ((looking-at a68--keywords-regexp)
163 61b0b383 2021-11-08 op (goto-char (match-end 0))
164 61b0b383 2021-11-08 op (match-string-no-properties 0))
165 61b0b383 2021-11-08 op (t (buffer-substring-no-properties (point)
166 61b0b383 2021-11-08 op (progn (skip-syntax-forward "w_")
169 61b0b383 2021-11-08 op (defun a68--smie-backward-token ()
170 61b0b383 2021-11-08 op (forward-comment (- (point)))
172 61b0b383 2021-11-08 op ((looking-back a68--keywords-regexp (- (point) 2) t)
173 61b0b383 2021-11-08 op (goto-char (match-beginning 0))
174 61b0b383 2021-11-08 op (match-string-no-properties 0))
175 61b0b383 2021-11-08 op (t (buffer-substring-no-properties (point)
176 61b0b383 2021-11-08 op (progn (skip-syntax-backward "w_")
179 364d8905 2021-11-07 op (defvar a68-mode-syntax-table
180 364d8905 2021-11-07 op (let ((st (make-syntax-table)))
181 364d8905 2021-11-07 op (modify-syntax-entry ?# "<" st)
182 364d8905 2021-11-07 op (modify-syntax-entry ?# ">" st)
183 364d8905 2021-11-07 op (modify-syntax-entry ?\\ "." st)
184 0effda17 2021-11-08 op (modify-syntax-entry ?, "." st)
185 b18a7d7e 2021-11-08 op (modify-syntax-entry ?: "." st)
186 364d8905 2021-11-07 op ;; define parentheses to match
187 364d8905 2021-11-07 op (modify-syntax-entry ?\( "()" st)
188 364d8905 2021-11-07 op (modify-syntax-entry ?\) ")(" st)
191 e9c672cf 2021-11-07 op (defvar a68-mode-abbrev-table nil
192 e9c672cf 2021-11-07 op "Abbreviation table used in `a68-mode' buffers.")
194 e9c672cf 2021-11-07 op (define-abbrev-table 'a68-mode-abbrev-table
197 364d8905 2021-11-07 op ;;;###autoload
198 364d8905 2021-11-07 op (define-derived-mode a68-mode prog-mode "Algol68"
199 364d8905 2021-11-07 op "Major mode for editing Alogl68 files."
200 e9c672cf 2021-11-07 op :abbrev-table a68-mode-abbrev-table
201 364d8905 2021-11-07 op (setq-local font-lock-defaults '(a68-font-lock-keywords))
202 61b0b383 2021-11-08 op (smie-setup a68--smie-grammar #'a68--smie-rules
203 61b0b383 2021-11-08 op :forward-token #'a68--smie-forward-token
204 61b0b383 2021-11-08 op :backward-token #'a68--smie-backward-token)
205 18be0e13 2021-11-07 op (setq-local comment-start a68-comment-style)
206 18be0e13 2021-11-07 op (setq-local comment-end a68-comment-style)
207 4fcb92ee 2021-11-07 op (setq-local syntax-propertize-function
208 4fcb92ee 2021-11-07 op (syntax-propertize-rules ((rx (group bow "COMMENT" eow)
209 4fcb92ee 2021-11-07 op (group (*? anychar))
210 4fcb92ee 2021-11-07 op (group bow "COMMENT" eow))
213 4fcb92ee 2021-11-07 op ((rx (group bow "CO" eow)
214 4fcb92ee 2021-11-07 op (group (*? anychar))
215 4fcb92ee 2021-11-07 op (group bow "CO" eow))
218 4fcb92ee 2021-11-07 op ((rx (group "#")
219 4fcb92ee 2021-11-07 op (group (*? anychar))
224 364d8905 2021-11-07 op ;;;###autoload
225 364d8905 2021-11-07 op (add-to-list 'auto-mode-alist '("\\.a68\\'" . a68-mode))
227 48415058 2021-11-07 op (provide 'a68-mode)
228 48415058 2021-11-07 op ;;; a68-mode.el ends here
