gn-mode: Add matching for variables in strings.

tools/gn/misc/emacs/gn-mode.el

-;;; gn.el - A major mode for editing gn files.
+;;; gn-mode.el - A major mode for editing gn files.
 
 ;; Copyright 2015 The Chromium Authors. All rights reserved.
 ;; Use of this source code is governed by a BSD-style license that can be
 ;; found in the LICENSE file.
 
-;; Put this somewhere in your load-path and
-;; (require 'gn)
+;; Author: Elliot Glaysher <erg@chromium.org>
+;; Created: April 03, 2015
+;; Keywords: tools, gn, ninja, chromium
 
-;; TODO(erg): There's a lot of general improvements that could be made here:
-;;
+;; This file is not part of GNU Emacs.
+
+;;; Commentary:
+
+;; A major mode for editing GN files. GN stands for Generate Ninja. GN is the
+;; meta build system used in Chromium. For more information on GN, see the GN
+;; manual: <https://code.google.com/p/chromium/wiki/gn>
+
+;;; To Do:
+
 ;; - We syntax highlight builtin actions, but don't highlight instantiations of
 ;;   templates. Should we?
 ;; - `fill-paragraph' works for comments, but when pointed at code, breaks
 ;;   spectacularly.
-;; - Might want to support `imenu' users. Even if it's just a list of toplevel
-;;   targets?
+
+
 
 (eval-when-compile (require 'cl))       ;For the `case' macro.
 (require 'smie)
 
+(defgroup gn nil
+  "Major mode for editing Generate Ninja files."
+  :prefix "gn-"
+  :group 'languages)
+
+(defcustom gn-indent-basic 2
+  "The number of spaces to indent a new scope."
+  :group 'gn
+  :type 'integer)
+
+(defgroup gn-faces nil
+  "Faces used in Generate Ninja mode."
+  :group 'gn
+  :group 'faces)
+
+(defface gn-embedded-variable
+  '((t :inherit font-lock-variable-name-face))
+  "Font lock face used to highlight variable names in strings."
+  :group 'gn-faces)
+
+(defface gn-embedded-variable-boundary
+  '((t :bold t
+       :inherit gn-embedded-variable))
+  "Font lock face used to highlight the '$' that starts a
+variable name or the '{{' and '}}' which surround it."
+  :group 'gn-faces)
+
 (defvar gn-font-lock-target-declaration-keywords
   '("action" "action_foreach" "copy" "executable" "group"
     "shared_library" "source_set" "static_library" "if" "else"))
 
 (defvar gn-font-lock-buildfile-fun-keywords
   '("assert" "config" "declare_args" "defined" "exec_script" "foreach"
     "get_label_info" "get_path_info" "get_target_outputs" "getenv" "import"
     "print" "process_file_template" "read_file" "rebase_path"
     "set_default_toolchain" "set_defaults" "set_sources_assignment_filter"
     "template" "tool" "toolchain" "toolchain_args" "write_file"))
@@ skipping 13 matching lines @@
     "visibility"))
 
 (defconst gn-font-lock-keywords
   `((,(regexp-opt gn-font-lock-target-declaration-keywords 'words) .
      font-lock-keyword-face)
     (,(regexp-opt gn-font-lock-buildfile-fun-keywords 'words) .
      font-lock-function-name-face)
     (,(regexp-opt gn-font-lock-predefined-var-keywords 'words) .
      font-lock-constant-face)
     (,(regexp-opt gn-font-lock-var-keywords 'words) .
-     font-lock-variable-name-face)))
-
-(defvar gn-indent-basic 2)
+     font-lock-variable-name-face)
+    ;; $variables_like_this

[Nico, 2015/04/04 20:30:35]

I like these comments.

+    ("\\(\\$\\)\\([a-zA-Z0-9_]+\\)"
+     (1 'gn-embedded-variable-boundary t)
+     (2 'gn-embedded-variable t))
+    ;; ${variables_like_this}
+    ("\\(\\${\\)\\([^\n }]+\\)\\(}\\)"
+     (1 'gn-embedded-variable-boundary t)
+     (2 'gn-embedded-variable t)
+     (3 'gn-embedded-variable-boundary t))
+    ;; {{variables_like_this}}
+    ("\\({{\\)\\([^\n }]+\\)\\(}}\\)"

[Nico, 2015/04/04 20:30:34]

Huh, I wasn't aware this is a thing. It's not on
https://code.google.com/p/chromium/wiki/GNLanguage . What do {{var}} blocks do?

[Elliot Glaysher, 2015/04/07 18:01:20]

Calling substitutions variables isn't strictly correct and I changed the
comment.

(For bonus points, this should probably be another long keyword list of  valid
substitutions, but I'm going to punt on this until a further cl.)

+     (1 'gn-embedded-variable-boundary t)
+     (2 'gn-embedded-variable t)
+     (3 'gn-embedded-variable-boundary t))))
 
 (defun gn-smie-rules (kind token)
   "These are slightly modified indentation rules from the SMIE
   Indentation Example info page. This changes the :before rule
   and adds a :list-intro to handle our x = [ ] syntax."
   (pcase (cons kind token)
     (`(:elem . basic) gn-indent-basic)
     (`(,_ . ",") (smie-rule-separator kind))
     (`(:list-intro . "") gn-indent-basic)
     (`(:before . ,(or `"[" `"(" `"{"))
      (if (smie-rule-hanging-p) (smie-rule-parent)))
     (`(:before . "if")
      (and (not (smie-rule-bolp)) (smie-rule-prev-p "else")
           (smie-rule-parent)))))
 
 ;;;###autoload
 (define-derived-mode gn-mode prog-mode "GN"
   "Major mode for editing gn (Generate Ninja)."
-
-  (setq-local font-lock-defaults '(gn-font-lock-keywords))
+  :group 'gn
 
   (setq-local comment-use-syntax t)
   (setq-local comment-start "#")
   (setq-local comment-end "")
 
+  (setq-local font-lock-defaults '(gn-font-lock-keywords))
+
+  (setq-local imenu-generic-expression
+              '((nil "^\s*[a-zA-Z0-9_]+(\"\\([a-zA-Z0-9_]+\\)\")\s*{" 1)))

[Nico, 2015/04/04 20:30:35]

Maybe have a comment for this too?

+
   (smie-setup nil #'gn-smie-rules)
   (setq-local smie-indent-basic gn-indent-basic)
 
   ;; python style comment: “# …”
   (modify-syntax-entry ?# "< b" gn-mode-syntax-table)
   (modify-syntax-entry ?\n "> b" gn-mode-syntax-table)
   (modify-syntax-entry ?_ "w" gn-mode-syntax-table))
 
 ;;;###autoload
 (add-to-list 'auto-mode-alist '("\\.gni?\\'" . gn-mode))
 
 (provide 'gn-mode)