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
| | ;;; sieve-mode.el --- Sieve code editing commands for Emacs -*- lexical-binding: t -*-
;; Copyright (C) 2001-2024 Free Software Foundation, Inc.
;; Author: Simon Josefsson <simon@josefsson.org>
;; This file is part of GNU Emacs.
;; GNU Emacs 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 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This file contain editing mode functions and font-lock support for
;; editing Sieve scripts. It sets up C-mode with support for
;; sieve-style #-comments and a lightly hacked syntax table. It was
;; strongly influenced by awk-mode.el.
;;
;; References:
;;
;; RFC 3028,
;; "Sieve: A Mail Filtering Language",
;; by Tim Showalter.
;;
;; Release history:
;;
;; 2001-03-02 version 1.0 posted to gnu.emacs.sources
;; version 1.1 change file extension into ".siv" (official one)
;; added keymap and menubar to hook into sieve-manage
;; 2001-10-31 version 1.2 committed to Oort Gnus
;;; Code:
(autoload 'sieve-manage "sieve")
(autoload 'sieve-upload "sieve")
(defgroup sieve nil
"Sieve."
:group 'languages)
(defcustom sieve-mode-hook nil
"Hook run in sieve mode buffers."
:type 'hook)
;; Font-lock
(defface sieve-control-commands
'((t :inherit font-lock-builtin-face))
"Face used for Sieve Control Commands.")
(defface sieve-action-commands
'((t :inherit font-lock-function-name-face))
"Face used for Sieve Action Commands.")
(defface sieve-test-commands
'((t :inherit font-lock-constant-face))
"Face used for Sieve Test Commands.")
(defface sieve-tagged-arguments
'((t :inherit font-lock-keyword face))
"Face used for Sieve Tagged Arguments.")
(defconst sieve-font-lock-keywords
(eval-when-compile
`(
;; control commands
(,(regexp-opt '("require" "if" "else" "elsif" "stop") 'words)
. 'sieve-control-commands)
;; action commands
(,(regexp-opt '("fileinto" "redirect" "reject" "keep" "discard") 'words)
. 'sieve-action-commands)
;; test commands
(,(regexp-opt '("address" "allof" "anyof" "exists" "false"
"true" "header" "not" "size" "envelope"
"body")
'words)
. 'sieve-test-commands)
("\\Sw+:\\sw+" . 'sieve-tagged-arguments))))
;; Syntax table
(defvar sieve-mode-syntax-table
(let ((st (make-syntax-table)))
(modify-syntax-entry ?\\ "\\" st)
(modify-syntax-entry ?\n "> " st)
(modify-syntax-entry ?\f "> " st)
(modify-syntax-entry ?\# "< " st)
(modify-syntax-entry ?/ ". 14" st)
(modify-syntax-entry ?* ". 23b" st)
(modify-syntax-entry ?+ "." st)
(modify-syntax-entry ?- "." st)
(modify-syntax-entry ?= "." st)
(modify-syntax-entry ?% "." st)
(modify-syntax-entry ?< "." st)
(modify-syntax-entry ?> "." st)
(modify-syntax-entry ?& "." st)
(modify-syntax-entry ?| "." st)
(modify-syntax-entry ?_ "_" st)
(modify-syntax-entry ?\' "\"" st)
(modify-syntax-entry ?\{ "(}" st)
(modify-syntax-entry ?\} "){" st)
(modify-syntax-entry ?\" "\"" st)
st)
"Syntax table in use in `sieve-mode' buffers.")
;; Key map definition
(defvar-keymap sieve-mode-map
:doc "Keymap used in sieve mode."
"C-c C-l" #'sieve-upload
"C-c C-c" #'sieve-upload-and-kill
"C-c RET" #'sieve-manage)
;; Menu
(easy-menu-define sieve-mode-menu sieve-mode-map
"Sieve Menu."
'("Sieve"
["Upload script" sieve-upload t]
["Manage scripts on server" sieve-manage t]))
;; Code for Sieve editing mode.
(defun sieve-syntax-propertize (beg end)
(goto-char beg)
(sieve-syntax-propertize-text end)
(funcall
(syntax-propertize-rules
;; FIXME: When there's a "text:" with a # comment, the \n plays dual role:
;; it closes the comment and starts the string. This is problematic for us
;; since syntax-table entries can either close a comment or
;; delimit a string, but not both.
("\\_<text:[ \t]*\\(?:#.*\\(.\\)\\)?\\(\n\\)"
(1 ">")
(2 (prog1 (unless (save-excursion
(nth 8 (syntax-ppss (match-beginning 0))))
(string-to-syntax "|"))
(sieve-syntax-propertize-text end)))))
beg end))
(defun sieve-syntax-propertize-text (end)
(let ((ppss (syntax-ppss)))
(when (and (eq t (nth 3 ppss))
(re-search-forward "^\\.\\(\n\\)" end 'move))
(put-text-property (match-beginning 1) (match-end 1)
'syntax-table (string-to-syntax "|")))))
;;;###autoload
(define-derived-mode sieve-mode prog-mode "Sieve"
"Major mode for editing Sieve code.
Turning on Sieve mode runs `sieve-mode-hook'."
(setq-local paragraph-start (concat "$\\|" page-delimiter))
(setq-local paragraph-separate paragraph-start)
(setq-local comment-start "#")
(setq-local comment-end "")
;; (setq-local comment-start-skip "\\(^\\|\\s-\\);?#+ *")
(setq-local comment-start-skip "#+ *")
(setq-local syntax-propertize-function #'sieve-syntax-propertize)
(setq-local font-lock-defaults
'(sieve-font-lock-keywords nil nil ((?_ . "w"))))
(setq-local indent-line-function #'sieve-mode-indent-function)
(easy-menu-add-item nil nil sieve-mode-menu))
(defun sieve-mode-indent-function ()
(save-excursion
(beginning-of-line)
(let ((depth (car (syntax-ppss))))
(when (looking-at "[ \t]*}")
(setq depth (1- depth)))
(indent-line-to (* 2 depth))))
;; Skip to the end of the indentation if at the beginning of the
;; line.
(when (save-excursion
(skip-chars-backward " \t")
(bolp))
(skip-chars-forward " \t")))
(provide 'sieve-mode)
;;; sieve-mode.el ends here
|