[Fix #1794] Flush ansi color context after printing (#1813)

Author: dpsutton

cider-repl.el

@@ -526,6 +526,14 @@ Return the position of the prompt beginning."
         (set-marker cider-repl-prompt-start-mark prompt-start)
         prompt-start))))
 
+(defun cider-repl--flush-ansi-color-context ()
+  "Flush ansi color context after printing.  
+When there is a possible unfinished ansi control sequence,
+ `ansi-color-context` maintains this list."
+  (when (and ansi-color-context (stringp (cadr ansi-color-context)))
+    (insert-before-markers (cadr ansi-color-context))
+    (setq ansi-color-context nil)))
+
 (defun cider-repl--emit-output-at-pos (buffer string output-face position &optional bol)
   "Using BUFFER, insert STRING (applying to it OUTPUT-FACE) at POSITION.
 If BOL is non-nil insert at the beginning of line."
@@ -540,6 +548,7 @@ If BOL is non-nil insert at the beginning of line."
            (ansi-color-apply (propertize string
                                          'font-lock-face output-face
                                          'rear-nonsticky '(font-lock-face))))
+          (cider-repl--flush-ansi-color-context)
           (when (and (= (point) cider-repl-prompt-start-mark)
                      (not (bolp)))
             (insert-before-markers "\n")

test/cider-repl-tests.el

@@ -68,3 +68,62 @@
 ;;  Javadoc: (javadoc java-object-or-class)
 ;;     Exit: <C-c C-q>
 ;;  Results: Stored in vars *1, *2, *3, an exception in *e;"))))
+
+(defvar cider-testing-ansi-colors-vector
+  ["black" "red3" "green3" "yellow3" "blue2"
+   "magenta3" "cyan3" "gray90"]
+  "Vector of translations for ansi color codes")
+
+(defmacro with-testing-ansi-table (colors &rest body)
+  `(let* ((ansi-color-names-vector ,colors)
+             (ansi-color-map (ansi-color-make-color-map)))
+     ,@body))
+
+(describe "multiple calls to cider-repl--emit-output-at-pos"
+  (it "Multiple emit output calls set properties and emit text"
+    (with-temp-buffer
+      (with-testing-ansi-table cider-testing-ansi-colors-vector
+        (cider-repl-reset-markers)
+
+        (cider-repl--emit-output-at-pos (current-buffer) "a" 'cider-repl-stdout-face (point))
+        (cider-repl--emit-output-at-pos (current-buffer) "b" 'cider-repl-stdout-face (point))
+        (cider-repl--emit-output-at-pos (current-buffer) "c" 'cider-repl-stdout-face (point))
+        (cider-repl--emit-output-at-pos (current-buffer) "d" 'cider-repl-stdout-face (point))
+
+        (expect (buffer-string) :to-equal "a\nb\nc\nd\n")
+        (expect (get-text-property 1 'font-lock-face)
+                :to-equal '(foreground-color . "black"))
+        (expect (get-text-property 3 'font-lock-face)
+                :to-equal 'cider-repl-stdout-face)
+        (expect (get-text-property 5 'font-lock-face)
+                :to-equal '(foreground-color . "red3"))
+        (expect (get-text-property 7 'font-lock-face)
+                :to-equal '(foreground-color . "red3"))))))
+
+(defun simulate-cider-output (s property)
+  "Return properties from cider-repl--emit-output-at-pos.
+PROPERTY shoudl be a symbol of either 'text, 'ansi-context or
+'properties."
+  (with-temp-buffer
+    (with-testing-ansi-table cider-testing-ansi-colors-vector
+      (cider-repl-reset-markers)
+      (cider-repl--emit-output-at-pos (current-buffer) s nil (point-min) nil))
+    (case property
+      ('text (substring-no-properties (buffer-string)))
+      ('ansi-context ansi-color-context)
+      ('properties (substring (buffer-string))))))
+
+(describe "cider-repl--emit-output-at-pos"
+  (it "prints simple strings"
+    (expect (simulate-cider-output "hi" 'text)
+            :to-equal "hi\n"))
+
+  (it "when invlaid escape code, doesn't hold string looking for close tag"
+    (expect (simulate-cider-output "\033hi" 'text)
+            :to-equal "\033hi\n")
+    (expect (simulate-cider-output "\033hi" 'ansi-context)
+            :to-equal nil))
+
+  (it "preserves context when valid"
+    (let ((context (simulate-cider-output "abcd" 'ansi-context)))
+      (expect context :to-equal '((31) nil)))))

test/cider-util-tests.el

@@ -138,28 +138,6 @@
     (expect (cider-repl-prompt-abbreviated "some.pretty.long.namespace.name")
             :to-equal "s.p.l.n.name> ")))
 
-(describe "cider-repl--emit-output-at-pos"
-  (it "formats and inserts the text in the given buffer"
-    (with-temp-buffer
-      (let* ((ansi-color-names-vector ["black" "red3" "green3" "yellow3" "blue2" "magenta3" "cyan3" "gray90"])
-             (ansi-color-map (ansi-color-make-color-map)))
-        (cider-repl-reset-markers)
-
-        (cider-repl--emit-output-at-pos (current-buffer) "a" 'cider-repl-stdout-face (point))
-        (cider-repl--emit-output-at-pos (current-buffer) "b" 'cider-repl-stdout-face (point))
-        (cider-repl--emit-output-at-pos (current-buffer) "c" 'cider-repl-stdout-face (point))
-        (cider-repl--emit-output-at-pos (current-buffer) "d" 'cider-repl-stdout-face (point))
-
-        (expect (buffer-string) :to-equal "a\nb\nc\nd\n")
-        (expect (get-text-property 1 'font-lock-face)
-                :to-equal '(foreground-color . "black"))
-        (expect (get-text-property 3 'font-lock-face)
-                :to-equal 'cider-repl-stdout-face)
-        (expect (get-text-property 5 'font-lock-face)
-                :to-equal '(foreground-color . "red3"))
-        (expect (get-text-property 7 'font-lock-face)
-                :to-equal '(foreground-color . "red3"))))))
-
 (describe "cider--url-to-file"
   (it "returns a url for a given file name"
     (expect (cider--url-to-file "file:/space%20test")