branch: elpa/scala-mode
commit 17c63065df44b8c4a3449507e5e353f3f0c21146
Author: Gary Pamparà <gpamp...@gmail.com>
Commit: Gary Pamparà <gpamp...@gmail.com>
Highlight "var"s differently.
Currently, both var and val definitions are font-lock'd the same, which
is compeltely valid. It is rather useful to have "var"s highlighted
differently to indicate special treatment.
var highlighting is governed by the defined face scala-font-lock:var-face,
which defaults to inherit styling from 'font-lock-warning-face. The
face is customizable from the customize-face command in emacs, ie:
M-x customize-face
Signed-off-by: Gary Pamparà <gpamp...@gmail.com>
---
README.md | 23 ++++++++++++----
scala-mode-fontlock.el | 75 +++++++++++++++++++++++++++++++-------------------
2 files changed, 63 insertions(+), 35 deletions(-)
diff --git a/README.md b/README.md
index 6a76e0d..5a9d95b 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ standard emacs motions work ofcourse.
## Setting the mode up for use
-1. Make sure you have the latest version of **GNU Emacs** installed.
+1. Make sure you have the latest version of **GNU Emacs** installed.
The mode has been developed on 24.2 and uses features not available
in emacs prior to version 24.
@@ -41,7 +41,7 @@ modified from the scala-mode customization menu.
## Indenting modes
*Where four developers meet, there are four opinions on how code should
-be indented. Luckily scala-mode already supports 2^4 different ways of
+be indented. Luckily scala-mode already supports 2^4 different ways of
indenting.*
### Run-on lines (scala-indent:default-run-on-strategy)
@@ -63,7 +63,7 @@ The *operators* and *eager* modes will indent the second row
in the
following code, as the first line ends with an operator character.
```
-val x = 20 +
+val x = 20 +
21
```
@@ -234,7 +234,7 @@ or a mode-hook.
## Motion
-Basic emacs motion will work as expected.
+Basic emacs motion will work as expected.
Text paragraph motion (i.e. *forward-paragraph*, *backward-paragraph*)
works inside comments and multi-line strings, and it respect scaladoc's
@@ -271,7 +271,7 @@ you may want to try. Just copy-paste it to your `.emacs`
file.
;; Bind the backtab (shift tab) to
;; 'scala-indent:indent-with-reluctant-strategy command. This is usefull
- ;; when using the 'eager' mode by default and you want to "outdent" a
+ ;; when using the 'eager' mode by default and you want to "outdent" a
;; code line as a new statement.
(local-set-key (kbd "<backtab>")
'scala-indent:indent-with-reluctant-strategy)
@@ -309,7 +309,7 @@ can do so in the mode hook (set *indent-tabs-mode* to t).
Highlighting code is still a work in progress. Feedback on how it
should work is welcomed as issues to this github project.
-It may come as a suprice to some that scaladoc comments (comments that
+It may come as a surprise to some that scaladoc comments (comments that
start with exactly `/** `) are highlighted in the same color as
strings. This is because scaladoc comments get the font-lock-doc-face,
which is usually an alias for font-lock-string-face (a heritage from
@@ -322,6 +322,17 @@ background and you are having trouble with colors, try
setting the
customization variable *frame-background-mode* to *dark* (use **M-x**
*customize-variable*).
+### Highlighting of variable definitions
+The highlighting of variable definitions, such as
+
+```var test = "some mutable variable"```
+
+now result in the variable name ("test" above) to be highlighted using the
variable
+scala-font-lock:var-face. Per default, the value of scala-font-lock:var-face
+is 'font-lock-warning-face. You can always change the highlighting of vars
+by changing scala-font-lock:var-face through the Emacs face customization
+(use **M-x** *customize-face*).
+
## Other features
- highlights only properly formatted string and character constants
- indenting a code line removes trailing whitespace
diff --git a/scala-mode-fontlock.el b/scala-mode-fontlock.el
index 010e12a..a655588 100644
--- a/scala-mode-fontlock.el
+++ b/scala-mode-fontlock.el
@@ -97,7 +97,7 @@ Does not continue past limit.
(while (not (or (eobp)
(scala-syntax:looking-at "[,);]")
(scala-syntax:looking-at-reserved-symbol "|")
- (scala-syntax:looking-at-reserved-symbol
+ (scala-syntax:looking-at-reserved-symbol
scala-syntax:double-arrow-unsafe-re)
(scala-syntax:looking-at-empty-line-p)))
(scala-syntax:forward-sexp)
@@ -116,7 +116,7 @@ Does not continue past limit.
(varid (scala-syntax:looking-at-varid-p)))
(goto-char end)
(let ((new-match-data
- (cond
+ (cond
((= (char-after end) ?\()
;; matched type
; (message "it's a type")
@@ -133,7 +133,7 @@ Does not continue past limit.
`(,beg ,end nil nil ,beg ,end nil nil)))))
(goto-char end)
(scala-syntax:skip-forward-ignorable)
- (cond
+ (cond
((and (not (or (scala-syntax:looking-at-reserved-symbol nil)
(scala-syntax:looking-at-reserved-symbol "|")))
(scala-syntax:looking-at-stableIdOrPath))
@@ -159,8 +159,8 @@ Does not continue past limit.
;; else leave point at start of first element.
((= (char-after) ?\()
; (message "(")
- (let ((alternatives-p
- (save-excursion
+ (let ((alternatives-p
+ (save-excursion
(forward-char)
(ignore-errors
;; forward-sexp will terminate the loop with error
@@ -186,25 +186,25 @@ Does not continue past limit.
(set-match-data nil)
t)
;; none of the above, just stop
- (t
-; (message "Cannot continue Pattern1 at %d" (point))
+ (t
+; (message "Cannot continue Pattern1 at %d" (point))
nil)
))
(defun scala-font-lock:limit-pattern (&optional start)
- (save-excursion
+ (save-excursion
(goto-char (scala-font-lock:limit-pattern2 start))
; (message "now at %d" (point))
(when (scala-syntax:looking-at-reserved-symbol ":")
(while (not (or (eobp)
(scala-syntax:looking-at-reserved-symbol "|")
- (scala-syntax:looking-at-reserved-symbol
+ (scala-syntax:looking-at-reserved-symbol
scala-syntax:double-arrow-unsafe-re)
(scala-syntax:looking-at-empty-line-p)))
(scala-syntax:forward-sexp)
(scala-syntax:skip-forward-ignorable)))
(if (or (/= (char-after) ?|)
- (scala-syntax:looking-at-reserved-symbol
+ (scala-syntax:looking-at-reserved-symbol
scala-syntax:double-arrow-unsafe-re))
(point)
(forward-char)
@@ -219,7 +219,7 @@ Does not continue past limit.
(defun scala-font-lock:limit-type (&optional start)
start)
-
+
(defun scala-font-lock:limit-simpleType (&optional start)
(when start (goto-char start))
@@ -253,7 +253,7 @@ Does not continue past limit.
t)
;; jump over blocks
((= (char-after) ?\{)
- (ignore-errors
+ (ignore-errors
(forward-list)
(set-match-data nil)
t))
@@ -316,7 +316,7 @@ Does not continue past limit.
(scala-font-lock:mark-numberLiteral
scala-syntax:integerLiteral-re
limit))
-
+
(defun scala-font-lock:keywords ()
;; chars, string, comments are handled acording to syntax and
;; syntax propertize
@@ -346,22 +346,22 @@ Does not continue past limit.
(scala-font-lock:mark-string-escapes (0 font-lock-constant-face prepend
nil))
;; object
- (,(concat "\\<object[ \t]+\\("
- scala-syntax:id-re
- "\\)")
+ (,(concat "\\<object[ \t]+\\("
+ scala-syntax:id-re
+ "\\)")
1 font-lock-constant-face)
;; class, trait, object
- (,(concat "\\<\\(class\\|trait\\)[ \t]+\\("
- scala-syntax:id-re
- "\\)")
+ (,(concat "\\<\\(class\\|trait\\)[ \t]+\\("
+ scala-syntax:id-re
+ "\\)")
2 font-lock-type-face)
;; ;; extends, with, new
- ;; (,(concat "\\<\\(extends\\|with\\|new\\)[ \t]+\\([("
+ ;; (,(concat "\\<\\(extends\\|with\\|new\\)[ \t]+\\([("
;; scala-syntax:id-first-char-group "]\\)")
- ;; (scala-font-lock:mark-simpleType (scala-font-lock:limit-simpleType
- ;; (goto-char (match-beginning 2)))
+ ;; (scala-font-lock:mark-simpleType (scala-font-lock:limit-simpleType
+ ;; (goto-char (match-beginning 2)))
;; nil
;; (0 font-lock-type-face nil t)))
@@ -376,14 +376,23 @@ Does not continue past limit.
(,(concat "\\<def[ \t]+\\(" scala-syntax:id-re "\\)") 1
font-lock-function-name-face)
;; VarDcl
- ("\\<va[rl][ \t]+\\([^:]\\)"
- (scala-font-lock:mark-pattern1-part (scala-font-lock:limit-pattern2-list
+ ("\\<val[ \t]+\\([^:]\\)"
+ (scala-font-lock:mark-pattern1-part (scala-font-lock:limit-pattern2-list
(goto-char (match-beginning 1)))
nil
(1 font-lock-variable-name-face nil t)
(2 font-lock-constant-face nil t)
(3 font-lock-type-face nil t)))
+ ("\\<var[ \t]+\\([^:]\\)"
+ (scala-font-lock:mark-pattern1-part (scala-font-lock:limit-pattern2-list
+ (goto-char (match-beginning 1)))
+ nil
+ (1 scala-font-lock:var-face t)
+ (2 font-lock-constant-face nil t)
+ (3 font-lock-type-face nil t)
+ ))
+
;; case (but not case class|object)
("\\<case[ \t]+\\([^:]\\)"
(scala-font-lock:mark-pattern-part (scala-font-lock:limit-pattern
@@ -394,7 +403,7 @@ Does not continue past limit.
(3 font-lock-type-face nil t)))
;; type ascriptions (: followed by a type)
- (,(rx
+ (,(rx
(or (not (in "!#%&*+-/:<=>?@\\^|~")) line-start)
(group ":")
(0+ space)
@@ -415,7 +424,7 @@ Does not continue past limit.
(\? (and "_" (1+ (in "!#%&*+-/:<=>?@\\^|~")))))
(1+ (in "!#%&*+-/:<=>?@\\^|~")))))
(1 font-lock-keyword-face) (2 font-lock-type-face))
-
+
;; with followed by type
(,(rx symbol-start
(group "with")
@@ -426,7 +435,7 @@ Does not continue past limit.
(\? (and "_" (1+ (in "!#%&*+-/:<=>?@\\^|~")))))
(1+ (in "!#%&*+-/:<=>?@\\^|~")))))
(1 font-lock-keyword-face) (2 font-lock-type-face))
-
+
;; new followed by type
(,(rx symbol-start
(group "new")
@@ -449,7 +458,7 @@ Does not continue past limit.
;; uppercase
(,(rx symbol-start
- (group
+ (group
(and (in "A-Z")
(0+ (in "a-zA-Z0-9_"))
(\? (and "_" (1+ (in "!#%&*+-/:<=>?@\\^|~")))))))
@@ -465,7 +474,7 @@ Does not continue past limit.
;; number literals (have to be here so that other rules take precedence)
(scala-font-lock:mark-floatingPointLiteral . font-lock-constant-face)
(scala-font-lock:mark-integerLiteral . font-lock-constant-face)
-
+
))
(defun scala-font-lock:syntactic-face-function (state)
@@ -476,3 +485,11 @@ Does not continue past limit.
(looking-at "/\\*\\*\\($\\|[^*]\\)")))
font-lock-doc-face
(if (nth 3 state) font-lock-string-face font-lock-comment-face)))
+
+(defface scala-font-lock:var-face
+ '((t (:inherit font-lock-warning-face)))
+ "Font Lock mode face used to highlight scala variable names."
+ :group 'scala)
+
+(defvar scala-font-lock:var-face 'scala-font-lock:var-face
+ "Face for scala variable names.")
