diff options
Diffstat (limited to 'branch-1.1.x/pprint-api.html')
| -rw-r--r-- | branch-1.1.x/pprint-api.html | 233 |
1 files changed, 209 insertions, 24 deletions
diff --git a/branch-1.1.x/pprint-api.html b/branch-1.1.x/pprint-api.html index 789fbfd8..223f015d 100644 --- a/branch-1.1.x/pprint-api.html +++ b/branch-1.1.x/pprint-api.html @@ -40,7 +40,7 @@ namespace. <a class="wiki_link" href="api-index.html">API Index</a><br /> <a class="wiki_link" href="#">Namespaces:</a> <ul id="left-sidebar-list"> - <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> + <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> </ul> </div> </div> @@ -54,6 +54,8 @@ namespace. <div style="margin-left: 1em;" class="toc-section"> <a href="#toc0">Overview</a> <div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*code-dispatch*">*code-dispatch*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/*print-base*">*print-base*</a> </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/*print-circle*">*print-circle*</a> @@ -74,8 +76,18 @@ namespace. </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/*print-suppress-namespaces*">*print-suppress-namespaces*</a> </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*simple-dispatch*">*simple-dispatch*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/cl-format">cl-format</a> </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/compile-format">compile-format</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/formatter">formatter</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/formatter-out">formatter-out</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/fresh-line">fresh-line</a> + </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/pp">pp</a> </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/pprint">pprint</a> @@ -101,11 +113,23 @@ namespace. <br /> </div><div style="margin-left: 1em;" class="toc-section"> <a href="#pprint.examples.json">pprint.examples.json</a> - + <div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint.examples.json/dispatch-json">dispatch-json</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint.examples.json/json-str">json-str</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint.examples.json/print-json">print-json</a> + </div> <br /> </div><div style="margin-left: 1em;" class="toc-section"> <a href="#pprint.examples.xml">pprint.examples.xml</a> - + <div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint.examples.xml/*html-compatible*">*html-compatible*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint.examples.xml/*prxml-indent*">*prxml-indent*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint.examples.xml/prxml">prxml</a> + </div> <br /> </div> </div> @@ -141,13 +165,24 @@ documentation on the the clojure-contrib web site on github.</pre> <div id="var-entry"> <br /> <hr /> + <h2 id="clojure.contrib.pprint/*code-dispatch*">*code-dispatch*</h2> + <span id="var-type">multimethod</span><br /> + <pre id="var-usage">Usage: (*code-dispatch* object) +</pre> + <pre id="var-docstr">The pretty print dispatch function for pretty printing Clojure code.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/eb73c54687a9ed63dc939bbe886170f4a47455ed/src/clojure/contrib/pprint/dispatch.clj#L354" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> <h2 id="clojure.contrib.pprint/*print-base*">*print-base*</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> <pre id="var-docstr">The base to use for printing integers and rationals.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L78" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -157,7 +192,7 @@ documentation on the the clojure-contrib web site on github.</pre> <pre id="var-docstr">Mark circular structures (N.B. This is not yet used)</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L56" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -167,7 +202,7 @@ documentation on the the clojure-contrib web site on github.</pre> <pre id="var-docstr">Maximum number of lines to print in a pretty print instance (N.B. This is not yet used)</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L51" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -179,7 +214,7 @@ miser style add newlines in more places to try to keep lines short allowing for levels of nesting.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L44" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -190,7 +225,7 @@ levels of nesting.</pre> to modify.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L33" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -200,7 +235,7 @@ to modify.</pre> <pre id="var-docstr">Bind to true if you want write to use pretty printing</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L29" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -212,7 +247,7 @@ or 16, then the radix specifier used is #b, #o, or #x, respectively. Otherwise t radix specifier is in the form #XXr where XX is the decimal value of *print-base* </pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L72" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -224,7 +259,7 @@ Set it to nil to have pprint let the line be arbitrarily long. This will ignore non-mandatory newlines.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L38" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -234,7 +269,7 @@ non-mandatory newlines.</pre> <pre id="var-docstr">Mark repeated structures rather than repeat them (N.B. This is not yet used)</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L61" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -245,7 +280,18 @@ non-mandatory newlines.</pre> pretty printing the results of macro expansions</pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L65" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*simple-dispatch*">*simple-dispatch*</h2> + <span id="var-type">multimethod</span><br /> + <pre id="var-usage">Usage: (*simple-dispatch* object) +</pre> + <pre id="var-docstr">The pretty print dispatch function for simple data structure format.</pre> + + <a href="http://github.com/richhickey/clojure-contrib/blob/eb73c54687a9ed63dc939bbe886170f4a47455ed/src/clojure/contrib/pprint/dispatch.clj#L125" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -282,7 +328,63 @@ and in the Common Lisp HyperSpec at <a href="http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm">http://www.lispworks.com/documentation/HyperSpec/Body/22_c.htm</a></pre> + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/cl_format.clj#L26" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/compile-format">compile-format</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (compile-format format-str) +</pre> + <pre id="var-docstr">Compiles format-str into a compiled format which can be used as an argument +to cl-format just like a plain format string. Use this function for improved +performance when you're using the same format string repeatedly</pre> + + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/cl_format.clj#L1748" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/formatter">formatter</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (formatter format-in) +</pre> + <pre id="var-docstr">Makes a function which can directly run format-in. The function is +fn [stream & args] ... and returns nil unless the stream is nil (meaning +output to a string) in which case it returns the resulting string. + +format-in can be either a control string or a previously compiled format.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/cl_format.clj#L1816" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/formatter-out">formatter-out</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (formatter-out format-in) +</pre> + <pre id="var-docstr">Makes a function which can directly run format-in. The function is +fn [& args] ... and returns nil. This version of the formatter macro is +designed to be used with *out* set to an appropriate Writer. In particular, +this is meant to be used as part of a pretty printer dispatch method. + +format-in can be either a control string or a previously compiled format.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/cl_format.clj#L1830" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/fresh-line">fresh-line</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (fresh-line) +</pre> + <pre id="var-docstr">Make a newline if the Writer is not already at the beginning of the line. +N.B. Only works on ColumnWriters right now.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/cl_format.clj#L1152" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -294,7 +396,7 @@ and in the Common Lisp HyperSpec at exactly equivalent to (pprint *1).</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L241" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -307,7 +409,7 @@ exactly equivalent to (pprint *1).</pre> print the object to the currently bound value of *out*.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L229" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -323,7 +425,7 @@ the current column position. n is an offset. Output is sent to *out* which must be a pretty printing writer.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L315" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -339,7 +441,7 @@ Before the body, the caller can optionally specify options: :prefix, :per-line-p and :suffix.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L286" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -353,7 +455,7 @@ newline is :linear, :miser, :fill, or :mandatory. Output is sent to *out* which must be a pretty printing writer.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L306" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -372,7 +474,7 @@ Output is sent to *out* which must be a pretty printing writer. THIS FUNCTION IS NOT YET IMPLEMENTED.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L327" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -388,7 +490,7 @@ For example functions, see *simple-dispatch* and *code-dispatch* in clojure.contrib.pprint.dispatch.clj.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L246" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -399,7 +501,7 @@ clojure.contrib.pprint.dispatch.clj.</pre> <pre id="var-docstr">Installs a function as a new method of multimethod associated with dispatch-value. </pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/eb73c54687a9ed63dc939bbe886170f4a47455ed/src/clojure/contrib/pprint/dispatch.clj#L19" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -410,7 +512,7 @@ clojure.contrib.pprint.dispatch.clj.</pre> <pre id="var-docstr">Execute body with the pretty print dispatch function bound to function.</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L259" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -441,7 +543,7 @@ The following keyword arguments can be passed with values: * = not yet supported</pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L186" id="var-source">Source</a> </div><div id="var-entry"> <br /> <hr /> @@ -461,7 +563,7 @@ already know that the pretty printer will have set up their environment appropri Normal library clients should use the standard "write" interface. </pre> - + <a href="http://github.com/richhickey/clojure-contrib/blob/74c5bf10a5e92c2f2ee83d09eb15938914f95fbe/src/clojure/contrib/pprint/pprint_base.clj#L161" id="var-source">Source</a> </div> <h2 id="namespace-name">pprint.examples.json</h2> <pre id="namespace-docstr">Pretty printing JavaScript Object Notation (JSON) generator. @@ -474,13 +576,96 @@ This is an example of using a pretty printer dispatch function to generate JSON <a href="http://json.org/">JSON Home Page</a> </span><br /> </span><br /> - +<div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.pprint.examples.json/dispatch-json">dispatch-json</h2> + <span id="var-type">multimethod</span><br /> + <pre id="var-usage">Usage: (dispatch-json x) +</pre> + <pre id="var-docstr">The dispatch function for printing objects as JSON</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/e20e8effe977640592b1f285d6c666492d74df00/src/clojure/contrib/pprint/examples/json.clj#L28" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.pprint.examples.json/json-str">json-str</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (json-str x) +</pre> + <pre id="var-docstr">Converts x to a JSON-formatted string.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/e20e8effe977640592b1f285d6c666492d74df00/src/clojure/contrib/pprint/examples/json.clj#L96" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.pprint.examples.json/print-json">print-json</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (print-json x) +</pre> + <pre id="var-docstr">Prints x as JSON. Nil becomes JSON null. Keywords become +strings, without the leading colon. Maps become JSON objects, all +other collection types become JSON arrays. Java arrays become JSON +arrays. Unicode characters in strings are escaped as \uXXXX. +Numbers print as with pr.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/e20e8effe977640592b1f285d6c666492d74df00/src/clojure/contrib/pprint/examples/json.clj#L87" id="var-source">Source</a> +</div> <h2 id="namespace-name">pprint.examples.xml</h2> <pre id="namespace-docstr">A version of prxml that uses a pretty print dispatch function.</pre> <br /> +<div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.pprint.examples.xml/*html-compatible*">*html-compatible*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">If true, empty tags will have a space before the closing /></pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/2f7ddf7205bbd47ace5d2240c66a4686de18d7e7/src/clojure/contrib/pprint/examples/xml.clj#L27" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.pprint.examples.xml/*prxml-indent*">*prxml-indent*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">The number of spaces to indent sub-tags.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/2f7ddf7205bbd47ace5d2240c66a4686de18d7e7/src/clojure/contrib/pprint/examples/xml.clj#L31" id="var-source">Source</a> +</div><div id="var-entry"> + <hr /> + <h2 id="clojure.contrib.pprint.examples.xml/prxml">prxml</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (prxml & args) +</pre> + <pre id="var-docstr">Print XML to *out*. Vectors become XML tags: the first item is the +tag name; optional second item is a map of attributes. + +Sequences are processed recursively, so you can use map and other +sequence functions inside prxml. + (prxml [:p {:class "greet"} [:i "Ladies & gentlemen"]]) + ; => <p class="greet"><i>Ladies &amp; gentlemen</i></p> + +PSEUDO-TAGS: some keywords have special meaning: + + :raw! do not XML-escape contents + :comment! create an XML comment + :decl! create an XML declaration, with attributes + :cdata! create a CDATA section + :doctype! create a DOCTYPE! + + (prxml [:p [:raw! "<i>here & gone</i>"]]) + ; => <p><i>here & gone</i></p> + + (prxml [:decl! {:version "1.1"}]) + ; => <?xml version="1.1" encoding="UTF-8"?></pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/2f7ddf7205bbd47ace5d2240c66a4686de18d7e7/src/clojure/contrib/pprint/examples/xml.clj#L92" id="var-source">Source</a> +</div> </div> |