@@ -45,15 +45,15 @@ In stack traces printed by <code>pst</code>: * Elements are vertically aligned for better readability. * Printing is directed to <code>*out*</code>. -If you want to direct the printing to somewhere other than stdout, either dynamically rebind <code>*out*</code> to the desired location or use <code>(pst-str e)</code> to capture the stacktrace dump as a string. +If you want to direct the printing to somewhere other than <code>*out*</code>, either use <code>pst-on</code> to specify the output location or <code>pst-str</code> to capture the printing as a string. The library also offers an API for programatically 'parsing' exceptions. This API is used internal for <code>pst</code> and can be used to e.g. improve development tools. Try for example: <pre><code> -=> (use '(clj-stacktrace core repl)) -=> (try ("foo") +=> (use '(clj-stacktrace core)) +=> (try (nofn) (catch Exception e - (print-trace-elems (take 5 (:trace-elems (parse-exception e)))))) + (prn (take 5 (:trace-elems (parse-exception e)))))) </code></pre> --- README.textile @@ -1,8 +1,6 @@ (ns clj-stacktrace.repl (:use (clj-stacktrace core utils))) -(def *use-color* false) - (def color-codes {:red "\033[31m" :green "\033[32m" @@ -12,31 +10,28 @@ :cyan "\033[36m" :default "\033[39m"}) -(defn with-color - "If *use-color* is bound to logical truth, returns text surrounded by - strings that will turn the text the given color and then reset the color - to default. Otherwise returns the given string." - [color text] - (if *use-color* +(defn- colored + [color? color text] + (if color? (str (color-codes color) text (color-codes :default)) text)) (defn elem-color "Returns a symbol identifying the color appropriate for the given trace elem. :green All Java elems - :magenta Any fn in the user or repl* namespaces (i.e. entered at REPL) + :yellow Any fn in the user or repl* namespaces (i.e. entered at REPL) :blue Any fn in clojure.* (e.g. clojure.core, clojure.contrib.*) - :default Anything else - i.e. Clojure libraries and app code." + :magenta Anything else - i.e. Clojure libraries and app code." [elem] (cond (:java elem) :green (or (nil? (:ns elem)) (re-match? #"^(user|repl)" (:ns elem))) - :magenta + :yellow (re-match? #"^clojure\." (:ns elem)) :blue :else - :default)) + :magenta)) (defn source-str [parsed] (if (and (:file parsed) (:line parsed)) @@ -52,24 +47,30 @@ (defn method-str [parsed] (if (:java parsed) (java-method-str parsed) (clojure-method-str parsed))) -(defn print-trace-elems - "Print a pretty stack trace for the parsed elems." - [parsed-elems & [source-width]] +(defn pst-message-on [on color? message] + (.append on (colored color? :red message)) + (.append on "\n") + (.flush on)) + +(defn pst-elems-on + [on color? parsed-elems & [source-width]] (let [print-width (+ 6 (or source-width (high (map (memfn length) (map source-str parsed-elems)))))] (doseq [parsed-elem parsed-elems] - (println (with-color (elem-color parsed-elem) - (str (rjust print-width (source-str parsed-elem)) - " " (method-str parsed-elem))))))) + (.append on + (colored color? (elem-color parsed-elem) + (str (rjust print-width (source-str parsed-elem)) + " " (method-str parsed-elem)))) + (.append on "\n") + (.flush on)))) -(defn- pst-cause - "Print a pretty stack trace for a parsed exception in a causal chain." - [exec source-width] - (println (with-color :red (str "Caused by: " (:message exec)))) - (print-trace-elems (:trimmed-elems exec) source-width) +(defn- pst-cause-on + [on color? exec source-width] + (pst-message-on on color? (str "Caused by: " (:message exec))) + (pst-elems-on on color? (:trimmed-elems exec) source-width) (if-let [cause (:cause exec)] - (pst-cause cause source-width))) + (pst-cause-on on color? cause source-width))) (defn- find-source-width "Returns the width of the longest source-string among all trace elems of the @@ -81,23 +82,29 @@ (max this-source-width (find-source-width cause)) this-source-width))) +(defn pst-on [on color? e] + "Prints to the given Writer on a pretty stack trace for the given exception e, + ANSI colored if color? is true." + (let [exec (parse-exception e) + source-width (find-source-width exec)] + (pst-message-on on color? (:message exec)) + (pst-elems-on on color? (:trace-elems exec) source-width) + (if-let [cause (:cause exec)] + (pst-cause-on on color? cause source-width)))) + (defn pst "Print to *out* a pretty stack trace for an exception, by default *e." [& [e]] - (let [exec (parse-exception (or e *e)) - source-width (find-source-width exec)] - (println (with-color :red (:message exec))) - (print-trace-elems (:trace-elems exec) source-width) - (if-let [cause (:cause exec)] - (pst-cause cause source-width)))) + (pst-on *out* false (or e *e))) (defn pst-str "Like pst, but returns a string instead of printing that string to *out*" [& [e]] - (with-out-str (pst (or e *e)))) + (let [sw (java.io.StringWriter.)] + (pst-on sw false (or e *e)) + (str sw))) (defn pst+ - "Experimenal. Like pst, but with ANSI terminal color coding." + "Like pst, but with ANSI terminal color coding." [& [e]] - (binding [*use-color* true] - (pst e))) + (pst-on *out* true (or e *e))) src/clj_stacktrace/repl.clj @@ -43,4 +43,4 @@ "If width is greater than the length of s, returns a new string of length width with s right justified within it, otherwise returns s." [width s] - (format (str "%" width "s") s)) \ No newline at end of file + (format (str "%" width "s") s)) src/clj_stacktrace/utils.clj @@ -1,6 +1,6 @@ (ns clj-stacktrace.repl-test (:use (clj-unit core) - (clj-stacktrace repl))) + (clj-stacktrace repl utils))) (defmacro with-cascading-exception "Execute body in the context of a variable bound to an exception instance @@ -11,7 +11,13 @@ (let [~binding-sym e#] ~@body)))) -(deftest "pst, pst-str" +(deftest "pst" + (with-cascading-exception e + (assert-that (with-out-str (pst e))) + (binding [*e e] + (assert-that (with-out-str (pst)))))) + +(deftest "pst" (with-cascading-exception e (assert-that (pst-str e)) (binding [*e e] @@ -19,8 +25,6 @@ (deftest "pst+" (with-cascading-exception e - (assert-not= - (pst-str e) - (with-out-str (pst+ e))) + (assert-that (with-out-str (pst+ e))) (binding [*e e] (assert-that (with-out-str (pst+)))))) \ No newline at end of file test/clj_stacktrace/repl_test.clj 459f2e5ea1a190e4ff4df5659c5b61b1513a9a6e Mark McGranaghan mmcgrana@gmail.com http://github.com/mmcgrana/clj-stacktrace/commit/0e99eb63e7a8730fb20859cff305007be27bac8d 0e99eb63e7a8730fb20859cff305007be27bac8d 2009-11-01T06:42:09-08:00 2009-11-01T06:42:09-08:00 Explicitly pass output targets and coloring option for pretty printing. f393a043571a33a365e1ff4ea5d0806af91048f1 Mark McGranaghan mmcgrana@gmail.com