initial commit
This commit is contained in:
commit
a321bfe7b2
|
@ -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,65 @@
|
|||
# JSON parsing library
|
||||
|
||||
This library is an marshaler/unmarshaler for JSON in a tree of nodes. Also allows you to make queries over these trees.
|
||||
|
||||
## Library interface
|
||||
|
||||
```go
|
||||
package json // import "go.neonxp.dev/json"
|
||||
|
||||
// Marshal Node tree to []byte
|
||||
func Marshal(node *model.Node) ([]byte, error)
|
||||
|
||||
// Unmarshal data to Node tree
|
||||
func Unmarshal(data []byte) (*model.Node, error)
|
||||
|
||||
// Query returns node by query string (dot notation)
|
||||
func Query(json string, query string) (*model.Node, error)
|
||||
|
||||
// QueryArray returns node by array query
|
||||
func QueryArray(json string, query []string) (*model.Node, error)
|
||||
```
|
||||
|
||||
## Node methods
|
||||
|
||||
```go
|
||||
package model // import "go.neonxp.dev/json/model"
|
||||
|
||||
// Node of JSON tree
|
||||
type Node struct {
|
||||
Type NodeType
|
||||
}
|
||||
|
||||
// NewNode creates new node from value
|
||||
func NewNode(value any) *Node
|
||||
|
||||
// Get node from object by key
|
||||
func (n *Node) Get(key string) (*Node, error)
|
||||
|
||||
// Index returns node by index from array
|
||||
func (n *Node) Index(idx int) (*Node, error)
|
||||
|
||||
// Set node to object by key
|
||||
func (n *Node) Set(key string, value *Node) error
|
||||
|
||||
// SetIndex sets node to array by index
|
||||
func (n *Node) SetIndex(idx int, value *Node) error
|
||||
|
||||
// SetValue to node
|
||||
func (n *Node) SetValue(value any)
|
||||
|
||||
// Map callback to each key value pair of object
|
||||
func (n *Node) Map(cb func(key string, value *Node) (*Node, error)) error
|
||||
|
||||
// Each applies callback to each element of array
|
||||
func (n *Node) Each(cb func(idx int, value *Node) error) error
|
||||
|
||||
// Query returns node by array query
|
||||
func (n *Node) Query(query []string) (*Node, error)
|
||||
|
||||
// Value returns value of node
|
||||
func (n *Node) Value() any
|
||||
|
||||
// MarshalJSON to []byte
|
||||
func (n *Node) MarshalJSON() ([]byte, error)
|
||||
```
|
|
@ -0,0 +1,36 @@
|
|||
package json
|
||||
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"go.neonxp.dev/json/model"
|
||||
"go.neonxp.dev/json/parser"
|
||||
)
|
||||
|
||||
// Marshal Node tree to []byte
|
||||
func Marshal(node *model.Node) ([]byte, error) {
|
||||
return node.MarshalJSON()
|
||||
}
|
||||
|
||||
// Unmarshal data to Node tree
|
||||
func Unmarshal(data []byte) (*model.Node, error) {
|
||||
return parser.Parse(string(data))
|
||||
}
|
||||
|
||||
// Query returns node by query string (dot notation)
|
||||
func Query(json string, query string) (*model.Node, error) {
|
||||
n, err := parser.Parse(json)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return n.Query(strings.Split(query, "."))
|
||||
}
|
||||
|
||||
// QueryArray returns node by array query
|
||||
func QueryArray(json string, query []string) (*model.Node, error) {
|
||||
n, err := parser.Parse(json)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return n.Query(query)
|
||||
}
|
|
@ -0,0 +1,67 @@
|
|||
package json
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"go.neonxp.dev/json/model"
|
||||
)
|
||||
|
||||
func TestQuery(t *testing.T) {
|
||||
type args struct {
|
||||
json string
|
||||
query string
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
want *model.Node
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "Complex",
|
||||
args: args{
|
||||
json: `{
|
||||
"key1": "value1",
|
||||
"key2": [
|
||||
"item 1",
|
||||
"item 2",
|
||||
"item 3",
|
||||
"item 4",
|
||||
"item 5",
|
||||
"item 6",
|
||||
{
|
||||
"status": "invalid"
|
||||
},
|
||||
{
|
||||
"status": "valid",
|
||||
"embededArray": [
|
||||
"not target",
|
||||
"not target",
|
||||
"not target",
|
||||
"target",
|
||||
"not target",
|
||||
"not target",
|
||||
]
|
||||
}
|
||||
]
|
||||
}`,
|
||||
query: "key2.7.embededArray.3",
|
||||
},
|
||||
want: model.NewNode("target"),
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := Query(tt.args.json, tt.args.query)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("Query() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("Query() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
|
@ -0,0 +1,32 @@
|
|||
package model
|
||||
|
||||
import "fmt"
|
||||
|
||||
// Index returns node by index from array
|
||||
func (n *Node) Index(idx int) (*Node, error) {
|
||||
arrlen := len(n.arrayValue)
|
||||
if idx >= arrlen {
|
||||
return nil, fmt.Errorf("index %d out of range (len=%d)", idx, arrlen)
|
||||
}
|
||||
return n.arrayValue[idx], nil
|
||||
}
|
||||
|
||||
// SetIndex sets node to array by index
|
||||
func (n *Node) SetIndex(idx int, value *Node) error {
|
||||
arrlen := len(n.arrayValue)
|
||||
if idx >= arrlen {
|
||||
return fmt.Errorf("index %d out of range (len=%d)", idx, arrlen)
|
||||
}
|
||||
n.arrayValue[idx] = value
|
||||
return nil
|
||||
}
|
||||
|
||||
// Each applies callback to each element of array
|
||||
func (n *Node) Each(cb func(idx int, value *Node) error) error {
|
||||
for i, v := range n.arrayValue {
|
||||
if err := cb(i, v); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
|
@ -0,0 +1,43 @@
|
|||
package model
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Get node from object by key
|
||||
func (n *Node) Get(key string) (*Node, error) {
|
||||
if n.Type != ObjectNode {
|
||||
return nil, fmt.Errorf("node must be object, got %s", n.Type)
|
||||
}
|
||||
node, ok := n.objectValue[key]
|
||||
if !ok {
|
||||
keys := make([]string, 0, len(n.objectValue))
|
||||
for k := range n.objectValue {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
return nil, fmt.Errorf("field '%s' does not exist in object (keys %s)", key, strings.Join(keys, ", "))
|
||||
}
|
||||
return node, nil
|
||||
}
|
||||
|
||||
// Set node to object by key
|
||||
func (n *Node) Set(key string, value *Node) error {
|
||||
if n.Type != ObjectNode {
|
||||
return fmt.Errorf("node must be object, got %s", n.Type)
|
||||
}
|
||||
n.objectValue[key] = value
|
||||
return nil
|
||||
}
|
||||
|
||||
// Map callback to each key value pair of object
|
||||
func (n *Node) Map(cb func(key string, value *Node) (*Node, error)) error {
|
||||
for k, v := range n.objectValue {
|
||||
newNode, err := cb(k, v)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
n.objectValue[k] = newNode
|
||||
}
|
||||
return nil
|
||||
}
|
|
@ -0,0 +1,115 @@
|
|||
package model
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
// Node of JSON tree
|
||||
type Node struct {
|
||||
Type NodeType
|
||||
stringValue string
|
||||
numberValue float64
|
||||
objectValue NodeObjectValue
|
||||
arrayValue NodeArrayValue
|
||||
booleanValue bool
|
||||
}
|
||||
|
||||
// NewNode creates new node from value
|
||||
func NewNode(value any) *Node {
|
||||
n := new(Node)
|
||||
n.SetValue(value)
|
||||
return n
|
||||
}
|
||||
|
||||
// Value returns value of node
|
||||
func (n *Node) Value() any {
|
||||
switch n.Type {
|
||||
case StringNode:
|
||||
return n.stringValue
|
||||
case NumberNode:
|
||||
return n.numberValue
|
||||
case ObjectNode:
|
||||
return n.objectValue
|
||||
case ArrayNode:
|
||||
return n.arrayValue
|
||||
case BooleanNode:
|
||||
return n.booleanValue
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
// SetValue to node
|
||||
func (n *Node) SetValue(value any) {
|
||||
switch value := value.(type) {
|
||||
case string:
|
||||
n.Type = StringNode
|
||||
n.stringValue = value
|
||||
case float64:
|
||||
n.Type = NumberNode
|
||||
n.numberValue = value
|
||||
case int:
|
||||
n.Type = NumberNode
|
||||
n.numberValue = float64(value)
|
||||
case NodeObjectValue:
|
||||
n.Type = ObjectNode
|
||||
n.objectValue = value
|
||||
case NodeArrayValue:
|
||||
n.Type = ArrayNode
|
||||
n.arrayValue = value
|
||||
case bool:
|
||||
n.Type = BooleanNode
|
||||
n.booleanValue = value
|
||||
default:
|
||||
n.Type = NullNode
|
||||
}
|
||||
}
|
||||
|
||||
// MarshalJSON to []byte
|
||||
func (n *Node) MarshalJSON() ([]byte, error) {
|
||||
switch n.Type {
|
||||
case StringNode:
|
||||
return []byte(`"` + n.stringValue + `"`), nil
|
||||
case NumberNode:
|
||||
return []byte(strconv.FormatFloat(n.numberValue, 'g', -1, 64)), nil
|
||||
case ObjectNode:
|
||||
result := make([][]byte, 0, len(n.objectValue))
|
||||
for k, v := range n.objectValue {
|
||||
b, err := v.MarshalJSON()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result = append(result, []byte(fmt.Sprintf("\"%s\": %s", k, b)))
|
||||
}
|
||||
return bytes.Join(
|
||||
[][]byte{
|
||||
[]byte("{"),
|
||||
bytes.Join(result, []byte(", ")),
|
||||
[]byte("}"),
|
||||
}, []byte("")), nil
|
||||
case ArrayNode:
|
||||
result := make([][]byte, 0, len(n.arrayValue))
|
||||
for _, v := range n.arrayValue {
|
||||
b, err := v.MarshalJSON()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result = append(result, b)
|
||||
}
|
||||
return bytes.Join(
|
||||
[][]byte{
|
||||
[]byte("["),
|
||||
bytes.Join(result, []byte(", ")),
|
||||
[]byte("]"),
|
||||
}, []byte("")), nil
|
||||
case BooleanNode:
|
||||
if n.booleanValue {
|
||||
return []byte("true"), nil
|
||||
}
|
||||
return []byte("false"), nil
|
||||
default:
|
||||
return []byte("null"), nil
|
||||
}
|
||||
}
|
|
@ -0,0 +1,108 @@
|
|||
package model
|
||||
|
||||
import (
|
||||
stdJSON "encoding/json"
|
||||
"reflect"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNode_MarshalJSON(t *testing.T) {
|
||||
type fields struct {
|
||||
node *Node
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
want []byte
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "empty",
|
||||
fields: fields{
|
||||
node: NewNode(nil),
|
||||
},
|
||||
want: []byte(`null`),
|
||||
},
|
||||
{
|
||||
name: "string",
|
||||
fields: fields{
|
||||
node: NewNode("this is a string"),
|
||||
},
|
||||
want: []byte(`"this is a string"`),
|
||||
},
|
||||
{
|
||||
name: "int",
|
||||
fields: fields{
|
||||
node: NewNode(123),
|
||||
},
|
||||
want: []byte(`123`),
|
||||
},
|
||||
{
|
||||
name: "float",
|
||||
fields: fields{
|
||||
node: NewNode(123.321),
|
||||
},
|
||||
want: []byte(`123.321`),
|
||||
},
|
||||
{
|
||||
name: "booleant",
|
||||
fields: fields{
|
||||
node: NewNode(true),
|
||||
},
|
||||
want: []byte(`true`),
|
||||
},
|
||||
{
|
||||
name: "booleanf",
|
||||
fields: fields{
|
||||
node: NewNode(false),
|
||||
},
|
||||
want: []byte(`false`),
|
||||
},
|
||||
{
|
||||
name: "complex",
|
||||
fields: fields{
|
||||
node: NewNode(
|
||||
NodeObjectValue{
|
||||
"string key": NewNode("string value"),
|
||||
"number key": NewNode(1337),
|
||||
"float key": NewNode(123.3),
|
||||
"object key": NewNode(NodeObjectValue{
|
||||
"ab": NewNode("cd"),
|
||||
}),
|
||||
"array key": NewNode(NodeArrayValue{
|
||||
NewNode(1), NewNode(2), NewNode("three"),
|
||||
}),
|
||||
"boolean key": NewNode(true),
|
||||
"null key": NewNode(nil),
|
||||
},
|
||||
),
|
||||
},
|
||||
want: []byte(
|
||||
`{"string key": "string value", "number key": 1337, "float key": 123.3, "object key": {"ab": "cd"}, "array key": [1, 2, "three"], "boolean key": true, "null key": null}`,
|
||||
),
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
var (
|
||||
gotObj any
|
||||
wantObj any
|
||||
)
|
||||
|
||||
got, err := tt.fields.node.MarshalJSON()
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("Node.MarshalJSON() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
err = stdJSON.Unmarshal(got, &gotObj) // TODO use own unmarshaller
|
||||
if err != nil {
|
||||
t.Errorf("Generated invalid json = %s, error = %v", got, err)
|
||||
}
|
||||
_ = stdJSON.Unmarshal(tt.want, &wantObj) // I belive, test is correct
|
||||
if !reflect.DeepEqual(gotObj, wantObj) {
|
||||
t.Errorf("Node.MarshalJSON() = %s, want %s", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
|
@ -0,0 +1,33 @@
|
|||
package model
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
// Query returns node by array query
|
||||
func (n *Node) Query(query []string) (*Node, error) {
|
||||
if len(query) == 0 {
|
||||
return n, nil
|
||||
}
|
||||
head, rest := query[0], query[1:]
|
||||
switch n.Type {
|
||||
case ArrayNode:
|
||||
idx, err := strconv.Atoi(head)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("index must be a number, got %s", head)
|
||||
}
|
||||
next, err := n.Index(idx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return next.Query(rest)
|
||||
case ObjectNode:
|
||||
next, err := n.Get(head)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return next.Query(rest)
|
||||
}
|
||||
return nil, fmt.Errorf("can't get %s from node type %s", head, n.Type)
|
||||
}
|
|
@ -0,0 +1,20 @@
|
|||
package model
|
||||
|
||||
type NodeType string
|
||||
|
||||
const (
|
||||
StringNode NodeType = "string"
|
||||
NumberNode NodeType = "number"
|
||||
ObjectNode NodeType = "object"
|
||||
ArrayNode NodeType = "array"
|
||||
BooleanNode NodeType = "boolean"
|
||||
NullNode NodeType = "null"
|
||||
)
|
||||
|
||||
type NodeObjectValue map[string]*Node
|
||||
|
||||
func (n NodeObjectValue) Set(k string, v any) {
|
||||
n[k] = NewNode(v)
|
||||
}
|
||||
|
||||
type NodeArrayValue []*Node
|
|
@ -0,0 +1,181 @@
|
|||
package parser
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
"unicode/utf8"
|
||||
)
|
||||
|
||||
const eof rune = -1
|
||||
|
||||
type lexem struct {
|
||||
Type lexType // Type of Lexem.
|
||||
Value string // Value of Lexem.
|
||||
Start int // Start position at input string.
|
||||
End int // End position at input string.
|
||||
}
|
||||
|
||||
type lexType int
|
||||
|
||||
const (
|
||||
lEOF lexType = iota
|
||||
lError
|
||||
lObjectStart
|
||||
lObjectEnd
|
||||
lObjectKey
|
||||
lObjectValue
|
||||
lArrayStart
|
||||
lArrayEnd
|
||||
lString
|
||||
lNumber
|
||||
lBoolean
|
||||
lNull
|
||||
)
|
||||
|
||||
// lexer holds current scanner state.
|
||||
type lexer struct {
|
||||
Input string // Input string.
|
||||
Start int // Start position of current lexem.
|
||||
Pos int // Pos at input string.
|
||||
Output chan lexem // Lexems channel.
|
||||
width int // Width of last rune.
|
||||
states stateStack // Stack of states to realize PrevState.
|
||||
}
|
||||
|
||||
// newLexer returns new scanner for input string.
|
||||
func newLexer(input string) *lexer {
|
||||
return &lexer{
|
||||
Input: input,
|
||||
Start: 0,
|
||||
Pos: 0,
|
||||
Output: make(chan lexem, 2),
|
||||
width: 0,
|
||||
}
|
||||
}
|
||||
|
||||
// Run lexing.
|
||||
func (l *lexer) Run(init stateFunc) {
|
||||
for state := init; state != nil; {
|
||||
state = state(l)
|
||||
}
|
||||
close(l.Output)
|
||||
}
|
||||
|
||||
// PopState returns previous state function.
|
||||
func (l *lexer) PopState() stateFunc {
|
||||
return l.states.Pop()
|
||||
}
|
||||
|
||||
// PushState pushes state before going deeper states.
|
||||
func (l *lexer) PushState(s stateFunc) {
|
||||
l.states.Push(s)
|
||||
}
|
||||
|
||||
// Emit current lexem to output.
|
||||
func (l *lexer) Emit(typ lexType) {
|
||||
l.Output <- lexem{
|
||||
Type: typ,
|
||||
Value: l.Input[l.Start:l.Pos],
|
||||
Start: l.Start,
|
||||
End: l.Pos,
|
||||
}
|
||||
l.Start = l.Pos
|
||||
}
|
||||
|
||||
// Errorf produces error lexem and stops scanning.
|
||||
func (l *lexer) Errorf(format string, args ...interface{}) stateFunc {
|
||||
l.Output <- lexem{
|
||||
Type: lError,
|
||||
Value: fmt.Sprintf(format, args...),
|
||||
Start: l.Start,
|
||||
End: l.Pos,
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Next rune from input.
|
||||
func (l *lexer) Next() (r rune) {
|
||||
if int(l.Pos) >= len(l.Input) {
|
||||
l.width = 0
|
||||
return eof
|
||||
}
|
||||
r, l.width = utf8.DecodeRuneInString(l.Input[l.Pos:])
|
||||
l.Pos += l.width
|
||||
return r
|
||||
}
|
||||
|
||||
// Back move position to previos rune.
|
||||
func (l *lexer) Back() {
|
||||
l.Pos -= l.width
|
||||
}
|
||||
|
||||
// Ignore previosly buffered text.
|
||||
func (l *lexer) Ignore() {
|
||||
l.Start = l.Pos
|
||||
l.width = 0
|
||||
}
|
||||
|
||||
// Peek rune at current position without moving position.
|
||||
func (l *lexer) Peek() (r rune) {
|
||||
r = l.Next()
|
||||
l.Back()
|
||||
return r
|
||||
}
|
||||
|
||||
// Accept any rune from valid string. Returns true if Next rune was in valid string.
|
||||
func (l *lexer) Accept(valid string) bool {
|
||||
if strings.ContainsRune(valid, l.Next()) {
|
||||
return true
|
||||
}
|
||||
l.Back()
|
||||
return false
|
||||
}
|
||||
|
||||
// AcceptString returns true if given string was at position.
|
||||
func (l *lexer) AcceptString(s string, caseInsentive bool) bool {
|
||||
input := l.Input[l.Start:]
|
||||
if caseInsentive {
|
||||
input = strings.ToLower(input)
|
||||
s = strings.ToLower(s)
|
||||
}
|
||||
if strings.HasPrefix(input, s) {
|
||||
l.width = 0
|
||||
l.Pos += len(s)
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// AcceptAnyOf substrings. Retuns true if any of substrings was found.
|
||||
func (l *lexer) AcceptAnyOf(s []string, caseInsentive bool) bool {
|
||||
for _, substring := range s {
|
||||
if l.AcceptString(substring, caseInsentive) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// AcceptWhile passing symbols from input while they at `valid` string.
|
||||
func (l *lexer) AcceptWhile(valid string) bool {
|
||||
isValid := false
|
||||
for l.Accept(valid) {
|
||||
isValid = true
|
||||
}
|
||||
return isValid
|
||||
}
|
||||
|
||||
// AcceptWhileNot passing symbols from input while they NOT in `invalid` string.
|
||||
func (l *lexer) AcceptWhileNot(invalid string) bool {
|
||||
isValid := false
|
||||
for !strings.ContainsRune(invalid, l.Next()) {
|
||||
isValid = true
|
||||
}
|
||||
l.Back()
|
||||
return isValid
|
||||
}
|
||||
|
||||
// AtStart returns true if current lexem not empty
|
||||
func (l *lexer) AtStart() bool {
|
||||
return l.Pos == l.Start
|
||||
}
|
|
@ -0,0 +1,34 @@
|
|||
// Code generated by "stringer -type=lexType"; DO NOT EDIT.
|
||||
|
||||
package parser
|
||||
|
||||
import "strconv"
|
||||
|
||||
func _() {
|
||||
// An "invalid array index" compiler error signifies that the constant values have changed.
|
||||
// Re-run the stringer command to generate them again.
|
||||
var x [1]struct{}
|
||||
_ = x[lEOF-0]
|
||||
_ = x[lError-1]
|
||||
_ = x[lObjectStart-2]
|
||||
_ = x[lObjectEnd-3]
|
||||
_ = x[lObjectKey-4]
|
||||
_ = x[lObjectValue-5]
|
||||
_ = x[lArrayStart-6]
|
||||
_ = x[lArrayEnd-7]
|
||||
_ = x[lString-8]
|
||||
_ = x[lNumber-9]
|
||||
_ = x[lBoolean-10]
|
||||
_ = x[lNull-11]
|
||||
}
|
||||
|
||||
const _lexType_name = "lEOFlErrorlObjectStartlObjectEndlObjectKeylObjectValuelArrayStartlArrayEndlStringlNumberlBooleanlNull"
|
||||
|
||||
var _lexType_index = [...]uint8{0, 4, 10, 22, 32, 42, 54, 65, 74, 81, 88, 96, 101}
|
||||
|
||||
func (i lexType) String() string {
|
||||
if i < 0 || i >= lexType(len(_lexType_index)-1) {
|
||||
return "lexType(" + strconv.FormatInt(int64(i), 10) + ")"
|
||||
}
|
||||
return _lexType_name[_lexType_index[i]:_lexType_index[i+1]]
|
||||
}
|
|
@ -0,0 +1,126 @@
|
|||
package parser
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"go.neonxp.dev/json/model"
|
||||
)
|
||||
|
||||
func Parse(json string) (*model.Node, error) {
|
||||
l := newLexer(json)
|
||||
go l.Run(initJson)
|
||||
n, err := parse(l.Output)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return model.NewNode(n), nil
|
||||
}
|
||||
|
||||
func parse(ch chan lexem) (any, error) {
|
||||
prefix := <-ch
|
||||
switch prefix.Type {
|
||||
case lObjectStart:
|
||||
return parseObject(ch)
|
||||
case lArrayStart:
|
||||
return parseArray(ch)
|
||||
case lString:
|
||||
return strings.Trim(prefix.Value, `"`), nil
|
||||
case lNumber:
|
||||
num, err := strconv.ParseFloat(prefix.Value, 64)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return num, nil
|
||||
case lBoolean:
|
||||
if strings.ToLower(prefix.Value) == "true" {
|
||||
return true, nil
|
||||
}
|
||||
return false, nil
|
||||
case lNull:
|
||||
return nil, nil
|
||||
}
|
||||
return nil, fmt.Errorf("ivalid token: '%s' type=%s", prefix.Value, prefix.Type.String())
|
||||
}
|
||||
|
||||
func parseObject(ch chan lexem) (model.NodeObjectValue, error) {
|
||||
m := model.NodeObjectValue{}
|
||||
nextKey := ""
|
||||
for l := range ch {
|
||||
switch l.Type {
|
||||
case lObjectKey:
|
||||
nextKey = strings.Trim(l.Value, `"`)
|
||||
case lString:
|
||||
m.Set(nextKey, strings.Trim(l.Value, `"`))
|
||||
case lNumber:
|
||||
num, err := strconv.ParseFloat(l.Value, 64)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m.Set(nextKey, num)
|
||||
case lBoolean:
|
||||
if strings.ToLower(l.Value) == "true" {
|
||||
m.Set(nextKey, true)
|
||||
continue
|
||||
}
|
||||
m.Set(nextKey, false)
|
||||
case lNull:
|
||||
m.Set(nextKey, nil)
|
||||
case lObjectStart:
|
||||
obj, err := parseObject(ch)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m.Set(nextKey, obj)
|
||||
case lArrayStart:
|
||||
arr, err := parseArray(ch)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m.Set(nextKey, arr)
|
||||
case lObjectEnd:
|
||||
return m, nil
|
||||
}
|
||||
}
|
||||
return nil, fmt.Errorf("unexpected end of object")
|
||||
}
|
||||
|
||||
func parseArray(ch chan lexem) (model.NodeArrayValue, error) {
|
||||
m := model.NodeArrayValue{}
|
||||
for l := range ch {
|
||||
switch l.Type {
|
||||
case lString:
|
||||
m = append(m, model.NewNode(strings.Trim(l.Value, `"`)))
|
||||
case lNumber:
|
||||
num, err := strconv.ParseFloat(l.Value, 64)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m = append(m, model.NewNode(num))
|
||||
case lBoolean:
|
||||
if strings.ToLower(l.Value) == "true" {
|
||||
m = append(m, model.NewNode(true))
|
||||
continue
|
||||
}
|
||||
m = append(m, model.NewNode(false))
|
||||
case lNull:
|
||||
m = append(m, model.NewNode(nil))
|
||||
case lObjectStart:
|
||||
obj, err := parseObject(ch)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m = append(m, model.NewNode(obj))
|
||||
case lArrayStart:
|
||||
arr, err := parseArray(ch)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
m = append(m, model.NewNode(arr))
|
||||
case lArrayEnd:
|
||||
return m, nil
|
||||
}
|
||||
}
|
||||
return nil, fmt.Errorf("unexpected end of object")
|
||||
}
|
|
@ -0,0 +1,71 @@
|
|||
package parser
|
||||
|
||||
import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"go.neonxp.dev/json/model"
|
||||
)
|
||||
|
||||
func TestParse(t *testing.T) {
|
||||
type args struct {
|
||||
json string
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
want *model.Node
|
||||
wantErr bool
|
||||
}{
|
||||
{
|
||||
name: "complex",
|
||||
args: args{
|
||||
json: `{
|
||||
"string key": "string value",
|
||||
"number key": 1337,
|
||||
"float key": 123.3,
|
||||
"object key": {
|
||||
"ab": "cd"
|
||||
},
|
||||
"array key": [
|
||||
1,
|
||||
2,
|
||||
"three"
|
||||
],
|
||||
"null key":null,
|
||||
"boolean key":true
|
||||
}`,
|
||||
},
|
||||
want: model.NewNode(
|
||||
model.NodeObjectValue{
|
||||
"string key": model.NewNode("string value"),
|
||||
"number key": model.NewNode(1337),
|
||||
"float key": model.NewNode(123.3),
|
||||
"object key": model.NewNode(model.NodeObjectValue{
|
||||
"ab": model.NewNode("cd"),
|
||||
}),
|
||||
"array key": model.NewNode(model.NodeArrayValue{
|
||||
model.NewNode(1),
|
||||
model.NewNode(2),
|
||||
model.NewNode("three"),
|
||||
}),
|
||||
"null key": model.NewNode(nil),
|
||||
"boolean key": model.NewNode(true),
|
||||
},
|
||||
),
|
||||
wantErr: false,
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := Parse(tt.args.json)
|
||||
if (err != nil) != tt.wantErr {
|
||||
t.Errorf("Parse() error = %v, wantErr %v", err, tt.wantErr)
|
||||
return
|
||||
}
|
||||
if !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("Parse() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
|
@ -0,0 +1,32 @@
|
|||
package parser
|
||||
|
||||
func scanNumber(l *lexer) bool {
|
||||
l.AcceptWhile("0123456789")
|
||||
if l.AtStart() {
|
||||
// not found any digit
|
||||
return false
|
||||
}
|
||||
l.Accept(".")
|
||||
l.AcceptWhile("0123456789")
|
||||
return !l.AtStart()
|
||||
}
|
||||
|
||||
func scanQuotedString(l *lexer, quote rune) bool {
|
||||
start := l.Pos
|
||||
if l.Next() != quote {
|
||||
l.Back()
|
||||
return false
|
||||
}
|
||||
for {
|
||||
ch := l.Next()
|
||||
switch ch {
|
||||
case eof:
|
||||
l.Pos = start // Return position to start
|
||||
return false // Unclosed quote string?
|
||||
case '\\':
|
||||
l.Next() // Skip next char
|
||||
case quote:
|
||||
return true // Closing quote
|
||||
}
|
||||
}
|
||||
}
|
|
@ -0,0 +1,17 @@
|
|||
package parser
|
||||
|
||||
type stateFunc func(*lexer) stateFunc
|
||||
|
||||
type stateStack []stateFunc
|
||||
|
||||
func (ss *stateStack) Push(s stateFunc) {
|
||||
*ss = append(*ss, s)
|
||||
}
|
||||
|
||||
func (ss *stateStack) Pop() (s stateFunc) {
|
||||
if len(*ss) == 0 {
|
||||
return nil
|
||||
}
|
||||
*ss, s = (*ss)[:len(*ss)-1], (*ss)[len(*ss)-1]
|
||||
return s
|
||||
}
|
|
@ -0,0 +1,110 @@
|
|||
package parser
|
||||
|
||||
func initJson(l *lexer) stateFunc {
|
||||
ignoreWhiteSpace(l)
|
||||
switch {
|
||||
case l.Accept("{"):
|
||||
l.Emit(lObjectStart)
|
||||
return stateInObject
|
||||
case l.Accept("["):
|
||||
l.Emit(lArrayStart)
|
||||
case l.Peek() == eof:
|
||||
return nil
|
||||
}
|
||||
return l.Errorf("Unknown token: %s", string(l.Peek()))
|
||||
}
|
||||
|
||||
func stateInObject(l *lexer) stateFunc {
|
||||
// we in object, so we expect field keys and values
|
||||
ignoreWhiteSpace(l)
|
||||
if l.Accept("}") {
|
||||
l.Emit(lObjectEnd)
|
||||
// If meet close object return to previous state (including initial)
|
||||
return l.PopState()
|
||||
}
|
||||
ignoreWhiteSpace(l)
|
||||
l.Accept(",")
|
||||
ignoreWhiteSpace(l)
|
||||
if !scanQuotedString(l, '"') {
|
||||
return l.Errorf("Unknown token: %s", string(l.Peek()))
|
||||
}
|
||||
l.Emit(lObjectKey)
|
||||
ignoreWhiteSpace(l)
|
||||
if !l.Accept(":") {
|
||||
return l.Errorf("Expected ':'")
|
||||
}
|
||||
ignoreWhiteSpace(l)
|
||||
l.Emit(lObjectValue)
|
||||
switch {
|
||||
case scanQuotedString(l, '"'):
|
||||
l.Emit(lString)
|
||||
ignoreWhiteSpace(l)
|
||||
l.Accept(",")
|
||||
l.Ignore()
|
||||
ignoreWhiteSpace(l)
|
||||
return stateInObject
|
||||
case scanNumber(l):
|
||||
l.Emit(lNumber)
|
||||
ignoreWhiteSpace(l)
|
||||
l.Accept(",")
|
||||
l.Ignore()
|
||||
ignoreWhiteSpace(l)
|
||||
return stateInObject
|
||||
case l.AcceptAnyOf([]string{"true", "false"}, true):
|
||||
l.Emit(lBoolean)
|
||||
ignoreWhiteSpace(l)
|
||||
l.Accept(",")
|
||||
l.Ignore()
|
||||
ignoreWhiteSpace(l)
|
||||
return stateInObject
|
||||
case l.AcceptString("null", true):
|
||||
l.Emit(lNull)
|
||||
ignoreWhiteSpace(l)
|
||||
l.Accept(",")
|
||||
l.Ignore()
|
||||
ignoreWhiteSpace(l)
|
||||
return stateInObject
|
||||
case l.Accept("{"):
|
||||
l.Emit(lObjectStart)
|
||||
l.PushState(stateInObject)
|
||||
return stateInObject
|
||||
case l.Accept("["):
|
||||
l.Emit(lArrayStart)
|
||||
l.PushState(stateInObject)
|
||||
return stateInArray
|
||||
}
|
||||
return l.Errorf("Unknown token: %s", string(l.Peek()))
|
||||
}
|
||||
|
||||
func stateInArray(l *lexer) stateFunc {
|
||||
ignoreWhiteSpace(l)
|
||||
l.Accept(",")
|
||||
ignoreWhiteSpace(l)
|
||||
switch {
|
||||
case scanQuotedString(l, '"'):
|
||||
l.Emit(lString)
|
||||
case scanNumber(l):
|
||||
l.Emit(lNumber)
|
||||
case l.AcceptAnyOf([]string{"true", "false"}, true):
|
||||
l.Emit(lBoolean)
|
||||
case l.AcceptString("null", true):
|
||||
l.Emit(lNull)
|
||||
case l.Accept("{"):
|
||||
l.Emit(lObjectStart)
|
||||
l.PushState(stateInArray)
|
||||
return stateInObject
|
||||
case l.Accept("["):
|
||||
l.Emit(lArrayStart)
|
||||
l.PushState(stateInArray)
|
||||
return stateInArray
|
||||
case l.Accept("]"):
|
||||
l.Emit(lArrayEnd)
|
||||
return l.PopState()
|
||||
}
|
||||
return stateInArray
|
||||
}
|
||||
|
||||
func ignoreWhiteSpace(l *lexer) {
|
||||
l.AcceptWhile(" \n\t") // ignore whitespaces
|
||||
l.Ignore()
|
||||
}
|
Loading…
Reference in New Issue