CrossClj

1.3.0 docs

SourceDocs



RECENT
    VARS
    *alias-map*
    *data-readers*
    *default-data-reader-fn*
    *read-delim*
    *read-eval*
    *suppress-read*
    add-meta
    arg-env
    check-eof-error
    check-invalid-read-cond
    check-reserved-features
    default-data-readers
    dispatch-macros
    ending-line-col-info
    escape-char
    expand-list
    flatten-map
    garg
    gensym-env
    has-feature?
    lower-limit
    macro-terminating?
    macros
    map-func
    match-feature
    NO_MATCH
    ns-name*
    read
    read*
    read-arg
    read-char*
    read-cond
    read-cond-delimited
    read-ctor
    read-delimited
    read-discard
    read-dispatch
    read-eval
    read-fn
    read-keyword
    read-list
    read-map
    read-meta
    read-namespaced-map
    read-number
    read-regex
    read-set
    read-string
    read-string*
    read-suppress
    read-symbol
    read-symbolic-value
    read-syntax-quote
    read-tagged
    read-token
    read-unicode-char
    read-unmatched-delimiter
    read-unquote
    read-vector
    READ_EOF
    READ_FINISHED
    register-arg
    register-gensym
    RESERVED_FEATURES
    resolve-alias
    resolve-ns
    resolve-symbol
    starting-line-col-info
    syntax-quote
    syntax-quote*
    syntax-quote-coll
    unquote-splicing?
    unquote?
    upper-limit
    wrapping-reader

    « Index of all namespaces of this project

    A clojure reader in clojure
    

    — Bronsa

    Dynamic
    Map from ns alias to ns, if non-nil, it will be used to resolve read-time
    ns aliases instead of (ns-aliases *ns*).
    
    Defaults to nil
    Dynamic
    Map from reader tag symbols to data reader Vars.
    Reader tags without namespace qualifiers are reserved for Clojure.
    Default reader tags are defined in clojure.tools.reader/default-data-readers
    and may be overridden by binding this Var.
    Dynamic
    When no data reader is found for a tag and *default-data-reader-fn*
    is non-nil, it will be called with two arguments, the tag and the value.
    If *default-data-reader-fn* is nil (the default value), an exception
    will be thrown for the unknown tag.
    Dynamic
    Defaults to true.
    
    ***WARNING***
    This setting implies that the full power of the reader is in play,
    including syntax that can cause code to execute. It should never be
    used with untrusted sources. See also: clojure.tools.reader.edn/read.
    
    When set to logical false in the thread-local binding,
    the eval reader (#=) and *record/type literal syntax* are disabled in read/load.
    Example (will fail): (binding [*read-eval* false] (read-string "#=(* 2 21)"))
    
    When set to :unknown all reads will fail in contexts where *read-eval*
    has not been explicitly bound to either true or false. This setting
    can be a useful diagnostic tool to ensure that all of your reads
    occur in considered contexts.
    Private
    (add-meta form ret)
    PrivateDynamic
    Private
    (check-eof-error form rdr first-line)
    Private
    (check-invalid-read-cond form rdr first-line)
    Private
    (check-reserved-features rdr form)
    Default map of data reader functions provided by Clojure.
    May be overridden by binding *data-readers*
    Private
    (dispatch-macros ch)
    Private
    (ending-line-col-info rdr)
    Private
    (escape-char sb rdr)
    Private
    (expand-list s)
    Expand a list by resolving its syntax quotes and unquotes
    
    Private
    (flatten-map form)
    Flatten a map into a seq of alternate keys and values
    
    Private
    (garg n)
    Get a symbol for an anonymous ?argument?
    
    Private
    (has-feature? rdr feature opts)
    Private
    (macro-terminating? ch)
    Private
    (macros ch)
    (map-func coll)
    Decide which map type to use, array-map if less than 16 elements
    
    Private
    (match-feature first-line rdr opts pending-forms)
    Read next feature. If matched, read next form and return.
    Otherwise, read and skip next form, returning READ_FINISHED or nil.
    Private
    (ns-name* x)
    (read)(read reader)(read opts reader)(read reader eof-error? eof-value)
    Reads the first object from an IPushbackReader or a java.io.PushbackReader.
    Returns the object read. If EOF, throws if eof-error? is true.
    Otherwise returns sentinel. If no stream is providen, *in* will be used.
    
    Opts is a persistent map with valid keys:
     :read-cond - :allow to process reader conditionals, or
                  :preserve to keep all branches
     :features - persistent set of feature keywords for reader conditionals
     :eof - on eof, return value unless :eofthrow, then throw.
            if not specified, will throw
    
    ***WARNING***
    Note that read can execute code (controlled by *read-eval*),
    and as such should be used only with trusted sources.
    
    To read data structures only, use clojure.tools.reader.edn/read
    
    Note that the function signature of clojure.tools.reader/read and
    clojure.tools.reader.edn/read is not the same for eof-handling
    Private
    (read* reader eof-error? sentinel opts pending-forms)(read* reader eof-error? sentinel return-on opts pending-forms)
    Private
    (read-arg rdr pct opts pending-forms)
    Private
    (read-char* rdr backslash opts pending-forms)
    Read in a character literal
    
    Private
    (read-cond rdr _ opts pending-forms)
    Private
    (read-cond-delimited rdr splicing opts pending-forms)
    Private
    (read-ctor rdr class-name opts pending-forms)
    Private
    (read-delimited kind delim rdr opts pending-forms)
    Reads and returns a collection ended with delim
    
    Private
    (read-discard rdr _ opts pending-forms)
    Read and discard the first object from rdr
    
    Private
    (read-dispatch rdr _ opts pending-forms)
    Private
    (read-eval rdr _ opts pending-forms)
    Evaluate a reader literal
    
    Private
    (read-fn rdr _ opts pending-forms)
    Private
    (read-keyword reader initch opts pending-forms)
    Private
    (read-list rdr _ opts pending-forms)
    Read in a list, including its location if the reader is an indexing reader
    
    Private
    (read-map rdr _ opts pending-forms)
    Read in a map, including its location if the reader is an indexing reader
    
    Private
    (read-meta rdr _ opts pending-forms)
    Read metadata and return the following object with the metadata applied
    
    Private
    (read-namespaced-map rdr _ opts pending-forms)
    Private
    (read-number rdr initch)
    (read-regex rdr ch opts pending-forms)
    Private
    (read-set rdr _ opts pending-forms)
    (read-string s)(read-string opts s)
    Reads one object from the string s.
    Returns nil when s is nil or empty.
    
    ***WARNING***
    Note that read-string can execute code (controlled by *read-eval*),
    and as such should be used only with trusted sources.
    
    To read data structures only, use clojure.tools.reader.edn/read-string
    
    Note that the function signature of clojure.tools.reader/read-string and
    clojure.tools.reader.edn/read-string is not the same for eof-handling
    Private
    (read-string* reader _ opts pending-forms)
    Private
    (read-suppress first-line rdr opts pending-forms)
    Read next form and suppress. Return nil or READ_FINISHED.
    
    Private
    (read-symbolic-value rdr _ opts pending-forms)
    Private
    (read-syntax-quote rdr backquote opts pending-forms)
    Private
    (read-tagged rdr initch opts pending-forms)
    Private
    (read-token rdr kind initch)
    Read in a single logical token from the reader
    
    Private
    (read-unicode-char token offset length base)(read-unicode-char rdr initch base length exact?)
    Private
    (read-unmatched-delimiter rdr ch opts pending-forms)
    Private
    (read-unquote rdr comma opts pending-forms)
    Private
    (read-vector rdr _ opts pending-forms)
    Read in a vector, including its location if the reader is an indexing reader
    
    Private
    (register-arg n)
    Registers an argument to the arg-env
    
    Private
    (register-gensym sym)
    Private
    (resolve-alias sym)
    Private
    (resolve-ns sym)
    Dynamic
    (resolve-symbol s)
    Resolve a symbol s into its fully qualified namespace version
    
    Private
    (starting-line-col-info rdr)
    macro
    (syntax-quote form)
    Macro equivalent to the syntax-quote reader macro (`).
    
    Private
    (syntax-quote* form)
    Private
    (syntax-quote-coll type coll)
    Private
    (unquote-splicing? form)
    Private
    (unquote? form)
    Private
    (wrapping-reader sym)
    Returns a function which wraps a reader in a call to sym