Initial commit.
This commit is contained in:
commit
18b0f03995
15 changed files with 1966 additions and 0 deletions
4
.dir-locals.el
Normal file
4
.dir-locals.el
Normal file
|
@ -0,0 +1,4 @@
|
|||
((nil . ((eval . (add-hook 'before-save-hook 'copyright-update))))
|
||||
(scheme-mode . ((tab-width . 2)
|
||||
(indent-tabs-mode . t)
|
||||
(geiser-scheme-implementation . guile))))
|
68
.gitignore
vendored
Normal file
68
.gitignore
vendored
Normal file
|
@ -0,0 +1,68 @@
|
|||
### Autotools ###
|
||||
Makefile.in
|
||||
Makefile
|
||||
|
||||
# http://www.gnu.org/software/autoconf
|
||||
autom4te.cache
|
||||
/autoscan.log
|
||||
/autoscan-*.log
|
||||
/aclocal.m4
|
||||
/compile
|
||||
/config.gues
|
||||
/config.h.in
|
||||
/config.log
|
||||
/config.status
|
||||
/config.sub
|
||||
/config.guess
|
||||
/config.rpath
|
||||
/configure
|
||||
/config.scan
|
||||
/depcomp
|
||||
/install-sh
|
||||
/missing
|
||||
/stamp-h1
|
||||
/stamp-h
|
||||
/config.h
|
||||
/ABOUT-NLS
|
||||
/INSTALL
|
||||
/timestamp
|
||||
/AUTHORS
|
||||
/ChangeLog
|
||||
|
||||
# Libtool.
|
||||
/ltmain.sh
|
||||
libtool
|
||||
|
||||
# temp files.
|
||||
*~
|
||||
|
||||
# http://www.gnu.org/software/m4/
|
||||
m4/build-to-host.m4
|
||||
m4/gettext.m4
|
||||
m4/host-cpu-c-abi.m4
|
||||
m4/iconv.m4
|
||||
m4/intlmacosx.m4
|
||||
m4/lib-ld.m4
|
||||
m4/lib-link.m4
|
||||
m4/lib-prefix.m4
|
||||
m4/libtool.m4
|
||||
m4/lt~obsolete.m4
|
||||
m4/ltoptions.m4
|
||||
m4/ltsugar.m4
|
||||
m4/ltversion.m4
|
||||
m4/nls.m4
|
||||
m4/po.m4
|
||||
m4/progtest.m4
|
||||
|
||||
# Executables
|
||||
*.go
|
||||
|
||||
# gettext autogenerated files.
|
||||
po/*sed
|
||||
po/*.header
|
||||
po/*.sin
|
||||
po/Rules-quot
|
||||
po/Makevars.template
|
||||
po/POTFILES
|
||||
po/Makefile.in.in
|
||||
*.pot
|
661
COPYING
Normal file
661
COPYING
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/>.
|
50
Makefile.am
Normal file
50
Makefile.am
Normal file
|
@ -0,0 +1,50 @@
|
|||
################################################################################
|
||||
# Makefile.am
|
||||
# Copyright (C) 2025 Cor Legemaat <cor@cor.za.net>
|
||||
#
|
||||
# This file is part of scheme-dql: 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, version 3 of the License.
|
||||
|
||||
# scheme-dql 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
|
||||
# scheme-dql. If not, see <https://www.gnu.org/licenses/>.
|
||||
################################################################################
|
||||
|
||||
ACLOCAL_AMFLAGS=-I m4
|
||||
|
||||
SUBDIRS = po dql doc
|
||||
|
||||
dist_doc_DATA = \
|
||||
README.org \
|
||||
COPYING \
|
||||
AUTHORS \
|
||||
INSTALL \
|
||||
NEWS
|
||||
|
||||
README: README.org
|
||||
|
||||
AUTHORS:
|
||||
$(file >AUTHORS,$(shell git --no-pager shortlog -sn --email HEAD))
|
||||
.PHONY: AUTHORS
|
||||
|
||||
ChangeLog:
|
||||
$(file >ChangeLog,$(shell git log --oneline --graph))
|
||||
.PHONY: ChangeLog
|
||||
|
||||
release-tag:
|
||||
$(shell git tag -a "v$(VERSION)" -m "Release v$(VERSION)")
|
||||
$(shell git push origin "v$(VERSION)")
|
||||
|
||||
live:
|
||||
mkdir -p /usr/share/guile/site/dql
|
||||
mount --bind -o ro dql /usr/share/guile/site/dql/
|
||||
|
||||
# Remove doc directory on uninstall
|
||||
uninstall-local:
|
||||
-rm -r $(docdir)
|
||||
|
||||
# End of Makefile.am
|
0
NEWS
Normal file
0
NEWS
Normal file
110
README.org
Normal file
110
README.org
Normal file
|
@ -0,0 +1,110 @@
|
|||
* scheme-dql
|
||||
A library that exposes an interface for processing data, written as a proof of
|
||||
concept for fixing SQL syntax in the same sense as how [[https://synthcode.com/scheme/irregex/][irregex]] fixed regular
|
||||
expression syntax in a scheme way.
|
||||
|
||||
The data is in lists of alists stored and read by the calling application in the same
|
||||
way as how json is used. [[https://github.com/aconchillo/guile-json][guile-json]] could be used to convert to and from json data.
|
||||
|
||||
The interface is implemented thru a macro that will compile the query lambda in
|
||||
the calling code. That function is then called to execute the query on the data.
|
||||
The idea is to have this as an [[https://sqlite.org/index.html][SQLite]] for scheme but implemented like a header
|
||||
only library in c/c++ via the macro. Most of the logic is done by calling a function
|
||||
supplied in the query to keep it simple but powerful.
|
||||
|
||||
This is still alpha software, only used in [[https://www.gnu.org/software/guile/][guile]] and not fully tested. The purpose is
|
||||
to determine how feasible a polish noted data query language could be.
|
||||
|
||||
** License
|
||||
You can redistribute and/or modify [[https://www.cor.za.net/code/scheme-dql][scheme-dql]] under the terms of the GNU
|
||||
Affero General Public License as published by the Free Software Foundation,
|
||||
version 3 of the License. Please see =COPYING= file for the terms of GNU Affero
|
||||
General Public License.
|
||||
|
||||
** query language
|
||||
Each method consist of a list with the first atom a symbol for the method like in
|
||||
scheme, the second parameter is either the return from a sub query or the
|
||||
``implied'' data fed thru the function call.
|
||||
|
||||
The ~<key-path>~ is multiple string values to follow in order to reach the final
|
||||
association that contain the data to use.
|
||||
|
||||
*** Methods
|
||||
**** filter
|
||||
#+begin_src scheme
|
||||
(filter ;; other query or implied data.
|
||||
(where <callback> <key-path>))
|
||||
#+end_src
|
||||
This will return only the alists that return a ~#true~ from the ~where~ method.
|
||||
All the where clauses are passed true an ~and~ to the where sub method.
|
||||
|
||||
**** sort
|
||||
#+begin_src scheme
|
||||
(sort ;; other query or implied data.
|
||||
(by <callback> <key-path>))
|
||||
#+end_src
|
||||
The ~<callback>~ should be a function with two parameters that return
|
||||
~#true~ if the first parameter should be before the second parameter
|
||||
~#false~ otherwise.
|
||||
|
||||
**** alter
|
||||
#+begin_src scheme
|
||||
(alter ;; other query or implied data.
|
||||
(where <callback> <key-path>)
|
||||
(insert <data> <key>)
|
||||
(update <data> <key>)
|
||||
(drop <key>))
|
||||
#+end_src
|
||||
~where~ will act as a filter for application but the returned data is the full
|
||||
alist, if you want to filter the data use the ~filter~ method.
|
||||
- ~insert~ will call ~acons~ on the alist.
|
||||
- ~update~ will call ~assoc-set!~ on the alist.
|
||||
- ~drop~ will call ~assoc-remove!~ on the alist.
|
||||
|
||||
**** select
|
||||
#+begin_src scheme
|
||||
(select ;; other query or implied data.
|
||||
(parm <key-path>)
|
||||
(parm-as <key> <key-path>)
|
||||
(parm-val <key-path>))
|
||||
#+end_src
|
||||
- ~parm~ will return the association as is.
|
||||
- ~parm-as~ will return an assosiation with the value represented by the
|
||||
path but the key will be the ~<key>~ paramter.
|
||||
- ~parm-val~ will return only the value represented by the path.
|
||||
|
||||
*** sub methods
|
||||
**** where
|
||||
#+begin_src scheme
|
||||
(where <callback> <key-path>)
|
||||
(where (and (where <callback> <key-path>)
|
||||
(or (where <callback> <key-path>)
|
||||
(where <callback> <key-path>))))
|
||||
#+end_src
|
||||
The ~<callback>~ should be a function with a single parameter that return
|
||||
~#true~ if the data in the parameter passes the filter and ~#false~ otherwise.
|
||||
Boolean ~and~ and ~or~ combinations are allowed.
|
||||
|
||||
*** example
|
||||
#+begin_src scheme
|
||||
(use-modules (dql dql))
|
||||
(define my-filter
|
||||
(lambda (val)
|
||||
(if (string=? val "test") #t #f)))
|
||||
((dql (select (filter (where my-filter "name"))
|
||||
(parm "name")
|
||||
(parm-as "date" "created_at"))
|
||||
#:print-query "test-query")
|
||||
data)
|
||||
#+end_src
|
||||
|
||||
** extras
|
||||
*** write to file
|
||||
#+begin_src scheme
|
||||
(dql-write <data> <file-path>)
|
||||
#+end_src
|
||||
|
||||
*** read from file
|
||||
#+begin_src scheme
|
||||
(dql-read <file-path>)
|
||||
#+end_src
|
98
configure.ac
Normal file
98
configure.ac
Normal file
|
@ -0,0 +1,98 @@
|
|||
define(SCHEME_DQL_CONFIGURE_COPYRIGHT, [[
|
||||
Copyright (C) 2025 Cor Legemaat <cor@cor.za.net>
|
||||
All Rights Reserved
|
||||
|
||||
This file is part of scheme-dql: 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, version 3 of the License.
|
||||
|
||||
scheme-dql 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
|
||||
scheme-dql. If not, see <https://www.gnu.org/licenses/>.
|
||||
]])
|
||||
|
||||
m4_define([version_major], [0])
|
||||
m4_define([version_minor], [0])
|
||||
m4_define([version_revision], [0])
|
||||
|
||||
AC_PACKAGE_URL([http://www.cor.za.net/code/scheme-dql])
|
||||
AC_INIT(scheme-dql,
|
||||
[version_major.version_minor.version_revision],
|
||||
[mailto:cor@cor.za.net],
|
||||
[],
|
||||
[http://www.cor.za.net/code/scheme-dql])
|
||||
AC_COPYRIGHT(SCHEME_DQL_CONFIGURE_COPYRIGHT)
|
||||
AM_INIT_AUTOMAKE([1.16 gnu])
|
||||
|
||||
AC_CONFIG_MACRO_DIR([m4])
|
||||
|
||||
dnl ****************************************************************************
|
||||
dnl Add version detail to config.h and makefile.am
|
||||
dnl ****************************************************************************
|
||||
AC_DEFINE([VERSION_MAJOR], [version_major], [Major section of version])
|
||||
AC_DEFINE([VERSION_MINOR], [version_minor], [Minor section of version])
|
||||
AC_DEFINE([VERSION_REVISION], [version_revision], [Revision section of version])
|
||||
|
||||
dnl Push version detail to makefile.am
|
||||
VERSION=[version_major.version_minor.version_revision]
|
||||
AC_SUBST(VERSION,[version_major.version_minor.version_revision])
|
||||
VERSION_MAJOR=[version_major]
|
||||
AC_SUBST(VERSION_MAJOR,[version_major])
|
||||
VERSION_MINOR=[version_minor]
|
||||
AC_SUBST(VERSION_MINOR,[version_minor])
|
||||
VERSION_REVISION=[version_revision]
|
||||
AC_SUBST(VERSION_REVISION,[version_revision])
|
||||
|
||||
dnl ****************************************************************************
|
||||
dnl Check for the required guile dependency's.
|
||||
dnl ****************************************************************************
|
||||
m4_pattern_forbid([^GUILE_PKG$])
|
||||
m4_pattern_forbid([^GUILE_PROGS$])
|
||||
|
||||
GUILE_PKG([3.0 2.0 2.2])
|
||||
|
||||
GUILE_PROGS
|
||||
GUILE_FLAGS
|
||||
GUILE_SITE_DIR
|
||||
|
||||
GUILE_MODULE_REQUIRED([srfi srfi-1])
|
||||
GUILE_MODULE_REQUIRED([ice-9 pretty-print])
|
||||
GUILE_MODULE_REQUIRED([ice-9 optargs])
|
||||
GUILE_MODULE_REQUIRED([oop goops])
|
||||
|
||||
dnl Guile prefix and libdir.
|
||||
GUILE_PREFIX=`$PKG_CONFIG --print-errors --variable=prefix guile-$GUILE_EFFECTIVE_VERSION`
|
||||
GUILE_LIBDIR=`$PKG_CONFIG --print-errors --variable=libdir guile-$GUILE_EFFECTIVE_VERSION`
|
||||
AC_SUBST(GUILE_PREFIX)
|
||||
AC_SUBST(GUILE_LIBDIR)
|
||||
|
||||
if test "$cross_compiling" != no; then
|
||||
GUILE_TARGET="--target=$host_alias"
|
||||
AC_SUBST([GUILE_TARGET])
|
||||
fi
|
||||
|
||||
|
||||
dnl ***************************************************************************
|
||||
dnl Internationalization
|
||||
dnl ***************************************************************************
|
||||
AM_GNU_GETTEXT_REQUIRE_VERSION(0.20)
|
||||
dnl AM_GNU_GETTEXT_VERSION(0.20)
|
||||
AM_GNU_GETTEXT([external])
|
||||
|
||||
dnl ***************************************************************************
|
||||
|
||||
AM_EXTRA_RECURSIVE_TARGETS([doc])
|
||||
|
||||
AC_CONFIG_FILES([Makefile
|
||||
po/Makefile.in
|
||||
dql/Makefile
|
||||
doc/Makefile])
|
||||
AC_CONFIG_COMMANDS([timestamp], [date >timestamp])
|
||||
|
||||
AC_OUTPUT
|
||||
|
||||
# End the configure script.
|
||||
|
0
doc/Makefile.am
Normal file
0
doc/Makefile.am
Normal file
43
dql/Makefile.am
Normal file
43
dql/Makefile.am
Normal file
|
@ -0,0 +1,43 @@
|
|||
################################################################################
|
||||
# Makefile.am
|
||||
# Copyright (C) 2025 Cor Legemaat <cor@cor.za.net>
|
||||
#
|
||||
# This file is part of scheme-dql: 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, version 3 of the License.
|
||||
|
||||
# scheme-dql 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
|
||||
# scheme-dql. If not, see <https://www.gnu.org/licenses/>.
|
||||
################################################################################
|
||||
|
||||
moddir=$(datadir)/guile/site/$(GUILE_EFFECTIVE_VERSION)/dql
|
||||
objdir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache/dql
|
||||
|
||||
SOURCES = dql.scm
|
||||
|
||||
GOBJECTS = $(SOURCES:%.scm=%.go)
|
||||
|
||||
nobase_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES)
|
||||
nobase_obj_DATA = $(GOBJECTS)
|
||||
|
||||
# Make sure source files are installed first, so that the mtime of
|
||||
# installed compiled files is greater than that of installed source
|
||||
# files. See
|
||||
# <http://lists.gnu.org/archive/html/guile-devel/2010-07/msg00125.html>
|
||||
# for details.
|
||||
guile_install_obj_files = install-nobase_obj_DATA
|
||||
$(guile_install_obj_files): install-nobase_mod_DATA
|
||||
|
||||
EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES)
|
||||
|
||||
CLEANFILES = $(GOBJECTS)
|
||||
|
||||
GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat
|
||||
GUILE_OPTS = -L $(abs_top_builddir)/src
|
||||
SUFFIXES = .scm .go
|
||||
.scm.go:
|
||||
$(GUILD) compile $(GUILE_TARGET) $(GUILE_OPTS) $(GUILE_WARNINGS) -o "$@" "$<"
|
401
dql/dql.scm
Normal file
401
dql/dql.scm
Normal file
|
@ -0,0 +1,401 @@
|
|||
;; -*- Mode: Scheme; geiser-scheme-implementation: guile; tab-width: 2 -*-
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
;;; dql.scm
|
||||
;;; Copyright (C) 2025 Cor Legemaat <cor@cor.za.net>
|
||||
;;;
|
||||
;;; This file is part of scheme-dql: 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, version 3 of the License.
|
||||
;;;
|
||||
;;; scheme-dql 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
|
||||
;;; scheme-dql. If not, see <https://www.gnu.org/licenses/>.
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
#|
|
||||
This module creates an interface for processing alist data in the same sense as
|
||||
how sqlite is used for processing data. The data is in alists stored and read
|
||||
by the calling application in the same way as how json is used. The querry
|
||||
syntax is fixed from SQL like how irregex fixed regular expressions.
|
||||
|#
|
||||
|
||||
;; TODO move non public functions to sub modules and generate api documentation
|
||||
;; for this module with https://luis-felipe.gitlab.io/guile-documenta/.
|
||||
|
||||
(define-module (dql dql)
|
||||
#:use-module (srfi srfi-1)
|
||||
#:use-module (ice-9 pretty-print)
|
||||
#:use-module (ice-9 optargs)
|
||||
#:use-module (oop goops))
|
||||
|
||||
(define-public alist?
|
||||
(lambda (test-list)
|
||||
"Check if the test data is an alist with the keys as strings.
|
||||
|
||||
@strong{test-list} (list):
|
||||
The data to check.
|
||||
|
||||
@strong{return} (bool):
|
||||
True if the test data is an alist with the keys as strings, false
|
||||
otherwise."
|
||||
(if (pair? test-list)
|
||||
(every (lambda (ass)
|
||||
(if (pair? ass)
|
||||
(or (string? (car ass))
|
||||
(symbol? (car ass)))
|
||||
#f))
|
||||
test-list)
|
||||
#f)))
|
||||
|
||||
(define path-val
|
||||
(lambda (path data)
|
||||
"Return the code that can determine the last key of the path, where the path
|
||||
forms a list of keys with each following key is read from the data of the
|
||||
preceding key.
|
||||
|
||||
@strong{path} (list):
|
||||
A list of key strings in the sequence as how you should traverse the
|
||||
data to get to the value.
|
||||
|
||||
@strong{data} (alist):
|
||||
The a-list data tree to retrieve the value from.
|
||||
|
||||
@strong{return} (any):
|
||||
The value stored by the last key in the path."
|
||||
(if (null? (cdr path))
|
||||
`(assoc-ref ,data ,(car path))
|
||||
(path-val (cdr path)
|
||||
`(assoc-ref ,data ,(car path))))))
|
||||
|
||||
(define-public dql-data->list
|
||||
(lambda (data)
|
||||
"Function to convert the supplied data into a list of alists from a non
|
||||
list like a vector that could be represented as a list of alists or ill
|
||||
formatted data.
|
||||
|
||||
@strong{data} (any data type that could be represented as a list):
|
||||
The source data to convert.
|
||||
|
||||
@strong{return} (list of alists):
|
||||
The input data converted to a list of alists.
|
||||
|
||||
Only vectors and ill formatted lists of alists are supported at the moment
|
||||
but more could be added like arrays etc."
|
||||
(cond ((vector? data)
|
||||
(vector->list data))
|
||||
((list? data)
|
||||
(cond ((and (pair? data) (pair? (car data)) (null? (cdr data))
|
||||
(pair? (car data)) (pair? (caar data)) (null? (cdar data)))
|
||||
;;Hack to handle nestling of answers.
|
||||
(caar data))
|
||||
((alist? data)
|
||||
;;Hack for if alist no inside list.
|
||||
(list data))
|
||||
(else data)))
|
||||
(else (error (string-append "Data not a list but \""
|
||||
(object->string (class-of data))
|
||||
"\"!\n"))))))
|
||||
|
||||
(define map-query-symbols
|
||||
(lambda (query data)
|
||||
"Function to map the querry keywords to their representative functions.
|
||||
|
||||
@strong{query} (dql-querry):
|
||||
The querry to map.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong(return) (function call):
|
||||
The call to the correct function.
|
||||
|
||||
Only the first symbol is used to determine what function to apply the
|
||||
function handle it from there and will call this function again if needed."
|
||||
(cond ((eq? (car query) 'filter)
|
||||
(dql-filter (cdr query) data))
|
||||
((eq? (car query) 'select)
|
||||
(dql-select (cdr query) data))
|
||||
((eq? (car query) 'sort)
|
||||
(dql-sort (cdr query) data))
|
||||
((eq? (car query) 'alter)
|
||||
(dql-alter (cdr query) data))
|
||||
(else (error (string-append "ERROR: Unimplemented query \""
|
||||
(object->string (car query))
|
||||
"\"!"))))))
|
||||
|
||||
(define first-parm-other
|
||||
(lambda (parms . local)
|
||||
"Function to determine if the first parameter is a local parameter or an
|
||||
sub querry that will supply the data for this query.
|
||||
|
||||
@strong{parms} (dql-query):
|
||||
The query to analyze.
|
||||
|
||||
@strong{local} (symbols):
|
||||
The function local symbols that define local parameters.
|
||||
|
||||
@strong{return} (bool):
|
||||
True if the first parameter is a sub query false otherwise."
|
||||
(and (pair? parms)
|
||||
(pair? (car parms))
|
||||
(not (any (lambda (parm)
|
||||
(eq? (caar parms) parm))
|
||||
local)))))
|
||||
|
||||
(define dql-boolean-where
|
||||
(lambda (bool-op filters entry)
|
||||
"Function to return the code that can determine if the data processed by the
|
||||
code should be selected for processing or not.
|
||||
|
||||
@strong{bool-op} (symbol):
|
||||
The boolean operation to use for multiple selections.
|
||||
|
||||
@strong{filters} (filter list):
|
||||
The list of callback filters for this query.
|
||||
|
||||
@strong{entry} (symbol)
|
||||
The symbol representing the data entry.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will analyze the data.
|
||||
|
||||
A filter is in the form of @code{(where <callback> <key> <key-n>)} where the
|
||||
keys are passed as is to @ref(path-val) and the return from that as the data
|
||||
to the callback function.
|
||||
|
||||
A boolean keyword like @samp{and} or @samp{or} will result in a tail call
|
||||
with the rest of the entries as filters."
|
||||
(if (or (eq? bool-op 'and)
|
||||
(eq? bool-op 'or))
|
||||
(append (list bool-op)
|
||||
(map (lambda (rule)
|
||||
(if (eq? (car rule) 'where)
|
||||
`(,(cadr rule) ,(path-val (cddr rule)
|
||||
entry))
|
||||
(dql-boolean-where (car rule)
|
||||
(cdr rule)
|
||||
entry)))
|
||||
filters))
|
||||
(error (string-append "Unimplemented boolean operand \""
|
||||
(symbol->string bool-op)
|
||||
"\" for where!")))))
|
||||
|
||||
(define dql-filter
|
||||
(lambda (query data)
|
||||
"Function to return the code that will filter the data entries based on the
|
||||
@xref{where, dql-boolean-where} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let ((fpo (first-parm-other query 'where 'and 'or))
|
||||
(entry (gensym)))
|
||||
`(filter-map (lambda (,entry)
|
||||
(if ,(dql-boolean-where 'and
|
||||
(if fpo
|
||||
(cdr query)
|
||||
query)
|
||||
entry)
|
||||
,entry #f))
|
||||
(dql-data->list ,(if fpo
|
||||
(map-query-symbols (car query)
|
||||
data)
|
||||
data))))))
|
||||
|
||||
(define dql-sort
|
||||
(lambda (query data)
|
||||
"Function to return the code that will sort the data entries based on the
|
||||
@code{by} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let ((fpo (first-parm-other query 'by)))
|
||||
(let ((first-parm (if fpo
|
||||
(cadr query)
|
||||
(car query)))
|
||||
(a (gensym))
|
||||
(b (gensym)))
|
||||
`(sort (dql->data->list ,(if fpo
|
||||
(map-query-symbols (car query)
|
||||
data)
|
||||
(if (null? (cdr query))
|
||||
data
|
||||
`(dql-sort ,(cdr query)))))
|
||||
(lambda (,a ,b)
|
||||
,((cadr first-parm)
|
||||
(path-val (cddr first-parm) a)
|
||||
(path-val (cddr first-parm) b))))))))
|
||||
|
||||
(define dql-alter
|
||||
(lambda (query data)
|
||||
"Function to return the code that will alter the data entries based on the
|
||||
@xref{where, dql-boolean-where} filter as the first rule and then the
|
||||
subsequent @code{insert}, @code{update} and @code{drop} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let* ((fpo (first-parm-other query 'insert 'update 'drop 'where))
|
||||
(entry (gensym))
|
||||
(parm->code
|
||||
(lambda (parm)
|
||||
;;TODO get entry from path-val.
|
||||
(cond ((eq? (car parm) 'update)
|
||||
`(set! ,entry
|
||||
(assoc-set! ,entry ,(second parm) ,(third parm))))
|
||||
((eq? (car parm) 'insert)
|
||||
`(set! ,entry
|
||||
(acons ,(second parm) ,(third parm) ,entry)))
|
||||
((eq? (car parm) 'drop)
|
||||
`(set! ,entry
|
||||
(assoc-remove! ,entry
|
||||
,(second parm))))
|
||||
(else (error (string-append "Illegal parameter \""
|
||||
(symbol->string (car parm))
|
||||
"\" for alter")))))))
|
||||
`(map ,(append (list 'lambda (list entry))
|
||||
(list (append (list 'if
|
||||
(if fpo
|
||||
(if (first-parm-other (cdr query)
|
||||
'where)
|
||||
#t
|
||||
(dql-boolean-where 'where
|
||||
(cadr query)
|
||||
entry))
|
||||
(if (first-parm-other query 'where)
|
||||
#t
|
||||
(dql-boolean-where 'where
|
||||
(car query)
|
||||
entry))))
|
||||
(list (append (list 'begin)
|
||||
(map parm->code
|
||||
(if fpo
|
||||
(cdr query)
|
||||
query))))))
|
||||
(list entry))
|
||||
(dql-data->list ,(if fpo
|
||||
(map-query-symbols (car query) data)
|
||||
data))))))
|
||||
|
||||
(define dql-select
|
||||
(lambda (query data)
|
||||
"Function to return the code that will select a subsections of the
|
||||
associations of the alist data entries based on the @code{parm},
|
||||
@code{parm-as} and @code{parm-val} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let* ((fpo (first-parm-other query 'parm 'parm-as 'parm-val))
|
||||
(entry (gensym))
|
||||
(parm->code
|
||||
(lambda (parm)
|
||||
(cond ((eq? (car parm) 'parm)
|
||||
(let ((last-parm (last parm))
|
||||
(rest-parms (drop-right (cdr parm) 1)))
|
||||
`(assoc ,last-parm
|
||||
,(if (null? rest-parms)
|
||||
entry
|
||||
(path-val rest-parms
|
||||
entry)))))
|
||||
((eq? (car parm) 'parm-as)
|
||||
`(cons ,(car (cdr parm))
|
||||
,(path-val (cdr (cdr parm))
|
||||
entry)))
|
||||
((eq? (car parm) 'parm-val)
|
||||
(let ((last-parm (last parm))
|
||||
(rest-parms (drop-right (cdr parm) 1)))
|
||||
`(assoc-ref ,(if (null? rest-parms)
|
||||
entry
|
||||
(path-val rest-parms
|
||||
entry))
|
||||
,last-parm)))
|
||||
(else
|
||||
(error "Illegal parameter for select."))))))
|
||||
`(map (lambda (,entry)
|
||||
,(append (list 'list)
|
||||
(map parm->code
|
||||
(if fpo (cdr query) query))))
|
||||
(dql-data->list ,(if fpo
|
||||
(map-query-symbols (car query) data)
|
||||
data))))))
|
||||
|
||||
(defmacro*-public dql (query #:key (print-query #f))
|
||||
"The main exported macro to return the lambda that will process the data
|
||||
based on the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{print-query} (boolean)
|
||||
Option to @code{pretty-print} the generated lambda's code.
|
||||
|
||||
@strong{return} (lambda):
|
||||
The lambda function that will process the data according to the query."
|
||||
(let ((data (gensym)))
|
||||
(if print-query
|
||||
(begin (display "generated query for ")
|
||||
(display print-query)
|
||||
(display ":")
|
||||
(newline)
|
||||
(pretty-print `(lambda (,data)
|
||||
,(map-query-symbols query data)))))
|
||||
`(lambda (,data)
|
||||
,(map-query-symbols query data))))
|
||||
|
||||
(define-public dql-write
|
||||
(lambda (data path)
|
||||
"A helper procedure to write the data to a file.
|
||||
|
||||
@strong{data} (alist-data):
|
||||
The data to write to the file.
|
||||
|
||||
@strong{path} (string):
|
||||
The file path to write the data to.
|
||||
|
||||
@strong{return} (undefined):"
|
||||
(let ((output-port (open-output-file path)))
|
||||
(pretty-print data output-port
|
||||
#:display? #f
|
||||
#:width 600
|
||||
#:max-expr-width 600)
|
||||
(close output-port))))
|
||||
|
||||
(define-public dql-read
|
||||
(lambda (path)
|
||||
"A helper function to read data from a file.
|
||||
|
||||
@strong{path} (string):
|
||||
The file path to read the data from.
|
||||
|
||||
@strong{return} (alist-data):
|
||||
The data read from the file."
|
||||
(let* ((input-port (open-input-file path))
|
||||
(data (read input-port)))
|
||||
(close input-port)
|
||||
data)))
|
4
po/ChangeLog
Normal file
4
po/ChangeLog
Normal file
|
@ -0,0 +1,4 @@
|
|||
2025-06-21 gettextize <bug-gnu-gettext@gnu.org>
|
||||
|
||||
* POTFILES.in: New file.
|
||||
|
82
po/Makevars
Normal file
82
po/Makevars
Normal file
|
@ -0,0 +1,82 @@
|
|||
# Makefile variables for PO directory in any package using GNU gettext.
|
||||
#
|
||||
# Copyright (C) 2003-2019 Free Software Foundation, Inc.
|
||||
# This file is free software; the Free Software Foundation gives
|
||||
# unlimited permission to use, copy, distribute, and modify it.
|
||||
|
||||
# Usually the message domain is the same as the package name.
|
||||
DOMAIN = $(PACKAGE)
|
||||
|
||||
# These two variables depend on the location of this directory.
|
||||
subdir = po
|
||||
top_builddir = ..
|
||||
|
||||
# These options get passed to xgettext.
|
||||
XGETTEXT_OPTIONS = --keyword=_ --keyword=N_
|
||||
|
||||
# This is the copyright holder that gets inserted into the header of the
|
||||
# $(DOMAIN).pot file. Set this to the copyright holder of the surrounding
|
||||
# package. (Note that the msgstr strings, extracted from the package's
|
||||
# sources, belong to the copyright holder of the package.) Translators are
|
||||
# expected to transfer the copyright for their translations to this person
|
||||
# or entity, or to disclaim their copyright. The empty string stands for
|
||||
# the public domain; in this case the translators are expected to disclaim
|
||||
# their copyright.
|
||||
COPYRIGHT_HOLDER = Free Software Foundation, Inc.
|
||||
|
||||
# This tells whether or not to prepend "GNU " prefix to the package
|
||||
# name that gets inserted into the header of the $(DOMAIN).pot file.
|
||||
# Possible values are "yes", "no", or empty. If it is empty, try to
|
||||
# detect it automatically by scanning the files in $(top_srcdir) for
|
||||
# "GNU packagename" string.
|
||||
PACKAGE_GNU =
|
||||
|
||||
# This is the email address or URL to which the translators shall report
|
||||
# bugs in the untranslated strings:
|
||||
# - Strings which are not entire sentences, see the maintainer guidelines
|
||||
# in the GNU gettext documentation, section 'Preparing Strings'.
|
||||
# - Strings which use unclear terms or require additional context to be
|
||||
# understood.
|
||||
# - Strings which make invalid assumptions about notation of date, time or
|
||||
# money.
|
||||
# - Pluralisation problems.
|
||||
# - Incorrect English spelling.
|
||||
# - Incorrect formatting.
|
||||
# It can be your email address, or a mailing list address where translators
|
||||
# can write to without being subscribed, or the URL of a web page through
|
||||
# which the translators can contact you.
|
||||
MSGID_BUGS_ADDRESS =
|
||||
|
||||
# This is the list of locale categories, beyond LC_MESSAGES, for which the
|
||||
# message catalogs shall be used. It is usually empty.
|
||||
EXTRA_LOCALE_CATEGORIES =
|
||||
|
||||
# This tells whether the $(DOMAIN).pot file contains messages with an 'msgctxt'
|
||||
# context. Possible values are "yes" and "no". Set this to yes if the
|
||||
# package uses functions taking also a message context, like pgettext(), or
|
||||
# if in $(XGETTEXT_OPTIONS) you define keywords with a context argument.
|
||||
USE_MSGCTXT = no
|
||||
|
||||
# These options get passed to msgmerge.
|
||||
# Useful options are in particular:
|
||||
# --previous to keep previous msgids of translated messages,
|
||||
# --quiet to reduce the verbosity.
|
||||
MSGMERGE_OPTIONS =
|
||||
|
||||
# These options get passed to msginit.
|
||||
# If you want to disable line wrapping when writing PO files, add
|
||||
# --no-wrap to MSGMERGE_OPTIONS, XGETTEXT_OPTIONS, and
|
||||
# MSGINIT_OPTIONS.
|
||||
MSGINIT_OPTIONS =
|
||||
|
||||
# This tells whether or not to regenerate a PO file when $(DOMAIN).pot
|
||||
# has changed. Possible values are "yes" and "no". Set this to no if
|
||||
# the POT file is checked in the repository and the version control
|
||||
# program ignores timestamps.
|
||||
PO_DEPENDS_ON_POT = yes
|
||||
|
||||
# This tells whether or not to forcibly update $(DOMAIN).pot and
|
||||
# regenerate PO files on "make dist". Possible values are "yes" and
|
||||
# "no". Set this to no if the POT file and PO files are maintained
|
||||
# externally.
|
||||
DIST_DEPENDS_ON_UPDATE_PO = yes
|
1
po/POTFILES.in
Normal file
1
po/POTFILES.in
Normal file
|
@ -0,0 +1 @@
|
|||
# List of source files which contain translatable strings.
|
43
src/Makefile.am
Normal file
43
src/Makefile.am
Normal file
|
@ -0,0 +1,43 @@
|
|||
################################################################################
|
||||
# Makefile.am
|
||||
# Copyright (C) 2025 Cor Legemaat <cor@cor.za.net>
|
||||
#
|
||||
# This file is part of scheme-dql: 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, version 3 of the License.
|
||||
|
||||
# scheme-dql 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
|
||||
# scheme-dql. If not, see <https://www.gnu.org/licenses/>.
|
||||
################################################################################
|
||||
|
||||
moddir=$(datadir)/guile/site/$(GUILE_EFFECTIVE_VERSION)/dql
|
||||
objdir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache/dql
|
||||
|
||||
SOURCES = dql.scm
|
||||
|
||||
GOBJECTS = $(SOURCES:%.scm=%.go)
|
||||
|
||||
nobase_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES)
|
||||
nobase_obj_DATA = $(GOBJECTS)
|
||||
|
||||
# Make sure source files are installed first, so that the mtime of
|
||||
# installed compiled files is greater than that of installed source
|
||||
# files. See
|
||||
# <http://lists.gnu.org/archive/html/guile-devel/2010-07/msg00125.html>
|
||||
# for details.
|
||||
guile_install_obj_files = install-nobase_obj_DATA
|
||||
$(guile_install_obj_files): install-nobase_mod_DATA
|
||||
|
||||
EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES)
|
||||
|
||||
CLEANFILES = $(GOBJECTS)
|
||||
|
||||
GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat
|
||||
GUILE_OPTS = -L $(abs_top_builddir)/src
|
||||
SUFFIXES = .scm .go
|
||||
.scm.go:
|
||||
$(GUILD) compile $(GUILE_TARGET) $(GUILE_OPTS) $(GUILE_WARNINGS) -o "$@" "$<"
|
401
src/dql.scm
Normal file
401
src/dql.scm
Normal file
|
@ -0,0 +1,401 @@
|
|||
;; -*- Mode: Scheme; geiser-scheme-implementation: guile; tab-width: 2 -*-
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
;;; dql.scm
|
||||
;;; Copyright (C) 2025 Cor Legemaat <cor@cor.za.net>
|
||||
;;;
|
||||
;;; This file is part of scheme-dql: 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, version 3 of the License.
|
||||
;;;
|
||||
;;; scheme-dql 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
|
||||
;;; scheme-dql. If not, see <https://www.gnu.org/licenses/>.
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
#|
|
||||
This module creates an interface for processing alist data in the same sense as
|
||||
how sqlite is used for processing data. The data is in alists stored and read
|
||||
by the calling application in the same way as how json is used. The querry
|
||||
syntax is fixed from SQL like how irregex fixed regular expressions.
|
||||
|#
|
||||
|
||||
;; TODO move non public functions to sub modules and generate api documentation
|
||||
;; for this module with https://luis-felipe.gitlab.io/guile-documenta/.
|
||||
|
||||
(define-module (dql dql)
|
||||
#:use-module (srfi srfi-1)
|
||||
#:use-module (ice-9 pretty-print)
|
||||
#:use-module (ice-9 optargs)
|
||||
#:use-module (oop goops))
|
||||
|
||||
(define-public alist?
|
||||
(lambda (test-list)
|
||||
"Check if the test data is an alist with the keys as strings.
|
||||
|
||||
@strong{test-list} (list):
|
||||
The data to check.
|
||||
|
||||
@strong{return} (bool):
|
||||
True if the test data is an alist with the keys as strings, false
|
||||
otherwise."
|
||||
(if (pair? test-list)
|
||||
(every (lambda (ass)
|
||||
(if (pair? ass)
|
||||
(or (string? (car ass))
|
||||
(symbol? (car ass)))
|
||||
#f))
|
||||
test-list)
|
||||
#f)))
|
||||
|
||||
(define path-val
|
||||
(lambda (path data)
|
||||
"Return the code that can determine the last key of the path, where the path
|
||||
forms a list of keys with each following key is read from the data of the
|
||||
preceding key.
|
||||
|
||||
@strong{path} (list):
|
||||
A list of key strings in the sequence as how you should traverse the
|
||||
data to get to the value.
|
||||
|
||||
@strong{data} (alist):
|
||||
The a-list data tree to retrieve the value from.
|
||||
|
||||
@strong{return} (any):
|
||||
The value stored by the last key in the path."
|
||||
(if (null? (cdr path))
|
||||
`(assoc-ref ,data ,(car path))
|
||||
(path-val (cdr path)
|
||||
`(assoc-ref ,data ,(car path))))))
|
||||
|
||||
(define-public dql-data->list
|
||||
(lambda (data)
|
||||
"Function to convert the supplied data into a list of alists from a non
|
||||
list like a vector that could be represented as a list of alists or ill
|
||||
formatted data.
|
||||
|
||||
@strong{data} (any data type that could be represented as a list):
|
||||
The source data to convert.
|
||||
|
||||
@strong{return} (list of alists):
|
||||
The input data converted to a list of alists.
|
||||
|
||||
Only vectors and ill formatted lists of alists are supported at the moment
|
||||
but more could be added like arrays etc."
|
||||
(cond ((vector? data)
|
||||
(vector->list data))
|
||||
((list? data)
|
||||
(cond ((and (pair? data) (pair? (car data)) (null? (cdr data))
|
||||
(pair? (car data)) (pair? (caar data)) (null? (cdar data)))
|
||||
;;Hack to handle nestling of answers.
|
||||
(caar data))
|
||||
((alist? data)
|
||||
;;Hack for if alist no inside list.
|
||||
(list data))
|
||||
(else data)))
|
||||
(else (error (string-append "Data not a list but \""
|
||||
(object->string (class-of data))
|
||||
"\"!\n"))))))
|
||||
|
||||
(define map-query-symbols
|
||||
(lambda (query data)
|
||||
"Function to map the querry keywords to their representative functions.
|
||||
|
||||
@strong{query} (dql-querry):
|
||||
The querry to map.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong(return) (function call):
|
||||
The call to the correct function.
|
||||
|
||||
Only the first symbol is used to determine what function to apply the
|
||||
function handle it from there and will call this function again if needed."
|
||||
(cond ((eq? (car query) 'filter)
|
||||
(dql-filter (cdr query) data))
|
||||
((eq? (car query) 'select)
|
||||
(dql-select (cdr query) data))
|
||||
((eq? (car query) 'sort)
|
||||
(dql-sort (cdr query) data))
|
||||
((eq? (car query) 'alter)
|
||||
(dql-alter (cdr query) data))
|
||||
(else (error (string-append "ERROR: Unimplemented query \""
|
||||
(object->string (car query))
|
||||
"\"!"))))))
|
||||
|
||||
(define first-parm-other
|
||||
(lambda (parms . local)
|
||||
"Function to determine if the first parameter is a local parameter or an
|
||||
sub querry that will supply the data for this query.
|
||||
|
||||
@strong{parms} (dql-query):
|
||||
The query to analyze.
|
||||
|
||||
@strong{local} (symbols):
|
||||
The function local symbols that define local parameters.
|
||||
|
||||
@strong{return} (bool):
|
||||
True if the first parameter is a sub query false otherwise."
|
||||
(and (pair? parms)
|
||||
(pair? (car parms))
|
||||
(not (any (lambda (parm)
|
||||
(eq? (caar parms) parm))
|
||||
local)))))
|
||||
|
||||
(define dql-boolean-where
|
||||
(lambda (bool-op filters entry)
|
||||
"Function to return the code that can determine if the data processed by the
|
||||
code should be selected for processing or not.
|
||||
|
||||
@strong{bool-op} (symbol):
|
||||
The boolean operation to use for multiple selections.
|
||||
|
||||
@strong{filters} (filter list):
|
||||
The list of callback filters for this query.
|
||||
|
||||
@strong{entry} (symbol)
|
||||
The symbol representing the data entry.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will analyze the data.
|
||||
|
||||
A filter is in the form of @code{(where <callback> <key> <key-n>)} where the
|
||||
keys are passed as is to @ref(path-val) and the return from that as the data
|
||||
to the callback function.
|
||||
|
||||
A boolean keyword like @samp{and} or @samp{or} will result in a tail call
|
||||
with the rest of the entries as filters."
|
||||
(if (or (eq? bool-op 'and)
|
||||
(eq? bool-op 'or))
|
||||
(append (list bool-op)
|
||||
(map (lambda (rule)
|
||||
(if (eq? (car rule) 'where)
|
||||
`(,(cadr rule) ,(path-val (cddr rule)
|
||||
entry))
|
||||
(dql-boolean-where (car rule)
|
||||
(cdr rule)
|
||||
entry)))
|
||||
filters))
|
||||
(error (string-append "Unimplemented boolean operand \""
|
||||
(symbol->string bool-op)
|
||||
"\" for where!")))))
|
||||
|
||||
(define dql-filter
|
||||
(lambda (query data)
|
||||
"Function to return the code that will filter the data entries based on the
|
||||
@xref{where, dql-boolean-where} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let ((fpo (first-parm-other query 'where 'and 'or))
|
||||
(entry (gensym)))
|
||||
`(filter-map (lambda (,entry)
|
||||
(if ,(dql-boolean-where 'and
|
||||
(if fpo
|
||||
(cdr query)
|
||||
query)
|
||||
entry)
|
||||
,entry #f))
|
||||
(dql-data->list ,(if fpo
|
||||
(map-query-symbols (car query)
|
||||
data)
|
||||
data))))))
|
||||
|
||||
(define dql-sort
|
||||
(lambda (query data)
|
||||
"Function to return the code that will sort the data entries based on the
|
||||
@code{by} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let ((fpo (first-parm-other query 'by)))
|
||||
(let ((first-parm (if fpo
|
||||
(cadr query)
|
||||
(car query)))
|
||||
(a (gensym))
|
||||
(b (gensym)))
|
||||
`(sort (dql->data->list ,(if fpo
|
||||
(map-query-symbols (car query)
|
||||
data)
|
||||
(if (null? (cdr query))
|
||||
data
|
||||
`(dql-sort ,(cdr query)))))
|
||||
(lambda (,a ,b)
|
||||
,((cadr first-parm)
|
||||
(path-val (cddr first-parm) a)
|
||||
(path-val (cddr first-parm) b))))))))
|
||||
|
||||
(define dql-alter
|
||||
(lambda (query data)
|
||||
"Function to return the code that will alter the data entries based on the
|
||||
@xref{where, dql-boolean-where} filter as the first rule and then the
|
||||
subsequent @code{insert}, @code{update} and @code{drop} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let* ((fpo (first-parm-other query 'insert 'update 'drop 'where))
|
||||
(entry (gensym))
|
||||
(parm->code
|
||||
(lambda (parm)
|
||||
;;TODO get entry from path-val.
|
||||
(cond ((eq? (car parm) 'update)
|
||||
`(set! ,entry
|
||||
(assoc-set! ,entry ,(second parm) ,(third parm))))
|
||||
((eq? (car parm) 'insert)
|
||||
`(set! ,entry
|
||||
(acons ,(second parm) ,(third parm) ,entry)))
|
||||
((eq? (car parm) 'drop)
|
||||
`(set! ,entry
|
||||
(assoc-remove! ,entry
|
||||
,(second parm))))
|
||||
(else (error (string-append "Illegal parameter \""
|
||||
(symbol->string (car parm))
|
||||
"\" for alter")))))))
|
||||
`(map ,(append (list 'lambda (list entry))
|
||||
(list (append (list 'if
|
||||
(if fpo
|
||||
(if (first-parm-other (cdr query)
|
||||
'where)
|
||||
#t
|
||||
(dql-boolean-where 'where
|
||||
(cadr query)
|
||||
entry))
|
||||
(if (first-parm-other query 'where)
|
||||
#t
|
||||
(dql-boolean-where 'where
|
||||
(car query)
|
||||
entry))))
|
||||
(list (append (list 'begin)
|
||||
(map parm->code
|
||||
(if fpo
|
||||
(cdr query)
|
||||
query))))))
|
||||
(list entry))
|
||||
(dql-data->list ,(if fpo
|
||||
(map-query-symbols (car query) data)
|
||||
data))))))
|
||||
|
||||
(define dql-select
|
||||
(lambda (query data)
|
||||
"Function to return the code that will select a subsections of the
|
||||
associations of the alist data entries based on the @code{parm},
|
||||
@code{parm-as} and @code{parm-val} rules of the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{data} (symbol)
|
||||
The symbol representing the data.
|
||||
|
||||
@strong{return} (code):
|
||||
The code that will process the data according to the query."
|
||||
(let* ((fpo (first-parm-other query 'parm 'parm-as 'parm-val))
|
||||
(entry (gensym))
|
||||
(parm->code
|
||||
(lambda (parm)
|
||||
(cond ((eq? (car parm) 'parm)
|
||||
(let ((last-parm (last parm))
|
||||
(rest-parms (drop-right (cdr parm) 1)))
|
||||
`(assoc ,last-parm
|
||||
,(if (null? rest-parms)
|
||||
entry
|
||||
(path-val rest-parms
|
||||
entry)))))
|
||||
((eq? (car parm) 'parm-as)
|
||||
`(cons ,(car (cdr parm))
|
||||
,(path-val (cdr (cdr parm))
|
||||
entry)))
|
||||
((eq? (car parm) 'parm-val)
|
||||
(let ((last-parm (last parm))
|
||||
(rest-parms (drop-right (cdr parm) 1)))
|
||||
`(assoc-ref ,(if (null? rest-parms)
|
||||
entry
|
||||
(path-val rest-parms
|
||||
entry))
|
||||
,last-parm)))
|
||||
(else
|
||||
(error "Illegal parameter for select."))))))
|
||||
`(map (lambda (,entry)
|
||||
,(append (list 'list)
|
||||
(map parm->code
|
||||
(if fpo (cdr query) query))))
|
||||
(dql-data->list ,(if fpo
|
||||
(map-query-symbols (car query) data)
|
||||
data))))))
|
||||
|
||||
(defmacro*-public dql (query #:key (print-query #f))
|
||||
"The main exported macro to return the lambda that will process the data
|
||||
based on the query.
|
||||
|
||||
@strong{query} (dql-query):
|
||||
The query to generate the code for.
|
||||
|
||||
@strong{print-query} (boolean)
|
||||
Option to @code{pretty-print} the generated lambda's code.
|
||||
|
||||
@strong{return} (lambda):
|
||||
The lambda function that will process the data according to the query."
|
||||
(let ((data (gensym)))
|
||||
(if print-query
|
||||
(begin (display "generated query for ")
|
||||
(display print-query)
|
||||
(display ":")
|
||||
(newline)
|
||||
(pretty-print `(lambda (,data)
|
||||
,(map-query-symbols query data)))))
|
||||
`(lambda (,data)
|
||||
,(map-query-symbols query data))))
|
||||
|
||||
(define-public dql-write
|
||||
(lambda (data path)
|
||||
"A helper procedure to write the data to a file.
|
||||
|
||||
@strong{data} (alist-data):
|
||||
The data to write to the file.
|
||||
|
||||
@strong{path} (string):
|
||||
The file path to write the data to.
|
||||
|
||||
@strong{return} (undefined):"
|
||||
(let ((output-port (open-output-file path)))
|
||||
(pretty-print data output-port
|
||||
#:display? #f
|
||||
#:width 600
|
||||
#:max-expr-width 600)
|
||||
(close output-port))))
|
||||
|
||||
(define-public dql-read
|
||||
(lambda (path)
|
||||
"A helper function to read data from a file.
|
||||
|
||||
@strong{path} (string):
|
||||
The file path to read the data from.
|
||||
|
||||
@strong{return} (alist-data):
|
||||
The data read from the file."
|
||||
(let* ((input-port (open-input-file path))
|
||||
(data (read input-port)))
|
||||
(close input-port)
|
||||
data)))
|
Loading…
Add table
Reference in a new issue