1 ;;; sisu-mode.el --- Major mode for SiSU markup text
3 ;; Copyright (C) 2011 Free Software Foundation, Inc.
5 ;; Author: Ambrose Kofi Laing (& Ralph Amissah)
6 ;; Keywords: text, processes, tools
9 ;; Home URL: SiSU: http://www.jus.uio.no/sisu
10 ;; originally looked at (based on) doc-mode, with kind permission of the author
11 ;; Author: SUN, Tong <suntong001@users.sf.net>, (c)2001-6, all right reserved
12 ;; Version: $Date: 2006/01/19 03:13:41 $ $Revision: 1.14 $
13 ;; Home URL: http://xpt.sourceforge.net/
15 ;; This program is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 3, or (at your option)
20 ;; This program is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
28 ;; Viva Software Libre!
29 ;; Support the free software movement!
30 ;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
34 ;; SiSU (http://www.sisudoc.org/) is a document structuring and
35 ;; publishing framework. This package provides an Emacs major mode
38 ;; When this package is installed, files ending in ".sisu" are
39 ;; automatically associated with sisu-mode. If a file doesn't have a
40 ;; .sisu extension, add a first line:
43 ;; The documentation for the "Structure Of The Hierarchy Text" can be
44 ;; found in the sisustring for the sisu-mode function.
50 (defgroup sisu-faces nil
51 "AsciiSisu highlighting"
55 ; color n is more prominent than color n+1
57 (defface sisu-title-1-face
60 (:foreground "brown3" :bold t :height 1.2 :inherit variable-pitch))
63 (:foreground "brown3" :bold t :height 1.2 :inherit variable-pitch))
64 (t (:weight bold :inherit variable-pitch)))
65 "Face for AsciiSisu titles at level 1."
68 (defface sisu-title-2-face
71 (:foreground "yellow4" :bold t :height 1.1 :inherit variable-pitch))
74 (:foreground "yellow4" :bold t :height 1.1 :inherit variable-pitch))
75 (t (:weight bold :inherit variable-pitch)))
76 "Face for AsciiSisu titles at level 2."
79 (defface sisu-title-3-face
82 (:foreground "sienna3" :bold t))
85 (:foreground "sienna3" :bold t))
87 "Face for AsciiSisu titles at level 3."
90 (defface sisu-title-4-face
93 (:foreground "burlywood3"))
96 (:foreground "burlywood3"))
98 "Face for AsciiSisu titles at level 4."
102 '((((class color) (background light)) (:foreground "brown" :bold t :italic t))
103 (((class color) (background dark)) (:foreground "white" :bold t :italic t))
104 (t (:bold t :italic t)))
105 "Face for Info node names."
108 (defvar sisu-title-1 'sisu-title-1-face)
109 (defvar sisu-title-2 'sisu-title-2-face)
110 (defvar sisu-title-3 'sisu-title-3-face)
111 (defvar sisu-title-4 'sisu-title-4-face)
113 (defvar general-font-lock-red1 font-lock-warning-face)
114 (defvar general-font-lock-red2 font-lock-comment-face)
115 (defvar general-font-lock-red3 font-lock-string-face)
117 (defvar general-font-lock-green1 font-lock-type-face)
118 (defvar general-font-lock-green2 font-lock-constant-face)
120 (defvar general-font-lock-blue1 font-lock-keyword-face)
121 (defvar general-font-lock-blue2 font-lock-function-name-face)
122 (defvar general-font-lock-blue3 font-lock-builtin-face)
124 (defvar general-font-lock-yellow1 font-lock-variable-name-face)
125 (defvar general-font-lock-yellow2 font-lock-comment-face)
127 ;; == sisu-mode settings
129 (defvar sisu-mode-hook nil
130 "Normal hook run when entering Sisu Text mode.")
132 (defvar sisu-mode-abbrev-table nil
133 "Abbrev table in use in Sisu-mode buffers.")
134 (define-abbrev-table 'sisu-mode-abbrev-table ())
136 (defconst sisu-font-lock-keywords
141 (cons "^group\{\\|^\}group" 'general-font-lock-red2)
142 (cons "^block\{\\|^\}block" 'general-font-lock-red2)
143 (cons "^code\{\\|^\}code" 'general-font-lock-red2)
144 (cons "^poem\{\\|^\}poem" 'general-font-lock-red2)
145 (cons "^alt\{\\|^\}alt" 'general-font-lock-red2)
146 (cons "^table\{.+\\|^\}table" 'general-font-lock-red2)
147 (cons "^\{table[^}]+\}" 'general-font-lock-red2)
150 ;(cons "\~\{.+?\}\~" 'general-font-lock-green1)
151 (cons "\~\{\\*\\*\\|\~\{\\*\\|\~\{\\|\}\~" 'general-font-lock-red2)
152 (cons "\~\\[\\+\\|\~\\[\\*\\|\~\\[\\|\\]\~" 'general-font-lock-red2)
154 (cons "\~\\^ \\|^\\^\~ " 'general-font-lock-red2)
159 '(1 general-font-lock-red1 t)
160 '(2 general-font-lock-blue2 t))
162 ;; emphasis (can be program configured to be bold italics or underscore)
167 '(1 general-font-lock-red1 t)
168 '(2 general-font-lock-red1 t)
169 '(3 general-font-lock-red1 t))
176 '(1 general-font-lock-red1 t)
177 '(2 general-font-lock-red1 t)
178 '(3 general-font-lock-red1 t))
179 (cons "\\*[^ ]+\\*" 'general-font-lock-red1)
180 (cons "^!_ .+" 'general-font-lock-red1)
187 '(1 general-font-lock-red1 t)
188 '(2 general-font-lock-blue1 t)
189 '(3 general-font-lock-red1 t))
196 '(1 general-font-lock-red1 t)
197 '(2 general-font-lock-red1 t)
198 '(3 general-font-lock-red1 t))
205 '(1 general-font-lock-red1 t)
206 '(2 general-font-lock-red1 t)
207 '(3 general-font-lock-red1 t))
214 '(1 general-font-lock-red1 t)
215 '(2 general-font-lock-red1 t)
216 '(3 general-font-lock-red1 t))
223 '(1 general-font-lock-red1 t)
224 '(2 general-font-lock-red1 t)
225 '(3 general-font-lock-red1 t))
232 '(1 general-font-lock-red1 t)
233 '(2 general-font-lock-red1 t)
234 '(3 general-font-lock-red1 t))
241 '(1 general-font-lock-red1 t)
242 '(2 general-font-lock-red1 t)
243 '(3 general-font-lock-red1 t))
250 '(1 general-font-lock-red1 t)
251 '(2 general-font-lock-red1 t)
252 '(3 general-font-lock-red1 t))
255 (cons "^# \\|^_# " 'general-font-lock-red1)
258 (cons "^_\\*[1-9] \\|^_\\* " 'general-font-lock-red1)
261 (cons "^_[1-9] " 'general-font-lock-red1)
264 (cons "\\(^\\|[ ]\\)http:[/][/][^ \t\n\r<]+" 'general-font-lock-blue2)
269 (cons "^% .*" 'general-font-lock-blue1)
271 (cons "<br>" 'general-font-lock-red1)
274 (list "^\\(\\([1-8]\\|:?[A-C]\\)\\~\\)\\(.*\\)"
282 "\\(\}http:[/][/][^ \r\n\t<]+\\)")
283 '(1 general-font-lock-blue2 t)
284 '(2 general-font-lock-red1 t)
285 '(3 general-font-lock-blue2 t))
288 (cons "^\=\{.+\}" 'general-font-lock-green1)
291 (cons "\\<[.0-9]+\\>" 'general-font-lock-green2)
293 ;; bullets sisu_normal (nearly copied regexp)
294 (cons "^_\\([1-9*]\\|[1-9]\\*\\) " 'general-font-lock-blue2)
301 '(1 general-font-lock-blue2 t)
302 '(2 general-font-lock-red1 t)
303 '(3 general-font-lock-blue2 t))
308 "\\([^ \r\t\n]+\\.ss\\)"
310 '(1 general-font-lock-blue2 t)
311 '(2 general-font-lock-blue2 t)
312 '(3 general-font-lock-blue2 t))
328 '(1 sisu-title-2 keep)
329 '(3 sisu-title-3 keep))
332 "Default expressions to highlight in AsciiSisu mode.")
336 ;;{{{ Sisu & Autoload:
339 (define-derived-mode sisu-mode text-mode "SiSU"
340 "Major mode for editing SiSU files.
341 SiSU (http://www.sisudoc.org/) is a document structuring and
342 publishing framework. This major mode handles SiSU markup."
343 (modify-syntax-entry ?\' ".")
346 (make-local-variable 'paragraph-start)
347 (setq paragraph-start (concat "$\\|>" page-delimiter))
348 (make-local-variable 'paragraph-separate)
349 (setq paragraph-separate paragraph-start)
350 (make-local-variable 'paragraph-ignore-fill-prefix)
351 (setq paragraph-ignore-fill-prefix t)
353 (make-local-variable 'require-final-newline)
354 (setq require-final-newline t)
356 (make-local-variable 'font-lock-defaults)
357 (setq font-lock-defaults
358 '(sisu-font-lock-keywords
359 nil ; KEYWORDS-ONLY: no
361 ((?_ . "w")) ; SYNTAX-ALIST
363 (run-hooks 'sisu-mode-hook))
365 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.sisu\\'" . sisu-mode))
371 ;;; sisu-mode.el ends here