Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 41 additions & 6 deletions codox/resources/codox/theme/default/css/default.css
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ h5.license {
right: 0;
height: 22px;
color: #f5f5f5;
padding: 5px 7px;
padding: 7px 10px;
}

#content {
Expand Down Expand Up @@ -92,16 +92,17 @@ h5.license {

#header {
background: #3f3f3f;
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4);
border-bottom: 1px solid #cccccc;
z-index: 100;
}

#header h1 {
display: block;
float: left;
margin: 0;
padding: 0;
font-size: 18px;
font-weight: lighter;
text-shadow: -1px -1px 0px #333;
}

#header h1 .project-version {
Expand All @@ -121,6 +122,27 @@ h5.license {
color: #f5f5f5;
}

#langs {
display: block;
float: left;
font-size: 16px;
margin: 0 10px;
font-weight: lighter;
}

#langs .lang {
display: inline-block;
margin: 0 2px;
padding: 0 7px;
background-color: #bbb;
border-radius: 6px;
vertical-align: middle;
}

#langs .lang.current {
background-color: #a33;
}

.sidebar a {
color: #333;
}
Expand Down Expand Up @@ -325,7 +347,8 @@ h5.license {
h4.type,
h4.dynamic,
h4.added,
h4.deprecated {
h4.deprecated,
h4.lang {
float: left;
margin: 3px 10px 15px 0;
font-size: 15px;
Expand All @@ -336,15 +359,17 @@ h4.deprecated {
.public h4.type,
.public h4.dynamic,
.public h4.added,
.public h4.deprecated {
.public h4.deprecated,
.public h4.lang {
font-size: 13px;
font-weight: bold;
margin: 3px 0 0 10px;
}

.members h4.type,
.members h4.added,
.members h4.deprecated {
.members h4.deprecated,
.members h4.lang {
margin-top: 1px;
}

Expand All @@ -364,6 +389,16 @@ h4.deprecated {
color: #880000;
}

.public h4.lang, .public h4.lang a {
font-weight: normal;
font-variant: normal;
color: #717171;
}

.public h4.lang.current {
color: #a33;
}

.namespace {
margin-bottom: 30px;
}
Expand Down
77 changes: 48 additions & 29 deletions codox/src/codox/main.clj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
(:require [clojure.string :as str]
[clojure.java.shell :as shell]
[codox.reader.clojure :as clj]
[codox.reader.clojurescript :as cljs]
[codox.reader.plaintext :as text]))

(defn- writer [{:keys [writer]}]
Expand All @@ -19,29 +20,9 @@
(throw
(Exception. (str "Could not resolve codox writer " writer-sym))))))

(defn- macro? [var]
(= (:type var) :macro))

(defn- read-macro-namespaces [paths read-opts]
(->> (clj/read-namespaces paths read-opts)
(map (fn [ns] (update-in ns [:publics] #(filter macro? %))))
(remove (comp empty? :publics))))

(defn- merge-namespaces [namespaces]
(for [[name namespaces] (group-by :name namespaces)]
(assoc (first namespaces) :publics (mapcat :publics namespaces))))

(defn- cljs-read-namespaces [paths read-opts]
;; require is here to allow Clojure 1.3 and 1.4 when not using ClojureScript
(require 'codox.reader.clojurescript)
(let [reader (find-var 'codox.reader.clojurescript/read-namespaces)]
(merge-namespaces
(concat (reader paths read-opts)
(read-macro-namespaces paths read-opts)))))

(def ^:private namespace-readers
{:clojure clj/read-namespaces
:clojurescript cljs-read-namespaces})
:clojurescript cljs/read-namespaces})

(defn- var-symbol [namespace var]
(symbol (name (:name namespace)) (name (:name var))))
Expand Down Expand Up @@ -77,14 +58,49 @@
(filter #(some (partial ns-matches? %) ns-filters) namespaces)
namespaces))

(defn- cross-platform?
"Do given options indicate *both* Clojure and ClojureScript sources?"
[{:keys [language] :as opts}]
(= language :both))

(defn- read-namespaces
"Returns {<language> <namespace-seq>} for cross-platform opts,
or <namespace-seq> otherwise."
[{:keys [language root-path source-paths namespaces metadata exclude-vars] :as opts}]
(let [reader (namespace-readers language)]
(-> (reader source-paths (select-keys opts [:exception-handler]))
(filter-namespaces namespaces)
(remove-excluded-vars exclude-vars)
(add-source-paths root-path source-paths)
(add-ns-defaults metadata))))
(if (cross-platform? opts)
{:clojure (read-namespaces (assoc opts :language :clojure))
:clojurescript (read-namespaces (assoc opts :language :clojurescript))}
(let [reader (namespace-readers language)]
(-> (reader source-paths (select-keys opts [:exception-handler]))
(filter-namespaces namespaces)
(remove-excluded-vars exclude-vars)
(add-source-paths root-path source-paths)
(add-ns-defaults metadata)))))

(defn- get-var-langs
"Returns {<ns> {<var> <set-of-languages>}} for given namespaces."
([language namespaces var-langs]
(reduce
(fn [var-langs ns]
(reduce
(fn [var-langs public-var]
(update-in var-langs [(:name ns) (:name public-var)]
#(conj (or % #{}) language)))
var-langs
(:publics ns)))
var-langs
namespaces))

([options namespaces]
(if-not (cross-platform? options)
(get-var-langs (:language options) namespaces {})
(->>
(get-var-langs :clojure (:clojure namespaces) {})
(get-var-langs :clojurescript (:clojurescript namespaces))))))

(comment (get-var-langs {:language :clojure}
'({:name codox.main :publics ({:name defaults} {:name bar})}
{:name codox.foo :publics ({:name bar})})))

(defn- read-documents [{:keys [doc-paths doc-files] :or {doc-files :all}}]
(cond
Expand Down Expand Up @@ -121,7 +137,10 @@
(let [options (merge defaults options)
write-fn (writer options)
namespaces (read-namespaces options)
documents (read-documents options)]
documents (read-documents options)
var-langs (get-var-langs options namespaces)]
(write-fn (assoc options
:namespaces namespaces
:documents documents)))))
:documents documents
:var-langs var-langs
:cross-platform? (cross-platform? options))))))
4 changes: 2 additions & 2 deletions codox/src/codox/reader/clojure.clj
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@

(defn- find-namespaces [file]
(cond
(.isDirectory file) (ns/find-namespaces-in-dir file)
(jar-file? file) (ns/find-namespaces-in-jarfile (JarFile. file))))
(.isDirectory file) (set (ns/find-namespaces-in-dir file))
(jar-file? file) (set (ns/find-namespaces-in-jarfile (JarFile. file)))))

(defn read-namespaces
"Read Clojure namespaces from a set of source directories (defaults
Expand Down
32 changes: 18 additions & 14 deletions codox/src/codox/reader/clojurescript.clj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
(:require [clojure.java.io :as io]
[cljs.analyzer :as an]
[cljs.analyzer.api :as ana]
[cljs.closure]
[cljs.env]
[clojure.string :as str]))

(defn- cljs-filename? [filename]
Expand All @@ -15,7 +17,7 @@
(-> file .getName cljs-filename?)))

(defn- remove-quote [x]
(if (and (list? x) (= (first x) 'quote))
(if (and (seq? x) (= (first x) 'quote))
(second x)
x))

Expand Down Expand Up @@ -50,15 +52,16 @@
:else :var))

(defn- read-var [file vars var]
(-> var
(select-keys [:name :line :arglists :doc :dynamic :added :deprecated :doc/format])
(update-some :name (comp symbol name))
(update-some :arglists remove-quote)
(update-some :doc correct-indent)
(assoc-some :file (.getPath file)
:type (var-type var)
:members (map (partial read-var file vars)
(protocol-methods var vars)))))
(let [vt (var-type var)]
(-> var
(select-keys [:name :line :arglists :doc :dynamic :added :deprecated :doc/format])
(update-some :name (comp symbol name))
(update-some :arglists remove-quote)
(update-some :doc correct-indent)
(assoc-some :file (if (= vt :macro) (:file var) (.getPath file))
:type vt
:members (map (partial read-var file vars)
(protocol-methods var vars))))))

(defn- read-publics [state namespace file]
(let [vars (vals (ana/ns-publics state namespace))]
Expand All @@ -70,10 +73,11 @@
(sort-by (comp str/lower-case :name)))))

(defn- analyze-file [file]
(let [state (ana/empty-state)]
(binding [an/*analyze-deps* false]
(ana/no-warn
(ana/analyze-file state file {})))
(let [opts (cljs.closure/add-implicit-options {})
state (cljs.env/default-compiler-env opts)]
(ana/no-warn
(cljs.closure/validate-opts opts)
(ana/analyze-file state file opts))
state))

(defn- read-file [path file exception-handler]
Expand Down
Loading