API for clojure.main - Clojure v1.6 (stable)


Full namespace name: clojure.main

Overview





Public Variables and Functions



demunge

function
Usage: (demunge fn-name)
Given a string representation of a fn class,
as in a stack trace element, returns a readable version.
Added in Clojure version 1.3
Source


load-script

function
Usage: (load-script path)
Loads Clojure source from a file or resource given its path. Paths
beginning with @ or @/ are considered relative to classpath.
Source


main

function
Usage: (main & args)
Usage: java -cp clojure.jar clojure.main [init-opt*] [main-opt] [arg*]

With no options or args, runs an interactive Read-Eval-Print Loop

init options:
  -i, --init path     Load a file or resource
  -e, --eval string   Evaluate expressions in string; print non-nil values

main options:
  -m, --main ns-name  Call the -main function from a namespace with args
  -r, --repl          Run a repl
  path                Run a script from from a file or resource
  -                   Run a script from standard input
  -h, -?, --help      Print this help message and exit

operation:

  - Establishes thread-local bindings for commonly set!-able vars
  - Enters the user namespace
  - Binds *command-line-args* to a seq of strings containing command line
    args that appear after any main option
  - Runs all init options in order
  - Calls a -main function or runs a repl or script if requested

The init options may be repeated and mixed freely, but must appear before
any main option. The appearance of any eval option before running a repl
suppresses the usual repl greeting message: "Clojure ~(clojure-version)".

Paths may be absolute or relative in the filesystem or relative to
classpath. Classpath-relative paths have prefix of @ or @/
Source


repl

function
Usage: (repl & options)
Generic, reusable, read-eval-print loop. By default, reads from *in*,
writes to *out*, and prints exception summaries to *err*. If you use the
default :read hook, *in* must either be an instance of
LineNumberingPushbackReader or duplicate its behavior of both supporting
.unread and collapsing CR, LF, and CRLF into a single \newline. Options
are sequential keyword-value pairs. Available options and their defaults:

   - :init, function of no arguments, initialization hook called with
     bindings for set!-able vars in place.
     default: #()

   - :need-prompt, function of no arguments, called before each
     read-eval-print except the first, the user will be prompted if it
     returns true.
     default: (if (instance? LineNumberingPushbackReader *in*)
                #(.atLineStart *in*)
                #(identity true))

   - :prompt, function of no arguments, prompts for more input.
     default: repl-prompt

   - :flush, function of no arguments, flushes output
     default: flush

   - :read, function of two arguments, reads from *in*:
       - returns its first argument to request a fresh prompt
         - depending on need-prompt, this may cause the repl to prompt
           before reading again
       - returns its second argument to request an exit from the repl
       - else returns the next object read from the input stream
     default: repl-read

   - :eval, function of one argument, returns the evaluation of its
     argument
     default: eval

   - :print, function of one argument, prints its argument to the output
     default: prn

   - :caught, function of one argument, a throwable, called when
     read, eval, or print throws an exception or error
     default: repl-caught
Source


repl-caught

function
Usage: (repl-caught e)
Default :caught hook for repl
Source


repl-exception

function
Usage: (repl-exception throwable)
Returns the root cause of throwables
Source


repl-prompt

function
Usage: (repl-prompt)
Default :prompt hook for repl
Source


repl-read

function
Usage: (repl-read request-prompt request-exit)
Default :read hook for repl. Reads from *in* which must either be an
instance of LineNumberingPushbackReader or duplicate its behavior of both
supporting .unread and collapsing all of CR, LF, and CRLF into a single
\newline. repl-read:
  - skips whitespace, then
    - returns request-prompt on start of line, or
    - returns request-exit on end of stream, or
    - reads an object from the input stream, then
      - skips the next input character if it's end of line, then
      - returns the object.
Source


repl-requires

var

    
A sequence of lib specs that are applied to `require`
by default when a new command-line REPL is started.
Source


root-cause

function
Usage: (root-cause t)
Returns the initial cause of an exception or error by peeling off all of
its wrappers
Added in Clojure version 1.3
Source


skip-if-eol

function
Usage: (skip-if-eol s)
If the next character on stream s is a newline, skips it, otherwise
leaves the stream untouched. Returns :line-start, :stream-end, or :body
to indicate the relative location of the next character on s. The stream
must either be an instance of LineNumberingPushbackReader or duplicate
its behavior of both supporting .unread and collapsing all of CR, LF, and
CRLF to a single \newline.
Source


skip-whitespace

function
Usage: (skip-whitespace s)
Skips whitespace characters on stream s. Returns :line-start, :stream-end,
or :body to indicate the relative location of the next character on s.
Interprets comma as whitespace and semicolon as comment to end of line.
Does not interpret #! as comment to end of line because only one
character of lookahead is available. The stream must either be an
instance of LineNumberingPushbackReader or duplicate its behavior of both
supporting .unread and collapsing all of CR, LF, and CRLF to a single
\newline.
Source


stack-element-str

function
Usage: (stack-element-str el)
Returns a (possibly unmunged) string representation of a StackTraceElement
Added in Clojure version 1.3
Source


with-bindings

macro
Usage: (with-bindings & body)
Executes body in the context of thread-local bindings for several vars
that often need to be set!: *ns* *warn-on-reflection* *math-context*
*print-meta* *print-length* *print-level* *compile-path*
*command-line-args* *1 *2 *3 *e
Source


with-read-known

macro
Usage: (with-read-known & body)
Evaluates body with *read-eval* set to a "known" value,
i.e. substituting true for :unknown if necessary.
Source
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.