Add syntax performance benchmarks

guns · guns · commit 9355ec0e4e07 · 2014-02-19T06:36:49.000-06:00
With frak fork at: https://github.com/guns/frak/tree/public-escape-chars Testing reveals that `syntax keyword` is ~2x faster than an equivalent frak-optimized `syntax match` for the same words, and ~8x faster than a naive approach using `syntax match`. Subjective experience matches these results. Clojure syntax highlighting is already a bit slow, so a 2x performance hit is not really acceptable.
diff --git a/clj/project.clj b/clj/project.clj
@@ -5,4 +5,4 @@
             :url "http://vimdoc.sourceforge.net/htmldoc/uganda.html#license"
             :comments ":help license"}
   :dependencies [[org.clojure/clojure "1.5.1"]
-                 [frak "0.1.3"]])
+                 [frak "0.1.6-SNAPSHOT"]])
diff --git a/clj/src/vim_clojure_static/generate.clj b/clj/src/vim_clojure_static/generate.clj
@@ -17,7 +17,7 @@
 (defn vim-frak-pattern
   "Create a non-capturing regular expression pattern compatible with Vim."
   [strs]
-  (-> (str (f/pattern strs))
+  (-> (f/string-pattern strs {:escape-chars :vim})
       (string/replace #"\(\?:" "\\%\\(")))
 
 (defn property-pattern
@@ -166,9 +166,9 @@
   "Vimscript literal `syntax keyword` for important identifiers."
   (->> keyword-groups
        (map (fn [[group keywords]]
-              (format "syntax keyword clojure%s %s\n"
+              (format "syntax match clojure%s \"\\v<%s>\"\n"
                       group
-                      (string/join \space (sort (map-keyword-names keywords))))))
+                      (vim-frak-pattern (map-keyword-names keywords)))))
        string/join))
 
 (def vim-completion-words
@@ -294,7 +294,36 @@
              generation-comment
              clojure-version-comment
              vim-completion-words))
+
   ;; Generate an example file with all possible character property literals.
   (spit "tmp/all-char-props.clj"
         comprehensive-clojure-character-property-regexps)
+
+  ;; Performance test: `syntax keyword` vs `syntax match`
+  (vim-clojure-static.test/benchmark
+    1000 "tmp/bench.clj" (str keyword-groups)
+    ;; `syntax keyword`
+    (->> keyword-groups
+         (map (fn [[group keywords]]
+                (format "syntax keyword clojure%s %s\n"
+                        group
+                        (string/join \space (sort (map-keyword-names keywords))))))
+         (map string/trim-newline)
+         (string/join " | "))
+    ;; Naive `syntax match`
+    (->> keyword-groups
+         (map (fn [[group keywords]]
+                (format "syntax match clojure%s \"\\V\\<%s\\>\"\n"
+                        group
+                        (string/join "\\|" (map-keyword-names keywords)))))
+         (map string/trim-newline)
+         (string/join " | "))
+    ;; Frak-optimized `syntax match`
+    (->> keyword-groups
+         (map (fn [[group keywords]]
+                (format "syntax match clojure%s \"\\v<%s>\"\n"
+                        group
+                        (vim-frak-pattern (map-keyword-names keywords)))))
+         (map string/trim-newline)
+         (string/join " | ")))
   )
diff --git a/clj/src/vim_clojure_static/test.clj b/clj/src/vim_clojure_static/test.clj
@@ -17,9 +17,9 @@
     (try
       (io/make-parents file)
       (spit file buf)
+      (spit tmp (str "let @x = " vim-expr))
       (shell/sh "vim" "-N" "-u" "vim/test-runtime.vim"
-                "-c" (str "let @x = " vim-expr)
-                "-c" (str "call writefile([@x], " (pr-str (str tmp)) ") | quitall!")
+                "-c" (str "source " tmp " | call writefile([@x], " (pr-str (str tmp)) ") | quitall!")
                 file)
       (edn/read-string (slurp tmp))
       (finally
@@ -99,3 +99,8 @@
        {:arglists '~'[coll]}
        [coll#]
        (boolean (some (partial not= ~kw) coll#)))))
+
+(defn benchmark [n file buf & exprs]
+  (vim-exec file buf (format "Benchmark(%d, %s)"
+                             n
+                             (string/join \, (map pr-str exprs)))))
diff --git a/clj/vim/test-runtime.vim b/clj/vim/test-runtime.vim
@@ -6,12 +6,34 @@ syntax on
 set synmaxcol=0
 setfiletype clojure
 
+function! EDN(value)
+    " Changing the quotes may make this valid EDN
+    return tr(string(a:value), "'", '"')
+endfunction
+
 function! ClojureSynIDNames()
     let names = []
     for lnum in range(1, line('$'))
         let f = 'synIDattr(synID(' . lnum . ', v:val, 0), "name")'
         call add(names, map(range(1, virtcol([lnum, '$']) - 1), f))
     endfor
-    " Changing the quotes makes this valid EDN
-    return tr(string(names), "'", '"')
+    return EDN(names)
+endfunction
+
+function! Time(n, expr)
+    let start = reltime()
+    let i = 0
+    while i < a:n
+        execute a:expr
+        let i += 1
+    endwhile
+    return eval(reltimestr(reltime(start)))
+endfunction
+
+function! Benchmark(n, ...)
+    let times = []
+    for expr in a:000
+        call add(times, Time(a:n, expr))
+    endfor
+    return EDN(times)
 endfunction
