1 ;;; sisu-mode.el --- Major mode for SiSU markup text
3 ;; Copyright (C) 2011, 2016 Free Software Foundation, Inc.
5 ;; Author: Ralph Amissah & Ambrose Kofi Laing
6 ;; Keywords: text, syntax, processes, tools
8 ;; URL: http://www.sisudoc.org/
9 ;; originally looked at (based on) doc-mode, with kind permission of the author
10 ;; Author: SUN, Tong <suntong001@users.sf.net>, (c)2001-6, all right reserved
11 ;; Version: $Date: 2006/01/19 03:13:41 $ $Revision: 1.14 $
12 ;; Home URL: http://xpt.sourceforge.net/
13 ;; with contributions from Kevin Ryde and Stefan Monnier
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
139 ;;grouped text ---------
140 ;(cons "^```[ ]code\\(.\\|\n\\)+?\n```\n" 'general-font-lock-red2)
141 (cons "^```[ ]+code.*?$\\|^```$" 'general-font-lock-red2)
142 (cons "^```[ ]+table.*?$\\|^```$" 'general-font-lock-red2)
143 (cons "^```[ ]+group$\\|^```$" 'general-font-lock-red2)
144 (cons "^```[ ]+block$\\|^```$" 'general-font-lock-red2)
145 (cons "^```[ ]+poem$\\|^```$" 'general-font-lock-red2)
146 (cons "^```[ ]+alt$\\|^```$" 'general-font-lock-red2)
147 ;;grouped text ---------
148 (cons "^group{\\|^}group" 'general-font-lock-red2)
149 (cons "^block{\\|^}block" 'general-font-lock-red2)
150 (cons "^code{\\|^}code" 'general-font-lock-red2)
151 (cons "^poem{\\|^}poem" 'general-font-lock-red2)
152 (cons "^alt{\\|^}alt" 'general-font-lock-red2)
153 (cons "^table{.+\\|^}table" 'general-font-lock-red2)
154 (cons "^{table[^}]+}" 'general-font-lock-red2)
158 "^\`\\{3\\}[ ]+code.*?$"
162 '(1 general-font-lock-red2 t)
164 '(3 general-font-lock-red2 t)
168 "^\`\\{3\\}[ ]+table.*?$"
172 '(1 general-font-lock-red2 t)
174 '(3 general-font-lock-red2 t)
178 "^\`\\{3\\}[ ]+\\(group\\|block\\|alt\\|poem\\)$"
182 '(1 general-font-lock-red2 t)
184 '(3 general-font-lock-red2 t)
187 ;; footnote/endnote ----
188 ;(cons "\~{.+?}\~" 'general-font-lock-green1)
189 (cons "\~{\\*\\*\\|\~{\\*\\|\~{\\|}\~" 'general-font-lock-red2)
190 (cons "\~\\[\\+\\|\~\\[\\*\\|\~\\[\\|\\]\~" 'general-font-lock-red2)
191 (cons "\~\\^ \\|^\\^\~ " 'general-font-lock-red2)
197 '(1 general-font-lock-red1 t)
198 '(2 general-font-lock-blue2 t)
201 ;; emphasis (can be program configured to be bold italics or underscore)
208 '(1 general-font-lock-red1 t)
209 '(2 general-font-lock-red1 t)
210 '(3 general-font-lock-red1 t)
213 ;; bold ----------------
220 '(1 general-font-lock-red1 t)
221 '(2 general-font-lock-red1 t)
222 '(3 general-font-lock-red1 t)
224 (cons "\\*[^ ]+\\*" 'general-font-lock-red1)
225 (cons "^!_ .+" 'general-font-lock-red1)
227 ;; italics -------------
234 '(1 general-font-lock-red1 t)
235 '(2 general-font-lock-blue1 t)
236 '(3 general-font-lock-red1 t)
239 ;; underscore ----------
246 '(1 general-font-lock-red1 t)
247 '(2 general-font-lock-red1 t)
248 '(3 general-font-lock-red1 t)
251 ;; monospace -----------
258 '(1 general-font-lock-red1 t)
259 '(2 general-font-lock-red1 t)
260 '(3 general-font-lock-red1 t)
263 ;; citation ------------
270 '(1 general-font-lock-red1 t)
271 '(2 general-font-lock-red1 t)
272 '(3 general-font-lock-red1 t)
275 ;; inserted text -------
282 '(1 general-font-lock-red1 t)
283 '(2 general-font-lock-red1 t)
284 '(3 general-font-lock-red1 t)
287 ;; strike through ------
294 '(1 general-font-lock-red1 t)
295 '(2 general-font-lock-red1 t)
296 '(3 general-font-lock-red1 t)
299 ;; superscript ---------
306 '(1 general-font-lock-red1 t)
307 '(2 general-font-lock-red1 t)
308 '(3 general-font-lock-red1 t)
311 ;; subscript -----------
318 '(1 general-font-lock-red1 t)
319 '(2 general-font-lock-red1 t)
320 '(3 general-font-lock-red1 t)
324 (cons "^# \\|^_# " 'general-font-lock-red1)
327 (cons "^_\\*[1-9] \\|^_\\* " 'general-font-lock-red1)
330 (cons "^_[1-9] " 'general-font-lock-red1)
331 (cons "^_[1-9]! " 'general-font-lock-red1)
333 ;; hanging indented text [proposed enable when implemented]
334 (cons "^__[1-9] " 'general-font-lock-red1)
335 (cons "^_[0-9]_[0-9] " 'general-font-lock-red1)
336 (cons "^__[1-9]! " 'general-font-lock-red1)
337 (cons "^_[0-9]_[0-9]! " 'general-font-lock-red1)
340 (cons "\\(^\\|[ ]\\)http:[/][/][^ \t\n\r<]+" 'general-font-lock-blue2)
343 (cons "^% .*" 'general-font-lock-blue1)
346 (cons "^\\(-\\\\\\\\-\\|=\\\\\\\\=\\|-\\.\\.-\\)" 'general-font-lock-red2)
349 (cons " \\\\\\\\ " 'general-font-lock-red1)
351 ;; line break (depreciated)
352 (cons "<br>" 'general-font-lock-red1)
355 (list "^\\(\\([1-4]\\|:?[A-D]\\)\\~\\)\\(.*\\)"
365 "\\(}http:[/][/][^ \r\n\t<]+\\)"
367 '(1 general-font-lock-blue2 t)
368 '(2 general-font-lock-red1 t)
369 '(3 general-font-lock-blue2 t)
379 '(1 general-font-lock-green1 t)
381 '(3 general-font-lock-green1 t)
384 ;(cons "^\={.+}" 'general-font-lock-green1)
387 (cons "\\<[.0-9]+\\>" 'general-font-lock-green2)
389 ;; bullets sisu_normal (nearly copied regexp)
390 (cons "^_\\([1-9*]\\|[1-9]\\*\\) " 'general-font-lock-blue2)
399 '(1 general-font-lock-blue2 t)
400 '(2 general-font-lock-red1 t)
401 '(3 general-font-lock-blue2 t)
408 "\\([^ \r\t\n]+\\.ss\\)"
411 '(1 general-font-lock-blue2 t)
412 '(2 general-font-lock-blue2 t)
413 '(3 general-font-lock-blue2 t)
433 '(1 sisu-title-2 keep)
434 '(3 sisu-title-3 keep)
438 "Default expressions to highlight in AsciiSisu mode."
441 ;; enables outlining for sisu
442 (add-hook 'sisu-mode-hook
445 ;;; outline mode "folding" if available
446 ;;; TODO make sure linum (line numbering) is off, else performance penalty, sucks bigtime
447 ;;(define-key evil-normal-state-map (kbd ",0") (lambda() (interactive) (show-all)))
448 ;;(define-key evil-normal-state-map (kbd ",-") (lambda() (interactive) (hide-body)))
449 ;;(define-key evil-normal-state-map (kbd ",+") (lambda() (interactive) (show-subtree)))
450 ;;(define-key evil-normal-state-map (kbd ",=") (lambda() (interactive) (show-subtree)))
452 ;;(define-key evil-normal-state-map ",0" 'show-all)
453 ;;(define-key evil-normal-state-map ",-" 'hide-body)
454 ;;(define-key evil-normal-state-map ",+" 'show-subtree)
455 ;;(define-key evil-normal-state-map ",=" 'show-subtree)
457 ;; C-c @ C-a show all
458 ;; C-c @ C-t show only the headings
459 ;; C-c @ C-s show subtree at cursor location
460 ;; C-c @ C-d hide subtree at cursor location
464 ;;{{{ Sisu & Autoload:
467 (define-derived-mode sisu-mode text-mode "SiSU"
468 "Major mode for editing SiSU files.
469 SiSU document structuring, publishing in multiple formats and search.
470 URL `http://www.sisudoc.org/'"
471 (modify-syntax-entry ?\' ".")
472 ;;(flyspell-mode nil)
474 (make-local-variable 'paragraph-start)
475 (setq paragraph-start (concat "$\\|>" page-delimiter))
476 (make-local-variable 'paragraph-separate)
477 (setq paragraph-separate paragraph-start)
478 (make-local-variable 'paragraph-ignore-fill-prefix)
479 (setq paragraph-ignore-fill-prefix t)
481 (set (make-local-variable 'outline-regexp)
482 "^\\(\\([1-4]\\|:?[A-D]\\)\\~\\|\\@[a-z]+:\\( \\|$\\)\\)")
484 (make-local-variable 'require-final-newline)
485 (setq require-final-newline t)
487 (make-local-variable 'font-lock-defaults)
488 (setq font-lock-defaults
489 '(sisu-font-lock-keywords
490 nil ; KEYWORDS-ONLY: no
492 ((?_ . "w")) ; SYNTAX-ALIST
495 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.ss[imt]\\'" . sisu-mode))
501 ;;; sisu-mode.el ends here