1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 ;;; haskell-font-lock.el --- Font locking module for Haskell Mode ;; Copyright 2003, 2004, 2005 Free Software Foundation, Inc. ;; Copyright 1997-1998 Graeme E Moss, and Tommy Thorn ;; Authors: 1997-1998 Graeme E Moss and ;; Tommy Thorn ;; 2003 Dave Love ;; Keywords: faces files Haskell ;; This file is not part of GNU Emacs. ;; This file is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 2, or (at your option) ;; any later version. ;; This file is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;;; Commentary: ;; Purpose: ;; ;; To support fontification of standard Haskell keywords, symbols, ;; functions, etc. Supports full Haskell 1.4 as well as LaTeX- and ;; Bird-style literate scripts. ;; ;; Installation: ;; ;; To turn font locking on for all Haskell buffers under the Haskell ;; mode of Moss&Thorn, add this to .emacs: ;; ;; (add-hook 'haskell-mode-hook 'turn-on-haskell-font-lock) ;; ;; Otherwise, call turn-on-haskell-font-lock'. ;; ;; ;; Customisation: ;; ;; The colours and level of font locking may be customised. See the ;; documentation on turn-on-haskell-font-lock' for more details. ;; ;; ;; History: ;; ;; If you have any problems or suggestions, after consulting the list ;; below, email gem@cs.york.ac.uk and thorn@irisa.fr quoting the ;; version of the mode you are using, the version of Emacs you are ;; using, and a small example of the problem or suggestion. Note that ;; this module requires a reasonably recent version of Emacs. It ;; requires Emacs 21 to cope with Unicode characters and to do proper ;; syntactic fontification. ;; ;; Version 1.3: ;; From Dave Love: ;; Support for proper behaviour (including with Unicode identifiers) ;; in Emacs 21 only hacked in messily to avoid disturbing the old ;; stuff. Needs integrating more cleanly. Allow literate comment ;; face to be customized. Some support for fontifying definitions. ;; (I'm not convinced the faces should be customizable -- fontlock ;; faces are normally expected to be consistent.) ;; ;; Version 1.2: ;; Added support for LaTeX-style literate scripts. Allow whitespace ;; after backslash to end a line for string continuations. ;; ;; Version 1.1: ;; Use own syntax table. Use backquote (neater). Stop ''' being ;; highlighted as quoted character. Fixed \"' fontification bug ;; in comments. ;; ;; Version 1.0: ;; Brought over from Haskell mode v1.1. ;; ;; Present Limitations/Future Work (contributions are most welcome!): ;; ;; . Debatable whether ()' []' (->)' (,)' (,,)' etc. should be ;; highlighted as constructors or not. Should the ->' in ;; id :: a -> a' be considered a constructor or a keyword? If so, ;; how do we distinguish this from \x -> x'? What about the \'? ;; ;; . XEmacs can support both --' comments and {- -}' comments ;; simultaneously. If XEmacs is detected, this should be used. ;; ;; . Support for GreenCard? ;; ;; All functions/variables start with ;; (turn-(on/off)-)haskell-font-lock' or haskell-fl-'. ;;; Code: (eval-when-compile (require 'haskell-mode) (require 'cl)) (require 'font-lock) ;; Version. (defconst haskell-font-lock-version "1.17" "Version number of haskell-font-lock.") (defun haskell-font-lock-version () "Echo the current version of haskell-font-lock in the minibuffer." (interactive) (message "Using haskell-font-lock version %s" haskell-font-lock-version)) (defcustom haskell-font-lock-symbols nil "Display \\ and -> and such using symbols in fonts. This may sound like a neat trick, but be extra careful: it changes the alignment and can thus lead to nasty surprises w.r.t layout. If t, try to use whichever font is available. Otherwise you can set it to a particular font of your preference among japanese-jisx0208' and unicode'." :group 'haskell :type '(choice (const nil) (const t) (const unicode) (const japanese-jisx0208))) (defconst haskell-font-lock-symbols-alist (append ;; Prefer single-width Unicode font for lambda. (and (fboundp 'decode-char) (memq haskell-font-lock-symbols '(t unicode)) (list (cons "\\" (decode-char 'ucs 955)))) ;; The symbols can come from a JIS0208 font. (and (fboundp 'make-char) (charsetp 'japanese-jisx0208) (memq haskell-font-lock-symbols '(t japanese-jisx0208)) (list (cons "not" (make-char 'japanese-jisx0208 34 76)) (cons "\\" (make-char 'japanese-jisx0208 38 75)) (cons "->" (make-char 'japanese-jisx0208 34 42)) (cons "<-" (make-char 'japanese-jisx0208 34 43)) (cons "=>" (make-char 'japanese-jisx0208 34 77)))) ;; Or a unicode font. (and (fboundp 'decode-char) (memq haskell-font-lock-symbols '(t unicode)) (list (cons "not" (decode-char 'ucs 172)) (cons "->" (decode-char 'ucs 8594)) (cons "<-" (decode-char 'ucs 8592)) (cons "=>" (decode-char 'ucs 8658)) (cons "~>" (decode-char 'ucs 8669)) ;; Omega language ;; (cons "~>" (decode-char 'ucs 8605)) ;; less desirable (cons "-<" (decode-char 'ucs 8610)) ;; Paterson's arrow syntax ;; (cons "-<" (decode-char 'ucs 10521)) ;; nicer but uncommon (cons "::" (decode-char 'ucs 8759)) (cons "." (decode-char 'ucs 9675)))))) ;; Use new vars for the font-lock faces. The indirection allows people to ;; use different faces than in other modes, as before. (defvar haskell-keyword-face 'font-lock-keyword-face) (defvar haskell-constructor-face 'font-lock-type-face) ;; This used to be font-lock-variable-name-face' but it doesn't result in ;; a highlighting that's consistent with other modes (it's mostly used ;; for function defintions). (defvar haskell-definition-face 'font-lock-function-name-face) ;; This is probably just wrong, but it used to use ;; font-lock-function-name-face' with a result that was not consistent with ;; other major modes, so I just exchanged with haskell-definition-face'. (defvar haskell-operator-face 'font-lock-variable-name-face) (defvar haskell-default-face nil) (defvar haskell-literate-comment-face 'font-lock-doc-face "Face with which to fontify literate comments. Set to default' to avoid fontification of them.") (defconst haskell-emacs21-features (string-match "[[:alpha:]]" "x") "Non-nil if we have regexp char classes. Assume this means we have other useful features from Emacs 21.") (defun haskell-font-lock-compose-symbol (alist) "Compose a sequence of ascii chars into a symbol. Regexp match data 0 points to the chars." ;; Check that the chars should really be composed into a symbol. (let* ((start (match-beginning 0)) (end (match-end 0)) (syntaxes (cond ((eq (char-syntax (char-after start)) ?w) '(?w)) ;; Special case for the . used for qualified names. ((and (eq (char-after start) ?\.) (= end (1+ start))) '(?_ ?\\ ?w)) (t '(?_ ?\\))))) (if (or (memq (char-syntax (or (char-before start) ?\ )) syntaxes) (memq (char-syntax (or (char-after end) ?\ )) syntaxes) (memq (get-text-property start 'face) '(font-lock-doc-face font-lock-string-face font-lock-comment-face))) ;; No composition for you. Let's actually remove any composition ;; we may have added earlier and which is now incorrect. (remove-text-properties start end '(composition)) ;; That's a symbol alright, so add the composition. (compose-region start end (cdr (assoc (match-string 0) alist))))) ;; Return nil because we're not adding any face property. nil) (defun haskell-font-lock-symbols-keywords () (when (fboundp 'compose-region) (let ((alist nil)) (dolist (x haskell-font-lock-symbols-alist) (when (and (if (fboundp 'char-displayable-p) (char-displayable-p (cdr x)) t) (not (assoc (car x) alist))) ;Not yet in alist. (push x alist))) (when alist ((,(regexp-opt (mapcar 'car alist) t) (0 (haskell-font-lock-compose-symbol ',alist)))))))) ;; The font lock regular expressions. (defun haskell-font-lock-keywords-create (literate) "Create fontification definitions for Haskell scripts. Returns keywords suitable for font-lock-keywords'." (let* (;; Bird-style literate scripts start a line of code with ;; "^>", otherwise a line of code starts with "^". (line-prefix (if (eq literate 'bird) "^> ?" "^")) ;; Most names are borrowed from the lexical syntax of the Haskell ;; report. ;; Some of these definitions have been superseded by using the ;; syntax table instead. ;; (ASCsymbol "-!#$%&*+./<=>?@\\\\^|~") ;; Put the minus first to make it work in ranges. ;; (ISOsymbol "\241-\277\327\367") (ISOlarge "\300-\326\330-\337") (ISOsmall "\340-\366\370-\377") (small (if haskell-emacs21-features "[:lower:]" (concat "a-z" ISOsmall))) (large (if haskell-emacs21-features "[:upper:]" (concat "A-Z" ISOlarge))) (alnum (if haskell-emacs21-features "[:alnum:]" (concat small large "0-9"))) ;; (symbol ;; (concat ASCsymbol ISOsymbol)) ;; We allow _ as the first char to fit GHC (varid (concat "\\b[" small "_][" alnum "'_]*\\b")) (conid (concat "\\b[" large "][" alnum "'_]*\\b")) (modid (concat "\\b" conid "\$$\\." conid "\$$*\\b")) (qvarid (concat modid "\\." varid)) (qconid (concat modid "\\." conid)) (sym ;; We used to use the below for non-Emacs21, but I think the ;; regexp based on syntax works for other emacsen as well. -- Stef ;; (concat "[" symbol ":]+") ;; Add backslash to the symbol-syntax chars. This seems to ;; be thrown for some reason by backslash's escape syntax. "\$$\\s_\\|\\\\\$$+") ;; Reserved operations (reservedsym (concat "\\S_" ;; (regexp-opt '(".." "::" "=" "\\" "|" "<-" "->" ;; "@" "~" "=>") t) "\$$->\\|\\.\\.\\|::\\|<-\\|=>\\|[=@\\|~]\$$" "\\S_")) ;; Reserved identifiers (reservedid (concat "\\b" ;; ?? as' and qualified' aren't in the Haskell98 list. ;; _' can go in here since it has temporary word syntax. ;; (regexp-opt ;; '("as" "case" "class" "data" "default" "deriving" "do" ;; "else" "hiding" "if" "import" "in" "infix" "infixl" ;; "infixr" "instance" "let" "module" "newtype" "of" ;; "qualified" "then" "type" "where" "_") t) "\$$_\\|as\\|c\\(ase\\|lass\$$\\|d\$$ata\\|e\\(fault\\|riving\$$\\|o\\)\\|else\\|hiding\\|i\$$mport\\|n\\(fix[lr]?\\|stance\$$\\|[fn]\\)\\|let\\|module\\|newtype\\|of\\|qualified\\|t\$$hen\\|ype\$$\\|where\\)" "\\b")) ;; This unreadable regexp matches strings and character ;; constants. We need to do this with one regexp to handle ;; stuff like '"':"'". The regexp is the composition of ;; "([^"\\]|\\.)*" for strings and '([^\\]|\\.[^']*)' for ;; characters, allowing for string continuations. ;; Could probably be improved... (string-and-char (concat "\$$\\(\"\\|" line-prefix "[ \t]*\\\\\$$\$$[^\"\\\\\n]\\|\\\\.\$$*\$$\"\\|\\\$\t]*\$$\\|'\$$[^'\\\\\n]\\|\\\\.[^'\n]*\$$'\\)")) ;; Top-level declarations (topdecl-var (concat line-prefix "\$$" varid "\$$\\s-*\$$" varid "\\|" conid "\\|::\\|=\\||\\|\\s(\$$")) (topdecl-var2 (concat line-prefix "\$$" varid "\\|" conid "\$$\\s-*\$$" varid "\$$")) (topdecl-sym (concat line-prefix "\$$" varid "\\|" conid "\$$\\s-*\$$" sym "\$$")) (topdecl-sym2 (concat line-prefix "(\$$" sym "\$$)")) keywords) (setq keywords (;; NOTICE the ordering below is significant ;; ("^#.*" 0 'font-lock-warning-face t) ,@(unless haskell-emacs21-features ;; Expensive. ((,string-and-char 1 font-lock-string-face))) ;; This was originally at the very end (and needs to be after ;; all the comment/string/doc highlighting) but it seemed to ;; trigger a bug in Emacs-21.3 which caused the compositions to ;; be "randomly" dropped. Moving it earlier seemed to reduce ;; the occurrence of the bug. ,@(haskell-font-lock-symbols-keywords) (,reservedid 1 (symbol-value 'haskell-keyword-face)) (,reservedsym 1 (symbol-value 'haskell-operator-face)) ;; Toplevel Declarations. ;; Place them *before* generic id-and-op highlighting. (,topdecl-var (1 (symbol-value 'haskell-definition-face))) (,topdecl-var2 (2 (symbol-value 'haskell-definition-face))) (,topdecl-sym (2 (symbol-value 'haskell-definition-face))) (,topdecl-sym2 (1 (symbol-value 'haskell-definition-face))) ;; These four are debatable... ("(\$$,*\\|->\$$)" 0 (symbol-value 'haskell-constructor-face)) ("\\[\$" 0 (symbol-value 'haskell-constructor-face)) ;; Expensive. (,qvarid 0 haskell-default-face) (,qconid 0 (symbol-value 'haskell-constructor-face)) (,(concat "\" varid "\") 0 (symbol-value 'haskell-operator-face)) ;; Expensive. (,conid 0 (symbol-value 'haskell-constructor-face)) ;; Very expensive. (,sym 0 (if (eq (char-after (match-beginning 0)) ?:) haskell-constructor-face haskell-operator-face)))) (unless haskell-emacs21-features (case literate (bird (setq keywords (("^[^>\n].*$" 0 haskell-comment-face t) ,@keywords ("^>" 0 haskell-default-face t)))) (latex (setq keywords ((haskell-fl-latex-comments 0 'font-lock-comment-face t) ,@keywords))))) keywords)) ;; The next three aren't used in Emacs 21. (defvar haskell-fl-latex-cache-pos nil "Position of cache point used by haskell-fl-latex-cache-in-comment'. Should be at the start of a line.") (defvar haskell-fl-latex-cache-in-comment nil "If haskell-fl-latex-cache-pos' is outside a \\begin{code}..\\end{code} block (and therefore inside a comment), this variable is set to t, otherwise nil.") (defun haskell-fl-latex-comments (end) "Sets match-data' according to the region of the buffer before end that should be commented under LaTeX-style literate scripts." (let ((start (point))) (if (= start end) ;; We're at the end. No more to fontify. nil (if (not (eq start haskell-fl-latex-cache-pos)) ;; If the start position is not cached, calculate the state ;; of the start. (progn (setq haskell-fl-latex-cache-pos start) ;; If the previous \begin{code} or \end{code} is a ;; \begin{code}, then start is not in a comment, otherwise ;; it is in a comment. (setq haskell-fl-latex-cache-in-comment (if (and (re-search-backward "^\$$\\(\\\\begin{code}\$$\\|\$$\\\\end{code}\$$\\)$" (point-min) t) (match-end 2)) nil t)) ;; Restore position. (goto-char start))) (if haskell-fl-latex-cache-in-comment (progn ;; If start is inside a comment, search for next \begin{code}. (re-search-forward "^\\\\begin{code}$" end 'move) ;; Mark start to end of \begin{code} (if present, till end ;; otherwise), as a comment. (set-match-data (list start (point))) ;; Return point, as a normal regexp would. (point)) ;; If start is inside a code block, search for next \end{code}. (if (re-search-forward "^\\\\end{code}$" end t) ;; If one found, mark it as a comment, otherwise finish. (point)))))) (defconst haskell-basic-syntactic-keywords '(;; Character constants (since apostrophe can't have string syntax). ;; Beware: do not match something like 's-}' or '\n"+' since the first ' ;; might be inside a comment or a string. ;; This still gets fooled with "'"'"'"'"'"', but ... oh well. ("\\Sw\$$'\$$\$$[^\\'\n]\\|\\\\.[^\\'\n \"}]*\$$\$$'\$$" (1 "|") (3 "|")) ;; The \ is not escaping in $$x,y) -> x + y. ("\\(\\\\\$$(" (1 ".")) ;; The second \ in a gap does not quote the subsequent char. ;; It's probably not worth the trouble, tho. ;; ("^[ \t]*\$$\\\\\$$" (1 ".")) ;; Deal with instances of --' which don't form a comment. ("\\s_\\{3,\\}" (0 (if (string-match "\\-*\\'" (match-string 0)) ;; Sequence of hyphens. Do nothing in ;; case of things like {---'. nil "_"))))) ; other symbol sequence (defconst haskell-bird-syntactic-keywords (cons '("^[^\n>]" (0 "<")) haskell-basic-syntactic-keywords)) (defconst haskell-latex-syntactic-keywords (append '(("^\\\\begin{code}\$$\n\$$" 1 "!") ;; Note: buffer is widened during font-locking. ("\\\$$.\\|\n\$$" (1 "!")) ; start comment at buffer start ("^\$$\\\\\$$end{code}$" 1 "!")) haskell-basic-syntactic-keywords)) (defun haskell-syntactic-face-function (state) "font-lock-syntactic-face-function' for Haskell." (cond ((nth 3 state) font-lock-string-face) ; as normal ;; Else comment. If it's from syntax table, use default face. ((or (eq 'syntax-table (nth 7 state)) (and (eq haskell-literate 'bird) (memq (char-before (nth 8 state)) '(nil ?\n)))) haskell-literate-comment-face) (t font-lock-comment-face))) (defconst haskell-font-lock-keywords (haskell-font-lock-keywords-create nil) "Font lock definitions for non-literate Haskell.") (defconst haskell-font-lock-bird-literate-keywords (haskell-font-lock-keywords-create 'bird) "Font lock definitions for Bird-style literate Haskell.") (defconst haskell-font-lock-latex-literate-keywords (haskell-font-lock-keywords-create 'latex) "Font lock definitions for LaTeX-style literate Haskell.") (defun haskell-font-lock-choose-keywords () (let ((literate (if (boundp 'haskell-literate) haskell-literate))) (case literate (bird haskell-font-lock-bird-literate-keywords) (latex haskell-font-lock-latex-literate-keywords) (t haskell-font-lock-keywords)))) (defun haskell-font-lock-choose-syntactic-keywords () (let ((literate (if (boundp 'haskell-literate) haskell-literate))) (case literate (bird haskell-bird-syntactic-keywords) (latex haskell-latex-syntactic-keywords) (t haskell-basic-syntactic-keywords)))) (defun haskell-font-lock-defaults-create () "Locally set font-lock-defaults' for Haskell." (set (make-local-variable 'font-lock-defaults) '(haskell-font-lock-choose-keywords nil nil ((?\' . "w") (?_ . "w")) nil (font-lock-syntactic-keywords . haskell-font-lock-choose-syntactic-keywords) (font-lock-syntactic-face-function . haskell-syntactic-face-function) ;; Get help from font-lock-syntactic-keywords. (parse-sexp-lookup-properties . t)))) ;; The main functions. (defun turn-on-haskell-font-lock () "Turns on font locking in current buffer for Haskell 1.4 scripts. Changes the current buffer's font-lock-defaults', and adds the following variables: haskell-keyword-face' for reserved keywords and syntax, haskell-constructor-face' for data- and type-constructors, class names, and module names, haskell-operator-face' for symbolic and alphanumeric operators, haskell-default-face' for ordinary code. The variables are initialised to the following font lock default faces: haskell-keyword-face' font-lock-keyword-face' haskell-constructor-face' font-lock-type-face' haskell-operator-face' font-lock-function-name-face' haskell-default-face' Two levels of fontification are defined: level one (the default) and level two (more colour). The former does not colour operators. Use the variable font-lock-maximum-decoration' to choose non-default levels of fontification. For example, adding this to .emacs: (setq font-lock-maximum-decoration '((haskell-mode . 2) (t . 0))) uses level two fontification for haskell-mode' and default level for all other modes. See documentation on this variable for further details. To alter an attribute of a face, add a hook. For example, to change the foreground colour of comments to brown, add the following line to .emacs: (add-hook 'haskell-font-lock-hook (lambda () (set-face-foreground 'haskell-comment-face \"brown\"))) Note that the colours available vary from system to system. To see what colours are available on your system, call list-colors-display' from emacs. To turn font locking on for all Haskell buffers, add this to .emacs: (add-hook 'haskell-mode-hook 'turn-on-haskell-font-lock) To turn font locking on for the current buffer, call turn-on-haskell-font-lock'. To turn font locking off in the current buffer, call turn-off-haskell-font-lock'. Bird-style literate Haskell scripts are supported: If the value of haskell-literate-bird-style' (automatically set by the Haskell mode of Moss&Thorn) is non-nil, a Bird-style literate script is assumed. Invokes haskell-font-lock-hook' if not nil. Use haskell-font-lock-version' to find out what version this is." (interactive) (haskell-font-lock-defaults-create) (run-hooks 'haskell-font-lock-hook) (turn-on-font-lock)) (defun turn-off-haskell-font-lock () "Turns off font locking in current buffer." (interactive) (font-lock-mode -1)) ;; Provide ourselves: (provide 'haskell-font-lock) ;;; haskell-font-lock.el ends here