diff options
| author | Tom Faulhaber <git_net@infolace.com> | 2010-07-23 10:01:58 -0700 |
|---|---|---|
| committer | Tom Faulhaber <git_net@infolace.com> | 2010-07-23 10:01:58 -0700 |
| commit | 92bacc26d7b9e0a176e899831c7a0b361d68f6d6 (patch) | |
| tree | 7050befb1500263b4543e3a1c43b33351ca571f8 | |
| parent | 3a646de489c7a6f49d33678c3ad7dc247587419b (diff) | |
Autodoc commit for master/29a94caf, 1.1.x/d132c5f1
| -rw-r--r-- | api-index.html | 37 | ||||
| -rw-r--r-- | index.html | 37 | ||||
| -rw-r--r-- | json-api.html | 90 | ||||
| -rw-r--r-- | pprint-api.html | 562 |
4 files changed, 710 insertions, 16 deletions
diff --git a/api-index.html b/api-index.html index 8af2559b..c20d2e4e 100644 --- a/api-index.html +++ b/api-index.html @@ -157,6 +157,7 @@ Shortcuts:<br /> <h2 id="C"><span id="section-head">C</span></h2> <pre> <span id="section-content"> <a href="io-api.html#clojure.contrib.io/*char-array-type*">*char-array-type*</a><span id="line-content"> var io Type object for a Java primitive char array.. +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*code-dispatch*">*code-dispatch*</a><span id="line-content"> multimethod pprint The pretty print dispatch function for pretty prin... </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/*connection*">*connection*</a><span id="line-content"> var jmx The connection to be used for JMX ops. Defaults to... </span></span><span id="section-content"> <a href="monads-api.html#clojure.contrib.monads/call-cc">call-cc</a><span id="line-content"> function monads A computation in the cont monad that calls functio... </span></span><span id="section-content"> <a href="reflect-api.html#clojure.contrib.reflect/call-method">call-method</a><span id="line-content"> function reflect Calls a private or protected method. params is a ... @@ -179,6 +180,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="str-utils-api.html#clojure.contrib.str-utils/chop">chop</a><span id="line-content"> function str-utils Removes the last character of string.. </span></span><span id="section-content"> <a href="str-utils2-api.html#clojure.contrib.str-utils2/chop">chop</a><span id="line-content"> function str-utils2 Removes the last character of string, does nothing... </span></span><span id="section-content"> <a href="string-api.html#clojure.contrib.string/chop">chop</a><span id="line-content"> function string Removes the last character of string, does nothing... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/cl-format">cl-format</a><span id="line-content"> function pprint An implementation of a Common Lisp compatible form... </span></span><span id="section-content"> <a href="classpath-api.html#clojure.contrib.classpath/classpath">classpath</a><span id="line-content"> function classpath Returns a sequence of File objects of the elements... </span></span><span id="section-content"> <a href="classpath-api.html#clojure.contrib.classpath/classpath-directories">classpath-directories</a><span id="line-content"> function classpath Returns a sequence of File objects for the directo... </span></span><span id="section-content"> <a href="classpath-api.html#clojure.contrib.classpath/classpath-jarfiles">classpath-jarfiles</a><span id="line-content"> function classpath Returns a sequence of JarFile objects for the JAR ... @@ -190,6 +192,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="combinatorics-api.html#clojure.contrib.combinatorics/combinations">combinations</a><span id="line-content"> function combinatorics All the unique ways of taking n different elements... </span></span><span id="section-content"> <a href="accumulators-api.html#clojure.contrib.accumulators/combine">combine</a><span id="line-content"> multimethod accumulators Combine the values of the accumulators acc1 and ac... </span></span><span id="section-content"> <a href="find-namespaces-api.html#clojure.contrib.find-namespaces/comment?">comment?</a><span id="line-content"> function find-namespaces Returns true if form is a (comment ...). +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/compile-format">compile-format</a><span id="line-content"> function pprint Compiles format-str into a compiled format which c... </span></span><span id="section-content"> <a href="graph-api.html#clojure.contrib.graph/component-graph">component-graph</a><span id="line-content"> function graph Given a graph, perhaps with cycles, return a reduc... </span></span><span id="section-content"> <a href="miglayout-api.html#clojure.contrib.miglayout/components">components</a><span id="line-content"> function miglayout Returns a map from id (a keyword) to component for... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/compose-fixtures">compose-fixtures</a><span id="line-content"> function test-is Composes two fixture functions, creating a new fix... @@ -349,8 +352,11 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/flush">flush</a><span id="line-content"> function monadic-io-streams Flush. </span></span><span id="section-content"> <a href="generic.functor-api.html#clojure.contrib.generic.functor/fmap">fmap</a><span id="line-content"> multimethod generic.functor Applies function f to each item in the data struct... </span></span><span id="section-content"> <a href="fnmap-api.html#clojure.contrib.fnmap/fnmap">fnmap</a><span id="line-content"> function fnmap Creates a fnmap, or functional map. A fnmap behav... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/formatter">formatter</a><span id="line-content"> macro pprint Makes a function which can directly run format-in.... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/formatter-out">formatter-out</a><span id="line-content"> macro pprint Makes a function which can directly run format-in.... </span></span><span id="section-content"> <a href="seq-api.html#clojure.contrib.seq/frequencies">frequencies</a><span id="line-content"> function seq DEPRECATED. Prefer clojure.core version. Returns a... </span></span><span id="section-content"> <a href="seq-utils-api.html#clojure.contrib.seq-utils/frequencies">frequencies</a><span id="line-content"> function seq-utils DEPRECATED. Prefer clojure.core version. Returns a... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/fresh-line">fresh-line</a><span id="line-content"> function pprint Make a newline if the Writer is not already at the... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/function?">function?</a><span id="line-content"> function test-is Returns true if argument is a function or a symbol... </span></span></pre> </div><div id="index-body"> @@ -435,6 +441,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="string-api.html#clojure.contrib.string/join">join</a><span id="line-content"> function string Returns a string of all elements in coll, separate... </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/join-fixtures">join-fixtures</a><span id="line-content"> function test-is Composes a collection of fixtures, in order. Alwa... </span></span><span id="section-content"> <a href="probabilities.finite-distributions-api.html#clojure.contrib.probabilities.finite-distributions/join-with">join-with</a><span id="line-content"> function probabilities.finite-distributions Returns the distribution of (f x y... +</span></span><span id="section-content"> <a href="json-api.html#clojure.contrib.json/json-str">json-str</a><span id="line-content"> function json Converts x to a JSON-formatted string.. </span></span></pre> </div><div id="index-body"> <h2 id="K"><span id="section-head">K</span></h2> @@ -539,7 +546,16 @@ Shortcuts:<br /> </div><div id="index-body"> <h2 id="P"><span id="section-head">P</span></h2> <pre> -<span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-pretty*">*print-pretty*</a><span id="line-content"> var pprint Bind to true if you want write to use pretty print... +<span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-base*">*print-base*</a><span id="line-content"> var pprint The base to use for printing integers and rational... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-circle*">*print-circle*</a><span id="line-content"> var pprint Mark circular structures (N.B. This is not yet use... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-lines*">*print-lines*</a><span id="line-content"> var pprint Maximum number of lines to print in a pretty print... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-miser-width*">*print-miser-width*</a><span id="line-content"> var pprint The column at which to enter miser style. Dependin... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-pprint-dispatch*">*print-pprint-dispatch*</a><span id="line-content"> var pprint The pretty print dispatch function. Use with-pprin... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-pretty*">*print-pretty*</a><span id="line-content"> var pprint Bind to true if you want write to use pretty print... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-radix*">*print-radix*</a><span id="line-content"> var pprint Print a radix specifier in front of integers and r... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-right-margin*">*print-right-margin*</a><span id="line-content"> var pprint Pretty printing will try to avoid anything going b... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-shared*">*print-shared*</a><span id="line-content"> var pprint Mark repeated structures rather than repeat them (... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*print-suppress-namespaces*">*print-suppress-namespaces*</a><span id="line-content"> var pprint Don't print namespaces with symbols. This is parti... </span></span><span id="section-content"> <a href="prxml-api.html#clojure.contrib.prxml/*prxml-indent*">*prxml-indent*</a><span id="line-content"> var prxml The number of spaces to indent sub-tags. nil for ... </span></span><span id="section-content"> <a href="lazy-xml-api.html#clojure.contrib.lazy-xml/parse-seq">parse-seq</a><span id="line-content"> function lazy-xml Parses the source s, which can be a File, InputStr... </span></span><span id="section-content"> <a href="lazy-xml-api.html#clojure.contrib.lazy-xml/parse-trim">parse-trim</a><span id="line-content"> function lazy-xml Parses the source s, which can be a File, InputStr... @@ -560,11 +576,19 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="graph-api.html#clojure.contrib.graph/post-ordered-nodes">post-ordered-nodes</a><span id="line-content"> function graph Return a sequence of indexes of a post-ordered wal... </span></span><span id="section-content"> <a href="generic.math-functions-api.html#clojure.contrib.generic.math-functions/pow">pow</a><span id="line-content"> multimethod generic.math-functions Return the pow of x and y.. </span></span><span id="section-content"> <a href="lazy-seqs-api.html#clojure.contrib.lazy-seqs/powers-of-2">powers-of-2</a><span id="line-content"> function lazy-seqs Returns a lazy sequence of all the powers of 2. +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/pp">pp</a><span id="line-content"> macro pprint A convenience macro that pretty prints the last th... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/pprint">pprint</a><span id="line-content"> function pprint Pretty print object to the optional output writer.... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/pprint-indent">pprint-indent</a><span id="line-content"> function pprint Create an indent at this point in the pretty print... +</span></span><span id="section-content"> <a href="json-api.html#clojure.contrib.json/pprint-json">pprint-json</a><span id="line-content"> function json Pretty-prints JSON representation of x to *out*. +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/pprint-logical-block">pprint-logical-block</a><span id="line-content"> macro pprint Execute the body as a pretty printing logical bloc... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/pprint-newline">pprint-newline</a><span id="line-content"> function pprint Print a conditional newline to a pretty printing s... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/pprint-tab">pprint-tab</a><span id="line-content"> function pprint Tab at this point in the pretty printing stream. k... </span></span><span id="section-content"> <a href="lazy-seqs-api.html#clojure.contrib.lazy-seqs/primes">primes</a><span id="line-content"> var lazy-seqs Lazy sequence of all the prime numbers.. </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/print">print</a><span id="line-content"> function monadic-io-streams Print obj. </span></span><span id="section-content"> <a href="dataflow-api.html#clojure.contrib.dataflow/print-dataflow">print-dataflow</a><span id="line-content"> function dataflow Prints a dataflow, one cell per line. </span></span><span id="section-content"> <a href="ns-utils-api.html#clojure.contrib.ns-utils/print-dir">print-dir</a><span id="line-content"> function ns-utils Prints a sorted directory of public vars in a name... </span></span><span id="section-content"> <a href="ns-utils-api.html#clojure.contrib.ns-utils/print-docs">print-docs</a><span id="line-content"> function ns-utils Prints documentation for the public vars in a name... +</span></span><span id="section-content"> <a href="json-api.html#clojure.contrib.json/print-json">print-json</a><span id="line-content"> function json Write JSON-formatted output to *out*. </span></span><span id="section-content"> <a href="repl-ln-api.html#clojure.contrib.repl-ln/print-repl-info">print-repl-info</a><span id="line-content"> function repl-ln Prints info about the current repl. </span></span><span id="section-content"> <a href="condition-api.html#clojure.contrib.condition/print-stack-trace">print-stack-trace</a><span id="line-content"> function condition Prints a stack trace for a condition or Throwable.... </span></span><span id="section-content"> <a href="profile-api.html#clojure.contrib.profile/print-summary">print-summary</a><span id="line-content"> function profile Prints a table of the results returned by summariz... @@ -605,6 +629,8 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="jmx-api.html#clojure.contrib.jmx/read">read</a><span id="line-content"> var jmx Read an mbean property.. </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/read-char">read-char</a><span id="line-content"> function monadic-io-streams Read a single character. </span></span><span id="section-content"> <a href="find-namespaces-api.html#clojure.contrib.find-namespaces/read-file-ns-decl">read-file-ns-decl</a><span id="line-content"> function find-namespaces Attempts to read a (ns ...) declaration from file,... +</span></span><span id="section-content"> <a href="json-api.html#clojure.contrib.json/read-json">read-json</a><span id="line-content"> function json Reads one JSON value from input String or Reader. ... +</span></span><span id="section-content"> <a href="json-api.html#clojure.contrib.json/read-json-from">read-json-from</a><span id="line-content"> function json Reads one JSON value from input String or Reader. ... </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/read-line">read-line</a><span id="line-content"> function monadic-io-streams Read a single line. </span></span><span id="section-content"> <a href="duck-streams-api.html#clojure.contrib.duck-streams/read-lines">read-lines</a><span id="line-content"> function duck-streams Like clojure.core/line-seq but opens f with reader... </span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/read-lines">read-lines</a><span id="line-content"> function io Like clojure.core/line-seq but opens f with reader... @@ -672,7 +698,8 @@ Shortcuts:<br /> </div><div id="index-body"> <h2 id="S"><span id="section-head">S</span></h2> <pre> -<span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/*stack-trace-depth*">*stack-trace-depth*</a><span id="line-content"> var test-is The maximum depth of stack traces to print when an... +<span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/*simple-dispatch*">*simple-dispatch*</a><span id="line-content"> multimethod pprint The pretty print dispatch function for simple data... +</span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/*stack-trace-depth*">*stack-trace-depth*</a><span id="line-content"> var test-is The maximum depth of stack traces to print when an... </span></span><span id="section-content"> <a href="map-utils-api.html#clojure.contrib.map-utils/safe-get">safe-get</a><span id="line-content"> function map-utils Like get, but throws an exception if the key is no... </span></span><span id="section-content"> <a href="map-utils-api.html#clojure.contrib.map-utils/safe-get-in">safe-get-in</a><span id="line-content"> function map-utils Like get-in, but throws an exception if any key is... </span></span><span id="section-content"> <a href="probabilities.monte-carlo-api.html#clojure.contrib.probabilities.monte-carlo/sample">sample</a><span id="line-content"> function probabilities.monte-carlo Return the distribution of samples of lengt... @@ -694,6 +721,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="monads-api.html#clojure.contrib.monads/sequence-t">sequence-t</a><span id="line-content"> function monads Monad transformer that transforms a monad m into a... </span></span><span id="section-content"> <a href="http.agent-api.html#clojure.contrib.http.agent/server-error?">server-error?</a><span id="line-content"> function http.agent Returns true if the HTTP response code was in the ... </span></span><span id="section-content"> <a href="monads-api.html#clojure.contrib.monads/set-m">set-m</a><span id="line-content"> var monads Monad describing multi-valued computations, like s... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/set-pprint-dispatch">set-pprint-dispatch</a><span id="line-content"> function pprint Set the pretty print dispatch function to a functi... </span></span><span id="section-content"> <a href="repl-ln-api.html#clojure.contrib.repl-ln/set-repl-name">set-repl-name</a><span id="line-content"> function repl-ln Sets the repl name format to the string name-fmt. ... </span></span><span id="section-content"> <a href="repl-ln-api.html#clojure.contrib.repl-ln/set-repl-prompt">set-repl-prompt</a><span id="line-content"> function repl-ln Sets the repl prompt. Include the following codes ... </span></span><span id="section-content"> <a href="sql-api.html#clojure.contrib.sql/set-rollback-only">set-rollback-only</a><span id="line-content"> function sql Marks the outermost transaction such that it will ... @@ -802,6 +830,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="str-utils2-api.html#clojure.contrib.str-utils2/upper-case">upper-case</a><span id="line-content"> function str-utils2 Converts string to all upper-case.. </span></span><span id="section-content"> <a href="string-api.html#clojure.contrib.string/upper-case">upper-case</a><span id="line-content"> function string Converts string to all upper-case.. </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/use-fixtures">use-fixtures</a><span id="line-content"> multimethod test-is Wrap test runs in a fixture function to perform se... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/use-method">use-method</a><span id="line-content"> function pprint Installs a function as a new method of multimethod... </span></span></pre> </div><div id="index-body"> <h2 id="V"><span id="section-head">V</span></h2> @@ -830,6 +859,7 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/with-out-append-writer">with-out-append-writer</a><span id="line-content"> macro io Like with-out-writer but appends to file.. </span></span><span id="section-content"> <a href="duck-streams-api.html#clojure.contrib.duck-streams/with-out-writer">with-out-writer</a><span id="line-content"> macro duck-streams Opens a writer on f, binds it to *out*, and evalut... </span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/with-out-writer">with-out-writer</a><span id="line-content"> macro io Opens a writer on f, binds it to *out*, and evalut... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/with-pprint-dispatch">with-pprint-dispatch</a><span id="line-content"> macro pprint Execute body with the pretty print dispatch functi... </span></span><span id="section-content"> <a href="profile-api.html#clojure.contrib.profile/with-profile-data">with-profile-data</a><span id="line-content"> macro profile Executes body with *profile-data* bound to an atom... </span></span><span id="section-content"> <a href="sql-api.html#clojure.contrib.sql/with-query-results">with-query-results</a><span id="line-content"> macro sql Executes a query, then evaluates body with results... </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/with-reader">with-reader</a><span id="line-content"> function monadic-io-streams Create a reader from reader-spec, run the monadic ... @@ -842,8 +872,11 @@ Shortcuts:<br /> </span></span><span id="section-content"> <a href="test-is-api.html#clojure.contrib.test-is/with-test-out">with-test-out</a><span id="line-content"> macro test-is Runs body with *out* bound to the value of *test-o... </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/with-writer">with-writer</a><span id="line-content"> function monadic-io-streams Create a writer from writer-spec, run the monadic ... </span></span><span id="section-content"> <a href="monadic-io-streams-api.html#clojure.contrib.monadic-io-streams/write">write</a><span id="line-content"> function monadic-io-streams Write text (a string). +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/write">write</a><span id="line-content"> function pprint Write an object subject to the current bindings of... +</span></span><span id="section-content"> <a href="json-api.html#clojure.contrib.json/write-json">write-json</a><span id="line-content"> function json Print object to PrintWriter out as JSON. </span></span><span id="section-content"> <a href="duck-streams-api.html#clojure.contrib.duck-streams/write-lines">write-lines</a><span id="line-content"> function duck-streams Writes lines (a seq) to f, separated by newlines. ... </span></span><span id="section-content"> <a href="io-api.html#clojure.contrib.io/write-lines">write-lines</a><span id="line-content"> function io Writes lines (a seq) to f, separated by newlines. ... +</span></span><span id="section-content"> <a href="pprint-api.html#clojure.contrib.pprint/write-out">write-out</a><span id="line-content"> function pprint Write an object to *out* subject to the current bi... </span></span><span id="section-content"> <a href="java-utils-api.html#clojure.contrib.java-utils/write-properties">write-properties</a><span id="line-content"> function java-utils Write properties to file-able.. </span></span><span id="section-content"> <a href="properties-api.html#clojure.contrib.properties/write-properties">write-properties</a><span id="line-content"> function properties Write properties to file-able.. </span></span><span id="section-content"> <a href="duck-streams-api.html#clojure.contrib.duck-streams/writer">writer</a><span id="line-content"> multimethod duck-streams Attempts to coerce its argument into an open java.... @@ -1308,7 +1308,7 @@ To read JSON, use read-json.</pre> Public variables and functions: - <br /> + <span id="var-link"><a href="json-api.html#clojure.contrib.json/json-str" id="var-tag">json-str</a> </span><span id="var-link"><a href="json-api.html#clojure.contrib.json/pprint-json" id="var-tag">pprint-json</a> </span><span id="var-link"><a href="json-api.html#clojure.contrib.json/print-json" id="var-tag">print-json</a> </span><span id="var-link"><a href="json-api.html#clojure.contrib.json/read-json" id="var-tag">read-json</a> </span><span id="var-link"><a href="json-api.html#clojure.contrib.json/read-json-from" id="var-tag">read-json-from</a> </span><span id="var-link"><a href="json-api.html#clojure.contrib.json/write-json" id="var-tag">write-json</a> </span><br /> </div><div id="namespace-entry"> <br /> @@ -1671,21 +1671,44 @@ functions.</pre> <br /> <hr /> <h2 id="pprint">pprint</h2> - + <span id="author-line">by <span id="author-name">Tom Faulhaber</span><br /></span> <a href="pprint-api.html" id="api-link">Detailed API documentation</a><br /> - <pre id="namespace-docstr"></pre> - + <pre id="namespace-docstr">This module comprises two elements: +1) A pretty printer for Clojure data structures, implemented in the + function "pprint" +2) A Common Lisp compatible format function, implemented as + "cl-format" because Clojure is using the name "format" + for its Java-based format function. + +See documentation for those functions for more information or complete +documentation on the the clojure-contrib web site on github. + +As of the 1.2 release, pprint has been moved to clojure.pprint. Please prefer +the clojure.pprint version for new code.</pre> + <span class="ns-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span> Public variables and functions: - <span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-pretty*" id="var-tag">*print-pretty*</a> </span><br /> + <span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*code-dispatch*" id="var-tag">*code-dispatch*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-base*" id="var-tag">*print-base*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-circle*" id="var-tag">*print-circle*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-lines*" id="var-tag">*print-lines*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-miser-width*" id="var-tag">*print-miser-width*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-pprint-dispatch*" id="var-tag">*print-pprint-dispatch*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-pretty*" id="var-tag">*print-pretty*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-radix*" id="var-tag">*print-radix*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-right-margin*" id="var-tag">*print-right-margin*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-shared*" id="var-tag">*print-shared*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*print-suppress-namespaces*" id="var-tag">*print-suppress-namespaces*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/*simple-dispatch*" id="var-tag">*simple-dispatch*</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/cl-format" id="var-tag">cl-format</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/compile-format" id="var-tag">compile-format</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/formatter" id="var-tag">formatter</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/formatter-out" id="var-tag">formatter-out</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/fresh-line" id="var-tag">fresh-line</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/pp" id="var-tag">pp</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/pprint" id="var-tag">pprint</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/pprint-indent" id="var-tag">pprint-indent</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/pprint-logical-block" id="var-tag">pprint-logical-block</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/pprint-newline" id="var-tag">pprint-newline</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/pprint-tab" id="var-tag">pprint-tab</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/set-pprint-dispatch" id="var-tag">set-pprint-dispatch</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/use-method" id="var-tag">use-method</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/with-pprint-dispatch" id="var-tag">with-pprint-dispatch</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/write" id="var-tag">write</a> </span><span id="var-link"><a href="pprint-api.html#clojure.contrib.pprint/write-out" id="var-tag">write-out</a> </span><br /> <span id="subspace"><br />Variables and functions in <span id="name">pprint.examples.json</span>: - + <span id="sub-var-link"> + <a href="pprint-api.html#clojure.contrib.pprint.examples.json/dispatch-json">dispatch-json</a> + </span><span id="sub-var-link"> + <a href="pprint-api.html#clojure.contrib.pprint.examples.json/json-str">json-str</a> + </span><span id="sub-var-link"> + <a href="pprint-api.html#clojure.contrib.pprint.examples.json/print-json">print-json</a> + </span> <br /> </span><span id="subspace"><br />Variables and functions in <span id="name">pprint.examples.xml</span>: - + <span id="sub-var-link"> + <a href="pprint-api.html#clojure.contrib.pprint.examples.xml/*html-compatible*">*html-compatible*</a> + </span><span id="sub-var-link"> + <a href="pprint-api.html#clojure.contrib.pprint.examples.xml/*prxml-indent*">*prxml-indent*</a> + </span><span id="sub-var-link"> + <a href="pprint-api.html#clojure.contrib.pprint.examples.xml/prxml">prxml</a> + </span> <br /> </span> </div><div id="namespace-entry"> diff --git a/json-api.html b/json-api.html index 13b64d11..676a7308 100644 --- a/json-api.html +++ b/json-api.html @@ -53,7 +53,19 @@ namespace. <h1 class="nopad">Table of Contents</h1> <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.json/json-str">json-str</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.json/pprint-json">pprint-json</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.json/print-json">print-json</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.json/read-json">read-json</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.json/read-json-from">read-json-from</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.json/write-json">write-json</a> + </div> <br /> </div> </div> @@ -75,7 +87,81 @@ To read JSON, use read-json.</pre> <br /> <h2>Public Variables and Functions</h2> - +<div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/json.clj#L301" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.json/pprint-json">pprint-json</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (pprint-json x) +</pre> + <pre id="var-docstr">Pretty-prints JSON representation of x to *out*</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/json.clj#L338" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.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">Write JSON-formatted output to *out*</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/json.clj#L309" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.json/read-json">read-json</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (read-json input) + (read-json input keywordize?) + (read-json input keywordize? eof-error? eof-value) +</pre> + <pre id="var-docstr">Reads one JSON value from input String or Reader. +If keywordize? is true (default), object keys will be converted to +keywords. If eof-error? is true (default), empty input will throw +an EOFException; if false EOF will return eof-value. </pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/json.clj#L189" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.json/read-json-from">read-json-from</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (read-json-from input keywordize? eof-error? eof-value) +</pre> + <pre id="var-docstr">Reads one JSON value from input String or Reader. +If keywordize? is true, object keys will be converted to keywords. +If eof-error? is true, empty input will throw an EOFException; if +false EOF will return eof-value. </pre> + + + +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.json/write-json">write-json</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (write-json object out) +</pre> + <pre id="var-docstr">Print object to PrintWriter out as JSON</pre> + + + +</div> </div> diff --git a/pprint-api.html b/pprint-api.html index fb741c2a..74340610 100644 --- a/pprint-api.html +++ b/pprint-api.html @@ -54,32 +54,109 @@ 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> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*print-lines*">*print-lines*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*print-miser-width*">*print-miser-width*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*print-pprint-dispatch*">*print-pprint-dispatch*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> <a href="#clojure.contrib.pprint/*print-pretty*">*print-pretty*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*print-radix*">*print-radix*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*print-right-margin*">*print-right-margin*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/*print-shared*">*print-shared*</a> + </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> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/pprint-indent">pprint-indent</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/pprint-logical-block">pprint-logical-block</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/pprint-newline">pprint-newline</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/pprint-tab">pprint-tab</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/set-pprint-dispatch">set-pprint-dispatch</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/use-method">use-method</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/with-pprint-dispatch">with-pprint-dispatch</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/write">write</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.pprint/write-out">write-out</a> </div> <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> </div> <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">pprint</span> <span id="branch-name">(master branch)</span></h1> - +<span id="author-line">by <span id="author-name">Tom Faulhaber</span><br /></span> <br />Usage: <pre> (ns your-namespace (:require <span id="long-name">clojure.contrib.pprint</span>)) </pre><pre> </pre><h2>Overview</h2> -<pre id="namespace-docstr"></pre> +<pre id="namespace-docstr">This module comprises two elements: +1) A pretty printer for Clojure data structures, implemented in the + function "pprint" +2) A Common Lisp compatible format function, implemented as + "cl-format" because Clojure is using the name "format" + for its Java-based format function. + +See documentation for those functions for more information or complete +documentation on the the clojure-contrib web site on github. +As of the 1.2 release, pprint has been moved to clojure.pprint. Please prefer +the clojure.pprint version for new code.</pre> +<span class="ns-deprecated"><span id="content">Deprecated since clojure-contrib version 1.2</span><br /></span> <br /> <span id="external-doc">Related documentation: <span id="external-doc-link"> @@ -91,6 +168,70 @@ namespace. <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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L78" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-circle*">*print-circle*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L56" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-lines*">*print-lines*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L51" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-miser-width*">*print-miser-width*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">The column at which to enter miser style. Depending on the dispatch table, +miser style add newlines in more places to try to keep lines short allowing for further +levels of nesting.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L44" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-pprint-dispatch*">*print-pprint-dispatch*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">The pretty print dispatch function. Use with-pprint-dispatch or set-pprint-dispatch +to modify.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L33" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> <h2 id="clojure.contrib.pprint/*print-pretty*">*print-pretty*</h2> <span id="var-type">var</span><br /> <pre id="var-usage"></pre> @@ -98,6 +239,334 @@ namespace. <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L29" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-radix*">*print-radix*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">Print a radix specifier in front of integers and rationals. If *print-base* is 2, 8, +or 16, then the radix specifier used is #b, #o, or #x, respectively. Otherwise the +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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L72" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-right-margin*">*print-right-margin*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">Pretty printing will try to avoid anything going beyond this column. +Set it to nil to have pprint let the line be arbitrarily long. This will ignore all +non-mandatory newlines.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L38" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-shared*">*print-shared*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L61" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/*print-suppress-namespaces*">*print-suppress-namespaces*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">Don't print namespaces with symbols. This is particularly useful when +pretty printing the results of macro expansions</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/dispatch.clj#L125" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/cl-format">cl-format</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (cl-format writer format-in & args) +</pre> + <pre id="var-docstr">An implementation of a Common Lisp compatible format function. cl-format formats its +arguments to an output stream or string based on the format control string given. It +supports sophisticated formatting of structured data. + +Writer is an instance of java.io.Writer, true to output to *out* or nil to output +to a string, format-in is the format control string and the remaining arguments +are the data to be formatted. + +The format control string is a string to be output with embedded 'format directives' +describing how to format the various arguments passed in. + +If writer is nil, cl-format returns the formatted result string. Otherwise, cl-format +returns nil. + +For example: + (let [results [46 38 22]] + (cl-format true "There ~[are~;is~:;are~]~:* ~d result~:p: ~{~d~^, ~}~%" + (count results) results)) + +Prints to *out*: + There are 3 results: 46, 38, 22 + +Detailed documentation on format control strings is available in the "Common Lisp the +Language, 2nd edition", Chapter 22 (available online at: +<a href="http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000">http://www.cs.cmu.edu/afs/cs.cmu.edu/project/ai-repository/ai/html/cltl/clm/node200.html#SECTION002633000000000000000</a>) +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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/cl_format.clj#L1749" 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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/cl_format.clj#L1817" 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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/cl_format.clj#L1831" 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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/cl_format.clj#L1153" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/pp">pp</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (pp) +</pre> + <pre id="var-docstr">A convenience macro that pretty prints the last thing output. This is +exactly equivalent to (pprint *1).</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L241" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/pprint">pprint</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (pprint object) + (pprint object writer) +</pre> + <pre id="var-docstr">Pretty print object to the optional output writer. If the writer is not provided, +print the object to the currently bound value of *out*.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L229" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/pprint-indent">pprint-indent</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (pprint-indent relative-to n) +</pre> + <pre id="var-docstr">Create an indent at this point in the pretty printing stream. This defines how +following lines are indented. relative-to can be either :block or :current depending +whether the indent should be computed relative to the start of the logical block or +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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L315" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/pprint-logical-block">pprint-logical-block</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (pprint-logical-block options* body) +</pre> + <pre id="var-docstr">Execute the body as a pretty printing logical block with output to *out* which +must be a pretty printing writer. When used from pprint or cl-format, this can be +assumed. + +Before the body, the caller can optionally specify options: :prefix, :per-line-prefix, +and :suffix.</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L286" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/pprint-newline">pprint-newline</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (pprint-newline kind) +</pre> + <pre id="var-docstr">Print a conditional newline to a pretty printing stream. kind specifies if the +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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L306" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/pprint-tab">pprint-tab</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (pprint-tab kind colnum colinc) +</pre> + <pre id="var-docstr">Tab at this point in the pretty printing stream. kind specifies whether the tab +is :line, :section, :line-relative, or :section-relative. + +Colnum and colinc specify the target column and the increment to move the target +forward if the output is already past the original target. + +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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L327" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/set-pprint-dispatch">set-pprint-dispatch</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (set-pprint-dispatch function) +</pre> + <pre id="var-docstr">Set the pretty print dispatch function to a function matching (fn [obj] ...) +where obj is the object to pretty print. That function will be called with *out* set +to a pretty printing writer to which it should do its printing. + +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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L246" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/use-method">use-method</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (use-method multifn dispatch-val func) +</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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/dispatch.clj#L19" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/with-pprint-dispatch">with-pprint-dispatch</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (with-pprint-dispatch function & body) +</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/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L259" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/write">write</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (write object & kw-args) +</pre> + <pre id="var-docstr">Write an object subject to the current bindings of the printer control variables. +Use the kw-args argument to override individual variables for this call (and any +recursive calls). Returns the string result if :stream is nil or nil otherwise. + +The following keyword arguments can be passed with values: + Keyword Meaning Default value + :stream Writer for output or nil true (indicates *out*) + :base Base to use for writing rationals Current value of *print-base* + :circle* If true, mark circular structures Current value of *print-circle* + :length Maximum elements to show in sublists Current value of *print-length* + :level Maximum depth Current value of *print-level* + :lines* Maximum lines of output Current value of *print-lines* + :miser-width Width to enter miser mode Current value of *print-miser-width* + :dispatch The pretty print dispatch function Current value of *print-pprint-dispatch* + :pretty If true, do pretty printing Current value of *print-pretty* + :radix If true, prepend a radix specifier Current value of *print-radix* + :readably* If true, print readably Current value of *print-readably* + :right-margin The column for the right margin Current value of *print-right-margin* + :suppress-namespaces If true, no namespaces in symbols Current value of *print-suppress-namespaces* + + * = not yet supported</pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/clojure/contrib/pprint/pprint_base.clj#L186" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.pprint/write-out">write-out</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (write-out object) +</pre> + <pre id="var-docstr">Write an object to *out* subject to the current bindings of the printer control +variables. Use the kw-args argument to override individual variables for this call (and +any recursive calls). + +*out* must be a PrettyWriter if pretty printing is enabled. This is the responsibility +of the caller. + +This method is primarily intended for use by pretty print dispatch functions that +already know that the pretty printer will have set up their environment appropriately. +Normal library clients should use the standard "write" interface. </pre> + + + <a href="http://github.com/richhickey/clojure-contrib/blob/7188a51605136f36524e4091fe806859114d6056/src/main/clojure/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. @@ -110,13 +579,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/5d30e632710faf1b74ef7826ba5bf1bde737e5ef/src/examples/clojure/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/5d30e632710faf1b74ef7826ba5bf1bde737e5ef/src/examples/clojure/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/5d30e632710faf1b74ef7826ba5bf1bde737e5ef/src/examples/clojure/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/5d30e632710faf1b74ef7826ba5bf1bde737e5ef/src/examples/clojure/clojure/contrib/pprint/examples/xml.clj#L26" 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/5d30e632710faf1b74ef7826ba5bf1bde737e5ef/src/examples/clojure/clojure/contrib/pprint/examples/xml.clj#L30" 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/5d30e632710faf1b74ef7826ba5bf1bde737e5ef/src/examples/clojure/clojure/contrib/pprint/examples/xml.clj#L96" id="var-source">Source</a> +</div> </div> |