API for find-namespaces - clojure-contrib v1.1 (stable)

by Stuart Sierra

Usage:
(ns your-namespace
  (:require clojure.contrib.find-namespaces))

Overview

Search for ns declarations in dirs, JARs, or CLASSPATH

Public Variables and Functions



clojure-source-file?

function
Usage: (clojure-source-file? file)
Returns true if file is a normal file with a .clj extension.
Source


clojure-sources-in-jar

function
Usage: (clojure-sources-in-jar jar-file)
Returns a sequence of filenames ending in .clj found in the JAR file.
Source


comment?

function
Usage: (comment? form)
Returns true if form is a (comment ...)
Source


find-clojure-sources-in-dir

function
Usage: (find-clojure-sources-in-dir dir)
Searches recursively under dir for Clojure source files (.clj).
Returns a sequence of File objects, in breadth-first sort order.
Source


find-namespaces-in-dir

function
Usage: (find-namespaces-in-dir dir)
Searches dir recursively for (ns ...) declarations in Clojure
source files; returns the symbol names of the declared namespaces.
Source


find-namespaces-in-jarfile

function
Usage: (find-namespaces-in-jarfile jarfile)
Searches the JAR file for Clojure source files containing (ns ...)
declarations.  Returns a sequence of the symbol names of the
declared namespaces.
Source


find-namespaces-on-classpath

function
Usage: (find-namespaces-on-classpath)
Searches CLASSPATH (both directories and JAR files) for Clojure
source files containing (ns ...) declarations.  Returns a sequence
of the symbol names of the declared namespaces.
Source


find-ns-decls-in-dir

function
Usage: (find-ns-decls-in-dir dir)
Searches dir recursively for (ns ...) declarations in Clojure
source files; returns the unevaluated ns declarations.
Source


find-ns-decls-in-jarfile

function
Usage: (find-ns-decls-in-jarfile jarfile)
Searches the JAR file for Clojure source files containing (ns ...)
declarations; returns the unevaluated ns declarations.
Source


find-ns-decls-on-classpath

function
Usage: (find-ns-decls-on-classpath)
Searches CLASSPATH (both directories and JAR files) for Clojure
source files containing (ns ...) declarations.  Returns a sequence
of the unevaluated ns declaration forms.
Source


ns-decl?

function
Usage: (ns-decl? form)
Returns true if form is a (ns ...) declaration.
Source


read-file-ns-decl

function
Usage: (read-file-ns-decl file)
Attempts to read a (ns ...) declaration from file, and returns the
unevaluated form.  Returns nil if read fails, or if the first form
is not a ns declaration.
Source


read-ns-decl

function
Usage: (read-ns-decl rdr)
Attempts to read a (ns ...) declaration from rdr, and returns the
unevaluated form.  Returns nil if read fails or if a ns declaration
cannot be found.  The ns declaration must be the first Clojure form
in the file, except for (comment ...)  forms.
Source


read-ns-decl-from-jarfile-entry

function
Usage: (read-ns-decl-from-jarfile-entry jarfile entry-name)
Attempts to read a (ns ...) declaration from the named entry in the
JAR file, and returns the unevaluated form.  Returns nil if the read
fails, or if the first form is not a ns declaration.
Source
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.