luciano/specter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

defprotocolpath docstring

Browse source
This commit is contained in:
Nathan Marz 2016-06-04 14:30:38 -04:00
parent 57a2e967d4
commit b6e1f5f20f
1 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/clj/com/rpl/specter/macros.clj
View file

@ -210,6 +210,22 @@
(-> name (str "-prot") symbol)) (-> name (str "-prot") symbol))
(defmacro defprotocolpath (defmacro defprotocolpath
"Defines a navigator that chooses the path to take based on the type
of the value at the current point. May be specified with parameters to
specify that all extensions must require that number of parameters.
Currently not available for ClojureScript.
Example of usage:
(defrecord SingleAccount [funds])
(defrecord FamilyAccount [single-accounts])
(defprotocolpath FundsPath)
(extend-protocolpath FundsPath
SingleAccount :funds
FamilyAccount [ALL FundsPath]
)
"
([name] ([name]
`(defprotocolpath ~name [])) `(defprotocolpath ~name []))
([name params] ([name params]
@ -310,7 +326,9 @@
i/coerce-tfns-rich) i/coerce-tfns-rich)
))) )))
(defmacro extend-protocolpath [protpath & extensions] (defmacro extend-protocolpath
"Used in conjunction with `defprotocolpath`. See [[defprotocolpath]]."
[protpath & extensions]
`(i/extend-protocolpath* ~protpath ~(protpath-sym protpath) ~(vec extensions))) `(i/extend-protocolpath* ~protpath ~(protpath-sym protpath) ~(vec extensions)))
;; copied from tools.macro to avoid the dependency ;; copied from tools.macro to avoid the dependency
@ -341,8 +359,8 @@
(defmacro defpathedfn (defmacro defpathedfn
"Defines a higher order navigator that itself takes in one or more paths "Defines a higher order navigator that itself takes in one or more paths
as input. This macro is generally used in conjunction with fixed-pathed-nav as input. This macro is generally used in conjunction with [[fixed-pathed-nav]]
or variable-pathed-nav. When inline factoring is applied to a path containing or [[variable-pathed-nav]]. When inline factoring is applied to a path containing
one of these higher order navigators, it will automatically interepret all one of these higher order navigators, it will automatically interepret all
arguments as paths, factor them accordingly, and set up the callsite to arguments as paths, factor them accordingly, and set up the callsite to
provide the parameters dynamically. Use ^:notpath metadata on arguments provide the parameters dynamically. Use ^:notpath metadata on arguments