Compare commits
15 Commits
1fdb825793
...
develop
| Author | SHA1 | Date | |
|---|---|---|---|
| b4543efaeb | |||
| a238b63e51 | |||
| 36b065ddb2 | |||
| 431fe30e34 | |||
| d8b4550392 | |||
| 577c02c9a4 | |||
| 6863d7377b | |||
| 134e35cc9e | |||
| d20e159731 | |||
| 3efbd9de2a | |||
| c399b89632 | |||
| 921088a22a | |||
| cbdc635cb3 | |||
| 14e4ba0747 | |||
| bd8a6f48c4 |
13
Cargo.toml
13
Cargo.toml
@@ -5,8 +5,21 @@ description = "PHP Macro Pre-processor (PMP) written in Rust."
|
||||
version = "0.1.0-alpha"
|
||||
edition = "2024"
|
||||
|
||||
[workspace]
|
||||
members = ["crates/*"]
|
||||
resolver = "2"
|
||||
|
||||
[workspace.package]
|
||||
edition = "2024"
|
||||
authors = ["Dean J. Karstedt <dk@cl.team>"]
|
||||
license-file = "LICENSE"
|
||||
|
||||
[dependencies]
|
||||
pmp-macro = { path = "crates/pmp-macro" }
|
||||
pmp-emitter = { path = "crates/pmp-emitter" }
|
||||
|
||||
clap = { version = "^4", features = ["derive"] }
|
||||
owo-colors = { version = "^4", features = ["supports-colors"] }
|
||||
|
||||
rayon = "^1"
|
||||
|
||||
|
||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
12
crates/pmp-core/Cargo.toml
Normal file
12
crates/pmp-core/Cargo.toml
Normal file
@@ -0,0 +1,12 @@
|
||||
[package]
|
||||
name = "pmp-core"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[dependencies]
|
||||
syn = { version = "^2", features = ["full"] }
|
||||
darling = "^0"
|
||||
proc-macro2 = "^1"
|
||||
76
crates/pmp-core/src/attrs.rs
Normal file
76
crates/pmp-core/src/attrs.rs
Normal file
@@ -0,0 +1,76 @@
|
||||
use darling::FromMeta;
|
||||
|
||||
/// Implemented by any item that carries a `Vec<syn::Attribute>`.
|
||||
///
|
||||
/// Allows `parse_pmp_attrs` to be generic over variants, fields, etc.
|
||||
pub trait HasAttrs {
|
||||
fn attrs(&self) -> &[syn::Attribute];
|
||||
}
|
||||
|
||||
/// Blanket impl for anything that exposes `.attrs` as a public field via a deref,
|
||||
/// covered by explicit impls below for the common syn types.
|
||||
impl HasAttrs for syn::Field {
|
||||
fn attrs(&self) -> &[syn::Attribute] { &self.attrs }
|
||||
}
|
||||
|
||||
impl HasAttrs for syn::Variant {
|
||||
fn attrs(&self) -> &[syn::Attribute] { &self.attrs }
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------- //
|
||||
|
||||
/// Finds a `#[{attr_name}(...)]` attribute in the given list and parses it into `T`.
|
||||
///
|
||||
/// Returns `Ok(T::default())` if no such attribute is present or
|
||||
/// a span-accurate `Err` if the attribute is present but malformed.
|
||||
///
|
||||
/// Each proc-macro crate passes its own attribute name:
|
||||
/// ```
|
||||
/// // in pmp-emitter-core:
|
||||
/// let attrs: EnumAttrs = parse_pmp_attr(&input.attrs, "pmp_emitter")?;
|
||||
///
|
||||
/// // in pmp-macro-core:
|
||||
/// let attrs: MacroAttrs = parse_pmp_attr(&input.attrs, "pmp_macro")?;
|
||||
/// ```
|
||||
pub fn parse_pmp_attr<T>(attrs: &[syn::Attribute], attr_name: &str) -> syn::Result<T>
|
||||
where
|
||||
T: FromMeta + Default,
|
||||
{
|
||||
match attrs.iter().find(|a| a.path().is_ident(attr_name))
|
||||
{
|
||||
None => Ok(T::default()),
|
||||
Some(attr) => T::from_meta(&attr.meta)
|
||||
.map_err(|e| syn::Error::new_spanned(attr, e.to_string())),
|
||||
}
|
||||
}
|
||||
|
||||
/// Accumulates errors from parsing `#[{attr_name}(...)]` on a collection of items
|
||||
/// (e.g. enum variants or struct fields) into a single `syn::Error`.
|
||||
///
|
||||
/// Returns `Ok(Vec<T>)` with one parsed value per item, or `Err` containing all
|
||||
/// accumulated errors if any items failed.
|
||||
pub fn parse_pmp_attrs<T, I>(items: I, attr_name: &str) -> syn::Result<Vec<T>>
|
||||
where
|
||||
T: FromMeta + Default,
|
||||
I: IntoIterator<Item: HasAttrs>,
|
||||
{
|
||||
let mut results: Vec<T> = Vec::new();
|
||||
let mut errors: Option<syn::Error> = None;
|
||||
|
||||
for item in items
|
||||
{
|
||||
match parse_pmp_attr(item.attrs(), attr_name)
|
||||
{
|
||||
Ok(v) => results.push(v),
|
||||
Err(e) => match &mut errors {
|
||||
None => errors = Some(e),
|
||||
Some(existing) => existing.combine(e),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
match errors {
|
||||
None => Ok(results),
|
||||
Some(e) => Err(e),
|
||||
}
|
||||
}
|
||||
49
crates/pmp-core/src/functions.rs
Normal file
49
crates/pmp-core/src/functions.rs
Normal file
@@ -0,0 +1,49 @@
|
||||
|
||||
pub fn pascal_to_title(s: &str) -> String
|
||||
{
|
||||
let mut out = String::new();
|
||||
|
||||
for (i, ch) in s.chars().enumerate() {
|
||||
if ch.is_uppercase() && i > 0 { out.push(' '); }
|
||||
out.push(ch);
|
||||
}
|
||||
|
||||
out
|
||||
}
|
||||
|
||||
pub fn snake_to_title(s: &str) -> String
|
||||
{
|
||||
s.split('_')
|
||||
.map(|word| {
|
||||
let mut c = word.chars();
|
||||
match c.next() {
|
||||
None => String::new(),
|
||||
Some(f) => f.to_uppercase().collect::<String>() + c.as_str(),
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>()
|
||||
.join(" ")
|
||||
}
|
||||
|
||||
pub fn pascal_to_snake(s: &str) -> String
|
||||
{
|
||||
let mut out = String::with_capacity(s.len());
|
||||
let mut prev_lower = false;
|
||||
|
||||
for c in s.chars()
|
||||
{
|
||||
if c.is_uppercase()
|
||||
{
|
||||
if prev_lower { out.push('_'); }
|
||||
for lc in c.to_lowercase() { out.push(lc); }
|
||||
prev_lower = false;
|
||||
}
|
||||
else
|
||||
{
|
||||
prev_lower = true;
|
||||
out.push(c);
|
||||
}
|
||||
}
|
||||
|
||||
out
|
||||
}
|
||||
20
crates/pmp-core/src/lib.rs
Normal file
20
crates/pmp-core/src/lib.rs
Normal file
@@ -0,0 +1,20 @@
|
||||
//! Shared proc-macro utilities for all `pmp-*` crates.
|
||||
//!
|
||||
//! This crate provides building blocks that are identical across every
|
||||
//! `pmp-*-core` proc-derive-macro crate. Each consumer crate still defines
|
||||
//! its own darling input structs (because `forward_attrs` bakes in a per-crate
|
||||
//! attribute name at compile time), but everything else should be imported from here.
|
||||
//!
|
||||
//! | Module | Contents |
|
||||
//! |-----------|------------------------------------------------------------------|
|
||||
//! | `types` | [`StrictBool`], [`StrictString`], [`StrictPath`], [`StrictExpr`] |
|
||||
//! | `helpers` | [`pascal_to_title`], [`snake_to_title`] |
|
||||
//! | `attr` | [`parse_pmp_attr`], [`parse_pmp_attrs`], [`HasAttrs`] |
|
||||
|
||||
mod attrs;
|
||||
mod types;
|
||||
mod functions;
|
||||
|
||||
pub use attrs::*;
|
||||
pub use types::*;
|
||||
pub use functions::*;
|
||||
85
crates/pmp-core/src/types.rs
Normal file
85
crates/pmp-core/src/types.rs
Normal file
@@ -0,0 +1,85 @@
|
||||
use syn::{ Lit, Path };
|
||||
use darling::{ Error, Result, FromMeta };
|
||||
|
||||
/// A boolean that must be written as `= true` or `= false`
|
||||
#[allow(dead_code)]
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub struct StrictBool(pub bool);
|
||||
|
||||
impl FromMeta for StrictBool
|
||||
{
|
||||
fn from_word() -> Result<Self>
|
||||
{
|
||||
Err(Error::custom(
|
||||
"expected `= true/false`, provide a boolean value"
|
||||
))
|
||||
}
|
||||
|
||||
fn from_value(value: &Lit) -> Result<Self>
|
||||
{
|
||||
match value {
|
||||
Lit::Bool(b) => Ok(StrictBool(b.value)),
|
||||
_ => Err(Error::unexpected_lit_type(value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A string that must be written as `= "..."`
|
||||
#[allow(dead_code)]
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct StrictString(pub String);
|
||||
|
||||
impl FromMeta for StrictString
|
||||
{
|
||||
fn from_word() -> Result<Self>
|
||||
{
|
||||
Err(Error::custom(
|
||||
"expected `= \"...\"`, provide a string value"
|
||||
))
|
||||
}
|
||||
|
||||
fn from_value(value: &Lit) -> Result<Self> {
|
||||
String::from_value(value).map(StrictString)
|
||||
}
|
||||
}
|
||||
|
||||
/// A path that must be written as `= my_fn`
|
||||
#[allow(dead_code)]
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct StrictPath(pub Path);
|
||||
|
||||
impl FromMeta for StrictPath
|
||||
{
|
||||
fn from_word() -> Result<Self>
|
||||
{
|
||||
Err(Error::custom(
|
||||
"expected `= my_fn`, provide a function path"
|
||||
))
|
||||
}
|
||||
|
||||
fn from_value(value: &Lit) -> Result<Self> {
|
||||
Path::from_value(value).map(StrictPath)
|
||||
}
|
||||
|
||||
fn from_expr(expr: &syn::Expr) -> Result<Self> {
|
||||
Path::from_expr(expr).map(StrictPath)
|
||||
}
|
||||
}
|
||||
|
||||
/// A Rust expression that must be written as `= <expr>`
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct StrictExpr(pub syn::Expr);
|
||||
|
||||
impl FromMeta for StrictExpr
|
||||
{
|
||||
fn from_word() -> Result<Self>
|
||||
{
|
||||
Err(Error::custom(
|
||||
"expected `= <expr>`, provide an expression, e.g. `target = Target::CLASS | Target::INTERFACE`"
|
||||
))
|
||||
}
|
||||
|
||||
fn from_expr(expr: &syn::Expr) -> Result<Self> {
|
||||
Ok(StrictExpr(expr.clone()))
|
||||
}
|
||||
}
|
||||
11
crates/pmp-emitter/Cargo.toml
Normal file
11
crates/pmp-emitter/Cargo.toml
Normal file
@@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "pmp-emitter"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[dependencies]
|
||||
pmp-emitter-core = { path = "crates/pmp-emitter-core" }
|
||||
pmp-emitter-misc = { path = "crates/pmp-emitter-misc" }
|
||||
18
crates/pmp-emitter/crates/pmp-emitter-core/Cargo.toml
Normal file
18
crates/pmp-emitter/crates/pmp-emitter-core/Cargo.toml
Normal file
@@ -0,0 +1,18 @@
|
||||
[package]
|
||||
name = "pmp-emitter-core"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[lib]
|
||||
proc-macro = true
|
||||
|
||||
[dependencies]
|
||||
pmp-core = { path = "../../../pmp-core" }
|
||||
|
||||
syn = { version = "^2", features = ["full"] }
|
||||
quote = "^1"
|
||||
darling = "^0"
|
||||
proc-macro2 = "^1"
|
||||
46
crates/pmp-emitter/crates/pmp-emitter-core/src/attrs.rs
Normal file
46
crates/pmp-emitter/crates/pmp-emitter-core/src/attrs.rs
Normal file
@@ -0,0 +1,46 @@
|
||||
use darling::{ ast, FromMeta, FromVariant, FromDeriveInput };
|
||||
use pmp_core::{ StrictBool, StrictPath, StrictString };
|
||||
use syn::{ Type, Ident };
|
||||
|
||||
#[derive(Debug, FromDeriveInput)]
|
||||
#[darling(forward_attrs(pmp_emitter))]
|
||||
pub(crate) struct EmitterInput {
|
||||
pub ident: Ident,
|
||||
pub data: ast::Data<VariantReceiver, ()>,
|
||||
}
|
||||
|
||||
#[derive(Debug, FromVariant)]
|
||||
#[darling(forward_attrs(pmp_emitter))]
|
||||
pub(crate) struct VariantReceiver {
|
||||
pub ident: Ident,
|
||||
pub fields: ast::Fields<Type>,
|
||||
pub attrs: Vec<syn::Attribute>,
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------- //
|
||||
|
||||
/// - `descriptor = "..."` - prefix shown before all variant messages (default: enum name)
|
||||
/// - `exit = true|false` - whether to call process::exit (default: false)
|
||||
/// - `colorizer = fn` - fn(String) -> String applied to all variants unless overridden
|
||||
#[derive(Debug, Default, FromMeta)]
|
||||
pub(crate) struct EnumAttrs {
|
||||
#[darling(default)]
|
||||
pub exit: Option<StrictBool>,
|
||||
#[darling(default)]
|
||||
pub colorizer: Option<StrictPath>,
|
||||
#[darling(default)]
|
||||
pub descriptor: Option<StrictString>,
|
||||
}
|
||||
|
||||
/// - `message = "..."` - error message (default: variant name as title case)
|
||||
/// - `colorizer = fn` - optional fn(String) -> String for formatting
|
||||
/// - `exit = true|false` - overrides enum-level exit
|
||||
#[derive(Debug, Default, FromMeta)]
|
||||
pub(crate) struct VariantAttrs {
|
||||
#[darling(default)]
|
||||
pub exit: Option<StrictBool>,
|
||||
#[darling(default)]
|
||||
pub message: Option<StrictString>,
|
||||
#[darling(default)]
|
||||
pub colorizer: Option<StrictPath>,
|
||||
}
|
||||
103
crates/pmp-emitter/crates/pmp-emitter-core/src/expand.rs
Normal file
103
crates/pmp-emitter/crates/pmp-emitter-core/src/expand.rs
Normal file
@@ -0,0 +1,103 @@
|
||||
use proc_macro2::TokenStream as TokenStream2;
|
||||
use quote::{ quote, quote_spanned };
|
||||
use pmp_core::{ self, StrictPath };
|
||||
use syn::DeriveInput;
|
||||
use darling::ast;
|
||||
|
||||
use crate::attrs::{ EnumAttrs, EmitterInput, VariantAttrs };
|
||||
|
||||
// ---------------------------------------------------------------------------------------------- //
|
||||
|
||||
pub fn expand(shape: EmitterInput, raw_input: &DeriveInput) -> syn::Result<TokenStream2>
|
||||
{
|
||||
let enum_attrs: EnumAttrs = pmp_core::parse_pmp_attr(&raw_input.attrs, "pmp_emitter")?;
|
||||
|
||||
let enum_ident = &shape.ident;
|
||||
let descriptor = enum_attrs.descriptor
|
||||
.map(|s| s.0)
|
||||
.unwrap_or_else(|| pmp_core::pascal_to_title(&enum_ident.to_string()));
|
||||
let global_exit = enum_attrs.exit.map(|b| b.0).unwrap_or(false);
|
||||
let global_colorizer = enum_attrs.colorizer;
|
||||
|
||||
let variants = shape.data.take_enum().ok_or_else(|| {
|
||||
syn::Error::new_spanned(enum_ident, "PmpEmitter can only be derived on enums")
|
||||
})?;
|
||||
|
||||
let mut errors: Option<syn::Error> = None;
|
||||
let mut match_arms: Vec<TokenStream2> = Vec::with_capacity(variants.len());
|
||||
|
||||
for v in &variants
|
||||
{
|
||||
let var_ident = &v.ident;
|
||||
let title = pmp_core::pascal_to_title(&var_ident.to_string());
|
||||
|
||||
let v_attrs: VariantAttrs = match pmp_core::parse_pmp_attr(&v.attrs, "pmp_emitter")
|
||||
{
|
||||
Ok(a) => a,
|
||||
Err(e) =>
|
||||
{
|
||||
match &mut errors {
|
||||
None => errors = Some(e),
|
||||
Some(existing) => existing.combine(e),
|
||||
}
|
||||
continue;
|
||||
}
|
||||
};
|
||||
|
||||
let message = v_attrs.message.map(|s| s.0).unwrap_or_else(|| title.clone());
|
||||
let should_exit = v_attrs.exit.map(|b| b.0).unwrap_or(global_exit);
|
||||
|
||||
let header = format!("{}: {} (\"{}\")", descriptor, title, message);
|
||||
|
||||
let formatted_header = match v_attrs.colorizer.as_ref().or(global_colorizer.as_ref()) {
|
||||
Some(StrictPath(path)) => quote! { #path(#header) },
|
||||
None => quote! { #header.to_string() },
|
||||
};
|
||||
|
||||
let exit_tokens = if should_exit { quote! { std::process::exit(1); } } else { quote! {} };
|
||||
|
||||
let arm = match v.fields.style
|
||||
{
|
||||
ast::Style::Tuple =>
|
||||
{
|
||||
let pattern = if v.fields.len() == 1 { quote! { (trace) } } else { quote! { (trace, ..) } };
|
||||
|
||||
quote_spanned! { var_ident.span() =>
|
||||
#enum_ident::#var_ident #pattern =>
|
||||
{
|
||||
println!("{}\n\n{}", #formatted_header, trace);
|
||||
#exit_tokens
|
||||
}
|
||||
}
|
||||
},
|
||||
_ => quote_spanned! { var_ident.span() =>
|
||||
#enum_ident::#var_ident =>
|
||||
{
|
||||
println!("{}", #formatted_header);
|
||||
#exit_tokens
|
||||
}
|
||||
},
|
||||
};
|
||||
|
||||
match_arms.push(arm);
|
||||
}
|
||||
|
||||
if let Some(e) = errors { return Err(e); }
|
||||
|
||||
Ok(quote!
|
||||
{
|
||||
impl #enum_ident
|
||||
{
|
||||
pub fn emit(&self) {
|
||||
match self { #(#match_arms),* }
|
||||
}
|
||||
}
|
||||
|
||||
impl ::pmp_emitter::pmp_emitter_misc::Emittable for #enum_ident
|
||||
{
|
||||
fn emit(&self) {
|
||||
self.emit()
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
25
crates/pmp-emitter/crates/pmp-emitter-core/src/lib.rs
Normal file
25
crates/pmp-emitter/crates/pmp-emitter-core/src/lib.rs
Normal file
@@ -0,0 +1,25 @@
|
||||
use darling::FromDeriveInput;
|
||||
use proc_macro::TokenStream;
|
||||
use syn::DeriveInput;
|
||||
|
||||
mod attrs;
|
||||
mod expand;
|
||||
|
||||
use attrs::EmitterInput;
|
||||
|
||||
// ---------------------------------------------------------------------------------------------- //
|
||||
|
||||
#[proc_macro_derive(PmpEmitter, attributes(pmp_emitter))]
|
||||
pub fn pmp_emitter(item: TokenStream) -> TokenStream
|
||||
{
|
||||
let input = syn::parse_macro_input!(item as DeriveInput);
|
||||
|
||||
let shape = match EmitterInput::from_derive_input(&input) {
|
||||
Ok(s) => s,
|
||||
Err(e) => return e.write_errors().into(),
|
||||
};
|
||||
|
||||
expand::expand(shape, &input)
|
||||
.unwrap_or_else(syn::Error::into_compile_error)
|
||||
.into()
|
||||
}
|
||||
9
crates/pmp-emitter/crates/pmp-emitter-misc/Cargo.toml
Normal file
9
crates/pmp-emitter/crates/pmp-emitter-misc/Cargo.toml
Normal file
@@ -0,0 +1,9 @@
|
||||
[package]
|
||||
name = "pmp-emitter-misc"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[dependencies]
|
||||
4
crates/pmp-emitter/crates/pmp-emitter-misc/src/lib.rs
Normal file
4
crates/pmp-emitter/crates/pmp-emitter-misc/src/lib.rs
Normal file
@@ -0,0 +1,4 @@
|
||||
|
||||
pub trait Emittable {
|
||||
fn emit(&self);
|
||||
}
|
||||
5
crates/pmp-emitter/src/lib.rs
Normal file
5
crates/pmp-emitter/src/lib.rs
Normal file
@@ -0,0 +1,5 @@
|
||||
#[doc(hidden)]
|
||||
pub extern crate pmp_emitter_misc;
|
||||
|
||||
pub use pmp_emitter_misc::Emittable;
|
||||
pub use pmp_emitter_core::PmpEmitter;
|
||||
11
crates/pmp-macro/Cargo.toml
Normal file
11
crates/pmp-macro/Cargo.toml
Normal file
@@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "pmp-macro"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[dependencies]
|
||||
pmp-macro-core = { path = "crates/pmp-macro-core" }
|
||||
pmp-macro-misc = { path = "crates/pmp-macro-misc" }
|
||||
19
crates/pmp-macro/crates/pmp-macro-core/Cargo.toml
Normal file
19
crates/pmp-macro/crates/pmp-macro-core/Cargo.toml
Normal file
@@ -0,0 +1,19 @@
|
||||
[package]
|
||||
name = "pmp-macro-core"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[lib]
|
||||
proc-macro = true
|
||||
|
||||
[dependencies]
|
||||
pmp-core = { path = "../../../pmp-core" }
|
||||
pmp-macro-misc = { path = "../pmp-macro-misc" }
|
||||
|
||||
syn = { version = "^2", features = ["full"] }
|
||||
quote = "^1"
|
||||
darling = "^0"
|
||||
proc-macro2 = "^1"
|
||||
49
crates/pmp-macro/crates/pmp-macro-core/src/attrs.rs
Normal file
49
crates/pmp-macro/crates/pmp-macro-core/src/attrs.rs
Normal file
@@ -0,0 +1,49 @@
|
||||
use pmp_core::{ StrictBool, StrictExpr, StrictString };
|
||||
use darling::{ ast, FromField, FromDeriveInput };
|
||||
use syn::{ Type, Ident };
|
||||
|
||||
/// - `name = "..."` - PHP attribute name (default: struct name)
|
||||
/// - `target = <expr>` - which PHP constructs may use this attribute (default: Target::ALL)
|
||||
/// - `docs = "..."` - description for diagnostics and generated docs
|
||||
#[derive(Debug, FromDeriveInput)]
|
||||
#[darling(attributes(pmp_macro), forward_attrs(allow, doc, cfg))]
|
||||
pub struct MacroInput {
|
||||
pub ident: Ident,
|
||||
pub data: ast::Data<darling::util::Ignored, FieldInput>,
|
||||
|
||||
#[darling(default)]
|
||||
pub name: Option<StrictString>,
|
||||
#[darling(default)]
|
||||
pub target: Option<StrictExpr>,
|
||||
#[darling(default)]
|
||||
pub docs: Option<StrictString>,
|
||||
}
|
||||
|
||||
/// - `php_type = "..."` - PHP type hint, e.g. `"class-string[]"` (required)
|
||||
/// - `default = "..."` - PHP default value, e.g. `"[]"`
|
||||
/// - `required = bool` - overrides required inference
|
||||
#[derive(Debug, FromField)]
|
||||
#[darling(attributes(param))]
|
||||
pub struct FieldInput {
|
||||
pub ident: Option<Ident>,
|
||||
#[allow(dead_code)]
|
||||
pub ty: Type,
|
||||
|
||||
#[darling(default)]
|
||||
pub php_type: Option<StrictString>,
|
||||
#[darling(default)]
|
||||
pub default: Option<StrictString>,
|
||||
#[darling(default)]
|
||||
pub required: Option<StrictBool>,
|
||||
}
|
||||
|
||||
impl FieldInput
|
||||
{
|
||||
pub fn is_param(&self) -> bool {
|
||||
self.php_type.is_some()
|
||||
}
|
||||
|
||||
pub fn is_required(&self) -> bool {
|
||||
self.required.map(|b| b.0).unwrap_or(self.default.is_none())
|
||||
}
|
||||
}
|
||||
129
crates/pmp-macro/crates/pmp-macro-core/src/expand.rs
Normal file
129
crates/pmp-macro/crates/pmp-macro-core/src/expand.rs
Normal file
@@ -0,0 +1,129 @@
|
||||
use quote::{ format_ident, quote, quote_spanned };
|
||||
use proc_macro2::TokenStream as TokenStream2;
|
||||
|
||||
use crate::attrs::MacroInput;
|
||||
|
||||
fn rewrite_bitor_target_expr(expr: syn::Expr) -> syn::Expr
|
||||
{
|
||||
match expr
|
||||
{
|
||||
syn::Expr::Binary(mut bin) if matches!(bin.op, syn::BinOp::BitOr(_)) => {
|
||||
bin.left = Box::new(rewrite_bitor_target_expr(*bin.left));
|
||||
bin.right = Box::new(rewrite_bitor_target_expr(*bin.right));
|
||||
syn::Expr::Binary(bin)
|
||||
}
|
||||
|
||||
other => {
|
||||
syn::parse_quote! { (#other).bits() }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
pub fn expand(parsed: MacroInput) -> syn::Result<TokenStream2>
|
||||
{
|
||||
let struct_ident = &parsed.ident;
|
||||
|
||||
let fields = parsed.data.take_struct().ok_or_else(|| {
|
||||
syn::Error::new_spanned(struct_ident, "PmpMacro can only be derived for structs")
|
||||
})?;
|
||||
|
||||
let attr_name: String = parsed.name
|
||||
.map(|s| s.0)
|
||||
.unwrap_or_else(|| struct_ident.to_string());
|
||||
|
||||
let target_expr: syn::Expr = parsed.target
|
||||
.map(|e| rewrite_bitor_target_expr(e.0))
|
||||
.unwrap_or_else(|| syn::parse_quote! { ::pmp_macro::Target::ALL.bits() });
|
||||
|
||||
let docs: String = parsed.docs.map(|s| s.0).unwrap_or_default();
|
||||
|
||||
let mut param_tokens: Vec<TokenStream2> = Vec::new();
|
||||
let mut errors: Option<syn::Error> = None;
|
||||
|
||||
for field in fields.iter().filter(|f| f.is_param())
|
||||
{
|
||||
let span = field.ident.as_ref().map(|i| i.span()).unwrap_or_else(|| struct_ident.span());
|
||||
let field_name = field.ident.as_ref().map(|i| i.to_string()).unwrap_or_default();
|
||||
|
||||
let php_type = match &field.php_type
|
||||
{
|
||||
Some(s) => s.0.clone(),
|
||||
None =>
|
||||
{
|
||||
let e = syn::Error::new(
|
||||
span,
|
||||
format!("field `{field_name}` has #[param] but is missing `php_type = \"...\"`"),
|
||||
);
|
||||
match &mut errors {
|
||||
None => errors = Some(e),
|
||||
Some(existing) => existing.combine(e),
|
||||
}
|
||||
continue;
|
||||
}
|
||||
};
|
||||
|
||||
let required = field.is_required();
|
||||
let default_tokens = match field.default.as_ref().map(|s| s.0.as_str()) {
|
||||
Some(d) => quote! { Some(#d) },
|
||||
None => quote! { None },
|
||||
};
|
||||
|
||||
param_tokens.push(quote_spanned! { span =>
|
||||
::pmp_macro::ParamDescriptor {
|
||||
name: #field_name,
|
||||
php_type: #php_type,
|
||||
required: #required,
|
||||
default: #default_tokens,
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if let Some(e) = errors { return Err(e); }
|
||||
|
||||
let snaked_ident = pmp_core::pascal_to_snake(struct_ident.to_string().as_str());
|
||||
let mod_ident = format_ident!("__pmp_macro_impl_{}", snaked_ident);
|
||||
let handler = quote! { super::#struct_ident };
|
||||
|
||||
Ok(quote!
|
||||
{
|
||||
#[doc(hidden)]
|
||||
mod #mod_ident
|
||||
{
|
||||
use ::pmp_macro::{
|
||||
AnalyzeFn, MacroDescriptor, MacroRegistration,
|
||||
ParamDescriptor, Target, TransformFn, PmpMacro,
|
||||
};
|
||||
|
||||
static PARAMS: &[ParamDescriptor] = &[ #(#param_tokens),* ];
|
||||
|
||||
static DESCRIPTOR: MacroDescriptor = MacroDescriptor {
|
||||
name: #attr_name,
|
||||
target_bits: #target_expr,
|
||||
docs: #docs,
|
||||
params: PARAMS,
|
||||
};
|
||||
|
||||
fn analyze(
|
||||
ctx: &::pmp_macro::MacroContext,
|
||||
attr: &::pmp_macro::ResolvedAttr,
|
||||
node: &::pmp_macro::AttributedNode,
|
||||
) -> ::std::vec::Vec<::pmp_macro::Diagnostic>
|
||||
{
|
||||
<#handler as PmpMacro>::analyze(&::std::default::Default::default(), ctx, attr, node)
|
||||
}
|
||||
|
||||
fn transform(
|
||||
ctx: &::pmp_macro::MacroContext,
|
||||
attr: &::pmp_macro::ResolvedAttr,
|
||||
node: &::pmp_macro::AttributedNode,
|
||||
) -> ::std::vec::Vec<::pmp_macro::Rewrite>
|
||||
{
|
||||
<#handler as PmpMacro>::transform(&::std::default::Default::default(), ctx, attr, node)
|
||||
}
|
||||
|
||||
::pmp_macro::inventory::submit! {
|
||||
MacroRegistration::new(&DESCRIPTOR, analyze, transform)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
55
crates/pmp-macro/crates/pmp-macro-core/src/lib.rs
Normal file
55
crates/pmp-macro/crates/pmp-macro-core/src/lib.rs
Normal file
@@ -0,0 +1,55 @@
|
||||
use darling::FromDeriveInput;
|
||||
use proc_macro::TokenStream;
|
||||
use syn::DeriveInput;
|
||||
|
||||
mod attrs;
|
||||
mod expand;
|
||||
|
||||
use attrs::MacroInput;
|
||||
|
||||
/// Derives registration boilerplate for a PHP macro attribute handler.
|
||||
///
|
||||
/// #### Struct-level attributes (`#[pmp_macro(...)]`)
|
||||
///
|
||||
/// | Key | Type | Default | Description |
|
||||
/// |------------|---------------|------------------|----------------------------------------------|
|
||||
/// | `name` | `= "..."` | Struct name | PHP attribute name to match against |
|
||||
/// | `target` | `= <expr>` | `Target::ALL` | Which PHP constructs may use this attribute |
|
||||
/// | `docs` | `= "..."` | `""` | Description for diagnostics and generated docs |
|
||||
///
|
||||
/// #### Field-level attributes (`#[param(...)]`)
|
||||
///
|
||||
/// Fields without `#[param(...)]` are ignored - they are treated as handler
|
||||
/// implementation details, not PHP constructor parameters.
|
||||
///
|
||||
/// | Key | Type | Default | Description |
|
||||
/// |------------|-----------|-------------------|------------------------------------------|
|
||||
/// | `php_type` | `= "..."` | *(required)* | PHP type hint, e.g. `"class-string[]"` |
|
||||
/// | `default` | `= "..."` | `None` | PHP default value, e.g. `"[]"` |
|
||||
/// | `required` | `= bool` | inferred | Overrides required inference |
|
||||
///
|
||||
/// #### What is generated
|
||||
///
|
||||
/// - A hidden module containing a `static MacroDescriptor` and `static [ParamDescriptor]`
|
||||
/// - Two free functions delegating to the handler's `PmpMacro::analyze` / `::transform`
|
||||
/// - An `inventory::submit!` registration wiring it all together
|
||||
///
|
||||
/// #### Requirements
|
||||
///
|
||||
/// - The struct must implement [`pmp_macro_misc::PmpMacro`] (user-written)
|
||||
/// - The struct must implement [`Default`] (needed to construct a handler instance
|
||||
/// inside the generated delegation functions)
|
||||
#[proc_macro_derive(PmpMacro, attributes(pmp_macro, param))]
|
||||
pub fn pmp_macro_derive(item: TokenStream) -> TokenStream
|
||||
{
|
||||
let input = syn::parse_macro_input!(item as DeriveInput);
|
||||
|
||||
let parsed = match MacroInput::from_derive_input(&input) {
|
||||
Ok(p) => p,
|
||||
Err(e) => return e.write_errors().into(),
|
||||
};
|
||||
|
||||
expand::expand(parsed)
|
||||
.unwrap_or_else(syn::Error::into_compile_error)
|
||||
.into()
|
||||
}
|
||||
11
crates/pmp-macro/crates/pmp-macro-misc/Cargo.toml
Normal file
11
crates/pmp-macro/crates/pmp-macro-misc/Cargo.toml
Normal file
@@ -0,0 +1,11 @@
|
||||
[package]
|
||||
name = "pmp-macro-misc"
|
||||
version = "1.0.0"
|
||||
|
||||
edition.workspace = true
|
||||
authors.workspace = true
|
||||
license-file.workspace = true
|
||||
|
||||
[dependencies]
|
||||
bitflags = "^2"
|
||||
inventory = "^0"
|
||||
45
crates/pmp-macro/crates/pmp-macro-misc/src/context.rs
Normal file
45
crates/pmp-macro/crates/pmp-macro-misc/src/context.rs
Normal file
@@ -0,0 +1,45 @@
|
||||
// ---------------------------------------------------------------------------------------------- //
|
||||
// Mago-facing placeholders //
|
||||
// //
|
||||
// These types will wrap or re-export mago's AST / symbol / source types once the //
|
||||
// integration surface is understood. For now they are empty structs so the trait //
|
||||
// and derive can be written against concrete type names without a mago dependency. //
|
||||
// ---------------------------------------------------------------------------------------------- //
|
||||
|
||||
/// Global preprocessor state passed to every handler invocation.
|
||||
///
|
||||
/// Will hold references to mago's parsed file set, resolved symbol table,
|
||||
/// and any cross-file index needed for macros like `#[Sealed]` that must
|
||||
/// scan the entire project.
|
||||
///
|
||||
/// TODO: replace with real mago types.
|
||||
#[non_exhaustive]
|
||||
pub struct MacroContext;
|
||||
|
||||
/// The PHP AST node that carries the attribute being processed, together
|
||||
/// with the specific attribute instance (which macro it is, its position).
|
||||
///
|
||||
/// TODO: replace with real mago node types.
|
||||
#[non_exhaustive]
|
||||
pub struct AttributedNode;
|
||||
|
||||
/// The parsed and type-resolved arguments supplied to the attribute.
|
||||
///
|
||||
/// e.g. for `#[Sealed([Success::class, Failure::class])]` this would
|
||||
/// expose the two resolved class names as typed Rust values.
|
||||
///
|
||||
/// TODO: replace with real resolved argument types.
|
||||
#[non_exhaustive]
|
||||
pub struct ResolvedAttr;
|
||||
|
||||
/// A single source-level diagnostic emitted by a macro handler.
|
||||
///
|
||||
/// TODO: decide between a custom type or wrapping mago's / miette's diagnostic type.
|
||||
#[non_exhaustive]
|
||||
pub struct Diagnostic;
|
||||
|
||||
/// A rewrite instruction produced by `PmpMacro::transform`.
|
||||
///
|
||||
/// TODO: decide between text-span replacement or typed AST mutation depending on what mago exposes.
|
||||
#[non_exhaustive]
|
||||
pub struct Rewrite;
|
||||
26
crates/pmp-macro/crates/pmp-macro-misc/src/descriptor.rs
Normal file
26
crates/pmp-macro/crates/pmp-macro-misc/src/descriptor.rs
Normal file
@@ -0,0 +1,26 @@
|
||||
use crate::target::Target;
|
||||
|
||||
#[derive(Debug, Clone, Copy)]
|
||||
pub struct ParamDescriptor {
|
||||
pub name: &'static str,
|
||||
pub php_type: &'static str,
|
||||
pub required: bool,
|
||||
pub default: Option<&'static str>,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct MacroDescriptor {
|
||||
pub name: &'static str,
|
||||
/// Raw bitflags value - use `.target()` to get a `Target`.
|
||||
/// Stored as `u16` so the static initializer remains `const`.
|
||||
pub target_bits: u16,
|
||||
pub docs: &'static str,
|
||||
pub params: &'static [ParamDescriptor],
|
||||
}
|
||||
|
||||
impl MacroDescriptor
|
||||
{
|
||||
pub fn target(&self) -> Target {
|
||||
Target::from_bits_truncate(self.target_bits)
|
||||
}
|
||||
}
|
||||
23
crates/pmp-macro/crates/pmp-macro-misc/src/lib.rs
Normal file
23
crates/pmp-macro/crates/pmp-macro-misc/src/lib.rs
Normal file
@@ -0,0 +1,23 @@
|
||||
//! Shared types, traits, and registration machinery for `pmp-macro`.
|
||||
//!
|
||||
//! # Crate layout
|
||||
//!
|
||||
//! | Module | Contents |
|
||||
//! |--------------|-----------------------------------------------------------------|
|
||||
//! | `target` | [`Target`] bitflags for PHP attribute target sites |
|
||||
//! | `descriptor` | [`MacroDescriptor`] and [`ParamDescriptor`] - static metadata |
|
||||
//! | `context` | [`MacroContext`], [`AttributedNode`], [`ResolvedAttr`], etc. |
|
||||
//! | `traits` | [`PmpMacro`] trait, [`MacroRegistration`], [`MacroRegistry`] |
|
||||
|
||||
mod target;
|
||||
mod traits;
|
||||
mod context;
|
||||
mod descriptor;
|
||||
|
||||
#[doc(hidden)]
|
||||
pub use inventory;
|
||||
|
||||
pub use target::*;
|
||||
pub use traits::*;
|
||||
pub use context::*;
|
||||
pub use descriptor::*;
|
||||
75
crates/pmp-macro/crates/pmp-macro-misc/src/target.rs
Normal file
75
crates/pmp-macro/crates/pmp-macro-misc/src/target.rs
Normal file
@@ -0,0 +1,75 @@
|
||||
use std::fmt::{ Display, Formatter };
|
||||
use bitflags::bitflags;
|
||||
|
||||
bitflags!
|
||||
{
|
||||
/// The PHP construct(s) that a macro attribute is permitted to annotate.
|
||||
///
|
||||
/// Mirrors PHP's `Attribute::TARGET_*` constants. A macro may target
|
||||
/// multiple sites by OR-ing flags together:
|
||||
///
|
||||
/// ```
|
||||
/// let target = Target::CLASS | Target::INTERFACE;
|
||||
/// ```
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct Target: u16
|
||||
{
|
||||
const CLASS = 1 << 0;
|
||||
const INTERFACE = 1 << 1;
|
||||
const TRAIT = 1 << 2;
|
||||
const ENUM = 1 << 3;
|
||||
const METHOD = 1 << 4;
|
||||
const FUNCTION = 1 << 5;
|
||||
const PROPERTY = 1 << 6;
|
||||
const CONSTANT = 1 << 7;
|
||||
const PARAMETER = 1 << 8;
|
||||
|
||||
/// Convenience: any class-like construct.
|
||||
const ANY_CLASS_LIKE = Self::CLASS.bits()
|
||||
| Self::INTERFACE.bits()
|
||||
| Self::TRAIT.bits()
|
||||
| Self::ENUM.bits();
|
||||
|
||||
/// Convenience: any callable construct.
|
||||
const ANY_CALLABLE = Self::METHOD.bits()
|
||||
| Self::FUNCTION.bits();
|
||||
|
||||
/// Convenience: all targets.
|
||||
const ALL = u16::MAX;
|
||||
}
|
||||
}
|
||||
|
||||
impl Display for Target
|
||||
{
|
||||
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result
|
||||
{
|
||||
let mut first = true;
|
||||
|
||||
macro_rules! write_flag
|
||||
{
|
||||
($flag:ident) =>
|
||||
{
|
||||
if self.contains(Target::$flag)
|
||||
{
|
||||
if !first { write!(f, " | ")?; }
|
||||
write!(f, "Target::{}", stringify!($flag))?;
|
||||
first = false;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
write_flag!(CLASS);
|
||||
write_flag!(INTERFACE);
|
||||
write_flag!(TRAIT);
|
||||
write_flag!(ENUM);
|
||||
write_flag!(METHOD);
|
||||
write_flag!(FUNCTION);
|
||||
write_flag!(PROPERTY);
|
||||
write_flag!(CONSTANT);
|
||||
write_flag!(PARAMETER);
|
||||
|
||||
if first { write!(f, "Target::ALL")?; }
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
146
crates/pmp-macro/crates/pmp-macro-misc/src/traits.rs
Normal file
146
crates/pmp-macro/crates/pmp-macro-misc/src/traits.rs
Normal file
@@ -0,0 +1,146 @@
|
||||
use std::{
|
||||
sync::OnceLock,
|
||||
collections::HashMap
|
||||
};
|
||||
|
||||
use crate::{
|
||||
descriptor::MacroDescriptor,
|
||||
context::{ Rewrite, Diagnostic, ResolvedAttr, MacroContext, AttributedNode }
|
||||
};
|
||||
|
||||
// --------------------------------------------------------------------------------------------- //
|
||||
|
||||
/// The handler trait implemented by each PHP macro attribute struct.
|
||||
///
|
||||
/// The two handler methods have default no-op
|
||||
/// implementations so that analysis-only and transform-only macros only need
|
||||
/// to override what they actually do.
|
||||
///
|
||||
/// The trait is object-safe (`&self`, no generics), so the registry can store
|
||||
/// `Box<dyn PmpMacro>` without knowing concrete types.
|
||||
pub trait PmpMacro: Send + Sync
|
||||
{
|
||||
/// Analyse the attributed PHP node and emit diagnostics.
|
||||
///
|
||||
/// Called during the analysis pass. Returning an empty `Vec` means no
|
||||
/// issues were found. The default implementation is a no-op.
|
||||
#[allow(unused_variables)]
|
||||
fn analyze(
|
||||
&self,
|
||||
ctx: &MacroContext,
|
||||
attr: &ResolvedAttr,
|
||||
node: &AttributedNode,
|
||||
) -> Vec<Diagnostic> { vec![] }
|
||||
|
||||
/// Produce rewrite instructions for the attributed PHP node.
|
||||
///
|
||||
/// Called during the transform pass, after all analysis is complete.
|
||||
/// The default implementation is a no-op.
|
||||
#[allow(unused_variables)]
|
||||
fn transform(
|
||||
&self,
|
||||
ctx: &MacroContext,
|
||||
attr: &ResolvedAttr,
|
||||
node: &AttributedNode,
|
||||
) -> Vec<Rewrite> { vec![] }
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------------------------------- //
|
||||
|
||||
/// Type alias for the analyze handler function pointer.
|
||||
pub type AnalyzeFn = fn(&MacroContext, &ResolvedAttr, &AttributedNode) -> Vec<Diagnostic>;
|
||||
/// Type alias for the transform handler function pointer.
|
||||
pub type TransformFn = fn(&MacroContext, &ResolvedAttr, &AttributedNode) -> Vec<Rewrite>;
|
||||
|
||||
/// An entry in the global macro registry, submitted via `inventory::submit!`.
|
||||
///
|
||||
/// Stores static metadata alongside fn pointers that delegate to the
|
||||
/// handler struct's `PmpMacro` impl, avoiding the need for `dyn` dispatch.
|
||||
///
|
||||
/// Generated via `#[derive(PmpMacro)]`
|
||||
pub struct MacroRegistration {
|
||||
/// Static metadata for this macro — attribute name, targets, params, docs.
|
||||
pub descriptor: &'static MacroDescriptor,
|
||||
/// Delegates to `<Handler as PmpMacro>::analyze`.
|
||||
pub analyze: AnalyzeFn,
|
||||
/// Delegates to `<Handler as PmpMacro>::transform`.
|
||||
pub transform: TransformFn,
|
||||
}
|
||||
|
||||
impl MacroRegistration
|
||||
{
|
||||
pub const fn new(
|
||||
descriptor: &'static MacroDescriptor,
|
||||
analyze: AnalyzeFn,
|
||||
transform: TransformFn,
|
||||
) -> Self
|
||||
{
|
||||
Self { descriptor, analyze, transform }
|
||||
}
|
||||
}
|
||||
|
||||
inventory::collect!(MacroRegistration);
|
||||
|
||||
// --------------------------------------------------------------------------------------------- //
|
||||
|
||||
/// Validated, deduplicated view of the global macro registry.
|
||||
/// Built once on first access via [`registry()`] and cached for the process lifetime.
|
||||
pub struct MacroRegistry {
|
||||
/// Handlers keyed by attribute name for O(1) lookup during processing.
|
||||
handlers: HashMap<&'static str, &'static MacroRegistration>,
|
||||
}
|
||||
|
||||
static REGISTRY: OnceLock<MacroRegistry> = OnceLock::new();
|
||||
|
||||
impl MacroRegistry
|
||||
{
|
||||
/// Returns the global macro registry, validating and building it on first call.
|
||||
///
|
||||
/// Deduplication is checked here — if two macros share the same attribute name
|
||||
/// this will panic with a descriptive message. Subsequent calls are free
|
||||
/// (just an atomic load from the `OnceLock`).
|
||||
///
|
||||
/// This is the only intended way to access registered macros. Direct use of
|
||||
/// `inventory::iter::<MacroRegistration>` bypasses dedup and should be avoided.
|
||||
pub fn registry() -> &'static MacroRegistry {
|
||||
REGISTRY.get_or_init(MacroRegistry::build)
|
||||
}
|
||||
|
||||
fn build() -> Self
|
||||
{
|
||||
let mut handlers: HashMap<&'static str, &'static MacroRegistration> = HashMap::new();
|
||||
|
||||
for reg in inventory::iter::<MacroRegistration>
|
||||
{
|
||||
let name = reg.descriptor.name;
|
||||
|
||||
if handlers.insert(name, reg).is_some() {
|
||||
panic!(
|
||||
"duplicate PmpMacro registration: attribute name \"{name}\" is \
|
||||
registered more than once - check your macro definitions"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
Self { handlers }
|
||||
}
|
||||
|
||||
/// Look up a registered macro by its PHP attribute name.
|
||||
pub fn get(&self, name: &str) -> Option<&'static MacroRegistration> {
|
||||
self.handlers.get(name).copied()
|
||||
}
|
||||
|
||||
/// Iterate over all registered macros.
|
||||
pub fn iter(&self) -> impl Iterator<Item = &'static MacroRegistration> {
|
||||
self.handlers.values().copied()
|
||||
}
|
||||
|
||||
/// The number of registered macros.
|
||||
pub fn len(&self) -> usize {
|
||||
self.handlers.len()
|
||||
}
|
||||
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.handlers.is_empty()
|
||||
}
|
||||
}
|
||||
5
crates/pmp-macro/src/lib.rs
Normal file
5
crates/pmp-macro/src/lib.rs
Normal file
@@ -0,0 +1,5 @@
|
||||
#[doc(hidden)]
|
||||
pub extern crate pmp_macro_misc;
|
||||
|
||||
pub use pmp_macro_misc::*;
|
||||
pub use pmp_macro_core::*;
|
||||
0
src/cli/notifications.rs
Normal file
0
src/cli/notifications.rs
Normal file
Reference in New Issue
Block a user