1 ;;; a68-mode.el --- Major mode for editing Algol 68 code -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2011 Jose E. Marchesi
4 ;; Copyright (C) 2021 Omar Polo <op@omarpolo.com>
6 ;; Author: Jose E. Marchesi
7 ;; Omar Polo <op@omarpolo.com>
8 ;; Maintainer: Omar Polo
9 ;; URL: https://git.omarpolo.com/a68-mode
10 ;; Keywords: languages
12 ;; Package-Requires: ((emacs "24.3"))
14 ;; This file is NOT part of GNU Emacs.
16 ;; This program is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 3, or (at your option)
21 ;; This program is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with this program; see the file COPYING. If not, write to the
28 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
29 ;; Boston, MA 02110-1301, USA.
33 ;; A major mode for editing Algol 68 code.
35 ;; This is an improved and modernized version of the a68-mode written
36 ;; by Jose E. Marchesi. The original code was taken from
38 ;; https://github.com/lachrymology/me/blob/master/.emacs.d/extras/algol-mode.el
40 ;; TODO: support quote and dot stropping.
51 "Major mode for editing Algol68 code."
55 (defcustom a68-indent-level 3
56 "Indentation step for Algol 68."
60 (defcustom a68-comment-style "#"
61 "Default comment style used by e.g. `comment-dwim'."
62 :type '(choice (const "#")
67 (defvar a68-mode-hook '()
68 "Hook run when entering Algol68 mode.")
71 (let ((map (make-sparse-keymap)))
72 (define-key map (kbd "C-j") #'newline-and-indent)
73 (define-key map (kbd "RET") #'a68-electric-terminate-line)
75 "Keymap for Algol 68 major mode.")
77 (defconst a68-font-lock-keywords
80 (or "DECS" "PROGRAM" "CONTEXT" "USE" "FINISH" "KEEP"
82 "MODE" "OP" "PRIO" "PROC"
83 "OF" "AT" "IS" "ISNT" "EMPTY" "SKIP"
85 "CASE" "IN" "OUSE" "OUT" "ESAC"
86 "FOR" "FORALL" "FROM" "TO" "BY" "WHILE" "DO" "OD"
87 "IF" "THEN" "ELIF" "THEN" "ELSE" "FI"
88 "PAR" "BEGIN" "END" "GOTO" "EXIT"
89 "LWB" "UPB" "NOT" "ABS" "BIN" "REPR" "LENG"
90 "SHORTEN" "ODD" "SIGN" "ROUND" "ENTIER" "AND" "OR"
91 "DIV" "OVER" "MOD" "ELEM" "SHL" "SHR" "OVERAB" "DIVAB" "MODAB"
94 'font-lock-keyword-face)
98 'font-lock-constant-face)
99 ;; only valid for bold stropping
100 (cons (concat "\\<[A-Z]+\\>") 'font-lock-type-face)
102 'font-lock-variable-name-face))
103 "Highlighting expressions for Algol 68 mode.")
105 (defsubst a68-within-string ()
106 "Check if inside a string."
107 (nth 3 (syntax-ppss)))
109 (defsubst a68-within-comment ()
110 "Check if inside a comment."
111 (nth 4 (syntax-ppss)))
113 ;; Indentation rules:
115 ;; - If we are at the beginning of the buffer, or looking at some
116 ;; indent-0 content, indent to column 0.
118 ;; - If we are currently at an END, ), FI or OD, then de-indent
119 ;; relative to the previous line.
121 ;; - If we first see and "end line" before our current line,
122 ;; then we should indent our current line to the same indentation as
125 ;; - If we first see a "start line" like IF, then we need to increase
126 ;; our indentation relative to that start line.
128 ;; - If into a balanced expression, we should indent to the column
129 ;; where the start of the innermost parenthetical group.
131 ;; - If none of the above apply, then do not indent at all.
133 (defun a68-indent-line ()
134 "Indent current line as Algol 68 code."
136 (let ((case-fold-search nil))
139 (if (nth 1 (syntax-ppss)) ; Check for rule 5
140 (let ((offset (save-excursion (goto-char (+ (nth 1 (syntax-ppss)) 1))
142 (indent-line-to offset))
143 (if (or (bobp) ; Check for rule 1
144 (looking-at "^[ \t]*\\<\\(KEEP\\|FINISH\\|DECS\\|USE\\|PROGRAM\\)\\>"))
146 (let ((not-indented t)
147 (begin-indent-re "^[ \t]*\\<\\(PAR\\|BEGIN\\|KEEP\\|IF\\|DO\\|ELSE\\|ELIF\\|THEN\\)")
148 (deindent-line-re "^[ \t]*\\<\\(END\\|FI\\|OD\\|ELSE\\|ELIF\\)\\>")
149 (eqindent-line-re "^[ \t]*\\<\\(THEN\\)\\>")
150 (end-line-re "^[ \t]*\\(END\\|FI\\|OD\\)")
152 (if (looking-at eqindent-line-re)
155 (setq cur-indent (current-indentation)))
156 (if (looking-at deindent-line-re) ; Check for rule 2
160 (setq cur-indent (- (current-indentation) a68-indent-level)))
161 (when (< cur-indent 0)
162 (setq cur-indent 0)))
166 (if (looking-at end-line-re) ; Check for rule 3
168 (setq cur-indent (current-indentation))
169 (setq not-indented nil))
171 (if (looking-at begin-indent-re)
173 (setq cur-indent (+ (current-indentation) a68-indent-level))
174 (setq not-indented nil))
175 (when (bobp) ; Check for rule 5
176 (setq not-indented nil))))))))
178 (indent-line-to cur-indent)
179 ;; If we didn't see an indentation hint, then allow no
181 (indent-line-to 0)))))))
182 (when (< (current-column) (current-indentation))
183 (move-to-column (current-indentation))))
185 (defvar a68-mode-syntax-table
186 (let ((st (make-syntax-table)))
187 (modify-syntax-entry ?# "<" st)
188 (modify-syntax-entry ?# ">" st)
189 (modify-syntax-entry ?\\ "." st)
190 ;; define parentheses to match
191 (modify-syntax-entry ?\( "()" st)
192 (modify-syntax-entry ?\) ")(" st)
195 (defconst a68-autoindent-lines-re
197 (or "BEGIN" "END" "ELSE" "ELIF" "DO" "OD" "CASE" "ESAC" "IN" "OUT")
200 (defun a68-electric-terminate-line ()
201 "Terminate line and indent next line."
203 ;; First, check if current line should be indented
206 (skip-chars-forward " \t")
207 (when (looking-at a68-autoindent-lines-re)
209 (delete-horizontal-space) ; Removes triling whitespaces
211 ;; Indent next line if we are not in a string
212 (unless (a68-within-string)
215 (defvar a68-mode-abbrev-table nil
216 "Abbreviation table used in `a68-mode' buffers.")
218 (define-abbrev-table 'a68-mode-abbrev-table
222 (define-derived-mode a68-mode prog-mode "Algol68"
223 "Major mode for editing Alogl68 files."
224 :abbrev-table a68-mode-abbrev-table
225 (setq-local font-lock-defaults '(a68-font-lock-keywords))
226 (setq-local indent-line-function #'a68-indent-line)
227 (setq-local comment-start a68-comment-style)
228 (setq-local comment-end a68-comment-style)
229 (setq-local syntax-propertize-function
230 (syntax-propertize-rules ((rx (group bow "COMMENT" eow)
232 (group bow "COMMENT" eow))
235 ((rx (group bow "CO" eow)
237 (group bow "CO" eow))
247 (add-to-list 'auto-mode-alist '("\\.a68\\'" . a68-mode))
250 ;;; a68-mode.el ends here