1 ;;; css-mode.el --- Major mode to edit CSS files
3 ;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
6 ;; Keywords: hypermedia
8 ;; This file 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 3, or (at your option)
13 ;; This file 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
20 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 ;; Boston, MA 02110-1301, USA.
25 ;; Yet another CSS mode.
30 ;; - filling code with auto-fill-mode
32 ;; - fix font-lock errors with multi-line selectors
37 "Cascading Style Sheets (CSS) editing mode."
40 (eval-when-compile (require 'cl))
42 (defun css-extract-keyword-list (res)
44 (url-insert-file-contents "http://www.w3.org/TR/REC-CSS2/css2.txt")
45 (goto-char (point-max))
46 (search-backward "Appendix H. Index")
48 (delete-region (point-min) (point))
52 (goto-char (point-min))
54 (while (re-search-forward (cdr re) nil t)
55 (push (match-string 1) keys))
56 (push (cons (car re) (sort keys 'string-lessp)) result))
59 (defun css-extract-parse-val-grammar (string env)
65 (concat "<a [^>]+><span [^>]+>\\(?:"
66 "<\\([^&]+\\)>\\|'\\([^']+\\)'"
74 "\\|" "\\(\\w+\\(?:-\\w+\\)*\\)"
77 ;; (assert (eq start (match-beginning 0)))
78 (setq start (match-end 0))
80 ;; Reference to a type of value.
81 ((setq name (match-string-no-properties 1 string))
82 (push (intern name) elems))
83 ;; Reference to another property's values.
84 ((setq name (match-string-no-properties 2 string))
85 (setq elems (delete-dups (append (cdr (assoc name env)) elems))))
87 ((setq name (match-string-no-properties 9 string))
89 ;; We just ignore the rest. I.e. we ignore the structure because
90 ;; it's too difficult to exploit anyway (it would allow us to only
91 ;; complete top/center/bottom after one of left/center/right and
97 (defun css-extract-props-and-vals ()
99 (url-insert-file-contents "http://www.w3.org/TR/CSS21/propidx.html")
100 (goto-char (point-min))
102 (while (re-search-forward "#propdef-\\([^\"]+\\)\"><span class=\"propinst-\\1 xref\">'\\1'</span></a>" nil t)
103 (let ((prop (match-string-no-properties 1)))
105 (goto-char (match-end 0))
106 (search-forward "<td>")
107 (let ((vals-string (buffer-substring (point)
109 (re-search-forward "[ \t\n]+|[ \t\n]+<a href=\"cascade.html#value-def-inherit\" class=\"noxref\"><span class=\"value-inst-inherit\">inherit</span></a>")
110 (match-beginning 0)))))
112 (push (cons prop (css-extract-parse-val-grammar vals-string props))
116 ;; Extraction was done with:
117 ;; (css-extract-keyword-list
118 ;; '((pseudo . "^ +\\* :\\([^ \n,]+\\)")
119 ;; (at . "^ +\\* @\\([^ \n,]+\\)")
120 ;; (descriptor . "^ +\\* '\\([^ '\n]+\\)' (descriptor)")
121 ;; (media . "^ +\\* '\\([^ '\n]+\\)' media group")
122 ;; (property . "^ +\\* '\\([^ '\n]+\\)',")))
124 (defconst css-pseudo-ids
125 '("active" "after" "before" "first" "first-child" "first-letter" "first-line"
126 "focus" "hover" "lang" "left" "link" "right" "visited")
127 "Identifiers for pseudo-elements and pseudo-classes.")
130 '("charset" "font-face" "import" "media" "page")
131 "Identifiers that appear in the form @foo.")
133 (defconst css-descriptor-ids
134 '("ascent" "baseline" "bbox" "cap-height" "centerline" "definition-src"
135 "descent" "font-family" "font-size" "font-stretch" "font-style"
136 "font-variant" "font-weight" "mathline" "panose-1" "slope" "src" "stemh"
137 "stemv" "topline" "unicode-range" "units-per-em" "widths" "x-height")
138 "Identifiers for font descriptors.")
140 (defconst css-media-ids
141 '("all" "aural" "bitmap" "continuous" "grid" "paged" "static" "tactile"
143 "Identifiers for types of media.")
145 (defconst css-property-ids
146 '("azimuth" "background" "background-attachment" "background-color"
147 "background-image" "background-position" "background-repeat" "block"
148 "border" "border-bottom" "border-bottom-color" "border-bottom-style"
149 "border-bottom-width" "border-collapse" "border-color" "border-left"
150 "border-left-color" "border-left-style" "border-left-width" "border-right"
151 "border-right-color" "border-right-style" "border-right-width"
152 "border-spacing" "border-style" "border-top" "border-top-color"
153 "border-top-style" "border-top-width" "border-width" "bottom"
154 "caption-side" "clear" "clip" "color" "compact" "content"
155 "counter-increment" "counter-reset" "cue" "cue-after" "cue-before"
156 "cursor" "dashed" "direction" "display" "dotted" "double" "elevation"
157 "empty-cells" "float" "font" "font-family" "font-size" "font-size-adjust"
158 "font-stretch" "font-style" "font-variant" "font-weight" "groove" "height"
159 "hidden" "inline" "inline-table" "inset" "left" "letter-spacing"
160 "line-height" "list-item" "list-style" "list-style-image"
161 "list-style-position" "list-style-type" "margin" "margin-bottom"
162 "margin-left" "margin-right" "margin-top" "marker-offset" "marks"
163 "max-height" "max-width" "min-height" "min-width" "orphans" "outline"
164 "outline-color" "outline-style" "outline-width" "outset" "overflow"
165 "padding" "padding-bottom" "padding-left" "padding-right" "padding-top"
166 "page" "page-break-after" "page-break-before" "page-break-inside" "pause"
167 "pause-after" "pause-before" "pitch" "pitch-range" "play-during" "position"
168 "quotes" "richness" "ridge" "right" "run-in" "size" "solid" "speak"
169 "speak-header" "speak-numeral" "speak-punctuation" "speech-rate" "stress"
170 "table" "table-caption" "table-cell" "table-column" "table-column-group"
171 "table-footer-group" "table-header-group" "table-layout" "table-row"
172 "table-row-group" "text-align" "text-decoration" "text-indent"
173 "text-shadow" "text-transform" "top" "unicode-bidi" "vertical-align"
174 "visibility" "voice-family" "volume" "white-space" "widows" "width"
175 "word-spacing" "z-index")
176 "Identifiers for properties.")
178 (defcustom css-electric-keys '(?\} ?\;) ;; '()
179 "Self inserting keys which should trigger re-indentation."
180 :type '(repeat character)
181 :options '((?\} ?\;))
184 (defvar css-mode-syntax-table
185 (let ((st (make-syntax-table)))
187 (modify-syntax-entry ?/ ". 14" st)
188 (modify-syntax-entry ?* ". 23" st)
190 (modify-syntax-entry ?\" "\"" st)
191 (modify-syntax-entry ?\' "\"" st)
193 (modify-syntax-entry ?\{ "(}" st)
194 (modify-syntax-entry ?\} "){" st)
195 ;; Args in url(...) thingies and other "function calls".
196 (modify-syntax-entry ?\( "()" st)
197 (modify-syntax-entry ?\) ")(" st)
198 ;; To match attributes in selectors.
199 (modify-syntax-entry ?\[ "(]" st)
200 (modify-syntax-entry ?\] ")[" st)
201 ;; Special chars that sometimes come at the beginning of words.
202 (modify-syntax-entry ?@ "'" st)
203 ;; (modify-syntax-entry ?: "'" st)
204 (modify-syntax-entry ?# "'" st)
205 ;; Distinction between words and symbols.
206 (modify-syntax-entry ?- "_" st)
209 (defconst css-escapes-re
210 "\\\\\\(?:[^\000-\037\177]\\|[0-9a-fA-F]+[ \n\t\r\f]?\\)")
211 (defconst css-nmchar-re (concat "\\(?:[-[:alnum:]]\\|" css-escapes-re "\\)"))
212 (defconst css-nmstart-re (concat "\\(?:[[:alpha:]]\\|" css-escapes-re "\\)"))
213 (defconst css-ident-re (concat css-nmstart-re css-nmchar-re "*"))
214 (defconst css-name-re (concat css-nmchar-re "+"))
216 (defface css-selector '((t :inherit font-lock-function-name-face))
217 "Face to use for selectors."
219 (defface css-property '((t :inherit font-lock-variable-name-face))
220 "Face to use for properties."
223 (defvar css-font-lock-keywords
224 `(("!\\s-*important" . font-lock-builtin-face)
225 ;; Atrules keywords. IDs not in css-at-ids are valid (ignored).
226 ;; In fact the regexp should probably be
227 ;; (,(concat "\\(@" css-ident-re "\\)\\([ \t\n][^;{]*\\)[;{]")
228 ;; (1 font-lock-builtin-face))
229 ;; Since "An at-rule consists of everything up to and including the next
230 ;; semicolon (;) or the next block, whichever comes first."
231 (,(concat "@" css-ident-re) . font-lock-builtin-face)
233 ;; FIXME: attribute selectors don't work well because they may contain
234 ;; strings which have already been highlighted as f-l-string-face and
235 ;; thus prevent this highlighting from being applied (actually now that
236 ;; I use `append' this should work better). But really the part of hte
237 ;; selector between [...] should simply not be highlighted.
238 (,(concat "^\\([ \t]*[^@:{\n][^:{\n]+\\(?::" (regexp-opt css-pseudo-ids t)
239 "\\(?:([^)]+)\\)?[^:{\n]*\\)*\\)\\(?:\n[ \t]*\\)*{")
240 (1 'css-selector append))
241 ;; In the above rule, we allow the open-brace to be on some subsequent
242 ;; line. This will only work if we properly mark the intervening text
243 ;; as being part of a multiline element (and even then, this only
244 ;; ensures proper refontification, but not proper discovery).
245 ("^[ \t]*{" (0 (save-excursion
246 (goto-char (match-beginning 0))
247 (skip-chars-backward " \n\t")
248 (put-text-property (point) (match-end 0)
249 'font-lock-multiline t)
252 ;; Properties. Again, we don't limit ourselves to css-property-ids.
253 (,(concat "\\(?:[{;]\\|^\\)[ \t]*\\(" css-ident-re "\\)\\s-*:")
256 (defvar css-font-lock-defaults
257 '(css-font-lock-keywords nil t))
259 (unless (fboundp 'prog-mode) (defalias 'prog-mode 'fundamental-mode))
261 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.css\\'" . css-mode))
263 (define-derived-mode css-mode prog-mode "CSS"
264 "Major mode to edit Cascading Style Sheets."
265 (set (make-local-variable 'font-lock-defaults) css-font-lock-defaults)
266 (set (make-local-variable 'comment-start) "/*")
267 (set (make-local-variable 'comment-start-skip) "/\\*+[ \t]*")
268 (set (make-local-variable 'comment-end) "*/")
269 (set (make-local-variable 'comment-end-skip) "[ \t]*\\*+/")
270 (set (make-local-variable 'forward-sexp-function) 'css-forward-sexp)
271 (set (make-local-variable 'parse-sexp-ignore-comments) t)
272 (set (make-local-variable 'indent-line-function) 'css-indent-line)
273 (set (make-local-variable 'fill-paragraph-function)
275 (when css-electric-keys
276 (let ((fc (make-char-table 'auto-fill-chars)))
277 (set-char-table-parent fc auto-fill-chars)
278 (dolist (c css-electric-keys)
279 (aset fc c 'indent-according-to-mode))
280 (set (make-local-variable 'auto-fill-chars) fc))))
282 (defvar comment-continue)
284 (defun css-fill-paragraph (&optional justify)
286 (let ((ppss (syntax-ppss))
287 (eol (line-end-position)))
291 (goto-char (nth 8 ppss))
294 (setq eol (point)))))
295 ;; Filling inside a comment whose comment-end marker is not \n.
296 ;; This code is meant to be generic, so that it works not only for
297 ;; css-mode but for all modes.
299 (narrow-to-region (nth 8 ppss) eol)
300 (comment-normalize-vars) ;Will define comment-continue.
301 (let ((fill-paragraph-function nil)
303 (if (and comment-continue
304 (string-match "[^ \t]" comment-continue))
305 (concat "\\(?:[ \t]*" (regexp-quote comment-continue)
306 "\\)?\\(?:" paragraph-separate "\\)")
309 (if (and comment-continue
310 (string-match "[^ \t]" comment-continue))
311 (concat "\\(?:[ \t]*" (regexp-quote comment-continue)
312 "\\)?\\(?:" paragraph-start "\\)")
314 (fill-paragraph justify)
315 ;; Don't try filling again.
318 ((and (null (nth 8 ppss))
322 (when (<= (point) eol)
323 (setq ppss (syntax-ppss)))))))
324 (goto-char (nth 1 ppss))
325 (let ((end (save-excursion
326 (ignore-errors (forward-sexp 1) (copy-marker (point) t)))))
328 (while (re-search-forward "[{;}]" end t)
330 ;; This is a false positive inside a string or comment.
331 ((nth 8 (syntax-ppss)) nil)
332 ((eq (char-before) ?\})
335 (skip-chars-backward " \t")
336 (unless (bolp) (newline))))
340 (setq eol (line-end-position))
341 (and (forward-comment 1)
343 ;; A multi-line comment should be on its own line.
344 (save-excursion (forward-comment -1)
345 (when (< (point) eol)
348 (if (< (point) eol) (newline)))))
349 (goto-char (nth 1 ppss))
350 (indent-region (line-beginning-position 2) end)
351 ;; Don't use the default filling code.
354 ;;; Navigation and indentation.
356 (defconst css-navigation-syntax-table
357 (let ((st (make-syntax-table css-mode-syntax-table)))
358 (map-char-table (lambda (c v)
359 ;; Turn punctuation (code = 1) into symbol (code = 1).
360 (if (eq (car-safe v) 1)
361 (set-char-table-range st c (cons 3 (cdr v)))))
365 (defun css-backward-sexp (n)
366 (let ((forward-sexp-function nil))
367 (if (< n 0) (css-forward-sexp (- n))
370 (forward-comment (- (point-max)))
371 (if (not (eq (char-before) ?\;))
373 (while (progn (backward-sexp 1)
375 (forward-comment (- (point-max)))
376 ;; FIXME: We should also skip punctuation.
377 (not (memq (char-before) '(?\; ?\{)))))))))))
379 (defun css-forward-sexp (n)
380 (let ((forward-sexp-function nil))
381 (if (< n 0) (css-backward-sexp (- n))
384 (forward-comment (point-max))
385 (if (not (eq (char-after) ?\;))
387 (while (progn (forward-sexp 1)
389 (forward-comment (point-max))
390 ;; FIXME: We should also skip punctuation.
391 (not (memq (char-after) '(?\; ?\})))))))))))
393 (defun css-indent-calculate-virtual ()
394 (if (or (save-excursion (skip-chars-backward " \t") (bolp))
395 (if (looking-at "\\s(")
397 (forward-char 1) (skip-chars-forward " \t")
398 (not (or (eolp) (looking-at comment-start-skip))))))
400 (css-indent-calculate)))
402 (defcustom css-indent-offset 4
403 "Basic size of one indentation step."
407 (defun css-indent-calculate ()
408 (let ((ppss (syntax-ppss))
410 (with-syntax-table css-navigation-syntax-table
414 ((nth 3 ppss) 'noindent)
419 (skip-chars-forward " \t")
420 (if (>= (nth 8 ppss) (point))
422 (goto-char (nth 8 ppss))
423 (if (eq (char-after pos) ?*)
425 (if (not (looking-at comment-start-skip))
426 (error "Internal css-mode error")
427 (goto-char (match-end 0))))
429 (if (and (eq (char-after pos) ?*) (eq (char-after) ?*))
437 (when (looking-at "\\s)")
440 (css-indent-calculate-virtual))
441 (when (looking-at comment-start-skip)
442 (forward-comment (point-max))
443 (css-indent-calculate))
444 (when (save-excursion (forward-comment (- (point-max)))
446 (eq (char-syntax (preceding-char)) ?\())
448 (if (not (looking-at "\\s([ \t]*"))
449 (error "Internal css-mode error")
450 (if (or (memq (char-after (match-end 0)) '(?\n nil))
451 (save-excursion (goto-char (match-end 0))
452 (looking-at comment-start-skip)))
453 (+ (css-indent-calculate-virtual) css-indent-offset)
454 (progn (goto-char (match-end 0)) (current-column)))))
456 (css-backward-sexp 1)
457 (if (looking-at "\\s(")
458 (css-indent-calculate)
459 (css-indent-calculate-virtual))))))))))
462 (defun css-indent-line ()
463 "Indent current line according to CSS indentation rules."
465 (let* ((savep (point))
466 (forward-sexp-function nil)
467 (indent (condition-case nil
470 (skip-chars-forward " \t")
471 (if (>= (point) savep) (setq savep nil))
472 (css-indent-calculate))
474 (if (not (numberp indent)) 'noindent
476 (save-excursion (indent-line-to indent))
477 (indent-line-to indent)))))
480 ;; arch-tag: b4d8b8e2-b130-4e74-b3aa-cd8f1ab659d0
481 ;;; css-mode.el ends here