aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristopher R. Nelson <christopher.nelson@languidnights.com>2023-06-18 20:08:03 -0400
committerChristopher R. Nelson <christopher.nelson@languidnights.com>2023-06-18 20:08:03 -0400
commitbe36a5111c30af9d4dcd6a74c5fa1c43763e598e (patch)
tree9b261f95d768f8c1c94674d166010f51c61716a0
Initial Import
-rw-r--r--.gitignore65
-rw-r--r--COPYING661
-rw-r--r--HACKING54
l---------README1
-rw-r--r--README.org50
-rw-r--r--doc/reading-heap.texi60
-rw-r--r--guix.scm38
-rw-r--r--hall.scm34
-rw-r--r--manifest.scm3
-rwxr-xr-xreading-heap.scm62
-rw-r--r--reading-heap/client.scm18
-rw-r--r--reading-heap/hconfig.scm.hall23
-rw-r--r--reading-heap/heap.scm109
-rw-r--r--reading-heap/media.scm53
-rw-r--r--reading-heap/zmq.scm22
-rw-r--r--scripts/rh-client.scm.in5
-rw-r--r--tests/sample.json5
17 files changed, 1263 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0a123e7
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,65 @@
+*.eps
+*.go
+*.log
+*.pdf
+*.png
+*.tar.xz
+*.tar.gz
+*.tmp
+*~
+.#*
+\#*\#
+,*
+/ABOUT-NLS
+/INSTALL
+/aclocal.m4
+/autom4te.cache
+/build-aux/ar-lib
+/build-aux/compile
+/build-aux/config.guess
+/build-aux/config.rpath
+/build-aux/config.sub
+/build-aux/depcomp
+/build-aux/install-sh
+/build-aux/mdate-sh
+/build-aux/missing
+/build-aux/test-driver
+/build-aux/texinfo.tex
+/config.status
+/configure
+/doc/*.1
+/doc/.dirstamp
+/doc/contributing.*.texi
+/doc/*.aux
+/doc/*.cp
+/doc/*.cps
+/doc/*.fn
+/doc/*.fns
+/doc/*.html
+/doc/*.info
+/doc/*.info-[0-9]
+/doc/*.ky
+/doc/*.pg
+/doc/*.toc
+/doc/*.t2p
+/doc/*.tp
+/doc/*.vr
+/doc/*.vrs
+/doc/stamp-vti
+/doc/version.texi
+/doc/version-*.texi
+/m4/*
+/pre-inst-env
+/test-env
+/test-tmp
+/tests/*.trs
+GPATH
+GRTAGS
+GTAGS
+Makefile
+Makefile.in
+config.cache
+stamp-h[0-9]
+tmp
+/.version
+/doc/stamp-[0-9]
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..be3f7b2
--- /dev/null
+++ b/COPYING
@@ -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/>.
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..88435e9
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,54 @@
+# -*- mode: org; coding: utf-8; -*-
+
+#+TITLE: Hacking reading-heap
+
+* Contributing
+
+By far the easiest way to hack on reading-heap is to develop using Guix:
+
+#+BEGIN_SRC bash
+ # Obtain the source code
+ cd /path/to/source-code
+ guix shell -Df guix.scm
+ # In the new shell, run:
+ hall build --execute && autoreconf -vif && ./configure && make check
+#+END_SRC
+
+You may also want to set your directory as an authorized directory for
+`guix shell' so it works without arguments. To do that, simply run
+
+#+BEGIN_SRC bash
+ echo $(pwd) >> $HOME/.config/guix/shell-authorized-directories
+#+END_SRC
+
+You can now hack this project's files to your heart's content, whilst
+testing them from your `guix shell' shell.
+
+To try out any scripts in the project you can now use
+
+#+BEGIN_SRC bash
+ ./pre-inst-env scripts/${script-name}
+#+END_SRC
+
+If you'd like to tidy the project again, but retain the ability to test the
+project from the commandline, simply run:
+
+#+BEGIN_SRC bash
+ ./hall clean --skip "scripts/${script-name},pre-inst-env" --execute
+#+END_SRC
+
+** Manual Installation
+
+If you do not yet use Guix, you will have to install this project's
+dependencies manually:
+ - autoconf
+ - automake
+ - pkg-config
+ - texinfo
+ - guile-hall
+
+Once those dependencies are installed you can run:
+
+#+BEGIN_SRC bash
+ hall build -x && autoreconf -vif && ./configure && make check
+#+END_SRC
diff --git a/README b/README
new file mode 120000
index 0000000..314e17d
--- /dev/null
+++ b/README
@@ -0,0 +1 @@
+README.org \ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..8cd41cf
--- /dev/null
+++ b/README.org
@@ -0,0 +1,50 @@
+# -*- mode: org; coding: utf-8; -*-
+
+#+TITLE: README for Reading-Heap
+
+* Reading-Heap
+
+Reading-Heap: a service and clients for managing your media consumption order.
+
+* Description
+
+** What is Reading-Heap?
+
+Reading-Heap is a reference service and client to manage a "media heap". The basic concept is you put your media, along with a priority, on the heap and the service will calculate which one you should consume next.
+
+** What sets Reading-Heap apart?
+
+Reading-Heap is implemented as a service, so any zmq-enabled language can write a client for it. You can add an article from your phone via a web service, grab the details into your wayland clipboard from the command line, and maybe one day file it into your org-mode agenda buffer via a (upcoming) emacs client.
+
+* Installation
+
+** Dependencies
+
+- [[https://www.gnu.org/software/guile/][Guile 3.0]] (or later)
+- [[https://github.com/aconchillo/guile-json][guile-json]]
+- [[https://github.com/jerry40/guile-simple-zmq][Guile-Simple-ZMQ]]
+
+** Procedure
+
+The usual autotools make process applies here.
+
+#+BEGIN_SRC bash
+ autoreconf -vif
+ ./configure
+ make
+ sudo make install
+#+END_SRC
+
+* Usage
+
+** Command-line client
+
+#+BEGIN_SRC bash
+ reading-heap-client new --priority -1 --title "Foundation Trilogy" --author "Issac Asimov" --location "SF Bookshelf" --unique_id "0739444050"
+ reading-heap-client next
+#+END_SRC
+
+** TODO Web client
+
+Details Forthcoming
+
diff --git a/doc/reading-heap.texi b/doc/reading-heap.texi
new file mode 100644
index 0000000..5e2735a
--- /dev/null
+++ b/doc/reading-heap.texi
@@ -0,0 +1,60 @@
+\input texinfo
+@c -*-texinfo-*-
+
+@c %**start of header
+@setfilename reading-heap.info
+@documentencoding UTF-8
+@settitle Reading-Heap Reference Manual
+@c %**end of header
+
+@include version.texi
+
+@copying
+Copyright @copyright{} 2023 Christopher R. Nelson
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+copy of the license is included in the section entitled ``GNU Free
+Documentation License''.
+@end copying
+
+@dircategory The Algorithmic Language Scheme
+@direntry
+* Reading-Heap: (reading-heap).
+@end direntry
+
+@titlepage
+@title The Reading-Heap Manual
+@author Christopher R. Nelson
+
+@page
+@vskip 0pt plus 1filll
+Edition @value{EDITION} @*
+@value{UPDATED} @*
+
+@insertcopying
+@end titlepage
+
+@contents
+
+@c *********************************************************************
+@node Top
+@top Reading-Heap
+
+This document describes Reading-Heap version @value{VERSION}.
+
+@menu
+* Introduction:: Why Reading-Heap?
+@end menu
+
+@c *********************************************************************
+@node Introduction
+@chapter Introduction
+
+INTRODUCTION HERE
+
+This documentation is a stub.
+
+@bye
diff --git a/guix.scm b/guix.scm
new file mode 100644
index 0000000..3d418b8
--- /dev/null
+++ b/guix.scm
@@ -0,0 +1,38 @@
+(use-modules
+ (guix packages)
+ ((guix licenses) #:prefix license:)
+ (guix download)
+ (guix gexp)
+ (guix build-system gnu)
+ (gnu packages)
+ (gnu packages autotools)
+ (gnu packages guile)
+ (gnu packages guile-xyz)
+ (gnu packages pkg-config)
+ (gnu packages texinfo)
+ (srfi srfi-1))
+
+(package
+ (name "reading-heap")
+ (version "0.1")
+ (source
+ (local-file
+ (dirname (current-filename))
+ #:recursive?
+ #t
+ #:select?
+ (λ (file stat)
+ (not (any (lambda (my-string)
+ (string-contains file my-string))
+ (list ".git" ".dir-locals.el" "guix.scm"))))))
+ (build-system gnu-build-system)
+ (arguments `())
+ (native-inputs
+ (list autoconf automake pkg-config texinfo))
+ (inputs (list guile-3.0 guile-json guile-websocket))
+ ;; (propagated-inputs (list guile-json))
+ (synopsis "")
+ (description "")
+ (home-page "")
+ (license license:gpl3+))
+
diff --git a/hall.scm b/hall.scm
new file mode 100644
index 0000000..c3fe3d1
--- /dev/null
+++ b/hall.scm
@@ -0,0 +1,34 @@
+(hall-description
+ (name "reading-heap")
+ (prefix "")
+ (version "0.1")
+ (author "Christopher R. Nelson")
+ (email "christopher.nelson@languidnights.com")
+ (copyright (2023))
+ (synopsis "")
+ (description "")
+ (home-page "")
+ (license gpl3+)
+ (dependencies `())
+ (skip ())
+ (features
+ ((guix #f)
+ (native-language-support #f)
+ (licensing #f)))
+ (files (libraries
+ ((scheme-file "reading-heap")
+ (directory
+ "reading-heap"
+ ((unknown-type "hconfig.scm.hall")))))
+ (tests ((directory "tests" ())))
+ (programs ((directory "scripts" ())))
+ (documentation
+ ((org-file "README")
+ (symlink "README" "README.org")
+ (text-file "HACKING")
+ (text-file "COPYING")
+ (directory "doc" ((texi-file "reading-heap")))))
+ (infrastructure
+ ((scheme-file "guix")
+ (text-file ".gitignore")
+ (scheme-file "hall")))))
diff --git a/manifest.scm b/manifest.scm
new file mode 100644
index 0000000..3528e2f
--- /dev/null
+++ b/manifest.scm
@@ -0,0 +1,3 @@
+(use-modules (guix packages))
+
+(specifications->manifest (list "guile@3.0" "guile-json" "guile-simple-zmq" "zeromq"))
diff --git a/reading-heap.scm b/reading-heap.scm
new file mode 100755
index 0000000..6d821b2
--- /dev/null
+++ b/reading-heap.scm
@@ -0,0 +1,62 @@
+#!/usr/bin/env guile
+!#
+(define-module (reading-heap))
+
+(use-modules (srfi srfi-1)
+ (config)
+ (config api)
+ (config licenses)
+ (config parser sexp)
+ (reading-heap heap)
+ (reading-heap media)
+ (reading-heap zmq))
+
+(define config
+ (configuration
+ (name 'rh-server)
+ (synopsis "client for reading-heap")
+ (keywords
+ (list
+ (setting
+ (name 'media-library)
+ (synopsis "media library location")
+ (default (string-append (or (getenv "XDG_DATA_HOME")
+ (string-append (getenv "HOME")
+ "/.local/share"))
+ "/media-library")))
+ (switch
+ (name 'write)
+ (synopsis "write the default config")
+ (default #f)
+ (test boolean?)
+ (character #f))
+ (switch
+ (name 'serve)
+ (synopsis "server the media heap")
+ (default #f)
+ (test boolean?)
+ (character #t))
+ ))
+ (directory (list (in-home ".reading-heap/")
+ (path (given
+ (string-append (or (getenv "XDG_CONFIG_HOME")
+ (string-append (getenv "HOME")
+ "/.config"))
+ "/reading-heap/"))
+ (eager? #t))))
+ (parser sexp-parser)))
+
+(define-public media (filetree->media-list "/home/christopher/src/reading-heap/tests"))
+(define-public priorities (map media-priority media))
+(define-public heap (fold heap-insert 'E priorities media))
+
+;; (rh-receive heap)
+
+(define (main cmd-line)
+ (let ((options (getopt-config-auto cmd-line config)))
+ (when (option-ref options 'write)
+ (options-write options))
+ (when (option-ref options 'serve)
+ (rh-receive heap))))
+
+(main (command-line))
diff --git a/reading-heap/client.scm b/reading-heap/client.scm
new file mode 100644
index 0000000..92eb72b
--- /dev/null
+++ b/reading-heap/client.scm
@@ -0,0 +1,18 @@
+(define-module (reading-heap client))
+
+(use-modules (simple-zmq))
+
+(define context (zmq-create-context))
+(define client-socket (zmq-create-socket context ZMQ_REQ))
+
+(zmq-connect client-socket (string-append "ipc://"
+ (or (getenv "XDG_RUNTIME_DIR")
+ "/tmp")
+ "/reading-zmq"))
+
+(define (rh-client-receive)
+ (zmq-send client-socket "next")
+ (let ((msg (zmq-receive-bytevector client-socket 100)))
+ (display (bv->string msg))))
+
+(export rh-client-receive)
diff --git a/reading-heap/hconfig.scm.hall b/reading-heap/hconfig.scm.hall
new file mode 100644
index 0000000..62f3b9b
--- /dev/null
+++ b/reading-heap/hconfig.scm.hall
@@ -0,0 +1,23 @@
+(define-module
+ (reading-heap hconfig)
+ #:use-module
+ (srfi srfi-26)
+ #:export
+ (%version
+ %author
+ %license
+ %copyright
+ %gettext-domain
+ G_
+ N_
+ init-nls
+ init-locale))
+
+(define %version "0.1")
+
+(define %author "Christopher R. Nelson")
+
+(define %license 'gpl3+)
+
+(define %copyright '(2023))
+
diff --git a/reading-heap/heap.scm b/reading-heap/heap.scm
new file mode 100644
index 0000000..a4d040c
--- /dev/null
+++ b/reading-heap/heap.scm
@@ -0,0 +1,109 @@
+(define-module (reading-heap heap)
+ #:export (heap-insert)
+ #:export (heap-get-min)
+ #:export (heap-delete-min)
+ #:export (heap-traverse)
+ #:export (heap-graphviz-traverse))
+
+(use-modules (srfi srfi-9))
+
+(define-record-type <node>
+ (make-node rank priority media left right)
+ node?
+ (rank node-rank set-node-rank!)
+ (priority node-priority set-node-priority!)
+ (media node-media set-node-media!)
+ (left node-left set-node-left!)
+ (right node-right set-node-right!))
+
+(define empty-heap 'E)
+
+(define heap-empty?
+ (lambda (heap)
+ (if (eq? empty-heap heap) #t
+ #f)))
+
+(define heap-node-rank
+ (lambda (heap)
+ (if (heap-empty? heap)
+ 0
+ (node-rank heap))))
+
+(define heap-make-node
+ (lambda (node heap-1 heap-2)
+ (let ((rank-1 (heap-node-rank heap-1))
+ (rank-2 (heap-node-rank heap-2)))
+ (if (>= rank-1 rank-2)
+ (make-node (+ 1 rank-2)
+ (node-priority node)
+ (node-media node)
+ heap-1
+ heap-2)
+ (make-node (+ 1 rank-1)
+ (node-priority node)
+ (node-media node)
+ heap-2
+ heap-1)))))
+
+(define heap-merge
+ (lambda (heap-1 heap-2)
+ (cond ((heap-empty? heap-1) heap-2)
+ ((heap-empty? heap-2) heap-1)
+ (#t
+ (let ((priority-1 (node-priority heap-1))
+ (priority-2 (node-priority heap-2)))
+ (if (<= priority-1 priority-2)
+ (heap-make-node heap-1
+ (node-left heap-1)
+ (heap-merge (node-right heap-1) heap-2))
+ (heap-make-node heap-2
+ (node-left heap-2)
+ (heap-merge heap-1 (node-right heap-2)))))))))
+
+(define heap-insert
+ (lambda (priority media heap)
+ (heap-merge (make-node 1 priority media 'E 'E) heap)))
+
+(define heap-get-min
+ (lambda (heap)
+ (unless (heap-empty? heap) (node-media heap))))
+
+(define heap-delete-min
+ (lambda (heap)
+ (if (heap-empty? heap) heap
+ (heap-merge (node-left heap)
+ (node-right heap)))))
+
+(define heap-traverse
+ (lambda (visit heap)
+ (visit heap (node-left heap) (node-right heap))
+ (unless (heap-empty? (node-left heap)) (heap-traverse visit (node-left heap)))
+ (unless (heap-empty? (node-right heap)) (heap-traverse visit (node-right heap)))))
+
+(define heap-graphviz-traverse
+ (lambda (filename heap)
+ (let ((port (open-output-file filename)))
+ (display "digraph { rankdir=TB; splines=true; node [shape=box];\n" port)
+ (heap-traverse (lambda (heap heap-left heap-right)
+ (let ((head-data (node-media heap))
+ (head-priority (node-priority heap)))
+ (display "\"" port)
+ (display head-data port)
+ (display "\" [shape=Mrecord,label=\"" port)
+ (display head-data port)
+ (display "\"]\n" port)
+ (unless (heap-empty? heap-left)
+ (display "\"" port)
+ (display head-data port)
+ (display "\"->\"" port)
+ (display (node-media heap-left) port)
+ (display "\"\n" port))
+ (unless (heap-empty? heap-right)
+ (display "\"" port)
+ (display head-data port)
+ (display "\"->\"" port)
+ (display (node-media heap-left) port)
+ (display "\"\n" port))))
+ heap)
+ (display "}" port)
+ (close-port port))))
diff --git a/reading-heap/media.scm b/reading-heap/media.scm
new file mode 100644
index 0000000..12b6b0e
--- /dev/null
+++ b/reading-heap/media.scm
@@ -0,0 +1,53 @@
+(define-module (reading-heap media))
+
+(use-modules (ice-9 ftw)
+ (ice-9 textual-ports)
+ (json)
+ (reading-heap heap)
+ (srfi srfi-1)
+ (srfi srfi-9 gnu))
+
+(define-json-type <media>
+ (priority)
+ (title)
+ (author)
+ (location)
+ (unique-id)
+ (cover-img))
+
+(set-record-type-printer!
+ <media>
+ (lambda (record port)
+ (display "title:" port)
+ (display (media-title record) port)
+ (display "\nauthor:" port)
+ (display (media-author record) port)))
+
+(define file->media
+ (lambda (filename)
+ (json->media (call-with-input-file filename get-string-all))))
+
+(define (filetree->media-list dirname)
+ (define (enter? name stat result)
+ (not (member (basename name) '(".git" ".svn"))))
+ (define (leaf name stat result)
+ (cons (file->media name) result))
+ (define (down name stat result) result)
+ (define (up name stat result) result)
+ (define (skip name stat result) result)
+ (define (error name stat errno result) result)
+
+ (file-system-fold enter? leaf down up skip error '() dirname))
+
+(export <media>
+ make-media
+ media-author
+ media-cover-img
+ media-location
+ media-priority
+ media-title
+ media-unique-id
+ media->json
+ json->media
+ file->media
+ filetree->media-list)
diff --git a/reading-heap/zmq.scm b/reading-heap/zmq.scm
new file mode 100644
index 0000000..51b530c
--- /dev/null
+++ b/reading-heap/zmq.scm
@@ -0,0 +1,22 @@
+(define-module (reading-heap zmq))
+
+(use-modules (ice-9 match)
+ (simple-zmq)
+ (reading-heap heap)
+ (reading-heap media))
+
+(define context (zmq-create-context))
+(define server-socket (zmq-create-socket context ZMQ_REP))
+
+(zmq-bind-socket server-socket (string-append "ipc://"
+ (or (getenv "XDG_RUNTIME_DIR")
+ "/tmp")
+ "/reading-zmq"))
+
+(define (rh-receive heap)
+ (let ((command (zmq-receive server-socket 100)))
+ (display command)
+ (zmq-send server-socket (media->json (heap-get-min heap))))
+ (rh-receive heap))
+
+(export rh-receive)
diff --git a/scripts/rh-client.scm.in b/scripts/rh-client.scm.in
new file mode 100644
index 0000000..0fddb63
--- /dev/null
+++ b/scripts/rh-client.scm.in
@@ -0,0 +1,5 @@
+(use-modules (reading-heap client)
+ (config)
+ (config api)
+ (config licenses))
+
diff --git a/tests/sample.json b/tests/sample.json
new file mode 100644
index 0000000..b2fbffe
--- /dev/null
+++ b/tests/sample.json
@@ -0,0 +1,5 @@
+{
+ "title": "Foundation Trilogy",
+ "author": "Isaac Asimov",
+ "priority": 1
+}