Commit | Line | Data |
---|---|---|
23f87bed | 1 | ;;; sieve-mode.el --- Sieve code editing commands for Emacs |
e84b4b86 | 2 | |
5df4f04c | 3 | ;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
3d493bef | 4 | ;; Free Software Foundation, Inc. |
23f87bed MB |
5 | |
6 | ;; Author: Simon Josefsson <simon@josefsson.org> | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
5e809f55 | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
23f87bed | 11 | ;; it under the terms of the GNU General Public License as published by |
5e809f55 GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
23f87bed MB |
14 | |
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
5e809f55 | 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
23f87bed MB |
18 | ;; GNU General Public License for more details. |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
5e809f55 | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
23f87bed MB |
22 | |
23 | ;;; Commentary: | |
24 | ||
25 | ;; This file contain editing mode functions and font-lock support for | |
26 | ;; editing Sieve scripts. It sets up C-mode with support for | |
27 | ;; sieve-style #-comments and a lightly hacked syntax table. It was | |
28 | ;; strongly influenced by awk-mode.el. | |
29 | ;; | |
30 | ;; Put something similar to the following in your .emacs to use this file: | |
31 | ;; | |
32 | ;; (load "~/lisp/sieve") | |
33 | ;; (setq auto-mode-alist (cons '("\\.siv\\'" . sieve-mode) auto-mode-alist)) | |
34 | ;; | |
35 | ;; References: | |
36 | ;; | |
37 | ;; RFC 3028, | |
38 | ;; "Sieve: A Mail Filtering Language", | |
39 | ;; by Tim Showalter. | |
40 | ;; | |
41 | ;; Release history: | |
42 | ;; | |
43 | ;; 2001-03-02 version 1.0 posted to gnu.emacs.sources | |
44 | ;; version 1.1 change file extension into ".siv" (official one) | |
45 | ;; added keymap and menubar to hook into sieve-manage | |
46 | ;; 2001-10-31 version 1.2 committed to Oort Gnus | |
47 | ||
48 | ;;; Code: | |
49 | ||
50 | (autoload 'sieve-manage "sieve") | |
51 | (autoload 'sieve-upload "sieve") | |
23f87bed MB |
52 | (require 'easymenu) |
53 | (eval-when-compile | |
54 | (require 'font-lock)) | |
55 | ||
56 | (defgroup sieve nil | |
57 | "Sieve." | |
58 | :group 'languages) | |
59 | ||
60 | (defcustom sieve-mode-hook nil | |
61 | "Hook run in sieve mode buffers." | |
62 | :group 'sieve | |
63 | :type 'hook) | |
64 | ||
65 | ;; Font-lock | |
66 | ||
0f49874b | 67 | (defvar sieve-control-commands-face 'sieve-control-commands |
23f87bed MB |
68 | "Face name used for Sieve Control Commands.") |
69 | ||
0f49874b | 70 | (defface sieve-control-commands |
23f87bed MB |
71 | '((((type tty) (class color)) (:foreground "blue" :weight light)) |
72 | (((class grayscale) (background light)) (:foreground "LightGray" :bold t)) | |
73 | (((class grayscale) (background dark)) (:foreground "DimGray" :bold t)) | |
74 | (((class color) (background light)) (:foreground "Orchid")) | |
75 | (((class color) (background dark)) (:foreground "LightSteelBlue")) | |
76 | (t (:bold t))) | |
d0859c9a MB |
77 | "Face used for Sieve Control Commands." |
78 | :group 'sieve) | |
0f49874b MB |
79 | ;; backward-compatibility alias |
80 | (put 'sieve-control-commands-face 'face-alias 'sieve-control-commands) | |
3d493bef | 81 | (put 'sieve-control-commands-face 'obsolete-face "22.1") |
23f87bed | 82 | |
0f49874b | 83 | (defvar sieve-action-commands-face 'sieve-action-commands |
23f87bed MB |
84 | "Face name used for Sieve Action Commands.") |
85 | ||
0f49874b | 86 | (defface sieve-action-commands |
23f87bed MB |
87 | '((((type tty) (class color)) (:foreground "blue" :weight bold)) |
88 | (((class color) (background light)) (:foreground "Blue")) | |
89 | (((class color) (background dark)) (:foreground "LightSkyBlue")) | |
90 | (t (:inverse-video t :bold t))) | |
d0859c9a MB |
91 | "Face used for Sieve Action Commands." |
92 | :group 'sieve) | |
0f49874b MB |
93 | ;; backward-compatibility alias |
94 | (put 'sieve-action-commands-face 'face-alias 'sieve-action-commands) | |
3d493bef | 95 | (put 'sieve-action-commands-face 'obsolete-face "22.1") |
23f87bed | 96 | |
0f49874b | 97 | (defvar sieve-test-commands-face 'sieve-test-commands |
23f87bed MB |
98 | "Face name used for Sieve Test Commands.") |
99 | ||
0f49874b | 100 | (defface sieve-test-commands |
23f87bed MB |
101 | '((((type tty) (class color)) (:foreground "magenta")) |
102 | (((class grayscale) (background light)) | |
103 | (:foreground "LightGray" :bold t :underline t)) | |
104 | (((class grayscale) (background dark)) | |
105 | (:foreground "Gray50" :bold t :underline t)) | |
106 | (((class color) (background light)) (:foreground "CadetBlue")) | |
107 | (((class color) (background dark)) (:foreground "Aquamarine")) | |
108 | (t (:bold t :underline t))) | |
d0859c9a MB |
109 | "Face used for Sieve Test Commands." |
110 | :group 'sieve) | |
0f49874b MB |
111 | ;; backward-compatibility alias |
112 | (put 'sieve-test-commands-face 'face-alias 'sieve-test-commands) | |
3d493bef | 113 | (put 'sieve-test-commands-face 'obsolete-face "22.1") |
23f87bed | 114 | |
0f49874b | 115 | (defvar sieve-tagged-arguments-face 'sieve-tagged-arguments |
23f87bed MB |
116 | "Face name used for Sieve Tagged Arguments.") |
117 | ||
0f49874b | 118 | (defface sieve-tagged-arguments |
23f87bed MB |
119 | '((((type tty) (class color)) (:foreground "cyan" :weight bold)) |
120 | (((class grayscale) (background light)) (:foreground "LightGray" :bold t)) | |
121 | (((class grayscale) (background dark)) (:foreground "DimGray" :bold t)) | |
122 | (((class color) (background light)) (:foreground "Purple")) | |
123 | (((class color) (background dark)) (:foreground "Cyan")) | |
124 | (t (:bold t))) | |
d0859c9a MB |
125 | "Face used for Sieve Tagged Arguments." |
126 | :group 'sieve) | |
0f49874b MB |
127 | ;; backward-compatibility alias |
128 | (put 'sieve-tagged-arguments-face 'face-alias 'sieve-tagged-arguments) | |
3d493bef | 129 | (put 'sieve-tagged-arguments-face 'obsolete-face "22.1") |
23f87bed MB |
130 | |
131 | ||
132 | (defconst sieve-font-lock-keywords | |
133 | (eval-when-compile | |
134 | (list | |
135 | ;; control commands | |
136 | (cons (regexp-opt '("require" "if" "else" "elsif" "stop")) | |
137 | 'sieve-control-commands-face) | |
138 | ;; action commands | |
139 | (cons (regexp-opt '("fileinto" "redirect" "reject" "keep" "discard")) | |
140 | 'sieve-action-commands-face) | |
141 | ;; test commands | |
142 | (cons (regexp-opt '("address" "allof" "anyof" "exists" "false" | |
143 | "true" "header" "not" "size" "envelope")) | |
144 | 'sieve-test-commands-face) | |
145 | (cons "\\Sw+:\\sw+" | |
146 | 'sieve-tagged-arguments-face)))) | |
147 | ||
148 | ;; Syntax table | |
149 | ||
150 | (defvar sieve-mode-syntax-table nil | |
151 | "Syntax table in use in sieve-mode buffers.") | |
152 | ||
153 | (if sieve-mode-syntax-table | |
154 | () | |
155 | (setq sieve-mode-syntax-table (make-syntax-table)) | |
156 | (modify-syntax-entry ?\\ "\\" sieve-mode-syntax-table) | |
157 | (modify-syntax-entry ?\n "> " sieve-mode-syntax-table) | |
158 | (modify-syntax-entry ?\f "> " sieve-mode-syntax-table) | |
159 | (modify-syntax-entry ?\# "< " sieve-mode-syntax-table) | |
160 | (modify-syntax-entry ?/ "." sieve-mode-syntax-table) | |
161 | (modify-syntax-entry ?* "." sieve-mode-syntax-table) | |
162 | (modify-syntax-entry ?+ "." sieve-mode-syntax-table) | |
163 | (modify-syntax-entry ?- "." sieve-mode-syntax-table) | |
164 | (modify-syntax-entry ?= "." sieve-mode-syntax-table) | |
165 | (modify-syntax-entry ?% "." sieve-mode-syntax-table) | |
166 | (modify-syntax-entry ?< "." sieve-mode-syntax-table) | |
167 | (modify-syntax-entry ?> "." sieve-mode-syntax-table) | |
168 | (modify-syntax-entry ?& "." sieve-mode-syntax-table) | |
169 | (modify-syntax-entry ?| "." sieve-mode-syntax-table) | |
170 | (modify-syntax-entry ?_ "_" sieve-mode-syntax-table) | |
171 | (modify-syntax-entry ?\' "\"" sieve-mode-syntax-table)) | |
172 | ||
173 | ;; Key map definition | |
174 | ||
175 | (defvar sieve-mode-map | |
176 | (let ((map (make-sparse-keymap))) | |
177 | (define-key map "\C-c\C-l" 'sieve-upload) | |
178 | (define-key map "\C-c\C-c" 'sieve-upload-and-bury) | |
179 | (define-key map "\C-c\C-m" 'sieve-manage) | |
180 | map) | |
181 | "Key map used in sieve mode.") | |
182 | ||
183 | ;; Menu definition | |
184 | ||
185 | (defvar sieve-mode-menu nil | |
186 | "Menubar used in sieve mode.") | |
187 | ||
188 | ;; Code for Sieve editing mode. | |
189 | ||
190 | ;;;###autoload | |
191 | (define-derived-mode sieve-mode c-mode "Sieve" | |
192 | "Major mode for editing Sieve code. | |
193 | This is much like C mode except for the syntax of comments. Its keymap | |
194 | inherits from C mode's and it has the same variables for customizing | |
195 | indentation. It has its own abbrev table and its own syntax table. | |
196 | ||
197 | Turning on Sieve mode runs `sieve-mode-hook'." | |
198 | (set (make-local-variable 'paragraph-start) (concat "$\\|" page-delimiter)) | |
199 | (set (make-local-variable 'paragraph-separate) paragraph-start) | |
200 | (set (make-local-variable 'comment-start) "#") | |
201 | (set (make-local-variable 'comment-end) "") | |
202 | ;;(set (make-local-variable 'comment-start-skip) "\\(^\\|\\s-\\);?#+ *") | |
203 | (set (make-local-variable 'comment-start-skip) "#+ *") | |
204 | (unless (featurep 'xemacs) | |
205 | (set (make-local-variable 'font-lock-defaults) | |
206 | '(sieve-font-lock-keywords nil nil ((?_ . "w"))))) | |
207 | (easy-menu-add-item nil nil sieve-mode-menu)) | |
208 | ||
209 | ;; Menu | |
210 | ||
211 | (easy-menu-define sieve-mode-menu sieve-mode-map | |
212 | "Sieve Menu." | |
213 | '("Sieve" | |
214 | ["Upload script" sieve-upload t] | |
215 | ["Manage scripts on server" sieve-manage t])) | |
216 | ||
217 | (provide 'sieve-mode) | |
218 | ||
cbee283d | 219 | ;; arch-tag: 3b8ab76d-065d-4c52-b1e8-ab2ec21f2ace |
23f87bed | 220 | ;; sieve-mode.el ends here |