Archived
Initial commit
This commit is contained in:
commit
e7f089f9b8
10 files changed
+1230
No files matched your search
@@ -0,0 +1,3 @@
|
||||
[submodule "wsp"]
|
||||
path = wsp
|
||||
url = https://github.com/Thewafflication/wsp
|
||||
@@ -0,0 +1,675 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
@@ -0,0 +1,90 @@
|
||||
# Waughtal Shell
|
||||
|
||||
Waughtal Shell (`wsh`) is a Windows-native command shell inspired by Tom
|
||||
Duff's Plan 9 `rc` shell.
|
||||
|
||||
The project aims to preserve the small, regular ideas that distinguish
|
||||
`rc`—list-valued variables, apostrophe quoting, caret concatenation,
|
||||
functions, structured commands, pipelines, and ordered redirection—while
|
||||
defining explicit native behavior for Windows processes, paths, environment
|
||||
variables, consoles, and handles.
|
||||
|
||||
The implementation is currently in the planning and project-baselining stage.
|
||||
|
||||
## Project Goals
|
||||
|
||||
- Target Windows without requiring a POSIX compatibility layer.
|
||||
- Implement the shell in portable C99.
|
||||
- Keep language parsing, evaluation, and Win32 integration separate.
|
||||
- Configure and build the project with CMake presets.
|
||||
- Dispatch all automated tests through CTest.
|
||||
- Generate traceable TeX test evidence for release reports.
|
||||
- Provision WCRT, KerTeX, and cv2pdb through WPM.
|
||||
- Support x86, x64, and ARM64, with test claims backed by execution on the
|
||||
corresponding architecture.
|
||||
|
||||
Waughtal Shell is inspired by `rc`; it does not initially promise that every
|
||||
Plan 9 `rc` script will run unchanged. Platform-dependent behavior and
|
||||
intentional differences will be documented and tested.
|
||||
|
||||
## Planned Development
|
||||
|
||||
The proposed roadmap is:
|
||||
|
||||
1. Establish the WSP, dependency, build, and test-evidence baseline.
|
||||
2. Implement and test the lexer and parser.
|
||||
3. Add variables, built-ins, external command execution, status handling, and
|
||||
redirection.
|
||||
4. Add structured control flow, functions, pipelines, command substitution,
|
||||
and globbing.
|
||||
5. Add an interactive prompt, history, and Windows console interruption.
|
||||
6. Complete the documented 1.0 compatibility and release baseline.
|
||||
|
||||
See the [project plan], [draft requirements], and [architecture decisions] for
|
||||
details.
|
||||
|
||||
## Proposed Toolchain
|
||||
|
||||
Dependencies will be installed through WPM and pinned before the first release
|
||||
baseline:
|
||||
|
||||
```powershell
|
||||
wpm install wcrt --arch <x86|x64|arm64> --version <version>
|
||||
wpm install kertex --arch <architecture> --version <version>
|
||||
wpm install cv2pdb --arch <architecture> --version <version>
|
||||
```
|
||||
|
||||
The exact configure, build, and test commands will be added with the initial
|
||||
CMake skeleton. CTest will remain the top-level test dispatcher.
|
||||
|
||||
## Project Process
|
||||
|
||||
The repository adopts the Waughtal Software Process through the `wsp/` Git
|
||||
submodule. Requirements, architecture decisions, tests, evidence, and release
|
||||
artifacts are intended to remain bidirectionally traceable.
|
||||
|
||||
See the proposed [adoption record] for the selected WSP profiles and initial
|
||||
tailoring decisions.
|
||||
|
||||
## References
|
||||
|
||||
- [Rc — The Plan 9 Shell](https://doc.cat-v.org/plan_9/4th_edition/papers/rc),
|
||||
by Tom Duff
|
||||
- [Plan 9 from User Space rc(1)][rc-manual]
|
||||
|
||||
## License
|
||||
|
||||
Waughtal Shell is free software licensed under the GNU General Public License,
|
||||
version 3 or, at your option, any later version. See [LICENSE](LICENSE).
|
||||
|
||||
Project-owned source files should use:
|
||||
|
||||
```c
|
||||
/* SPDX-License-Identifier: GPL-3.0-or-later */
|
||||
```
|
||||
|
||||
[project plan]: docs/project-plan.md
|
||||
[draft requirements]: docs/requirements/product-requirements.md
|
||||
[architecture decisions]: docs/adr-0001-rc-inspired-windows-language.md
|
||||
[adoption record]: docs/adoption-record.md
|
||||
[rc-manual]: https://9fans.github.io/plan9port/man/man1/rc.html
|
||||
@@ -0,0 +1,78 @@
|
||||
# WSP Adoption Record — Waughtal Shell
|
||||
|
||||
**Content type:** Adoption record
|
||||
|
||||
**Project:** Waughtal Shell (`wsh`)
|
||||
|
||||
**WSP baseline:** Immutable commit
|
||||
`2198ccab08f969a789448767fe7017b774369adc`
|
||||
|
||||
**Submodule path:** `wsp/`
|
||||
|
||||
**Pinned commit:** `2198ccab08f969a789448767fe7017b774369adc`
|
||||
|
||||
**Status:** Proposed
|
||||
|
||||
**Approval:** Pending initial project-baseline review
|
||||
|
||||
## Common Baseline
|
||||
|
||||
| Requirement set or practice | Applicability | Project artifact or scope |
|
||||
| --- | --- | --- |
|
||||
| Common requirements management | Yes | `docs/requirements/` and traceability records |
|
||||
| WSP software lifecycle | Yes | `docs/project-plan.md` |
|
||||
| Project process | Yes | `docs/project-plan.md` and release records |
|
||||
| Documentation requirements | Yes | Controlled project and release documentation |
|
||||
| Documentation style and identifiers | Yes | Project-authored artifacts |
|
||||
| Testing requirements | Yes | CTest specifications, evidence, and reports |
|
||||
|
||||
## Selected Profiles
|
||||
|
||||
| Profile | Selected | Project scope or rationale |
|
||||
| --- | --- | --- |
|
||||
| Personal process | No | Deferred until individual planning records are useful |
|
||||
| Security/DFS | Yes | Shell parses untrusted text and launches processes |
|
||||
| C source style | Yes | All project-owned `.c` and `.h` files |
|
||||
| PowerShell style | Yes | Project-owned Windows automation |
|
||||
| CMake style | Yes | All project-owned CMake files and presets |
|
||||
| Windows version resources | Yes | Every shipped project-owned executable and DLL |
|
||||
| Windows code signing and Defender | Yes | Windows release artifacts |
|
||||
| Common tools | Yes | Traceability, source quality, evidence, reports, and documentation |
|
||||
|
||||
## Initial Tailoring Decisions
|
||||
|
||||
Detailed row-by-row dispositions will be completed during M0 before any
|
||||
release baseline is approved. No adopted requirement is silently omitted.
|
||||
|
||||
### WSP-DOC toolchain — KerTeX selection
|
||||
|
||||
- **Disposition:** Proposed tailoring, subject to M0 compatibility test
|
||||
- **Rationale:** The project requires KerTeX installed through WPM, while the
|
||||
current WSP documentation guidance describes a MiKTeX/PDFLaTeX pipeline.
|
||||
- **Impact:** WSP TeX inputs or automation may depend on MiKTeX-specific
|
||||
behavior and fail to produce the required release PDF.
|
||||
- **Compensating control:** Compile representative WSP test and release inputs
|
||||
with the pinned KerTeX engine; retain logs; propose portable fixes upstream
|
||||
or document an approved equivalent pipeline.
|
||||
- **Owner:** Project maintainer
|
||||
- **Completion condition:** M0 documentation-toolchain spike passes and the
|
||||
exact engine/version is recorded.
|
||||
- **Approval:** Pending
|
||||
|
||||
### WSP-TEST-0018 — cv2pdb output
|
||||
|
||||
- **Disposition:** Applicable without weakening
|
||||
- **Rationale:** PDB output is useful for Windows debugging but does not replace
|
||||
WSP's GDB-compatible DWARF requirement.
|
||||
- **Impact:** Debug builds retain both symbol forms, increasing artifact size.
|
||||
- **Compensating control:** Not required.
|
||||
- **Owner:** Project maintainer
|
||||
- **Completion condition:** N/A
|
||||
- **Approval:** Pending baseline review
|
||||
|
||||
## Baseline History
|
||||
|
||||
| Date | WSP baseline | Project change | Summary |
|
||||
| --- | --- | --- | --- |
|
||||
| 2026-08-04 | `2198ccab08f969a789448767fe7017b774369adc` | Initial plan | Proposed WSP adoption |
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# ADR-0001: Rc-Inspired Language with Explicit Windows Semantics
|
||||
|
||||
**Status:** Proposed
|
||||
|
||||
**Date:** 2026-08-04
|
||||
|
||||
## Context
|
||||
|
||||
Plan 9 `rc` obtains part of its behavior from Plan 9 facilities such as `/env`,
|
||||
notes, namespaces, string-valued exit status, and `rfork`. Windows has a
|
||||
different process, environment, path, console, and handle model.
|
||||
|
||||
## Decision
|
||||
|
||||
Waughtal Shell will preserve the documented `rc` language concepts that do not
|
||||
depend intrinsically on Plan 9: list-valued variables, apostrophe quotation,
|
||||
caret concatenation, functions, structured commands, substitution, pipelines,
|
||||
and ordered redirection. Platform-dependent behavior will have a Windows-native
|
||||
contract and will be identified as compatible, adapted, unsupported, or
|
||||
deferred in the language reference and tests.
|
||||
|
||||
The project will not claim that arbitrary Plan 9 `rc` scripts execute unchanged.
|
||||
|
||||
## Consequences
|
||||
|
||||
- The language remains recognizably `rc` and avoids accumulating unrelated
|
||||
PowerShell or Bourne syntax.
|
||||
- Windows users receive predictable native process and path behavior.
|
||||
- A compatibility matrix and conformance suite become release artifacts.
|
||||
- Some Plan 9 features require deliberate analogues or remain unsupported.
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
# ADR-0002: Separate Parser, Evaluator, and Windows Runtime
|
||||
|
||||
**Status:** Proposed
|
||||
|
||||
**Date:** 2026-08-04
|
||||
|
||||
## Context
|
||||
|
||||
A shell combines a language implementation with security-sensitive operating
|
||||
system orchestration. Mixing parsing, expansion, and process creation makes
|
||||
semantic testing difficult and increases injection and resource-lifetime risk.
|
||||
|
||||
## Decision
|
||||
|
||||
The implementation will use a lexer and explicit grammar to construct an AST.
|
||||
Evaluation will operate on list values and abstract runtime services. Win32
|
||||
process, console, filesystem, environment, and handle behavior will be isolated
|
||||
behind interfaces in `src/platform/windows/`.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Lexer, parser, expansion, and evaluation can be unit-tested without child
|
||||
processes.
|
||||
- Windows behavior can be tested with purpose-built helper executables.
|
||||
- Interfaces must carry explicit allocation, ownership, encoding, and error
|
||||
contracts, adding modest up-front design work.
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# ADR-0003: WPM-Provisioned CMake, CTest, and TeX Toolchain
|
||||
|
||||
**Status:** Proposed
|
||||
|
||||
**Date:** 2026-08-04
|
||||
|
||||
## Context
|
||||
|
||||
The project requires plain C, Windows targets, CMake, CTest, TeX test results,
|
||||
and WPM installation of WCRT, KerTeX, and cv2pdb. WSP requires reproducible
|
||||
test evidence and GDB-compatible Debug symbols.
|
||||
|
||||
## Decision
|
||||
|
||||
WPM will provision pinned WCRT, KerTeX, and cv2pdb packages. CMake presets will
|
||||
describe architecture and configuration. CTest will dispatch every automated
|
||||
test and evidence check. Test wrappers will generate TeX evidence and KerTeX
|
||||
will compile the assembled report. TinyCC Debug builds will retain DWARF;
|
||||
cv2pdb will generate an additional PDB where supported.
|
||||
|
||||
A milestone-zero spike must prove package discovery, CMake integration,
|
||||
KerTeX compatibility with the WSP report inputs, and dual-symbol retention.
|
||||
|
||||
## Consequences
|
||||
|
||||
- Developer and CI provisioning share the WPM dependency path.
|
||||
- Test reporting is a tested build product rather than a manual afterthought.
|
||||
- Generated PDBs improve native debugging without weakening WSP evidence.
|
||||
- Package metadata and KerTeX compatibility are early schedule risks.
|
||||
|
||||
@@ -0,0 +1,258 @@
|
||||
# Waughtal Shell Project Plan
|
||||
|
||||
**Document ID:** `WSH-PLAN-0001`
|
||||
|
||||
**Status:** Proposed
|
||||
|
||||
**Date:** 2026-08-04
|
||||
|
||||
## Purpose
|
||||
|
||||
Waughtal Shell (`wsh`) will be a Windows-native command interpreter inspired
|
||||
by Tom Duff's Plan 9 `rc` shell. It will preserve the small, regular language
|
||||
model that distinguishes `rc`, while defining explicit Windows behavior for
|
||||
processes, paths, environment variables, consoles, and executable discovery.
|
||||
|
||||
The first supported implementation will be written in portable C99 and built
|
||||
with CMake. CTest will execute all automated tests. Each controlled test run
|
||||
will produce LaTeX evidence suitable for inclusion in a WSP release report.
|
||||
|
||||
## Product Principles
|
||||
|
||||
1. Preserve `rc` concepts rather than copying Bourne or PowerShell semantics.
|
||||
2. Be a native Windows program; do not require POSIX emulation at runtime.
|
||||
3. Keep parsing, evaluation, and Windows integration as separate components.
|
||||
4. Make compatibility and intentional deviations observable and tested.
|
||||
5. Keep the dependency and build baseline reproducible through WPM.
|
||||
6. Prefer a small correct language over broad, partially compatible syntax.
|
||||
|
||||
## Scope
|
||||
|
||||
### Version 0.1 — Language Core
|
||||
|
||||
- batch execution with `wsh script.wsh` and `wsh -c command`;
|
||||
- lexer and parser for words, apostrophe quoting, comments, command lists,
|
||||
assignments, variable expansion, list construction, and `^` concatenation;
|
||||
- simple external commands and the `exit`, `cd`, and `echo` built-ins;
|
||||
- `$status`, `$*`, `$#name`, `$name(n)`, and `$name` list behavior;
|
||||
- sequential commands and `&&`, `||`, and `!` status composition;
|
||||
- input, output, append, and standard-error redirection;
|
||||
- deterministic diagnostics with source locations; and
|
||||
- x86, x64, and ARM64 build configurations, with execution claims made only
|
||||
where tests run on the corresponding architecture.
|
||||
|
||||
### Version 0.2 — Structured Shell Language
|
||||
|
||||
- blocks, `if`, `if not`, `while`, `for`, `switch`, and `~` matching;
|
||||
- shell functions and command-local variables;
|
||||
- linear pipelines and background execution;
|
||||
- command substitution and configurable `ifs` splitting;
|
||||
- globbing with `rc`'s unmatched-pattern behavior; and
|
||||
- script inclusion and initial profile loading.
|
||||
|
||||
### Version 0.3 — Interactive Shell
|
||||
|
||||
- interactive prompt and multiline parsing;
|
||||
- console interrupt handling and child-process cancellation;
|
||||
- command history and a minimal line editor;
|
||||
- `whatis`, `shift`, `wait`, and job inspection; and
|
||||
- documented Windows script association and invocation behavior.
|
||||
|
||||
### Version 1.0 — Supported Compatibility Baseline
|
||||
|
||||
- here documents;
|
||||
- ordered descriptor duplication and closure where Windows can represent it;
|
||||
- a documented decision on generalized pipelines and process substitution;
|
||||
- stable language and Windows-compatibility reference;
|
||||
- signed Windows release packages and complete release evidence; and
|
||||
- conformance suite covering every supported `rc`-derived feature and every
|
||||
documented deviation.
|
||||
|
||||
### Initial Exclusions
|
||||
|
||||
- Plan 9 namespaces, `/env`, notes, and `rfork` semantics;
|
||||
- byte-for-byte compatibility with Plan 9 executables or environment storage;
|
||||
- POSIX job-control process groups;
|
||||
- Unix shebang execution by the Windows kernel; and
|
||||
- a requirement to execute existing Unix `rc` scripts unchanged.
|
||||
|
||||
Exclusions may be revisited only through requirements change analysis and an
|
||||
ADR. Where useful, `wsh` may offer a Windows analogue under a distinct,
|
||||
documented contract.
|
||||
|
||||
## Stakeholders and Responsibilities
|
||||
|
||||
| Responsibility | Initial owner |
|
||||
| --- | --- |
|
||||
| Product scope and release approval | Project maintainer |
|
||||
| Requirements and architecture | Project maintainer |
|
||||
| Implementation and source review | Project contributors |
|
||||
| Verification and evidence approval | Project maintainer or designated reviewer |
|
||||
| Dependency and release security | Project maintainer |
|
||||
| WSP process improvement | Project maintainer |
|
||||
|
||||
Material release findings should receive review by someone other than their
|
||||
author when another reviewer is available. A single-maintainer exception will
|
||||
be recorded in the release-readiness record.
|
||||
|
||||
## Technical Baseline
|
||||
|
||||
- Language: portable C99 with compiler extensions disabled.
|
||||
- Platform API: Win32, isolated below `src/platform/windows/`.
|
||||
- Build: CMake with checked-in configure, build, and test presets.
|
||||
- Test runner: CTest, with small C unit-test executables and process-level
|
||||
PowerShell acceptance runners where Windows orchestration is required.
|
||||
- Compilers: TinyCC/WCRT is the primary bootstrap toolchain. MSVC and a
|
||||
GCC-compatible Windows compiler are secondary compatibility gates once the
|
||||
core is stable.
|
||||
- Dependencies provisioned by WPM: `wcrt`, `kertex`, and `cv2pdb`.
|
||||
- Debug symbols: DWARF is retained for WSP/GDB evidence; `cv2pdb` generates an
|
||||
additional PDB artifact for Windows debugging.
|
||||
- Documentation: controlled Markdown remains authoritative. Generated test
|
||||
evidence is TeX; release documentation is assembled under the WSP process.
|
||||
|
||||
The exact WPM repository configuration, package versions, architectures, and
|
||||
install roots will be captured in a checked-in dependency lock or generated
|
||||
dependency inventory before the first release baseline. Provisioning will use
|
||||
commands of the following form, finalized against the package indexes:
|
||||
|
||||
```powershell
|
||||
wpm install wcrt --arch <x86|x64|arm64> --version <pinned-version>
|
||||
wpm install kertex --arch <architecture> --version <pinned-version>
|
||||
wpm install cv2pdb --arch <architecture> --version <pinned-version>
|
||||
```
|
||||
|
||||
## Proposed Repository Layout
|
||||
|
||||
```text
|
||||
CMakeLists.txt
|
||||
CMakePresets.json
|
||||
cmake/
|
||||
docs/
|
||||
adoption-record.md
|
||||
architecture.md
|
||||
requirements/
|
||||
adr-*.md
|
||||
include/wsh/
|
||||
src/
|
||||
main.c
|
||||
language/
|
||||
runtime/
|
||||
platform/windows/
|
||||
tests/
|
||||
unit/
|
||||
integration/
|
||||
conformance/
|
||||
specifications/
|
||||
evidence/
|
||||
tools/
|
||||
wsp/
|
||||
```
|
||||
|
||||
Generated files will be written beneath `out/`, `tmp/`, or `output/`, never
|
||||
under `wsp/` or the controlled source directories.
|
||||
|
||||
## Architecture Work Breakdown
|
||||
|
||||
1. **Source and diagnostics:** input abstraction, UTF decoding policy, source
|
||||
spans, and diagnostic rendering.
|
||||
2. **Lexer:** tokens, apostrophe quoting, comments, operators, and free-caret
|
||||
insertion rules.
|
||||
3. **Parser:** explicit grammar producing an immutable abstract syntax tree.
|
||||
4. **Values and scope:** owned lists of strings, variable tables, local scope,
|
||||
functions, and status values.
|
||||
5. **Expansion:** variables, subscripts, counts, concatenation, globbing, and
|
||||
command substitution.
|
||||
6. **Evaluator:** commands, control flow, functions, pipelines, and status
|
||||
propagation.
|
||||
7. **Windows process layer:** executable search, argument quoting, environment
|
||||
blocks, handles, pipes, process creation, waiting, and cancellation.
|
||||
8. **Interactive layer:** console input, prompt, history, and interrupts.
|
||||
|
||||
Each layer will expose narrow C interfaces with explicit ownership and error
|
||||
contracts. Parser tests will not launch processes; process tests will not
|
||||
depend on the interactive console.
|
||||
|
||||
## Verification Strategy
|
||||
|
||||
CTest will be the sole top-level test dispatcher. Labels will separate:
|
||||
|
||||
- `unit`: lexer, parser, list, scope, expansion, and status behavior;
|
||||
- `integration`: process creation, environment, pipes, redirections, and
|
||||
filesystem behavior;
|
||||
- `conformance`: examples and semantic cases derived from the `rc` paper and
|
||||
manual, with Windows deviations stated in the test specification;
|
||||
- `negative`: malformed syntax, unavailable executables, invalid handles,
|
||||
resource exhaustion, and interrupted execution; and
|
||||
- `quality`: traceability, C source documentation, line length, Doxygen,
|
||||
dependency inventory, and generated-evidence validation.
|
||||
|
||||
Every controlled test will have a `TC-NNNN` specification and link backward to
|
||||
one or more `WSH-REQ-NNNN` requirements. A CTest fixture or wrapper will record
|
||||
the source revision, preset, architecture, compiler, dependency versions,
|
||||
command, timestamps, exit code, and captured output. It will generate a TeX
|
||||
evidence fragment per test and a configuration-level TeX summary. Failure to
|
||||
generate complete evidence is itself a test failure.
|
||||
|
||||
The evidence generator will use WSP's `New-TestReport.ps1`,
|
||||
`Test-TestEvidence.ps1`, and `Test-Traceability.ps1` where their contracts fit.
|
||||
KerTeX will compile the assembled TeX report in CI. A short toolchain spike
|
||||
must prove that the WSP TeX inputs and selected KerTeX engine are compatible;
|
||||
otherwise an approved tailoring decision or a preamble change upstream in WSP
|
||||
is required before release claims are made.
|
||||
|
||||
## Milestones and Exit Criteria
|
||||
|
||||
| Milestone | Outcome | Exit criteria |
|
||||
| --- | --- | --- |
|
||||
| M0: Baseline | Governed repository | WSP adoption record, requirements index, ADRs, presets, WPM dependency spike |
|
||||
| M1: Parse | Language front end | Lexer/parser core passes unit and malformed-input tests with no leaks |
|
||||
| M2: Execute | Useful batch shell | External commands, variables, built-ins, status, and redirection pass acceptance tests |
|
||||
| M3: Compose | Structured scripts | Control flow, functions, pipelines, substitution, and globbing pass conformance tests |
|
||||
| M4: Interact | Daily interactive use | Prompt, history, interrupts, and child cleanup pass console tests |
|
||||
| M5: Release candidate | Supported baseline | All applicable requirements traced; x86/x64/ARM64 claims backed by native evidence; documentation and trust gates pass |
|
||||
|
||||
## Principal Risks
|
||||
|
||||
| Risk | Planned control |
|
||||
| --- | --- |
|
||||
| Windows command-line quoting cannot represent arbitrary argument lists for legacy programs | Define `CreateProcessW` serialization rules; test with an argument-echo helper; document irreducible application-specific parsing differences |
|
||||
| Windows environment variables cannot natively preserve `rc` lists | Keep lists internally; define a reversible WSH encoding only for child `wsh`; use a documented scalar join policy for other children |
|
||||
| Windows handles do not equal Plan 9 file descriptors | Model logical descriptors internally; support standard handles first; gate arbitrary-descriptor claims on a feasibility spike |
|
||||
| Console interrupts and background children leak processes | Use job objects and explicit control-event tests; verify cleanup after abnormal exit |
|
||||
| Unicode is corrupted at API boundaries | Use UTF-8 internally and wide Win32 APIs; define invalid-input behavior and round-trip tests |
|
||||
| Parser ambiguity or accidental shell injection | Use a formal grammar and direct `CreateProcessW`; never invoke `cmd.exe` implicitly |
|
||||
| KerTeX does not compile the WSP-oriented TeX pipeline | Complete an M0 compatibility spike and record the selected engine and required tailoring |
|
||||
| TinyCC diagnostics or code generation miss defects | Add MSVC and GCC-compatible warning/test gates before 1.0; run sanitizers where a compatible Windows toolchain permits |
|
||||
| Feature growth prevents a correct usable core | Enforce milestone scope and require ADR/requirements impact analysis for additions |
|
||||
|
||||
## Release Gate
|
||||
|
||||
A release candidate is acceptable only when:
|
||||
|
||||
- all requirements in its baseline have an approved disposition;
|
||||
- all required CTest tests pass on each claimed configuration;
|
||||
- TeX evidence is complete, traceable, and compiles successfully;
|
||||
- C source and CMake quality gates pass;
|
||||
- exact WPM dependency versions and digests are retained;
|
||||
- Debug symbols, including required DWARF evidence, are retained;
|
||||
- release documentation, checksums, provenance, signing decisions, and known
|
||||
limitations satisfy the adopted WSP baseline; and
|
||||
- no unresolved critical defect or unapproved security risk remains.
|
||||
|
||||
## Immediate Next Work
|
||||
|
||||
1. Approve the compatibility boundaries in the draft requirements and ADRs.
|
||||
2. Verify actual WPM package names, architectures, versions, and install-root
|
||||
metadata for WCRT, KerTeX, and cv2pdb.
|
||||
3. Run a KerTeX/WSP report compatibility spike.
|
||||
4. Create the CMake skeleton, presets, `wsh --version`, and a smoke CTest.
|
||||
5. Define the lexer grammar and the first `TC-NNNN` parser cases.
|
||||
|
||||
## References
|
||||
|
||||
- Tom Duff, *Rc — The Plan 9 Shell*.
|
||||
- Plan 9 from User Space, `rc(1)` manual.
|
||||
- WSP software lifecycle, requirements management, C style, CMake style,
|
||||
testing strategy, documentation requirements, and security profiles.
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# Waughtal Shell Product Requirements
|
||||
|
||||
**Document ID:** `WSH-REQ-INDEX`
|
||||
|
||||
**Status:** Proposed
|
||||
|
||||
These are planning-level requirements. Each will be split into a controlled
|
||||
requirement file with complete rationale, relationships, implementation
|
||||
allocation, and `TC-NNNN` references before acceptance into a release baseline.
|
||||
|
||||
| ID | Requirement | Planned verification |
|
||||
| --- | --- | --- |
|
||||
| `WSH-REQ-0001` | The product shall provide a Windows-native command interpreter executable named `wsh`. | Test |
|
||||
| `WSH-REQ-0002` | Project-owned production source shall be written in C99 with compiler extensions disabled. | Inspection and build |
|
||||
| `WSH-REQ-0003` | The project shall configure and build supported configurations with CMake presets. | Test |
|
||||
| `WSH-REQ-0004` | CTest shall be the top-level dispatcher for every automated release-gate test. | Inspection and test |
|
||||
| `WSH-REQ-0005` | Each controlled test execution shall generate complete, traceable TeX evidence. | Test |
|
||||
| `WSH-REQ-0006` | WPM shall provision pinned `wcrt`, `kertex`, and `cv2pdb` dependencies for supported build architectures. | Test and inspection |
|
||||
| `WSH-REQ-0007` | The interpreter shall represent a shell variable as an ordered list of strings. | Unit test |
|
||||
| `WSH-REQ-0008` | The interpreter shall implement `rc` apostrophe quotation and doubled-apostrophe behavior. | Unit and conformance test |
|
||||
| `WSH-REQ-0009` | The interpreter shall implement explicit and free-caret concatenation with defined list distribution behavior. | Unit and conformance test |
|
||||
| `WSH-REQ-0010` | The interpreter shall parse a documented grammar without delegating parsing to `cmd.exe` or PowerShell. | Inspection and negative test |
|
||||
| `WSH-REQ-0011` | The interpreter shall execute Windows programs without implicitly invoking another command interpreter. | Integration test |
|
||||
| `WSH-REQ-0012` | The interpreter shall define and test executable discovery for explicit paths, extensions, and `$path`. | Integration test |
|
||||
| `WSH-REQ-0013` | The interpreter shall preserve argument boundaries through its Windows command-line serialization contract for conforming child programs. | Integration test with echo helper |
|
||||
| `WSH-REQ-0014` | The interpreter shall support sequential, conditional, and inverted status composition. | Unit and integration test |
|
||||
| `WSH-REQ-0015` | The interpreter shall support ordered input, output, append, and standard-error redirections. | Integration test |
|
||||
| `WSH-REQ-0016` | The interpreter shall support linear pipelines without leaking inherited handles. | Integration and resource test |
|
||||
| `WSH-REQ-0017` | The interpreter shall support documented `rc` control-flow and function syntax. | Conformance test |
|
||||
| `WSH-REQ-0018` | The interpreter shall use UTF-8 internally and wide-character Win32 APIs at operating-system boundaries. | Inspection and round-trip test |
|
||||
| `WSH-REQ-0019` | Syntax and runtime diagnostics shall identify the source and location when one is available. | Unit and acceptance test |
|
||||
| `WSH-REQ-0020` | Interactive interruption shall return control to the prompt and terminate or detach children according to a documented policy. | Console integration test |
|
||||
| `WSH-REQ-0021` | The product shall document every intentional difference from the supported Plan 9 `rc` language baseline. | Review |
|
||||
| `WSH-REQ-0022` | Debug release evidence shall retain GDB-usable DWARF symbols; PDB output shall be additional. | Artifact inspection |
|
||||
| `WSH-REQ-0023` | The interpreter shall reject malformed input without executing a partial command unless the documented interactive continuation rule applies. | Negative test |
|
||||
| `WSH-REQ-0024` | The interpreter shall release owned memory, handles, and child-process resources on normal and tested error paths. | Analysis and test |
|
||||
|
||||
Submodule
+1
Submodule wsp added at 2198ccab08.
Reference in new issue
Block a user