emacs/external/django-html-mode.el

   1 ;; django-html-mode.el --- django html mode
   2
   3 ;; Author: TSKim (http://tsgates.cafe24.com, tsgatesv@gmail.com)
   4 ;; Keywords: django html languages
   5 ;; Created : 2007.01
   6
   7 ;; This file is NOT part of GNU Emacs.
   8
   9 ;; This file is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; This file is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to
  21 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22 ;; Boston, MA 02110-1301, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;
  27
  28 ;;; Code:
  29
  30 (require 'sgml-mode)
  31
  32 (defvar django-html-mode-hook nil)
  33
  34 (defvar django-html-mode-map
  35   (let ((django-html-mode-map (make-keymap)))
  36     (define-key django-html-mode-map "\C-j" 'newline-and-indent)
  37     django-html-mode-map)
  38   "Keymap for Django major mode")
  39
  40 ;; if : if, if not, if A or B, if not A or B, if not A and B
  41 ;; TODO in for loop
  42 ;; for : for a in alist reversed
  43   ;; forloop.counter    The current iteration of the loop (1-indexed)
  44   ;; forloop.counter0   The current iteration of the loop (0-indexed)
  45   ;; forloop.revcounter         The number of iterations from the end of the loop (1-indexed)
  46   ;; forloop.revcounter0        The number of iterations from the end of the loop (0-indexed)
  47   ;; forloop.first      True if this is the first time through the loop
  48   ;; forloop.last       True if this is the last time through the loop
  49   ;; forloop.parentloop         For nested loops, this is the loop "above" the current one
  50
  51 ;; ifequal : ifequal A B
  52 ;; comment : {% This is comment %}
  53 ;; filter : {{ name | lower }}
  54
  55 ;; keyword-end : if, for, ifequal, block, ifnotequal, spaceless
  56 ;; keyword-3 : regroup
  57 ;; keyword-2 : for, ifequal
  58 ;; keyword-1 : if, block, extends, include, ifchanged, load, now, ssi, withratio
  59 ;; keyword-0 : else, spaceless
  60
  61 ;; start and end keyword for block/comment/variable
  62 (defconst django-html-open-block     "{%")
  63 (defconst django-html-close-block    "%}")
  64 (defconst django-html-open-comment   "{#")
  65 (defconst django-html-close-comment  "#}")
  66 (defconst django-html-open-variable  "{{")
  67 (defconst django-html-close-variable "}}")
  68
  69 (defconst django-html-font-lock-keywords-1
  70   (append
  71    ;; html-mode keyword
  72    sgml-font-lock-keywords-1)
  73
  74   "First level keyword highlighting")
  75
  76 (defconst django-html-font-lock-keywords-2
  77   (append
  78    django-html-font-lock-keywords-1
  79    sgml-font-lock-keywords-2))
  80
  81 (defconst django-html-font-lock-keywords-3
  82   (append
  83    django-html-font-lock-keywords-1
  84    django-html-font-lock-keywords-2
  85
  86       `(;; comment
  87      (,(rx (eval django-html-open-comment)
  88            (1+ space)
  89            (0+ (not (any "#")))
  90            (1+ space)
  91            (eval django-html-close-comment))
  92       . font-lock-comment-face)
  93
  94      ;; variable font lock
  95      (,(rx (eval django-html-open-variable)
  96            (1+ space)
  97            (group (0+ (not (any "}"))))
  98            (1+ space)
  99            (eval django-html-close-variable))
 100       (1 font-lock-variable-name-face))
 101
 102      ;; start, end keyword font lock
 103      (,(rx (group (or (eval django-html-open-block)
 104                       (eval django-html-close-block)
 105                       (eval django-html-open-comment)
 106                       (eval django-html-close-comment)
 107                       (eval django-html-open-variable)
 108                       (eval django-html-close-variable))))
 109       (1 font-lock-builtin-face))
 110
 111      ;; end prefix keyword font lock
 112      (,(rx (eval django-html-open-block)
 113            (1+ space)
 114            (group (and "end"
 115                         ;; end prefix keywords
 116                        (or "if" "for" "ifequal" "block" "ifnotequal" "spaceless" "filter")))
 117            (1+ space)
 118            (eval django-html-close-block))
 119       (1 font-lock-keyword-face))
 120
 121      ;; more words after keyword
 122      (,(rx (eval django-html-open-block)
 123            (1+ space)
 124            (group (or "extends" "for" "cycle" "filter" "if not" "else"
 125                       "firstof" "debug" "if" "ifchanged" "ifequal" "ifnotequal"
 126                       "include" "load" "now" "regroup" "spaceless" "ssi"
 127                       "templatetag" "widthratio" "block"))
 128
 129            ;; TODO: is there a more beautiful way?
 130            (0+ (not (any "}")))
 131
 132            (1+ space)
 133            (eval django-html-close-block))
 134       (1 font-lock-keyword-face))
 135
 136      ;; TODO: if specific cases for supporting "or", "not", and "and"
 137
 138      ;; for sepcific cases for supporting in
 139      (,(rx (eval django-html-open-block)
 140            (1+ space)
 141            "for"
 142            (1+ space)
 143
 144            (group (1+ (or word ?_ ?.)))
 145
 146            (1+ space)
 147            (group "in")
 148            (1+ space)
 149
 150            (group (1+ (or word ?_ ?.)))
 151
 152            (group (? (1+ space) "reverse"))
 153
 154            (1+ space)
 155            (eval django-html-close-block))
 156       (1 font-lock-variable-name-face) (2 font-lock-keyword-face)
 157       (3 font-lock-variable-name-face) (4 font-lock-keyword-face)))))
 158
 159 (defvar django-html-font-lock-keywords
 160   django-html-font-lock-keywords-1)
 161
 162 (defvar django-html-mode-syntax-table
 163   (let ((django-html-mode-syntax-table (make-syntax-table)))
 164     django-html-mode-syntax-table)
 165   "Syntax table for django-html-mode")
 166
 167 ;;;###autoload
 168 (define-derived-mode django-html-mode html-mode  "django-html"
 169   "Major mode for editing django html files(.djhtml)"
 170   :group 'django-html
 171
 172   ;; it mainly from sgml-mode font lock setting
 173   (set (make-local-variable 'font-lock-defaults)
 174        '((django-html-font-lock-keywords
 175           django-html-font-lock-keywords-1
 176           django-html-font-lock-keywords-2
 177           django-html-font-lock-keywords-3)
 178          nil t nil nil
 179          (font-lock-syntactic-keywords
 180           . sgml-font-lock-syntactic-keywords))))
 181
 182 ;; ".html" is common in django
 183 ;; (add-to-list 'auto-mode-alist '("\\.djhtml$'" . django-html-mode))
 184
 185 (provide 'django-html-mode)