-
-
Notifications
You must be signed in to change notification settings - Fork 54
/
meta.clj
415 lines (373 loc) · 15.2 KB
/
meta.clj
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
(ns orchard.meta
"Utility functions for extracting and manipulating metadata."
(:require
[clojure.java.io :as io]
[clojure.pprint :as pprint]
[clojure.string :as string]
[clojure.walk :as walk]
[orchard.cljs.analysis :as cljs-ana]
[orchard.clojuredocs :as cljdocs]
[orchard.misc :as misc]
[orchard.namespace :as ns]
[orchard.spec :as spec])
(:import
(clojure.lang LineNumberingPushbackReader Namespace Var)))
;;; ## Extractors
(defn- format-spec-descripton
"Format the spec description to display each predicate on a new line."
[description]
(if (seq? description)
(str "(" (->> description
(map #(with-out-str (pprint/pprint %)))
string/join
string/trim-newline)
")")
(->> description
pprint/pprint
with-out-str
string/trim-newline)))
(defn format-spec
"Return sequence of [role spec-description] pairs."
[fnspec]
(for [role [:args :ret :fn]
:let [spec (get fnspec role)]
:when spec]
[role (-> spec spec/describe format-spec-descripton)]))
(declare var-name)
(defn- maybe-add-spec
"If the var `v` has a spec has associated with it, assoc that into meta-map.
The spec is formatted to avoid processing in the client (e.g. CIDER)."
[meta-map v]
(if-let [spec (when v (spec/spec-form (var-name v)))]
(merge meta-map {:spec spec})
meta-map))
(defn- maybe-add-url
"If `info` has a non blank :url or it's a :special-form build a :url
entry pointing to https://clojure.org/..."
[info]
(if-let [url (cond
(not (string/blank? (:url info)))
(str "https://clojure.org/" (:url info))
(:special-form info)
(str "https://clojure.org/special_forms#" (:name info)))]
(assoc info :url url)
info))
(defn- maybe-add-file
"If `meta-map` has no :file, assoc the canonical namespace source file."
[{:keys [file ns] :as meta-map}]
;; If we don't know its file, use the ns file.
(if (and ns (or (not file)
(re-find #"/form-init[^/]*$" file)))
(-> (dissoc meta-map :line)
(assoc :file (some-> (ns/canonical-source ns) .getPath)))
meta-map))
(defn- maybe-add-see-also
"If the var `v` has a see-also has associated with it, assoc that into meta-map."
[meta-map v]
(if-let [see-also (try
(cljdocs/see-also (var-name v))
;; Skip merging see-also if exception is thrown.
(catch Exception _ nil))]
(merge meta-map {:see-also see-also})
meta-map))
(defn- maybe-protocol
[info]
(if-let [prot-meta (meta (:protocol info))]
(merge info {:file (:file prot-meta)
:line (:line prot-meta)})
info))
(defn- map-seq [x]
(if (seq x)
x
nil))
(defn resolve-var
"Resolve `ns` and `sym` to a var.
The function is a simple wrapper around `clojure.core/ns-resolve`."
[ns sym]
{:pre [(symbol? ns) (symbol? sym)]}
(when-let [ns (find-ns ns)]
(try (ns-resolve ns sym)
;; Impl might try to resolve it as a class, which may fail
(catch ClassNotFoundException _
nil)
(catch java.lang.NoClassDefFoundError _
;; This can happen if there is a java class with a camel cased name
;; that otherwise matches the name of a clojure namespace, on a case
;; indifferent filesystem, eg. on macOS.
nil)
;; TODO: Preserve and display the exception info
(catch Exception _
nil))))
(defn resolve-aliases
"Retrieve the ns aliases for `ns`.
The function is a simple wrapper around `clojure.core/ns-alias`."
[ns]
{:pre [(symbol? ns)]}
(when-let [ns (find-ns ns)]
(ns-aliases ns)))
;; Even if things like catch or finally aren't clojure special
;; symbols we want to be able to talk about them.
;; They just map to a special symbol.
(def special-sub-symbs '{& fn*, catch try, finally try})
(defn repl-special-meta*
"Return the REPL specials info."
[sym]
(or (when-let [f (misc/require-and-resolve 'clojure.repl/special-doc)]
(f sym))
(when-let [f (misc/require-and-resolve 'cljs.repl/special-doc)]
(f sym))))
(def repl-special-meta
"Return the REPL specials info. Memoized."
(memoize repl-special-meta*))
;; What I find very confusing in Clojure documentation is the use of "special form" which is not a concept,
;; just an annotation on vars (always macros) that are special forms in other lisps.
;;
;; In Clojure, real "special forms" are called special symbols:
;;
;; user> (keys (. clojure.lang.Compiler specials))
;; (& let* monitor-exit case* fn* try reify* ... )
;;
;; and even if the oficial documentation says let is a special form,
;; it isn't special at all, let* is, while let is just a macro.
;;
;; Looking at Clojure code I couldn't find any use of :special-form annotation
;; apart from printing a label at the repl doc.
;; Here we only take care of special symbols, look var-meta for stuff like let, fn, defn, etc.
(defn special-sym-meta
"Return info for the symbol if it's a special-symbol?, or nil otherwise."
[sym]
(let [orig-sym sym
sym (get special-sub-symbs sym sym)
compiler-special? (special-symbol? orig-sym)]
(when-let [m (and compiler-special? (repl-special-meta sym))]
(-> m
(assoc :name orig-sym)
(assoc :see-also (try
(cljdocs/see-also (format "clojure.core/%s" sym))
;; Skip attaching see-also if exception is thrown.
(catch Exception _ nil)))
maybe-add-url))))
(declare var-code)
(defn- merge-meta-for-indirect-var*
[target-map var-ref var-meta-fn cljs-env]
(let [clj? (not cljs-env)
original-meta (var-meta-fn var-ref)
interesting-meta-keys [:doc :arglists :style/indent :indent]
original-has-interesting-meta? (seq (select-keys original-meta interesting-meta-keys))
source-var-ref-from-value (delay
(when clj?
(let [v @var-ref]
(when (var? v)
v))))
var-ns (:ns original-meta)
var-ns (if clj?
(if (instance? Namespace var-ns)
var-ns
(some-> var-ns :ns find-ns))
var-ns)
source-var-ref-from-reader (delay
(try
(let [{:keys [form]} (var-code var-ref :var-meta-fn var-meta-fn)]
(when (seq? form)
(let [indirect-var-as-symbol (last form)]
(when (symbol? indirect-var-as-symbol)
(if clj?
(ns-resolve var-ns indirect-var-as-symbol)
(cljs-ana/ns-resolve cljs-env var-ns indirect-var-as-symbol))))))
(catch Exception _
;; IO might have failed in the `var-code` call
nil)))
source-var (when-not original-has-interesting-meta?
(or @source-var-ref-from-value
@source-var-ref-from-reader))]
(or (when source-var
(when-let [copy (not-empty (select-keys (var-meta-fn source-var)
(into []
(remove (fn [k]
(contains? original-meta k)))
interesting-meta-keys)))]
(merge target-map copy)))
target-map)))
(defn merge-meta-for-indirect-var-clj
"If `var-ref` is a var that proxies another var (expressed as a var, or as a symbol denoting a var),
and `var-ref` lacks metadata that is present in its proxy var,
copies metadata from the proxied var to `var-ref`.
This is useful for when Clojure users code e.g. `(def foo bar)`, where `bar` has a docstring,
and for whatever reason, they do not wish to keep in sync the docstring from #'bar to #'foo manually.
Only important, safe-to-copy metadata is possibly copied: `:doc`, `:arglists`, `:style/indent`..."
[target-map ^Var var-ref]
(merge-meta-for-indirect-var* target-map var-ref meta nil))
(defn merge-meta-for-indirect-var-cljs
"If `var-map` describes a var that proxies another var (expressed as a symbol denoting a var),
and `var-map` lacks metadata that is present in its indirect var,
copies metadata from the proxied var to `var-map`.
This is useful for when Clojure users code e.g. `(def foo bar)`, where `bar` has a docstring,
and for whatever reason, they do not wish to keep in sync the docstring from #'bar to #'foo manually.
Only important, safe-to-copy metadata is possibly copied: `:doc`, `:arglists`, `:style/indent`..."
[cljs-env var-map]
(merge-meta-for-indirect-var* var-map var-map identity cljs-env))
(def var-meta-allowlist
[:ns :name :doc :file :arglists :forms :macro :special-form
:protocol :line :column :static :added :deprecated :resource :style/indent :indent])
(def ^:deprecated var-meta-whitelist
var-meta-allowlist)
;; TODO: Split the responsibility of finding meta and normalizing the meta map.
(defn var-meta
"Return a map of metadata for var v.
If `allowlist` is missing, use `var-meta-allowlist`."
([v] (var-meta v var-meta-allowlist))
([v allowlist]
(when (var? v)
(-> v
meta
maybe-protocol
(select-keys (or allowlist var-meta-allowlist))
map-seq
maybe-add-file
maybe-add-url
(update :ns ns-name)
(maybe-add-spec v)
(maybe-add-see-also v)
(merge-meta-for-indirect-var-clj v)))))
(defn meta+
"Return special form or var's meta."
[v]
(or (special-sym-meta v)
(meta v)))
(defn var-name
"Return special form or var's namespace-qualified name as string."
[v]
(let [mta (meta+ v)]
(if-let [ns (:ns mta)]
(str (ns-name ns) "/" (:name mta))
(name (:name mta)))))
(defn var-doc
"Return special form or var's docstring, optionally limiting the number of
sentences returned to n."
([v]
(or (:doc (meta+ v))
"(not documented)"))
([n v]
(->> (-> (var-doc v)
(string/replace #"\s+" " ") ; normalize whitespace
(string/split #"(?<=\.) ")) ; split sentences
(take n)
(string/join " "))))
(defn var-code
"Find the source of the var `v`.
Return a map of the var's metadata (:file, :line, :column, etc.) as well as:
- :form : The form, as read by `clojure.core/read`, and
- :code : The source code of the form
Return nil if the source of the var cannot be found."
[v & {:keys [var-meta-fn]
:or {var-meta-fn var-meta}}]
(when-let [{:keys [file line column] :as var-meta} (var-meta-fn v)]
;; file can be either absolute (eg: functions that have been eval-ed with
;; C-M-x), or relative to some path on the classpath.
(when-let [res (or (io/resource file)
(let [f (io/file file)]
(when (.exists f)
f)))]
(with-open [rdr (LineNumberingPushbackReader. (io/reader res))]
;; Skip to the right line
(dotimes [_ (dec line)]
(.readLine rdr))
;; Reader that collects the code as a string. Adapted from
;; clojure.repl/source.
(let [text (StringBuilder.)
collect? (atom false)
pbr (proxy [LineNumberingPushbackReader] [rdr]
(read []
(let [^LineNumberingPushbackReader this this ; remove reflection warning on proxy-super call
i (proxy-super read)]
(when @collect?
(.append text (char i)))
i))
(unread [c]
(when @collect?
(.deleteCharAt text (dec (.length text))))
(let [^LineNumberingPushbackReader this this] ; remove reflection warning on proxy-super call
(proxy-super unread ^int c))))
;; Fix bogus column number of 1, which really means 0
column (if (= 1 column) 0 column)]
;; Give it the right line and column number. We can just set the
;; line number directly, but there is no setColumnNumber method, so
;; we have to hack it a bit.
(.setLineNumber pbr (.getLineNumber rdr))
(dotimes [_ column]
(.read pbr))
;; Now start collecting the code
(reset! collect? true)
(let [form (read {} pbr)
code (str text)]
(assoc var-meta
:form form
:code code)))))))
(defn ns-file
"Finds the path to the file defining this `ns`"
^String
[ns]
(or (some-> (ns-publics ns)
first
second
var-meta
:file)
(some-> (ns/canonical-source ns)
.getPath)))
(defn ns-meta
[ns]
(when ns
(merge
(meta ns)
{:ns (ns-name ns)
:name (ns-name ns)
:file (ns-file ns)
:line 1})))
;;; ## Manipulation
(defn merge-meta
"Non-throwing version of (vary-meta obj merge metamap-1 metamap-2 ...).
Like `vary-meta`, this only applies to immutable objects. For
instance, this function does nothing on atoms, because the metadata
of an `atom` is part of the atom itself and can only be changed
destructively."
{:style/indent 1}
[obj & metamaps]
(try
(apply vary-meta obj merge metamaps)
(catch Exception _e obj)))
(defn strip-meta
"Strip meta from form.
If keys are provided, strip only those keys."
([form] (strip-meta form nil))
([form keys]
(if (and (instance? clojure.lang.IObj form)
(meta form))
(if keys
(with-meta form (apply dissoc (meta form) keys))
(with-meta form nil))
form)))
(defn macroexpand-all
"Like `clojure.walk/macroexpand-all`, but preserves and macroexpands
metadata. Also store the original form (unexpanded and stripped of
metadata) in the metadata of the expanded form under original-key."
[form & [original-key]]
(let [md (meta form)
expanded (walk/walk #(macroexpand-all % original-key)
identity
(if (seq? form)
;; Without this, `macroexpand-all`
;; throws if called on `defrecords`.
(try (macroexpand form)
(catch ClassNotFoundException _e form))
form))]
(if md
;; Macroexpand the metadata too, because sometimes metadata
;; contains, for example, functions. This is the case for
;; deftest forms.
(merge-meta expanded
(macroexpand-all md)
(when original-key
;; We have to quote this, or it will get evaluated by
;; Clojure (even though it's inside meta).
{original-key (list 'quote (strip-meta form))}))
expanded)))