vinsynlib 0.2.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,284 @@
1
+ Metadata-Version: 2.4
2
+ Name: vinsynlib
3
+ Version: 0.2.0
4
+ Summary: Shared base for ROMpler instrument browsers: settings, favourites, banks, dumps, CLI and key conventions
5
+ License-Expression: GPL-2.0-or-later
6
+ Project-URL: Homepage, https://github.com/lentferj/vinsynlib
7
+ Project-URL: Source, https://github.com/lentferj/vinsynlib
8
+ Project-URL: Issues, https://github.com/lentferj/vinsynlib/issues
9
+ Keywords: midi,synthesizer,sampler,textual,terminal
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: End Users/Desktop
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Multimedia :: Sound/Audio :: MIDI
17
+ Requires-Python: >=3.11
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ License-File: COPYING
21
+ Provides-Extra: ui
22
+ Requires-Dist: textual>=0.80; extra == "ui"
23
+ Provides-Extra: midi
24
+ Requires-Dist: python-rtmidi>=1.5; extra == "midi"
25
+ Dynamic: license-file
26
+
27
+ <!--
28
+ SPDX-License-Identifier: GPL-2.0-or-later
29
+ SPDX-FileCopyrightText: Copyright (C) 2026 vinsynLib contributors
30
+ -->
31
+
32
+ # vinsynlib
33
+
34
+ The shared base of a family of terminal instrument browsers.
35
+
36
+ Nine sibling programs browse nine instruments over MIDI from a terminal:
37
+ [emorphed](https://github.com/lentferj/emorphed) (E-mu Morpheus),
38
+ [ensqsqed](https://github.com/lentferj/ensqsqed) (Ensoniq SQ-R Plus),
39
+ [eosed](https://github.com/lentferj/eosed) (E-mu E4XT),
40
+ [kwsed](https://github.com/lentferj/kwsed) (Korg Wavestation SR),
41
+ [nanosyned](https://github.com/lentferj/nanosyned) (Alesis NanoSynth),
42
+ [p2ked](https://github.com/lentferj/p2ked) (E-mu Proteus 2000),
43
+ [rxved](https://github.com/lentferj/rxved) (Roland XV-2020),
44
+ [s3ked](https://github.com/lentferj/s3ked) (Akai S1000/S3000) and
45
+ [x5ded](https://github.com/lentferj/x5ded) (Korg X5D/X5DR).
46
+
47
+ They grew separately, which is the right way to learn what an instrument
48
+ does and the wrong way to arrive at nine copies of the same code. This
49
+ library is where the parts that are *not* the manufacturer's live, so that
50
+ a change to one of them happens once instead of nine times.
51
+
52
+ ---
53
+
54
+ ## Support this project
55
+
56
+ is free software and always will be. Nothing is behind a paywall, no
57
+ feature is withheld, and none of what follows changes that.
58
+
59
+ But if it has been useful — if it saved you an evening of mapping zones
60
+ by hand, or got a library onto a machine that had no way of reading it, or
61
+ **best of all, if it has your vintage instrument switched on and in use more often
62
+ than it was, and you are having more fun with it** — then please consider
63
+ supporting the work.
64
+
65
+ **Because here is what it has actually cost:**
66
+
67
+ - **Real machines on a real bench.** Much of what these tools know about these
68
+ formats was measured on hardware rather than read anywhere, because for most
69
+ of it there is nowhere to read it. That needs the machines — the instruments
70
+ themselves — and it puts hours of wear on hardware that has been locked up and
71
+ recovered more than once in the course of it. Some of these instruments were
72
+ bought specifically to add and verify a format; the others were already here,
73
+ because the person doing this is a vintage instrument enthusiast first and the
74
+ projects exist because the instruments were in the room.
75
+ - **Dozens — realistically hundreds — of hours of human time.** Format
76
+ reverse-engineering is slow: measure, be wrong, measure again. A single
77
+ parameter law in this README can represent an evening at the bench.
78
+ - **AI assistance, which is a paid service**, used heavily throughout and not
79
+ cheap at this volume.
80
+
81
+ **This is support, not a donation — and the distinction is a legal one, not a
82
+ turn of phrase.** The maintainer is based in Germany, where payments like these
83
+ are *not* `Spenden` in the tax sense: they count as **taxable income** for the
84
+ recipient and are **not tax-deductible** for the giver. So this section is
85
+ titled *Support*, deliberately, and no receipt for tax purposes can be issued.
86
+ (That is a statement of how it is handled here, not tax advice.)
87
+
88
+ If the project saved you the work, you can support it through
89
+ **[GitHub Sponsors](https://github.com/sponsors/lentferj)** — the *Sponsor*
90
+ button at the top of the repository. Payment is handled entirely by GitHub and
91
+ Stripe, so bank and tax details are never handed to the person paying.
92
+
93
+ **Support is not expected, and it is not the only currency.**
94
+
95
+ - **Bug reports** — ideally with the bank, preset or disk image that produced
96
+ them. A tool's failures are usually specific to one file rather than
97
+ general, and without that file they are very hard to reproduce.
98
+ - **Confirmations from hardware that is not on this bench**, which matters more
99
+ here than for a single-machine tool. These tools write for whole *families*
100
+ of instruments, and the bench holds only a subset. Whether a variant accepts
101
+ what we write is genuinely unknown, and several notes say "on this unit" for
102
+ that reason. A "loads fine here too", or a "no, mine refuses it", is worth a
103
+ great deal.
104
+ - **Corrections to the reverse-engineering notes.** The wrong turns are
105
+ recorded next to the findings in `docs/RESOLUTION_NOTES.md` — retractions
106
+ included, because a finding that was withdrawn is as useful as one that
107
+ stood. If any of it is wrong in a way that is still costing someone time,
108
+ saying so improves the record.
109
+
110
+ ---
111
+
112
+ ## AI assistance & human authorship
113
+
114
+ was built by its human author together with AI assistance. The
115
+ **ideas, the project vision, and every feature** came from the human author;
116
+ AI assisted with **writing the code and analyzing the binary formats**.
117
+ Crucially, the **reverse engineering rests on hands-on human work** — all testing
118
+ and verification on real hardware, creating the reference images/banks on those
119
+ instruments (disk saves, SysEx probes), and aural A/B comparison of presets —
120
+ which is what makes the results correct.
121
+ Full account in [DISCLAIMER.md](DISCLAIMER.md).
122
+
123
+ ---
124
+
125
+ ---
126
+
127
+ ## ⚠️ Use at your own risk — back up first
128
+
129
+ is provided **as is, with absolutely no warranty and no liability**
130
+ for data loss or **hardware damage**. You assume all risk. Full terms:
131
+ [DISCLAIMER.md](DISCLAIMER.md).
132
+
133
+ Before you use this software, **make good, current backups of all your files** —
134
+ and of any existing banks on your instrument and storage media. These tools can
135
+ write to hardware and storage media; a mistake, a bug, or untested output could
136
+ overwrite or corrupt data, or be rejected by hardware. Always test on a spare
137
+ unit or emulator **before** connecting irreplaceable equipment.
138
+
139
+ ---
140
+
141
+ ## What is in here, and what is not
142
+
143
+ **In here:** how a preference is remembered, where a favourite lives, what
144
+ an error says, which key means what, how a port list is printed, how a
145
+ legend wraps.
146
+
147
+ **In each project:** the wire format, the bank table, the meaning of a
148
+ byte, the LCD glyphs.
149
+
150
+ The line is *ours* versus *the manufacturer's*. A MIDI port name is
151
+ whatever ALSA reports, so the port listing is shared; which SysEx byte
152
+ selects which bank is that instrument's business and stays put.
153
+
154
+ ```
155
+ vinsynlib/
156
+ config.py the settings cache: port, channel, device ID
157
+ favorites.py the favourites database: SQLite, slots, ratings, tags
158
+ keys.py the keymap and the legend
159
+ cli.py the command line every tool builds the same way
160
+ spec.py that command line, as data: flags, commands, exit codes
161
+ terms.py the vocabulary: our words, and each tool's two
162
+ midi.py port listing, the shared error taxonomy, clean exit
163
+ conformance.py the checks a project runs against itself
164
+ devchecks.py checks that catch cross-project mistakes
165
+ ui/hints.py the legend widget
166
+ ```
167
+
168
+ ## Installing it, and who depends on it
169
+
170
+ This is a library, not a program, and it is **not on PyPI yet**. The ten tools
171
+ in the family depend on it, so it has to be a sibling checkout of whichever
172
+ one you are building:
173
+
174
+ ```
175
+ git-repos/
176
+ vinsynlib/ <- this one
177
+ x5ded/ <- and the ten tools beside it
178
+ emorphed/ ensqsqed/ eosed/ kwsed/ ...
179
+ ```
180
+
181
+ ```sh
182
+ cd ../x5ded # or any sibling
183
+ git clone https://github.com/lentferj/vinsynlib.git ../vinsynlib
184
+ python3 -m venv .venv
185
+ .venv/bin/pip install --no-deps -e ../vinsynlib # --no-deps: its deps are theirs
186
+ .venv/bin/pip install -e .
187
+ ```
188
+
189
+ Each of the ten writes those steps out in its own README, because a reader
190
+ starts from the tool and rarely from here. For projects that configure
191
+ `[tool.uv.sources]` pointing to this library, `uv sync` takes the path
192
+ from there, so the checkout only has to exist and neither `pip` line is needed.
193
+ For projects that work from an index (like the published tools), the explicit
194
+ `pip install -e ../vinsynlib` line remains necessary until the library is
195
+ published.
196
+
197
+ Publishing this to PyPI would replace all of it with an ordinary dependency
198
+ line. Until then, the sibling checkout *is* the install.
199
+
200
+ ## Why it exists
201
+
202
+ Nine projects each grew a `config.py` (about 190 lines, 90-97% identical),
203
+ a `favorites.py` (about 620 lines, 85-100% identical), a `KeyHints` widget
204
+ and a `wrap_blocks` helper. Measured across the family: **8,101 lines of
205
+ cloned code, roughly 6,300 of them duplicates that need not exist.**
206
+
207
+ Three of those copies had already drifted into bugs worth naming:
208
+
209
+ * `emorphed`'s `LICENSE` file opened with the words "nanosyned — Terminal
210
+ browser for the Alesis NanoSynth".
211
+ * `emorphed`'s `mypy` and `deptry` configuration still named the `nano`
212
+ module, and one function imported `nano.config` -- `nanosyned`'s package,
213
+ which is not installed beside it. That function worked in the project it
214
+ was copied from and raised `ImportError` the moment `--config` was used.
215
+ * `eosed` wrote port names into `config.toml` without escaping them, so a
216
+ port name containing a quote produced a file that is not TOML -- and its
217
+ settings writer refuses to overwrite a file it cannot parse, so the
218
+ cache never healed until somebody deleted it by hand.
219
+
220
+ None of these were visible in review. They were visible the moment there
221
+ was a second copy to compare against, which is what this library is.
222
+
223
+ ## Using it
224
+
225
+ ```python
226
+ from vinsynlib.config import Settings
227
+
228
+ settings = Settings("x5ded")
229
+ channel = settings.load_channel() # 0-15, or None; a TOML bool is None
230
+ settings.save_port("Midi Out: X5D")
231
+ ```
232
+
233
+ ```python
234
+ from vinsynlib.favorites import Favorites
235
+
236
+ with Favorites(app_name="x5ded") as favourites:
237
+ favourites.add("A", 7, name="Warm Pad", rating=4, tags="pad")
238
+ favourites.toggle("A", 7) # clears the flag, keeps the rating
239
+ ```
240
+
241
+ ```python
242
+ from vinsynlib import cli
243
+
244
+ parser = cli.make_parser("x5cli", "Browse a Korg X5D's sounds.")
245
+ cli.add_common_arguments(parser, port=True, scan=True, channel=True)
246
+ ```
247
+
248
+ ## Development
249
+
250
+ ```console
251
+ $ uv venv && uv pip install -e ".[ui,midi]" && uv pip install \
252
+ pytest pytest-cov mypy ruff vulture deptry detect-secrets pip-audit
253
+ $ make check
254
+ ```
255
+
256
+ `make check` runs the whole gate in order and stops at the first failure:
257
+ ruff, mypy in strict mode, the test suite with coverage, then vulture,
258
+ deptry and pip-audit.
259
+
260
+ > **Legal:** [DISCLAIMER.md](DISCLAIMER.md) · [LICENSE](LICENSE)
261
+
262
+ ## Where the rules are written down
263
+
264
+ **[docs/UX-SPEC.md](docs/UX-SPEC.md)** is the contract: terminology, the
265
+ command line, the keys, the paths, the exit codes, and the reasoning behind
266
+ the parts that are not obvious. It is the document to read before changing
267
+ anything here, and the document to argue with.
268
+
269
+ Three things in it are worth repeating, because they are the parts a new
270
+ contributor is most likely to get backwards:
271
+
272
+ **The instrument's word is the instrument's.** Each tool declares the word
273
+ for a stored sound and for the area it lives in, once, and uses it
274
+ consistently within itself. A Yamaha says PATCH; an E-mu says PRESET. The
275
+ unit's word wins, because a tool that renames it has to translate, and a
276
+ mistranslation is the difference between finding a sound and not.
277
+
278
+ **Our words are the same everywhere.** *favourite*, *search*, *scan*,
279
+ *dump*, *port*: no tool invents a synonym for a concept the family owns.
280
+
281
+ **`config.toml` is disposable; `favorites.db` is the user's own work.** The
282
+ first lives in the working directory and is safe to delete. The second
283
+ lives in the platform data directory, is keyed on the slot rather than the
284
+ name, and is the one file here worth backing up.
@@ -0,0 +1,19 @@
1
+ vinsynlib/__init__.py,sha256=KnnmwiwGjFsMlqddtUBTtitFqETPjAaDccgdCow0Eqw,3902
2
+ vinsynlib/cli.py,sha256=f81B_oIxp4PXA8KJ9V2_jlzFkpC2Istxk6rnifI5ZK8,9107
3
+ vinsynlib/config.py,sha256=lNOzVJqNSRpZE-llIwiTmuieZ_a6pi4rkvseMYiyt7s,19799
4
+ vinsynlib/conformance.py,sha256=XA1P_y_uWm3m272ee4t5KSlrl3P0QNOkK9dIqHjoF1M,9326
5
+ vinsynlib/devchecks.py,sha256=rrVWTWS0EF1_jm0Y5AgerMvB3wYrXbmX5wqFvEcLxzo,5542
6
+ vinsynlib/favorites.py,sha256=66BLy6lUTC9gYQ2ppKmew_UemKo8wJhQzOWzPH3GRJs,27871
7
+ vinsynlib/keys.py,sha256=34m52L1XzVjFaRkM6P3to5migNT6a7M1H1FKXsW8n54,9692
8
+ vinsynlib/midi.py,sha256=smiVpkHRZCbYcLPFXIt4jHLEIgiwb3dceHBBBPvnpng,12844
9
+ vinsynlib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
+ vinsynlib/spec.py,sha256=NV5CBTsx-vM_v2V2f5YhLWXq2MSHkMM32fOHGAolNoA,10782
11
+ vinsynlib/terms.py,sha256=WpFZyR1UzqGZ9tTrcsx3MYi8UcQ_UgDHTAwtR9ycRR0,8335
12
+ vinsynlib/ui/__init__.py,sha256=xUQBZBdsIFsIXotnF699OoGn135uiKZDHMgfZ-5GxEo,1008
13
+ vinsynlib/ui/hints.py,sha256=_DH8Aexz8bOct6eEpTsoTHzLjV_XVxTWxSp_eJ3ax3E,2877
14
+ vinsynlib-0.2.0.dist-info/licenses/COPYING,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
15
+ vinsynlib-0.2.0.dist-info/licenses/LICENSE,sha256=x4LDKkTx0Wsb-ACz_OxLnqxzRiD4RDFFn6kg5n3dpAQ,2839
16
+ vinsynlib-0.2.0.dist-info/METADATA,sha256=ntCcftqGihBypvOa-VJzLCpT3P34hKeLWZtkbtBwmQ4,12432
17
+ vinsynlib-0.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
18
+ vinsynlib-0.2.0.dist-info/top_level.txt,sha256=8917hpZDMR3BmOfy9awB_FLd0koTgGx4bzzrdPVZxfQ,10
19
+ vinsynlib-0.2.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (84.0.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,339 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ <signature of Ty Coon>, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.