24 | ```
25 |
26 | If no options are provided, tools.deps.graph will create a dependency graph for the current project and display it. Ctrl-C to quit.
27 |
28 | When using -T or -X, options:
29 |
30 | * `:deps` - Path to deps file (default = "deps.edn")
31 | * `:trace` - Boolean flag to use trace mode (default = false)
32 | * `:trace-file` - Path to trace.edn file to read
33 | * `:output` - Output file path
34 | * `:trace-omit` - Collection of lib symbols to omit in trace output
35 | * `:size` - Boolean flag to include sizes in images (default = false)
36 |
37 | Equivalent clojure.main options:
38 |
39 | * -d DEPSFILE - deps.edn file to read, default=deps.edn
40 | * -t - Trace mode, will output one image per expansion step
41 | * -f TRACEFILE - Trace file mode - read trace file, don't use deps.edn file
42 | * -o FILE - Output file, in trace mode, required and will create N images with this as a prefix
43 | * -a - Concatenated alias names to enable when reading deps file
44 | * --trace-omit - Comma-delimited list of libs to skip in trace images"
45 | * --size- Add jar size info to dep graph"
46 |
47 | # Examples
48 |
49 | Show dependency graph for current project:
50 |
51 | ```
52 | clj -Tgraph graph
53 | ```
54 |
55 | Save dependency graph to deps.png for current project:
56 |
57 | ```
58 | clj -Tgraph graph :output '"deps.png"'
59 | ```
60 |
61 | Show dependency graph for current project with jar sizes:
62 |
63 | ```
64 | clj -Tgraph graph :output '"deps.png"' :size true
65 | ```
66 |
67 | Read mydeps.edn, create deps graph, output image to mydeps.png:
68 |
69 | ```
70 | clj -Tgraph graph :deps '"mydeps.edn"' :output '"mydeps.png"'
71 | ```
72 |
73 | Read deps.edn, trace expansion, output steps as trace100.png, trace101.png, ... :
74 |
75 | ```
76 | clj -Tgraph graph :trace true :output '"trace"'
77 | ```
78 |
79 | Read mydeps.edn, trace expansion, output trace100.png, ... :
80 |
81 | ```
82 | clj -Tgraph graph :deps '"mydeps.edn"' :trace true :output '"trace"'
83 | ```
84 |
85 | Use -Strace to output a trace.edn file.
86 | Read trace.edn file, output trace100.png, ...
87 |
88 | ```
89 | clj -Strace
90 | clj -Tgraph graph :trace-file '"trace.edn"' :output '"trace"'
91 | ```
92 |
93 | # Release Information
94 |
95 | This project follows the version scheme MAJOR.MINOR.COMMITS where MAJOR and MINOR provide some relative indication of the size of the change, but do not follow semantic versioning. In general, all changes endeavor to be non-breaking (by moving to new names rather than by breaking existing names). COMMITS is an ever-increasing counter of commits since the beginning of this repository.
96 |
97 | Latest release: 1.1.90
98 |
99 | * [All released versions](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.clojure%22%20AND%20a%3A%22tools.deps.graph%22)
100 |
101 | [deps.edn](https://clojure.org/guides/deps_and_cli) dependency information:
102 |
103 | ```
104 | org.clojure/tools.deps.graph {:mvn/version "1.1.90"}
105 | ```
106 |
107 | # Developer Information
108 |
109 | * [GitHub project](https://github.com/clojure/tools.deps.graph)
110 | * [How to contribute](https://clojure.org/community/contributing)
111 | * [Bug Tracker](https://dev.clojure.org/jira/browse/TDEPS)
112 | * [Continuous Integration](https://github.com/clojure/tools.deps.graph/actions/workflows/test.yml)
113 |
114 | # Copyright and License
115 |
116 | Copyright © 2019-2023 Rich Hickey, Alex Miller, and contributors
117 |
118 | All rights reserved. The use and
119 | distribution terms for this software are covered by the
120 | [Eclipse Public License 1.0] which can be found in the file
121 | epl-v10.html at the root of this distribution. By using this software
122 | in any fashion, you are agreeing to be bound by the terms of this
123 | license. You must not remove this notice, or any other, from this
124 | software.
125 |
126 | [Eclipse Public License 1.0]: https://opensource.org/license/epl-1-0/
127 |
--------------------------------------------------------------------------------
/src/main/clojure/clojure/tools/deps/graph.clj:
--------------------------------------------------------------------------------
1 | ; Copyright (c) Rich Hickey. All rights reserved.
2 | ; The use and distribution terms for this software are covered by the
3 | ; Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
4 | ; which can be found in the file epl-v10.html at the root of this distribution.
5 | ; By using this software in any fashion, you are agreeing to be bound by
6 | ; the terms of this license.
7 | ; You must not remove this notice, or any other, from this software.
8 |
9 | (ns clojure.tools.deps.graph
10 | (:require
11 | [clojure.edn :as edn]
12 | [clojure.java.io :as jio]
13 | [clojure.string :as str]
14 | [clojure.tools.cli :as cli]
15 | [clojure.tools.deps :as deps]
16 | [clojure.tools.deps.extensions :as ext]
17 | [clojure.tools.deps.script.parse :as parse]
18 | [clojure.tools.deps.util.session :as session]
19 | [clojure.tools.deps.util.io :as io :refer [printerrln]]
20 | [dorothy.core :as dot]
21 | [dorothy.jvm :as dotjvm]
22 | [clojure.string :as str])
23 | (:import
24 | [java.io IOException]
25 | [clojure.lang IExceptionInfo]))
26 |
27 | (set! *warn-on-reflection* true)
28 |
29 | (defn parse-syms
30 | "Parses a concatenated string of libs into a collection of symbols
31 | Ex: (parse-libs \"org.clojure/clojure,org.clojure/test.check\")
32 | Returns: [org.clojure/clojure org.clojure/test.check]"
33 | [s]
34 | (->> (str/split (or s "") #",")
35 | (remove str/blank?)
36 | (map symbol)))
37 |
38 | ;; Examples:
39 | ;; no opts - read deps.edn, expand, and show deps image in viewer
40 | ;; -o deps.png - read deps.edn, expand, and output deps image to deps.png
41 | ;; -d mydeps.edn -o mydeps.png - read mydeps.edn, expand, and output deps image to mydeps.png
42 | ;; -t -o trace.png - read deps.edn, trace expansion, output trace-100.png, ...
43 | ;; -d mydeps.edn -t -o trace.png - read mydeps.edn, trace, output trace-100.png, ...
44 | ;; -f trace.edn -o trace.png - read trace file, output trace-100.png, ...
45 | ;; --size - include sizes in dep graph nodes
46 |
47 | (def ^:private opts
48 | [;; input
49 | ["-d" "--deps DEPSFILE" "deps.edn file to read, default ./deps.edn" :default "deps.edn"]
50 | ;; trace mode
51 | ["-t" "--trace" "Trace mode, output one image per trace step"]
52 | ["-f" "--trace-file TRACEFILE" "Read trace directly from file, output one image per trace step"]
53 | ;; options
54 | ["-o" "--output FILE" "Save output file (or files if trace), don't show"]
55 | ["-a" "--aliases ALIASES" "Concatenated alias names to enable" :parse-fn parse/parse-kws]
56 | [nil "--trace-omit LIBS" "Comma delimited list of libs to omit in trace imgs"
57 | :default '[org.clojure/clojure]
58 | :parse-fn parse-syms]
59 | [nil "--size" "Include sizes in dep graph nodes"]])
60 |
61 | (defn parse-opts
62 | "Parse the command line opts to make-classpath"
63 | [args]
64 | (cli/parse-opts args opts))
65 |
66 | (defn node-id
67 | [lib]
68 | (if (= (ns lib) (name lib))
69 | (keyword (ns lib))
70 | (keyword lib)))
71 |
72 | (defn make-node
73 | [id rows style-attrs]
74 | [id (merge {:shape :record
75 | :label (str/join "|" rows)
76 | :style :filled
77 | :color :black
78 | :fillcolor :lightgrey}
79 | style-attrs)])
80 |
81 | (defn get-size-path
82 | [path]
83 | (let [f (jio/file path)]
84 | (if (.exists f)
85 | (if (.isFile f)
86 | (.length f)
87 | 0) ;; TODO: sum dir size?
88 | 0)))
89 |
90 | (defn get-size
91 | [lib coord config]
92 | (let [{:deps/keys [manifest]} (ext/manifest-type lib coord config)
93 | paths (ext/coord-paths lib coord manifest config)]
94 | (->> paths (map get-size-path) (reduce +))))
95 |
96 | (defn make-dep-node
97 | [lib coord config opts style-attrs]
98 | (let [id (node-id lib)
99 | summary (ext/coord-summary lib coord)
100 | space (str/index-of summary " ")
101 | rows [(subs summary 0 space)
102 | (subs summary (inc space))]
103 | rows (if (:size opts)
104 | (let [size (get-size lib coord config)]
105 | (if (pos? size)
106 | (conj rows (format "%10.1f kb" (/ size 1024.0)))
107 | rows))
108 | rows)]
109 | (make-node id rows style-attrs)))
110 |
111 | (defn make-edges
112 | [lib {:keys [dependents] :as coord}]
113 | (if (seq dependents)
114 | (map (fn [dlib] [(node-id dlib) (node-id lib)]) dependents)
115 | [[:root (node-id lib)]]))
116 |
117 | (defn make-graph
118 | [lib-map config output opts]
119 | (let [statements (into [(make-node :root ["deps.edn"] {:shape :box :fillcolor :cadetblue1}) ]
120 | (mapcat
121 | (fn [[lib coord]]
122 | (into [(make-dep-node lib coord config opts nil)]
123 | (make-edges lib coord)))
124 | lib-map))]
125 | ;(clojure.pprint/pprint statements)
126 | (let [d (dot/dot (dot/digraph (concat [{:rankdir :LR, :splines :polyline}] statements)))]
127 | (if output
128 | (dotjvm/save! d output {:format :png})
129 | (dotjvm/show! d)))))
130 |
131 | (defn output-trace
132 | [trace output config trace-omit]
133 | (let [omitted-libs (set trace-omit)
134 | trace' (remove (fn [{:keys [lib include]}]
135 | (and (not include) (contains? omitted-libs lib)))
136 | trace)]
137 | (println "Writing" (inc (count trace')) "trace images, omitted" (inc (- (count trace) (count trace'))) "frames")
138 | (loop [[step & steps] trace'
139 | stmts [[:root {:label "deps.edn"
140 | :shape :box
141 | :fillcolor :cadetblue1
142 | :style :filled}]]
143 | i 100]
144 | (if step
145 | (let [{:keys [lib coord use-coord path include reason vmap]} step
146 | nx (symbol (namespace lib) (str (name lib) "-CONSIDER"))
147 | dependee-id (if-let [parent (last path)] (node-id parent) :root)
148 | nx-stmts [(make-dep-node nx use-coord config nil {:fillcolor (if include :green2 :brown1)})
149 | [dependee-id (node-id nx) {:label reason}]]]
150 | (print ".") (flush)
151 | (-> (dot/digraph (concat [{:rankdir :LR, :splines :polyline}] (into stmts nx-stmts)))
152 | dot/dot
153 | (dotjvm/save! (str output i ".png") {:format :png}))
154 | (recur steps
155 | (case reason
156 | ;; add new node and link from parent to it
157 | (:new-top-dep :new-dep)
158 | (into stmts [(make-dep-node lib use-coord config nil nil) [dependee-id (node-id lib)]])
159 |
160 | ;; add new node and remove previous node, link from parent to it
161 | :newer-version
162 | ;; todo: remove edges to dependents of old version
163 | ;; todo: remove then orphaned deps?
164 | (into (remove (fn [[id b]] (and (= id (node-id lib)) (not (keyword? b)))) stmts)
165 | [(make-dep-node lib use-coord config nil nil)
166 | [dependee-id (node-id lib)]])
167 |
168 | ;; just link to existing node
169 | (:same-version :old-version :use-top)
170 | (into stmts [[dependee-id (node-id lib)]])
171 |
172 | ;; no change
173 | ;; (:excluded :parent-omitted)
174 | stmts)
175 | (inc i)))
176 | (do
177 | (println)
178 | (-> (dot/digraph (concat [{:rankdir :LR, :splines :polyline}] stmts))
179 | dot/dot
180 | (dotjvm/save! (str output i ".png") {:format :png})))))))
181 |
182 | (defn- run
183 | [{:keys [deps trace trace-file output aliases trace-omit size] :as opts}]
184 | (try
185 | (if trace-file
186 | (do
187 | (when-not output (throw (ex-info "Must specify output file name in trace mode" {})))
188 | (let [tf (jio/file trace-file)]
189 | (if (.exists tf)
190 | (output-trace (-> tf slurp edn/read-string :log) nil output trace-omit)
191 | (throw (ex-info (str "Trace file does not exist: " trace-file) {})))))
192 | (let [{:keys [root-edn user-edn project-edn]} (deps/find-edn-maps (or deps "deps.edn"))
193 | master-edn (deps/merge-edns [root-edn user-edn project-edn])
194 | combined-aliases (deps/combine-aliases master-edn aliases)
195 | basis (session/with-session
196 | (deps/calc-basis master-edn {:resolve-args (merge combined-aliases {:trace true})
197 | :classpath-args combined-aliases}))
198 | lib-map (:libs basis)]
199 | (if trace
200 | (output-trace (-> lib-map meta :trace :log) output basis trace-omit)
201 | (make-graph lib-map basis output {:size size}))))
202 | (catch IOException e
203 | (if (str/starts-with? (.getMessage e) "Cannot run program")
204 | (throw (ex-info "tools.deps.graph requires Graphviz (https://graphviz.gitlab.io/download) to be installed to generate graphs." {} e))))))
205 |
206 | (defn graph
207 | "Create deps graphs. By default reads deps.edn in current directory, creates deps graph,
208 | and shows using a viewer. Use ctrl-c to exit.
209 |
210 | Options:
211 | :deps Path to deps file (default = \"./deps.edn\")
212 | :trace Flag to use trace mode (default = false)
213 | :trace-file Path to trace.edn file to read
214 | :output Output file path
215 | :trace-omit collection of lib symbols to omit in trace mode (default = nil)
216 | :size Flag to include sizes in images (default = false)"
217 | [opts]
218 | (try
219 | (run opts)
220 | (catch Throwable t
221 | (printerrln (.getMessage t))
222 | (when-not (instance? IExceptionInfo t)
223 | (.printStackTrace t))
224 | (System/exit 1))
225 | (finally
226 | (shutdown-agents))))
227 |
228 | (defn -main
229 | "Create deps graphs. By default, reads deps.edn in current directory, creates deps graph,
230 | and shows using a viewer. Use ctrl-c to exit.
231 |
232 | Options:
233 | -d DEPSFILE - deps.edn file to read, default=deps.edn
234 | -t - Trace mode, will output one image per expansion step
235 | -f TRACEFILE - Trace file mode - read trace file, don't use deps.edn file
236 | -o FILE - Output file, in trace mode required and will create N images
237 | -a - Concatenated alias names when reading deps file
238 | --trace-omit - Comma-delimited list of libs to skip in trace images
239 | --size - Include jar size in dep graph nodes"
240 | [& args]
241 | (let [{:keys [options errors]} (parse-opts args)]
242 | (when (seq errors)
243 | (run! println errors)
244 | (System/exit 1))
245 | (graph options)))
246 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Eclipse Public License - v 1.0
2 |
3 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
4 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
5 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
6 |
7 | 1. DEFINITIONS
8 |
9 | "Contribution" means:
10 |
11 | a) in the case of the initial Contributor, the initial code and documentation
12 | distributed under this Agreement, and
13 | b) in the case of each subsequent Contributor:
14 | i) changes to the Program, and
15 | ii) additions to the Program;
16 |
17 | where such changes and/or additions to the Program originate from and are
18 | distributed by that particular Contributor. A Contribution 'originates'
19 | from a Contributor if it was added to the Program by such Contributor
20 | itself or anyone acting on such Contributor's behalf. Contributions do not
21 | include additions to the Program which: (i) are separate modules of
22 | software distributed in conjunction with the Program under their own
23 | license agreement, and (ii) are not derivative works of the Program.
24 |
25 | "Contributor" means any person or entity that distributes the Program.
26 |
27 | "Licensed Patents" mean patent claims licensable by a Contributor which are
28 | necessarily infringed by the use or sale of its Contribution alone or when
29 | combined with the Program.
30 |
31 | "Program" means the Contributions distributed in accordance with this
32 | Agreement.
33 |
34 | "Recipient" means anyone who receives the Program under this Agreement,
35 | including all Contributors.
36 |
37 | 2. GRANT OF RIGHTS
38 | a) Subject to the terms of this Agreement, each Contributor hereby grants
39 | Recipient a non-exclusive, worldwide, royalty-free copyright license to
40 | reproduce, prepare derivative works of, publicly display, publicly
41 | perform, distribute and sublicense the Contribution of such Contributor,
42 | if any, and such derivative works, in source code and object code form.
43 | b) Subject to the terms of this Agreement, each Contributor hereby grants
44 | Recipient a non-exclusive, worldwide, royalty-free patent license under
45 | Licensed Patents to make, use, sell, offer to sell, import and otherwise
46 | transfer the Contribution of such Contributor, if any, in source code and
47 | object code form. This patent license shall apply to the combination of
48 | the Contribution and the Program if, at the time the Contribution is
49 | added by the Contributor, such addition of the Contribution causes such
50 | combination to be covered by the Licensed Patents. The patent license
51 | shall not apply to any other combinations which include the Contribution.
52 | No hardware per se is licensed hereunder.
53 | c) Recipient understands that although each Contributor grants the licenses
54 | to its Contributions set forth herein, no assurances are provided by any
55 | Contributor that the Program does not infringe the patent or other
56 | intellectual property rights of any other entity. Each Contributor
57 | disclaims any liability to Recipient for claims brought by any other
58 | entity based on infringement of intellectual property rights or
59 | otherwise. As a condition to exercising the rights and licenses granted
60 | hereunder, each Recipient hereby assumes sole responsibility to secure
61 | any other intellectual property rights needed, if any. For example, if a
62 | third party patent license is required to allow Recipient to distribute
63 | the Program, it is Recipient's responsibility to acquire that license
64 | before distributing the Program.
65 | d) Each Contributor represents that to its knowledge it has sufficient
66 | copyright rights in its Contribution, if any, to grant the copyright
67 | license set forth in this Agreement.
68 |
69 | 3. REQUIREMENTS
70 |
71 | A Contributor may choose to distribute the Program in object code form under
72 | its own license agreement, provided that:
73 |
74 | a) it complies with the terms and conditions of this Agreement; and
75 | b) its license agreement:
76 | i) effectively disclaims on behalf of all Contributors all warranties
77 | and conditions, express and implied, including warranties or
78 | conditions of title and non-infringement, and implied warranties or
79 | conditions of merchantability and fitness for a particular purpose;
80 | ii) effectively excludes on behalf of all Contributors all liability for
81 | damages, including direct, indirect, special, incidental and
82 | consequential damages, such as lost profits;
83 | iii) states that any provisions which differ from this Agreement are
84 | offered by that Contributor alone and not by any other party; and
85 | iv) states that source code for the Program is available from such
86 | Contributor, and informs licensees how to obtain it in a reasonable
87 | manner on or through a medium customarily used for software exchange.
88 |
89 | When the Program is made available in source code form:
90 |
91 | a) it must be made available under this Agreement; and
92 | b) a copy of this Agreement must be included with each copy of the Program.
93 | Contributors may not remove or alter any copyright notices contained
94 | within the Program.
95 |
96 | Each Contributor must identify itself as the originator of its Contribution,
97 | if
98 | any, in a manner that reasonably allows subsequent Recipients to identify the
99 | originator of the Contribution.
100 |
101 | 4. COMMERCIAL DISTRIBUTION
102 |
103 | Commercial distributors of software may accept certain responsibilities with
104 | respect to end users, business partners and the like. While this license is
105 | intended to facilitate the commercial use of the Program, the Contributor who
106 | includes the Program in a commercial product offering should do so in a manner
107 | which does not create potential liability for other Contributors. Therefore,
108 | if a Contributor includes the Program in a commercial product offering, such
109 | Contributor ("Commercial Contributor") hereby agrees to defend and indemnify
110 | every other Contributor ("Indemnified Contributor") against any losses,
111 | damages and costs (collectively "Losses") arising from claims, lawsuits and
112 | other legal actions brought by a third party against the Indemnified
113 | Contributor to the extent caused by the acts or omissions of such Commercial
114 | Contributor in connection with its distribution of the Program in a commercial
115 | product offering. The obligations in this section do not apply to any claims
116 | or Losses relating to any actual or alleged intellectual property
117 | infringement. In order to qualify, an Indemnified Contributor must:
118 | a) promptly notify the Commercial Contributor in writing of such claim, and
119 | b) allow the Commercial Contributor to control, and cooperate with the
120 | Commercial Contributor in, the defense and any related settlement
121 | negotiations. The Indemnified Contributor may participate in any such claim at
122 | its own expense.
123 |
124 | For example, a Contributor might include the Program in a commercial product
125 | offering, Product X. That Contributor is then a Commercial Contributor. If
126 | that Commercial Contributor then makes performance claims, or offers
127 | warranties related to Product X, those performance claims and warranties are
128 | such Commercial Contributor's responsibility alone. Under this section, the
129 | Commercial Contributor would have to defend claims against the other
130 | Contributors related to those performance claims and warranties, and if a
131 | court requires any other Contributor to pay any damages as a result, the
132 | Commercial Contributor must pay those damages.
133 |
134 | 5. NO WARRANTY
135 |
136 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN
137 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
138 | IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE,
139 | NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each
140 | Recipient is solely responsible for determining the appropriateness of using
141 | and distributing the Program and assumes all risks associated with its
142 | exercise of rights under this Agreement , including but not limited to the
143 | risks and costs of program errors, compliance with applicable laws, damage to
144 | or loss of data, programs or equipment, and unavailability or interruption of
145 | operations.
146 |
147 | 6. DISCLAIMER OF LIABILITY
148 |
149 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
150 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
151 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
152 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
153 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
154 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
155 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY
156 | OF SUCH DAMAGES.
157 |
158 | 7. GENERAL
159 |
160 | If any provision of this Agreement is invalid or unenforceable under
161 | applicable law, it shall not affect the validity or enforceability of the
162 | remainder of the terms of this Agreement, and without further action by the
163 | parties hereto, such provision shall be reformed to the minimum extent
164 | necessary to make such provision valid and enforceable.
165 |
166 | If Recipient institutes patent litigation against any entity (including a
167 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself
168 | (excluding combinations of the Program with other software or hardware)
169 | infringes such Recipient's patent(s), then such Recipient's rights granted
170 | under Section 2(b) shall terminate as of the date such litigation is filed.
171 |
172 | All Recipient's rights under this Agreement shall terminate if it fails to
173 | comply with any of the material terms or conditions of this Agreement and does
174 | not cure such failure in a reasonable period of time after becoming aware of
175 | such noncompliance. If all Recipient's rights under this Agreement terminate,
176 | Recipient agrees to cease use and distribution of the Program as soon as
177 | reasonably practicable. However, Recipient's obligations under this Agreement
178 | and any licenses granted by Recipient relating to the Program shall continue
179 | and survive.
180 |
181 | Everyone is permitted to copy and distribute copies of this Agreement, but in
182 | order to avoid inconsistency the Agreement is copyrighted and may only be
183 | modified in the following manner. The Agreement Steward reserves the right to
184 | publish new versions (including revisions) of this Agreement from time to
185 | time. No one other than the Agreement Steward has the right to modify this
186 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The
187 | Eclipse Foundation may assign the responsibility to serve as the Agreement
188 | Steward to a suitable separate entity. Each new version of the Agreement will
189 | be given a distinguishing version number. The Program (including
190 | Contributions) may always be distributed subject to the version of the
191 | Agreement under which it was received. In addition, after a new version of the
192 | Agreement is published, Contributor may elect to distribute the Program
193 | (including its Contributions) under the new version. Except as expressly
194 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or
195 | licenses to the intellectual property of any Contributor under this Agreement,
196 | whether expressly, by implication, estoppel or otherwise. All rights in the
197 | Program not expressly granted under this Agreement are reserved.
198 |
199 | This Agreement is governed by the laws of the State of New York and the
200 | intellectual property laws of the United States of America. No party to this
201 | Agreement will bring a legal action under this Agreement more than one year
202 | after the cause of action arose. Each party waives its rights to a jury trial in
203 | any resulting litigation.
204 |
205 |
206 |
--------------------------------------------------------------------------------
/epl.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | Eclipse Public License - Version 1.0
8 |
25 |
26 |
27 |
28 |
29 |
30 | Eclipse Public License - v 1.0
31 |
32 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
33 | PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR
34 | DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS
35 | AGREEMENT.
36 |
37 | 1. DEFINITIONS
38 |
39 | "Contribution" means:
40 |
41 | a) in the case of the initial Contributor, the initial
42 | code and documentation distributed under this Agreement, and
43 | b) in the case of each subsequent Contributor:
44 | i) changes to the Program, and
45 | ii) additions to the Program;
46 | where such changes and/or additions to the Program
47 | originate from and are distributed by that particular Contributor. A
48 | Contribution 'originates' from a Contributor if it was added to the
49 | Program by such Contributor itself or anyone acting on such
50 | Contributor's behalf. Contributions do not include additions to the
51 | Program which: (i) are separate modules of software distributed in
52 | conjunction with the Program under their own license agreement, and (ii)
53 | are not derivative works of the Program.
54 |
55 | "Contributor" means any person or entity that distributes
56 | the Program.
57 |
58 | "Licensed Patents" mean patent claims licensable by a
59 | Contributor which are necessarily infringed by the use or sale of its
60 | Contribution alone or when combined with the Program.
61 |
62 | "Program" means the Contributions distributed in accordance
63 | with this Agreement.
64 |
65 | "Recipient" means anyone who receives the Program under
66 | this Agreement, including all Contributors.
67 |
68 | 2. GRANT OF RIGHTS
69 |
70 | a) Subject to the terms of this Agreement, each
71 | Contributor hereby grants Recipient a non-exclusive, worldwide,
72 | royalty-free copyright license to reproduce, prepare derivative works
73 | of, publicly display, publicly perform, distribute and sublicense the
74 | Contribution of such Contributor, if any, and such derivative works, in
75 | source code and object code form.
76 |
77 | b) Subject to the terms of this Agreement, each
78 | Contributor hereby grants Recipient a non-exclusive, worldwide,
79 | royalty-free patent license under Licensed Patents to make, use, sell,
80 | offer to sell, import and otherwise transfer the Contribution of such
81 | Contributor, if any, in source code and object code form. This patent
82 | license shall apply to the combination of the Contribution and the
83 | Program if, at the time the Contribution is added by the Contributor,
84 | such addition of the Contribution causes such combination to be covered
85 | by the Licensed Patents. The patent license shall not apply to any other
86 | combinations which include the Contribution. No hardware per se is
87 | licensed hereunder.
88 |
89 | c) Recipient understands that although each Contributor
90 | grants the licenses to its Contributions set forth herein, no assurances
91 | are provided by any Contributor that the Program does not infringe the
92 | patent or other intellectual property rights of any other entity. Each
93 | Contributor disclaims any liability to Recipient for claims brought by
94 | any other entity based on infringement of intellectual property rights
95 | or otherwise. As a condition to exercising the rights and licenses
96 | granted hereunder, each Recipient hereby assumes sole responsibility to
97 | secure any other intellectual property rights needed, if any. For
98 | example, if a third party patent license is required to allow Recipient
99 | to distribute the Program, it is Recipient's responsibility to acquire
100 | that license before distributing the Program.
101 |
102 | d) Each Contributor represents that to its knowledge it
103 | has sufficient copyright rights in its Contribution, if any, to grant
104 | the copyright license set forth in this Agreement.
105 |
106 | 3. REQUIREMENTS
107 |
108 | A Contributor may choose to distribute the Program in object code
109 | form under its own license agreement, provided that:
110 |
111 | a) it complies with the terms and conditions of this
112 | Agreement; and
113 |
114 | b) its license agreement:
115 |
116 | i) effectively disclaims on behalf of all Contributors
117 | all warranties and conditions, express and implied, including warranties
118 | or conditions of title and non-infringement, and implied warranties or
119 | conditions of merchantability and fitness for a particular purpose;
120 |
121 | ii) effectively excludes on behalf of all Contributors
122 | all liability for damages, including direct, indirect, special,
123 | incidental and consequential damages, such as lost profits;
124 |
125 | iii) states that any provisions which differ from this
126 | Agreement are offered by that Contributor alone and not by any other
127 | party; and
128 |
129 | iv) states that source code for the Program is available
130 | from such Contributor, and informs licensees how to obtain it in a
131 | reasonable manner on or through a medium customarily used for software
132 | exchange.
133 |
134 | When the Program is made available in source code form:
135 |
136 | a) it must be made available under this Agreement; and
137 |
138 | b) a copy of this Agreement must be included with each
139 | copy of the Program.
140 |
141 | Contributors may not remove or alter any copyright notices contained
142 | within the Program.
143 |
144 | Each Contributor must identify itself as the originator of its
145 | Contribution, if any, in a manner that reasonably allows subsequent
146 | Recipients to identify the originator of the Contribution.
147 |
148 | 4. COMMERCIAL DISTRIBUTION
149 |
150 | Commercial distributors of software may accept certain
151 | responsibilities with respect to end users, business partners and the
152 | like. While this license is intended to facilitate the commercial use of
153 | the Program, the Contributor who includes the Program in a commercial
154 | product offering should do so in a manner which does not create
155 | potential liability for other Contributors. Therefore, if a Contributor
156 | includes the Program in a commercial product offering, such Contributor
157 | ("Commercial Contributor") hereby agrees to defend and
158 | indemnify every other Contributor ("Indemnified Contributor")
159 | against any losses, damages and costs (collectively "Losses")
160 | arising from claims, lawsuits and other legal actions brought by a third
161 | party against the Indemnified Contributor to the extent caused by the
162 | acts or omissions of such Commercial Contributor in connection with its
163 | distribution of the Program in a commercial product offering. The
164 | obligations in this section do not apply to any claims or Losses
165 | relating to any actual or alleged intellectual property infringement. In
166 | order to qualify, an Indemnified Contributor must: a) promptly notify
167 | the Commercial Contributor in writing of such claim, and b) allow the
168 | Commercial Contributor to control, and cooperate with the Commercial
169 | Contributor in, the defense and any related settlement negotiations. The
170 | Indemnified Contributor may participate in any such claim at its own
171 | expense.
172 |
173 | For example, a Contributor might include the Program in a commercial
174 | product offering, Product X. That Contributor is then a Commercial
175 | Contributor. If that Commercial Contributor then makes performance
176 | claims, or offers warranties related to Product X, those performance
177 | claims and warranties are such Commercial Contributor's responsibility
178 | alone. Under this section, the Commercial Contributor would have to
179 | defend claims against the other Contributors related to those
180 | performance claims and warranties, and if a court requires any other
181 | Contributor to pay any damages as a result, the Commercial Contributor
182 | must pay those damages.
183 |
184 | 5. NO WARRANTY
185 |
186 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS
187 | PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
188 | OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION,
189 | ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY
190 | OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
191 | responsible for determining the appropriateness of using and
192 | distributing the Program and assumes all risks associated with its
193 | exercise of rights under this Agreement , including but not limited to
194 | the risks and costs of program errors, compliance with applicable laws,
195 | damage to or loss of data, programs or equipment, and unavailability or
196 | interruption of operations.
197 |
198 | 6. DISCLAIMER OF LIABILITY
199 |
200 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT
201 | NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT,
202 | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING
203 | WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF
204 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
205 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR
206 | DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
207 | HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
208 |
209 | 7. GENERAL
210 |
211 | If any provision of this Agreement is invalid or unenforceable under
212 | applicable law, it shall not affect the validity or enforceability of
213 | the remainder of the terms of this Agreement, and without further action
214 | by the parties hereto, such provision shall be reformed to the minimum
215 | extent necessary to make such provision valid and enforceable.
216 |
217 | If Recipient institutes patent litigation against any entity
218 | (including a cross-claim or counterclaim in a lawsuit) alleging that the
219 | Program itself (excluding combinations of the Program with other
220 | software or hardware) infringes such Recipient's patent(s), then such
221 | Recipient's rights granted under Section 2(b) shall terminate as of the
222 | date such litigation is filed.
223 |
224 | All Recipient's rights under this Agreement shall terminate if it
225 | fails to comply with any of the material terms or conditions of this
226 | Agreement and does not cure such failure in a reasonable period of time
227 | after becoming aware of such noncompliance. If all Recipient's rights
228 | under this Agreement terminate, Recipient agrees to cease use and
229 | distribution of the Program as soon as reasonably practicable. However,
230 | Recipient's obligations under this Agreement and any licenses granted by
231 | Recipient relating to the Program shall continue and survive.
232 |
233 | Everyone is permitted to copy and distribute copies of this
234 | Agreement, but in order to avoid inconsistency the Agreement is
235 | copyrighted and may only be modified in the following manner. The
236 | Agreement Steward reserves the right to publish new versions (including
237 | revisions) of this Agreement from time to time. No one other than the
238 | Agreement Steward has the right to modify this Agreement. The Eclipse
239 | Foundation is the initial Agreement Steward. The Eclipse Foundation may
240 | assign the responsibility to serve as the Agreement Steward to a
241 | suitable separate entity. Each new version of the Agreement will be
242 | given a distinguishing version number. The Program (including
243 | Contributions) may always be distributed subject to the version of the
244 | Agreement under which it was received. In addition, after a new version
245 | of the Agreement is published, Contributor may elect to distribute the
246 | Program (including its Contributions) under the new version. Except as
247 | expressly stated in Sections 2(a) and 2(b) above, Recipient receives no
248 | rights or licenses to the intellectual property of any Contributor under
249 | this Agreement, whether expressly, by implication, estoppel or
250 | otherwise. All rights in the Program not expressly granted under this
251 | Agreement are reserved.
252 |
253 | This Agreement is governed by the laws of the State of New York and
254 | the intellectual property laws of the United States of America. No party
255 | to this Agreement will bring a legal action under this Agreement more
256 | than one year after the cause of action arose. Each party waives its
257 | rights to a jury trial in any resulting litigation.
258 |
259 |
260 |
261 |
262 |
--------------------------------------------------------------------------------