1 ;;; sieve-mode.el --- Sieve code editing commands for Emacs
2 ;; Copyright (C) 2001 Free Software Foundation, Inc.
4 ;; Author: Simon Josefsson <simon@josefsson.org>
6 ;; This file is not part of GNU Emacs, but the same permissions apply.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
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.
30 ;; Put something similar to the following in your .emacs to use this file:
32 ;; (load "~/lisp/sieve")
33 ;; (setq auto-mode-alist (cons '("\\.siv\\'" . sieve-mode) auto-mode-alist))
38 ;; "Sieve: A Mail Filtering Language",
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
48 ;; $Id: sieve-mode.el,v 6.1 2001/11/01 00:50:22 jas Exp $
52 (autoload 'sieve-manage "sieve-manage")
53 (autoload 'sieve-upload "sieve-manage")
62 (defcustom sieve-mode-hook nil
63 "Hook run in sieve mode buffers."
69 (defvar sieve-control-commands-face 'sieve-control-commands-face
70 "Face name used for Sieve Control Commands.")
72 (defface sieve-control-commands-face
73 '((((type tty) (class color)) (:foreground "blue" :weight light))
74 (((class grayscale) (background light)) (:foreground "LightGray" :bold t))
75 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
76 (((class color) (background light)) (:foreground "Orchid"))
77 (((class color) (background dark)) (:foreground "LightSteelBlue"))
79 "Face used for Sieve Control Commands.")
81 (defvar sieve-action-commands-face 'sieve-action-commands-face
82 "Face name used for Sieve Action Commands.")
84 (defface sieve-action-commands-face
85 '((((type tty) (class color)) (:foreground "blue" :weight bold))
86 (((class color) (background light)) (:foreground "Blue"))
87 (((class color) (background dark)) (:foreground "LightSkyBlue"))
88 (t (:inverse-video t :bold t)))
89 "Face used for Sieve Action Commands.")
91 (defvar sieve-test-commands-face 'sieve-test-commands-face
92 "Face name used for Sieve Test Commands.")
94 (defface sieve-test-commands-face
95 '((((type tty) (class color)) (:foreground "magenta"))
96 (((class grayscale) (background light))
97 (:foreground "LightGray" :bold t :underline t))
98 (((class grayscale) (background dark))
99 (:foreground "Gray50" :bold t :underline t))
100 (((class color) (background light)) (:foreground "CadetBlue"))
101 (((class color) (background dark)) (:foreground "Aquamarine"))
102 (t (:bold t :underline t)))
103 "Face used for Sieve Test Commands.")
105 (defvar sieve-tagged-arguments-face 'sieve-tagged-arguments-face
106 "Face name used for Sieve Tagged Arguments.")
108 (defface sieve-tagged-arguments-face
109 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
110 (((class grayscale) (background light)) (:foreground "LightGray" :bold t))
111 (((class grayscale) (background dark)) (:foreground "DimGray" :bold t))
112 (((class color) (background light)) (:foreground "Purple"))
113 (((class color) (background dark)) (:foreground "Cyan"))
115 "Face used for Sieve Tagged Arguments.")
118 (defconst sieve-font-lock-keywords
122 (cons (regexp-opt '("require" "if" "else" "elsif" "stop"))
123 'sieve-control-commands-face)
125 (cons (regexp-opt '("fileinto" "redirect" "reject" "keep" "discard"))
126 'sieve-action-commands-face)
128 (cons (regexp-opt '("address" "allof" "anyof" "exists" "false"
129 "true" "header" "not" "size" "envelope"))
130 'sieve-test-commands-face)
132 'sieve-tagged-arguments-face))))
136 (defvar sieve-mode-syntax-table nil
137 "Syntax table in use in sieve-mode buffers.")
139 (if sieve-mode-syntax-table
141 (setq sieve-mode-syntax-table (make-syntax-table))
142 (modify-syntax-entry ?\\ "\\" sieve-mode-syntax-table)
143 (modify-syntax-entry ?\n "> " sieve-mode-syntax-table)
144 (modify-syntax-entry ?\f "> " sieve-mode-syntax-table)
145 (modify-syntax-entry ?\# "< " sieve-mode-syntax-table)
146 (modify-syntax-entry ?/ "." sieve-mode-syntax-table)
147 (modify-syntax-entry ?* "." sieve-mode-syntax-table)
148 (modify-syntax-entry ?+ "." sieve-mode-syntax-table)
149 (modify-syntax-entry ?- "." sieve-mode-syntax-table)
150 (modify-syntax-entry ?= "." sieve-mode-syntax-table)
151 (modify-syntax-entry ?% "." sieve-mode-syntax-table)
152 (modify-syntax-entry ?< "." sieve-mode-syntax-table)
153 (modify-syntax-entry ?> "." sieve-mode-syntax-table)
154 (modify-syntax-entry ?& "." sieve-mode-syntax-table)
155 (modify-syntax-entry ?| "." sieve-mode-syntax-table)
156 (modify-syntax-entry ?_ "_" sieve-mode-syntax-table)
157 (modify-syntax-entry ?\' "\"" sieve-mode-syntax-table))
159 ;; Key map definition
161 (defvar sieve-mode-map
162 (let ((map (make-sparse-keymap)))
163 (define-key map "\C-c\C-l" 'sieve-upload)
164 (define-key map "\C-c\C-m" 'sieve-manage)
166 "Key map used in sieve mode.")
170 (defvar sieve-mode-menu nil
171 "Menubar used in sieve mode.")
173 ;; Code for Sieve editing mode.
176 (define-derived-mode sieve-mode c-mode "Sieve"
177 "Major mode for editing Sieve code.
178 This is much like C mode except for the syntax of comments. Its keymap
179 inherits from C mode's and it has the same variables for customizing
180 indentation. It has its own abbrev table and its own syntax table.
182 Turning on Sieve mode runs `sieve-mode-hook'."
183 (set (make-local-variable 'paragraph-start) (concat "$\\|" page-delimiter))
184 (set (make-local-variable 'paragraph-separate) paragraph-start)
185 (set (make-local-variable 'comment-start) "#")
186 (set (make-local-variable 'comment-end) "")
187 ;;(set (make-local-variable 'comment-start-skip) "\\(^\\|\\s-\\);?#+ *")
188 (set (make-local-variable 'comment-start-skip) "#+ *")
189 (unless (featurep 'xemacs)
190 (set (make-local-variable 'font-lock-defaults)
191 '(sieve-font-lock-keywords nil nil ((?_ . "w")))))
192 (easy-menu-add-item nil nil sieve-mode-menu))
196 (easy-menu-define sieve-mode-menu sieve-mode-map
199 ["Upload script" sieve-upload t]
200 ["Manage scripts on server" sieve-manage t]))
202 (provide 'sieve-mode)
204 ;; sieve-mode.el ends here