pax_global_header 0000666 0000000 0000000 00000000064 13622775470 0014527 g ustar 00root root 0000000 0000000 52 comment=47f18915dd0d2e07fd2493ab7f4de6d281eb8496
tools.analyzer-tools.analyzer-1.0.0/ 0000775 0000000 0000000 00000000000 13622775470 0017473 5 ustar 00root root 0000000 0000000 tools.analyzer-tools.analyzer-1.0.0/.gitignore 0000664 0000000 0000000 00000000156 13622775470 0021465 0 ustar 00root root 0000000 0000000 /target
/lib
/classes
/checkouts
*.jar
*.class
.lein-deps-sum
.lein-failures
.lein-plugins
.lein-repl-history
tools.analyzer-tools.analyzer-1.0.0/CHANGELOG.md 0000664 0000000 0000000 00000011772 13622775470 0021314 0 ustar 00root root 0000000 0000000 Changelog
========================================
* Release 0.7.0 on 10 Dec 2018
* Handle injected locals in add-binding-atom phase
* Release 0.6.9 on 9 Jun 2015
* Exclude `boolean?` from clojure.core
* Release 0.6.7 on 3 Nov 2015
* Don't elide significant 'quote
* Release 0.6.6 on 23 Apr 2015
* Fix emit-form for :host-field
* Release 0.6.5 on 23 Feb 2015
* Small performance enhancements
* Fixed some metadata handling
* Removed :ctx.invoke, derive :ctx/return from :ctx/expr
* Renamed resolve-var to resolve-sym
* Attached resolved op to :raw-forms
* Added var special form
* Release 0.6.4 on 20 Nov 2014
* Fixed a bug in the pass scheduler regarding transitive deps
* Added reduced support for update-children, walk, prewalk and postwalk
* Fixed parsing of catch expressions outside a try block
* Release 0.6.3 on 03 Oct 2014
* Preserve correct meta on emit-form
* Preserve :raw-forms in elide-meta
* Better source-info propagation
* Release 0.6.2 on 27 Oct 2014
* Fixes and improvements for looping pass scheduling
* Performance improvements on the scheduled pass function
* Release 0.6.1 on 13 Oct 2014
* Significant performance enhancements
* Fixed scheduling of looping passes
* Uniquify :env :locals only if the :uniquify/uniquify-env pass-opt is true
* Release 0.6.0 on 18 Sep 2014
* Added pass scheduler (clojure.tools.analyzer.passes/schedule) and configured all the passes
* Changed the interface of the collect-closed-overs pass
* Changed the interface of the add-binding-atom pass
* Removed the (experimental) trim pass
* Release 0.5.3 on 31 Aug 2014
* Made the source clojure-clr compatible
* Added butlast+last to utils
* Release 0.5.2 on 20 Aug 2014
* Compare contexts with isa? rather than =
* Release 0.5.1 on 09 Aug 2014
* Removed collect pass
* Moved collect-closed-overs pass to its own namespace
* Release 0.5.0 on 29 Jul 2014
* Made :host-field and :host-interop :assignable?
* Release 0.4.0 on 26 Jul 2014
* BREAKING CHANGE: The :class field for :new and :catch nodes are now children nodes rather than symbols
* More fine-grained elide-meta
* Release 0.3.0 on 21 Jun 2014
* BREAKING API CHANGE: :context is now either :ctx/statement, :ctx/return, :ctx/expr or a keyword derived from one of those
* elide-meta: elides can be any IFn, not only a set
* analyze :symbol will not throw when a Var is not found
* Release 0.2.3 on 16 Jun 2014
* Preserve :raw-forms for macroexpanded symbols
* Add :end-line :end-column info to source-info (only when directly available)
* Release 0.2.2 on 13 Jun 2014
* :fn node can be wrapped by :with-meta
* Remove :meta from :def :children when elide-meta removes it
* Release 0.2.1 on 08 Jun 2014
* Made constant-lift preserve the original AST fields
* Made elide-meta discard all meta on form if metadata becomes nil
* Release 0.2.0 on 05 Jun 2014
* BREAKING API CHANGE: Add global-env interface, move :namespaces from env to the global env
* Preserve original forms under :raw-forms in case of macroexpansion
* Open analyze-form dispatch
* Fixed collect-closed-overs for letfn*
* Make cleanup work on :env :locals
* Release 0.1.0-beta13 on 11 Mar 2014
* Fix elide-meta pass
* Release 0.1.0-beta12 on 25 Apr 2014
* Annotated top-level nodes with :top-level true
* Moved rseqv and into! to the c.t.a.utils namespace
* Don't uniquify "constructed" locals
* Preserve :locals in :env, uniquify locals :name in :env :locals
* Release 0.1.0-beta11 on 18 Apr 2014
* Reduced the number of calls to `symbol`, leading to some performance improvements
* Performance improvements on the uniquify pass
* BREAKING API CHANGE: ast/children* now returns a vector of [key node] rather than
a vector of nodes
* Performance improvement on ast/update-children
* Added options set to emit-form
* Release 0.1.0-beta10 on 1 Apr 2014
* Don't discard macroexpanded form meta, merge it with &form meta
* Improvements on source-info handling
* Release 0.1.0-beta9 on 29 Mar 2014
* Fixed a bug in constant-lift regarding array-maps
* Fixed elide-meta implementation
* :const nodes will have :meta only if the const object is an IObj
* Release 0.1.0-beta8 on 11 Mar 2014
* Removed :name in env for the :fn name, moved in a tools.analyzer.jvm pass
* Added docstrings
* Release 0.1.0-beta7 on 28 Feb 2014
* Fix macroexpand implementation
* Release 0.1.0-beta5 on 26 Feb 2014
* Unwrap the try if there's no catch/finally
* Fixed uniquify pass on letfn bindings
* Correctly quote :arglists meta in def sym
* Release 0.1.0-beta4 on 17 Feb 2014
* Analyze throws on `(quote)`
* General code cleanup, added docstrings
* Changed :loop-locals to hold the count of locals rather than their form
Holding their form was problematic since the uniquify pass would invaldiate those
* Attached :once to :fn nodes when ^:once fn*
* Release 0.1.0-beta3 on 15 Feb 2014
* Allowed :top-level collecting for collect-closed-overs
* Release 0.1.0-beta2 on 14 Feb 2014
* Fixed fn name munging
* Release 0.1.0-beta1 on 11 Feb 2014
* First beta release
tools.analyzer-tools.analyzer-1.0.0/CONTRIBUTING.md 0000664 0000000 0000000 00000000735 13622775470 0021731 0 ustar 00root root 0000000 0000000 This is a [Clojure contrib] project.
Under the Clojure contrib [guidelines], this project cannot accept
pull requests. All patches must be submitted via [JIRA].
See [Contributing] on the Clojure website for
more information on how to contribute.
[Clojure contrib]: https://clojure.org/community/contrib_libs
[Contributing]: https://clojure.org/community/contributing
[JIRA]: http://dev.clojure.org/jira/browse/TANAL
[guidelines]: https://clojure.org/community/contrib_howto
tools.analyzer-tools.analyzer-1.0.0/README.md 0000664 0000000 0000000 00000021652 13622775470 0020760 0 ustar 00root root 0000000 0000000 # tools.analyzer
An analyzer for host agnostic Clojure code, written in Clojure and producing AST in EDN.
I gave a talk on tools.analyzer[.jvm] at ClojureX in December 2015. Video [here](https://skillsmatter.com/skillscasts/7239-immutable-code-analysis-with-tools-analyzer)
Timothy Baldridge gave a talk on tools.analyzer[.jvm] at Clojure/West in
March 2014. Video
[here](https://www.youtube.com/watch?v=KhRQmT22SSg&list=PLZdCLR02grLp__wRg5OTavVj4wefg69hM&index=11).
Note that the analyzer in this library should not to be used directly as it lacks any knowledge about host-specific special forms and it should only be considered as a building platform for host-specific analyzers.
Currently the following platform specific analyzers written on top of tools.analyzer exist: [tools.analyzer.jvm](https://github.com/clojure/tools.analyzer.jvm), [tools.analyzer.js](https://github.com/clojure/tools.analyzer.js)
* [Example Usage](#example-usage)
* [Quickref](#quickref)
* [Releases and Dependency Information](#releases-and-dependency-information)
* [Changelog](#changelog)
* [API Index](#api-index)
* [Developer Information](#developer-information)
* [License](#license)
[Quickref](http://clojure.github.io/tools.analyzer/spec/quickref.html)
========================================
## Example Usage
`clojure.tools.analyzer/analyze` will not work out of the box, as it requires a number of entry-points to be set.
Here's what could happen trying to use `clojure.tools.analyzer/analyze` directly:
```clojure
clojure.tools.analyzer> (analyze 'a {})
Attempting to call unbound fn: #'clojure.tools.analyzer/macroexpand-1
[Thrown class java.lang.IllegalStateException]
```
At the moment there exist two official analyzers written on top of [tools.analyzer](https://github.com/clojure/tools.analyzer): [tools.analyzer.jvm](https://github.com/clojure/tools.analyzer.jvm) for clojure on the JVM and [tools.analyzer.js](https://github.com/clojure/tools.analyzer.js) for clojurescript.
We will use [tools.analyzer.jvm](https://github.com/clojure/tools.analyzer.jvm) for those examples.
Here's a simplified version of how `clojure.tools.analyzer.jvm/analyze` is defined:
```clojure
(require '[clojure.tools.analyzer :as ana])
(require '[clojure.tools.analyzer.env :as env])
(defn analyze [form env]
(binding [ana/macroexpand-1 macroexpand-1
ana/create-var create-var
ana/parse parse
ana/var? var?]
(env/ensure (global-env)
(run-passes (-analyze form env))))))
```
Here, `-analyze` is a multimethod that defaults to `ana/analyze` and defines analysis methods for the JVM specific special forms, `global-env` is a function that returns a global environment for the JVM analyzer and `run-passes` is a function that takes an AST and applies a number of passes to it.
The `tools.analyzer.jvm` [README](https://github.com/clojure/tools.analyzer.jvm#example-usage) contains more examples on how the `analyze` function works as well as a reference for all the nodes it can return.
One of the most important features of `tools.analyzer` is the ability to walk generically through the AST nodes, this has been immensely useful to write most of the passes used by the various analyzers.
The `tools.analyzer.ast` namespace provides a number of functions that implement various generic AST walking strategies.
The `children` function returns a vector of the children nodes of the current node (the output has been elided and pretty-printed for clarity):
```clojure
clojure.tools.analyzer.jvm> (require '[clojure.tools.analyzer.ast :as ast])
nil
clojure.tools.analyzer.jvm> (ast/children (analyze '(do 1 2 :foo)))
[{:op :const,
:id 0,
:type :number,
:val 1,
:form 1,
...}
{:op :const,
:id 1,
:type :number,
:val 2,
:form 2,
...}
{:op :const,
:id 3,
:type :keyword,
:val :foo,
:form :foo,
...}]
```
If we want to access a flattened view of all the nodes of an AST, we can use the `nodes` function:
```clojure
clojure.tools.analyzer.jvm> (ast/nodes (analyze '[1 (+ 1 2)]))
({:op :vector,
:top-level true,
:items
[{:op :const,
:type :number,
:val 1,
...}
{:op :static-call,
:class clojure.lang.Numbers,
:method add,
:form (. clojure.lang.Numbers (add 1 2)),
:args [{:op :const,
:val 1,
...}
{:op :const,
:val 2,
...}],
...}]
:form [1 (+ 1 2)],
...}
{:op :const,
:type :number,
:val 1,
...}
{:op :static-call,
:class clojure.lang.Numbers,
:method add,
:form (. clojure.lang.Numbers (add 1 2)),
:args [{:op :const,
:val 1,
...}
{:op :const,
:val 2,
...}],
...}
..)
```
The `update-children` function takes an AST node and a function and replaces the children nodes of the given node with the result of applying the function to each children node.
```clojure
clojure.tools.analyzer.jvm> (ast/update-children (analyze '(do 1 (+ 1 2) :foo))
#(assoc % :visited true))
{:op :do
:statements
[{:op :const,
:val 1,
:visited true,
...}
{:op :static-call,
:class clojure.lang.Numbers,
:method add,
:visited true,
:args [{:op :const
:val 1,
...}
{:op :const,
:val 2,
...}],
...}]
:ret
{:op :const,
:val :foo,
:visited true,
...},
...}
```
If it's desiderable to walk all the AST applying a function to all the nodes and the children nodes, one of `walk`, `prewalk` or `postwalk` should be used, read the docstrings of the three functions to understand the differences.
Here's the previous example using `prewalk` instead of `update-children`:
```clojure
clojure.tools.analyzer.jvm> (ast/prewalk (analyze '(do 1 (+ 1 2) :foo))
#(assoc % :visited true))
{:op :do
:visited true,
:statements
[{:op :const,
:val 1,
:visited true,
...}
{:op :static-call,
:class clojure.lang.Numbers,
:method add,
:visited true,
:args [{:op :const
:val 1,
:visited true,
...}
{:op :const,
:val 2,
:visited true,
...}],
...}]
:ret
{:op :const,
:val :foo,
:visited true,
...},
...}
```
As you can see, this time all the nodes have been marked `:visited`.
Since version `0.6.0`, passes can be scheduled automatically using `clojure.tools.analyzer.passes/schedule` rather than having to compose them and sort out pass dependencies manually, refer to its docstrings and examples from `tools.analyzer.jvm` for more info.
## SPONSORSHIP
* Cognitect (http://cognitect.com/) has sponsored tools.analyzer development (https://groups.google.com/d/msg/clojure/iaP16MHpX0E/EMtnGmOz-rgJ)
* Ambrose BS (https://twitter.com/ambrosebs) has sponsored tools.analyzer development in his typed clojure campaign (http://www.indiegogo.com/projects/typed-clojure).
## YourKit
YourKit has given an open source license for their profiler, greatly simplifying the profiling of tools.analyzer performance.
YourKit is kindly supporting open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products:
* YourKit Java Profiler and
* YourKit .NET Profiler.
Releases and Dependency Information
========================================
Latest stable release: 0.7.0
* [All Released Versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22tools.analyzer%22)
* [Development Snapshot Versions](https://oss.sonatype.org/index.html#nexus-search;gav%7Eorg.clojure%7Etools.analyzer%7E%7E%7E)
[Leiningen](https://github.com/technomancy/leiningen) dependency information:
```clojure
[org.clojure/tools.analyzer "0.7.0"]
```
[Maven](http://maven.apache.org/) dependency information:
```xml
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents" mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement , including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.
tools.analyzer-tools.analyzer-1.0.0/pom.xml 0000664 0000000 0000000 00000002124 13622775470 0021007 0 ustar 00root root 0000000 0000000