diff --git a/hashtbl/CHANGELOG.md b/hashtbl/CHANGELOG.md
new file mode 100644
index 00000000..faa59af7
--- /dev/null
+++ b/hashtbl/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Revision history for hashtbl
+
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.
diff --git a/hashtbl/LICENSE b/hashtbl/LICENSE
new file mode 100644
index 00000000..d9acb902
--- /dev/null
+++ b/hashtbl/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/hashtbl/app/Main.hs b/hashtbl/app/Main.hs
new file mode 100644
index 00000000..495a0d73
--- /dev/null
+++ b/hashtbl/app/Main.hs
@@ -0,0 +1,8 @@
+module Main where
+
+import qualified MyLib (someFunc)
+
+main :: IO ()
+main = do
+ putStrLn "Hello, Haskell!"
+ MyLib.someFunc
diff --git a/hashtbl/hashtbl.cabal b/hashtbl/hashtbl.cabal
new file mode 100644
index 00000000..4d590170
--- /dev/null
+++ b/hashtbl/hashtbl.cabal
@@ -0,0 +1,131 @@
+cabal-version: 3.4
+-- The cabal-version field refers to the version of the .cabal specification,
+-- and can be different from the cabal-install (the tool) version and the
+-- Cabal (the library) version you are using. As such, the Cabal (the library)
+-- version used must be equal or greater than the version stated in this field.
+-- Starting from the specification version 2.2, the cabal-version field must be
+-- the first thing in the cabal file.
+
+-- Initial package description 'hashtbl' generated by
+-- 'cabal init'. For further documentation, see:
+-- http://haskell.org/cabal/users-guide/
+--
+-- The name of the package.
+name: hashtbl
+
+-- The package version.
+-- See the Haskell package versioning policy (PVP) for standards
+-- guiding when and how versions should be incremented.
+-- https://pvp.haskell.org
+-- PVP summary: +-+------- breaking API changes
+-- | | +----- non-breaking API additions
+-- | | | +--- code changes with no API change
+version: 0.1.0.0
+
+-- A short (one-line) description of the package.
+synopsis: Clash order map
+
+-- A longer description of the package.
+-- description:
+
+-- URL for the project homepage or repository.
+homepage: https://punt-engine.com/
+
+-- The license under which the package is released.
+license: GPL-3.0-or-later
+
+-- The file containing the license text.
+license-file: LICENSE
+
+-- The package author(s).
+author: NaquanS
+
+-- An email address to which users can send suggestions, bug reports, and patches.
+maintainer: contact@naquansmith.com
+
+-- A copyright notice.
+-- copyright:
+category: Data Structure
+build-type: Simple
+
+-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.
+extra-doc-files: CHANGELOG.md
+
+-- Extra source files to be distributed with the package, such as examples, or a tutorial module.
+-- extra-source-files:
+
+common warnings
+ ghc-options: -Wall
+
+library
+ -- Import common warning flags.
+ import: warnings
+
+ -- Modules exported by the library.
+ exposed-modules: MyLib
+
+ -- Modules included in this library but not exported.
+ -- other-modules:
+
+ -- LANGUAGE extensions used by modules in this package.
+ -- other-extensions:
+
+ -- Other library packages from which modules are imported.
+ build-depends: base ^>=4.17.2.1
+
+ -- Directories containing source files.
+ hs-source-dirs: src
+
+ -- Base language which the package is written in.
+ default-language: GHC2021
+
+executable hashtbl
+ -- Import common warning flags.
+ import: warnings
+
+ -- .hs or .lhs file containing the Main module.
+ main-is: Main.hs
+
+ -- Modules included in this executable, other than Main.
+ -- other-modules:
+
+ -- LANGUAGE extensions used by modules in this package.
+ -- other-extensions:
+
+ -- Other library packages from which modules are imported.
+ build-depends:
+ base ^>=4.17.2.1,
+ hashtbl
+
+ -- Directories containing source files.
+ hs-source-dirs: app
+
+ -- Base language which the package is written in.
+ default-language: GHC2021
+
+test-suite hashtbl-test
+ -- Import common warning flags.
+ import: warnings
+
+ -- Base language which the package is written in.
+ default-language: GHC2021
+
+ -- Modules included in this executable, other than Main.
+ -- other-modules:
+
+ -- LANGUAGE extensions used by modules in this package.
+ -- other-extensions:
+
+ -- The interface type and version of the test suite.
+ type: exitcode-stdio-1.0
+
+ -- Directories containing source files.
+ hs-source-dirs: test
+
+ -- The entrypoint to the test suite.
+ main-is: Main.hs
+
+ -- Test dependencies.
+ build-depends:
+ base ^>=4.17.2.1,
+ hashtbl
diff --git a/hashtbl/src/MyLib.hs b/hashtbl/src/MyLib.hs
new file mode 100644
index 00000000..4e2b98d5
--- /dev/null
+++ b/hashtbl/src/MyLib.hs
@@ -0,0 +1,4 @@
+module MyLib (someFunc) where
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"
diff --git a/hashtbl/src/README.md b/hashtbl/src/README.md
new file mode 100644
index 00000000..380e2b9d
--- /dev/null
+++ b/hashtbl/src/README.md
@@ -0,0 +1,76 @@
+# FIX v4.4 parser
+
+## FSM
+
+
+
+## Building and testing
+
+## Cabal (Linux, MacOS)
+**The following instructions only work for Cabal >=3.0 and GHC >=8.4.**
+
+First, update your cabal package database:
+
+```bash
+cabal update
+```
+
+You only have to run the update command once. After that, you can keep rebuilding your project by running the build command:
+
+```bash
+cabal build
+```
+
+To run the tests defined in `tests/`, use:
+
+```bash
+cabal run test-library
+cabal run doctests
+```
+
+To compile the project to VHDL, run:
+
+```bash
+cabal run clash -- HashTable --vhdl
+```
+
+You can find the HDL files in `vhdl/`. The source can be found in `src/Example/Project.hs`.
+
+## REPL
+Clash offers a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) as a quick way to try things, similar to Python's `python` or Ruby's `irb`.
+
+Cabal users use:
+
+```
+cabal run clashi
+```
+
+## tests/
+Most of this directory is scaffolding, with the meat of the tests being defined in `tests/Tests/Example/Project.hs`. Writing good test cases is pretty hard: edge cases are easy to forget both in the implementation and tests. To this end, it's a good idea to use _fuzz testing_. In this project we use [Hedgehog](https://hedgehog.qa/):
+
+```haskell
+import Example.Project (plus)
+
+prop_plusIsCommutative :: H.Property
+prop_plusIsCommutative = H.property $ do
+ a <- H.forAll (Gen.integral (Range.linear minBound maxBound))
+ b <- H.forAll (Gen.integral (Range.linear minBound maxBound))
+ plus a b === plus b a
+```
+
+This test generates two numbers `a` and `b` that fit neatly into domain of `Signed 8`, thanks to the use of `minBound` and `maxBound`. It then tests whether the `plus` operation commutes. I.e., whether `a + b ~ b + a`. All functions called `prop_*` are collected automatically:
+
+```haskell
+tests :: TestTree
+tests = $(testGroupGenerator)
+```
+
+We can run the tests using `cabal run test-library`:
+
+```
+.
+ Tests.Example.Project
+ plusIsCommutative: OK
+ ✓ plusIsCommutative passed 100 tests.
+
+All 1 tests passed (0.00s)```
diff --git a/hashtbl/src/bin/Clash.hs b/hashtbl/src/bin/Clash.hs
new file mode 100644
index 00000000..7193d8b0
--- /dev/null
+++ b/hashtbl/src/bin/Clash.hs
@@ -0,0 +1,7 @@
+
+import Prelude
+import System.Environment (getArgs)
+import Clash.Main (defaultMain)
+
+main :: IO ()
+main = getArgs >>= defaultMain
diff --git a/hashtbl/src/bin/Clashi.hs b/hashtbl/src/bin/Clashi.hs
new file mode 100644
index 00000000..227a201e
--- /dev/null
+++ b/hashtbl/src/bin/Clashi.hs
@@ -0,0 +1,7 @@
+
+import Prelude
+import System.Environment (getArgs)
+import Clash.Main (defaultMain)
+
+main :: IO ()
+main = getArgs >>= defaultMain . ("--interactive":)
diff --git a/hashtbl/src/cabal.project b/hashtbl/src/cabal.project
new file mode 100644
index 00000000..b8e20976
--- /dev/null
+++ b/hashtbl/src/cabal.project
@@ -0,0 +1,7 @@
+packages:
+ punt-engine-haskell-cores.cabal
+
+write-ghc-environment-files: always
+
+-- Eliminates the need for `--enable-tests`, which is needed for HLS.
+tests: true
diff --git a/hashtbl/src/hie.yaml b/hashtbl/src/hie.yaml
new file mode 100644
index 00000000..0802e84a
--- /dev/null
+++ b/hashtbl/src/hie.yaml
@@ -0,0 +1,12 @@
+cradle:
+ cabal:
+ - path: "./src"
+ component: "lib:punt-engine-haskell-cores"
+ - path: "./tests/doctests.hs"
+ component: "punt-engine-haskell-cores:doctests"
+ - path: "./tests"
+ component: "punt-engine-haskell-cores:test-library"
+ - path: "./bin/Clashi.hs"
+ component: "punt-engine-haskell-cores:exe:clashi"
+ - path: "./bin/Clash.hs"
+ component: "punt-engine-haskell-cores:exe:clash"
diff --git a/hashtbl/src/punt-engine-haskell-cores.cabal b/hashtbl/src/punt-engine-haskell-cores.cabal
new file mode 100644
index 00000000..cf14f6f9
--- /dev/null
+++ b/hashtbl/src/punt-engine-haskell-cores.cabal
@@ -0,0 +1,135 @@
+cabal-version: 2.4
+name: punt-engine-haskell-cores
+version: 0.1
+license: MIT
+author: Race Williams
+maintainer: Race Williams
+
+common common-options
+ default-extensions:
+ BangPatterns
+ BinaryLiterals
+ ConstraintKinds
+ DataKinds
+ DefaultSignatures
+ DeriveAnyClass
+ DeriveDataTypeable
+ DeriveFoldable
+ DeriveFunctor
+ DeriveGeneric
+ DeriveLift
+ DeriveTraversable
+ DerivingStrategies
+ FlexibleContexts
+ InstanceSigs
+ KindSignatures
+ LambdaCase
+ NamedFieldPuns
+ NoStarIsType
+ PolyKinds
+ RankNTypes
+ RecordWildCards
+ ScopedTypeVariables
+ StandaloneDeriving
+ TupleSections
+ TypeApplications
+ TypeFamilies
+ TypeOperators
+ ViewPatterns
+
+ -- TemplateHaskell is used to support convenience functions such as
+ -- 'listToVecTH' and 'bLit'.
+ TemplateHaskell
+ QuasiQuotes
+
+ -- Prelude isn't imported by default as Clash offers Clash.Prelude
+ NoImplicitPrelude
+ ghc-options:
+ -Wall -Wcompat
+ -haddock
+
+ -- Plugins to support type-level constraint solving on naturals
+ -fplugin GHC.TypeLits.Extra.Solver
+ -fplugin GHC.TypeLits.Normalise
+ -fplugin GHC.TypeLits.KnownNat.Solver
+
+ -- Clash needs access to the source code in compiled modules
+ -fexpose-all-unfoldings
+
+ -- Worker wrappers introduce unstable names for functions that might have
+ -- blackboxes attached for them. You can disable this, but be sure to add
+ -- a no-specialize pragma to every function with a blackbox.
+ -fno-worker-wrapper
+
+ -- Strict annotations - while sometimes preventing space leaks - trigger
+ -- optimizations Clash can't deal with. See:
+ --
+ -- https://github.com/clash-lang/clash-compiler/issues/2361
+ --
+ -- These flags disables these optimizations. Note that the fields will
+ -- remain strict.
+ -fno-unbox-small-strict-fields
+ -fno-unbox-strict-fields
+ build-depends:
+ base,
+ Cabal,
+
+ -- clash-prelude will set suitable version bounds for the plugins
+ clash-prelude >= 1.8.1 && < 1.10,
+ ghc-typelits-natnormalise,
+ ghc-typelits-extra,
+ ghc-typelits-knownnat
+
+
+library
+ import: common-options
+ hs-source-dirs: src
+ exposed-modules:
+ HashTable.Top
+ Example.Project
+ default-language: Haskell2010
+
+-- Builds the executable 'clash', with punt-engine-haskell-cores project in scope
+executable clash
+ main-is: bin/Clash.hs
+ default-language: Haskell2010
+ Build-Depends: base, clash-ghc, punt-engine-haskell-cores
+ if !os(Windows)
+ ghc-options: -dynamic
+
+-- Builds the executable 'clashi', with punt-engine-haskell-cores project in scope
+executable clashi
+ main-is: bin/Clashi.hs
+ default-language: Haskell2010
+ if !os(Windows)
+ ghc-options: -dynamic
+ build-depends: base, clash-ghc, punt-engine-haskell-cores
+
+test-suite doctests
+ type: exitcode-stdio-1.0
+ default-language: Haskell2010
+ main-is: doctests.hs
+ ghc-options: -Wall -Wcompat -threaded
+ hs-source-dirs: tests
+ build-depends:
+ base,
+ punt-engine-haskell-cores,
+ doctest-parallel >= 0.2 && < 0.4,
+
+test-suite test-library
+ import: common-options
+ default-language: Haskell2010
+ hs-source-dirs: tests
+ type: exitcode-stdio-1.0
+ ghc-options: -threaded
+ main-is: unittests.hs
+ other-modules:
+ Tests.Example.Project
+ build-depends:
+ punt-engine-haskell-cores,
+ QuickCheck,
+ clash-prelude-hedgehog,
+ hedgehog,
+ tasty >= 1.2 && < 1.5,
+ tasty-hedgehog,
+ tasty-th
diff --git a/hashtbl/src/src/Example/Project.hs b/hashtbl/src/src/Example/Project.hs
new file mode 100644
index 00000000..22e4be40
--- /dev/null
+++ b/hashtbl/src/src/Example/Project.hs
@@ -0,0 +1,54 @@
+-- @createDomain@ below generates a warning about orphan instances, but we like
+-- our code to be warning-free.
+{-# OPTIONS_GHC -Wno-orphans #-}
+
+module Example.Project where
+
+import Clash.Prelude
+
+-- Create a domain with the frequency of your input clock. For this example we used
+-- 50 MHz.
+createDomain vSystem{vName="Dom50", vPeriod=hzToPeriod 50e6}
+
+-- | @topEntity@ is Clash@s equivalent of @main@ in other programming languages.
+-- Clash will look for it when compiling "Example.Project" and translate it to
+-- HDL. While polymorphism can be used freely in Clash projects, a @topEntity@
+-- must be monomorphic and must use non- recursive types. Or, to put it
+-- hand-wavily, a @topEntity@ must be translatable to a static number of wires.
+--
+-- Top entities must be monomorphic, meaning we have to specify all type variables.
+-- In this case, we are using the @Dom50@ domain, which we created with @createDomain@
+-- and we are using 8-bit unsigned numbers.
+topEntity ::
+ Clock Dom50 ->
+ Reset Dom50 ->
+ Enable Dom50 ->
+ Signal Dom50 (Unsigned 8) ->
+ Signal Dom50 (Unsigned 8)
+topEntity = exposeClockResetEnable accum
+
+-- To specify the names of the ports of our top entity, we create a @Synthesize@ annotation.
+{-# ANN topEntity
+ (Synthesize
+ { t_name = "accum"
+ , t_inputs = [ PortName "CLK"
+ , PortName "RST"
+ , PortName "EN"
+ , PortName "DIN"
+ ]
+ , t_output = PortName "DOUT"
+ }) #-}
+
+-- Make sure GHC does not apply any optimizations to the boundaries of the design.
+-- For GHC versions 9.2 or older, use: {-# NOINLINE topEntity #-}
+{-# OPAQUE topEntity #-}
+
+-- | A simple accumulator that works on unsigned numbers of any size.
+-- It has hidden clock, reset, and enable signals.
+accum ::
+ (HiddenClockResetEnable dom, KnownNat n) =>
+ Signal dom (Unsigned n) ->
+ Signal dom (Unsigned n)
+accum = mealy accumT 0
+ where
+ accumT s i = (s + i, s)
diff --git a/hashtbl/src/src/HashTable/Top.hs b/hashtbl/src/src/HashTable/Top.hs
new file mode 100644
index 00000000..fd81b10d
--- /dev/null
+++ b/hashtbl/src/src/HashTable/Top.hs
@@ -0,0 +1,221 @@
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE TypeFamilies #-}
+
+module HashTable where
+
+import Clash.Prelude
+import Data.Char (ord)
+
+type MaxTagLength = 5
+
+type MaxValueLength = 64
+
+type MaxNumTags = 64
+
+type Byte = Unsigned 8
+
+type Tag = Unsigned 16 -- Tag numbers up to 65535
+
+type TagDigits = Vec MaxTagLength Byte
+
+data ParserState
+ = WaitingForTag
+ | ReadingTag
+ | ReadingValue
+ | ValidatingChecksum
+ | MessageComplete
+ | ErrorState ErrorType
+ deriving (Generic, NFDataX, Show, Eq)
+
+data ErrorType
+ = InvalidTag
+ | InvalidValue
+ | ChecksumMismatch
+ | UnexpectedByte
+ | MalformedMessage
+ | BufferOverflow
+ deriving (Generic, NFDataX, Show, Eq)
+
+data ParserOutput
+ = ParsedMessage MessageData
+ | ParserError ErrorType
+ deriving (Generic, NFDataX, Show)
+
+newtype Value = Value (Vec MaxValueLength Byte)
+ deriving (Generic, NFDataX, Show)
+
+newtype MessageData = MessageData
+ { tags :: Vec MaxNumTags (Tag, Value)
+ }
+ deriving (Generic, NFDataX, Show)
+
+data ParserData = ParserData
+ { tagDigits :: Vec MaxTagLength Byte,
+ tagDigitIndex :: Index MaxTagLength,
+ currentTag :: Tag,
+ valueBytes :: Vec MaxValueLength Byte,
+ valueByteIndex :: Index MaxValueLength,
+ tagsAccum :: Vec MaxNumTags (Tag, Value),
+ tagIndex :: Index MaxNumTags,
+ calcChecksum :: Unsigned 16, -- Accumulated checksum
+ inMessage :: Bool -- Indicates whether we're in a message
+ }
+ deriving (Generic, NFDataX)
+
+topEntity ::
+ Clock System ->
+ Reset System ->
+ Enable System ->
+ Signal System Byte ->
+ Signal System (Maybe ParserOutput)
+topEntity = exposeClockResetEnable parser
+{-# ANN
+ topEntity
+ ( Synthesize
+ { t_name = "HashTableTop",
+ t_inputs =
+ [ PortName "CLK",
+ PortName "RST",
+ PortName "EN",
+ PortName "DIN"
+ ],
+ t_output = PortName "DOUT"
+ }
+ )
+ #-}
+
+parser ::
+ (HiddenClockResetEnable dom) =>
+ Signal dom Byte ->
+ Signal dom (Maybe ParserOutput)
+parser = mealy parserT initialState
+ where
+ initialState = (WaitingForTag, initialParserData)
+
+initialParserData :: ParserData
+initialParserData =
+ ParserData
+ { tagDigits = repeat 0,
+ tagDigitIndex = 0,
+ currentTag = 0,
+ valueBytes = repeat 0,
+ valueByteIndex = 0,
+ tagsAccum = repeat (0, Value (repeat 0)),
+ tagIndex = 0,
+ calcChecksum = 0,
+ inMessage = False
+ }
+
+parserT ::
+ (ParserState, ParserData) ->
+ Byte ->
+ ((ParserState, ParserData), Maybe ParserOutput)
+parserT (state, pdata@ParserData {..}) byte = case state of
+ WaitingForTag ->
+ if isDigitByte byte
+ then
+ let tagDigits' = replace 0 byte tagDigits
+ pdata' =
+ pdata
+ { tagDigits = tagDigits',
+ tagDigitIndex = 1,
+ inMessage = True,
+ calcChecksum = if inMessage then calcChecksum + byte else byte
+ }
+ in ((ReadingTag, pdata'), Nothing)
+ else ((WaitingForTag, pdata), Nothing)
+ ReadingTag ->
+ if isDigitByte byte
+ then
+ if tagDigitIndex < maxBound
+ then
+ let tagDigits' = replace tagDigitIndex byte tagDigits
+ pdata' =
+ pdata
+ { tagDigits = tagDigits',
+ tagDigitIndex = tagDigitIndex + 1,
+ calcChecksum = calcChecksum + byte
+ }
+ in ((ReadingTag, pdata'), Nothing)
+ else ((ErrorState BufferOverflow, pdata), Just (ParserError BufferOverflow))
+ else
+ if byte == asciiOf '='
+ then
+ let tag = parseTag tagDigits tagDigitIndex
+ pdata' =
+ pdata
+ { currentTag = tag,
+ tagDigits = repeat 0,
+ tagDigitIndex = 0,
+ calcChecksum = calcChecksum + byte
+ }
+ in ((ReadingValue, pdata'), Nothing)
+ else
+ ((ErrorState InvalidTag, pdata), Just (ParserError InvalidTag))
+ ReadingValue ->
+ if byte == asciiSOH
+ then
+ let value = Value (take valueByteIndex valueBytes)
+ tagsAccum' = replace tagIndex (currentTag, value) tagsAccum
+ calcChecksum' = if currentTag == 10 then calcChecksum else calcChecksum + byte
+ pdata' =
+ pdata
+ { tagsAccum = tagsAccum',
+ tagIndex = tagIndex + 1,
+ currentTag = 0,
+ valueBytes = repeat 0,
+ valueByteIndex = 0,
+ calcChecksum = calcChecksum'
+ }
+ nextState =
+ if currentTag == 10
+ then ValidatingChecksum
+ else WaitingForTag
+ in ((nextState, pdata'), Nothing)
+ else
+ if valueByteIndex < maxBound
+ then
+ let valueBytes' = replace valueByteIndex byte valueBytes
+ calcChecksum' = if currentTag == 10 then calcChecksum else calcChecksum + byte
+ pdata' =
+ pdata
+ { valueBytes = valueBytes',
+ valueByteIndex = valueByteIndex + 1,
+ calcChecksum = calcChecksum'
+ }
+ in ((ReadingValue, pdata'), Nothing)
+ else ((ErrorState BufferOverflow, pdata), Just (ParserError BufferOverflow))
+ ValidatingChecksum ->
+ let receivedChecksum = parseChecksum valueBytes valueByteIndex
+ calculatedChecksum = calcChecksum `mod` 256
+ in if receivedChecksum == calculatedChecksum
+ then
+ let message = MessageData {tags = take tagIndex tagsAccum}
+ in ((MessageComplete, pdata), Just (ParsedMessage message))
+ else ((ErrorState ChecksumMismatch, pdata), Just (ParserError ChecksumMismatch))
+ MessageComplete ->
+ let pdata' = initialParserData
+ in ((WaitingForTag, pdata'), Nothing)
+ ErrorState err ->
+ ((ErrorState err, pdata), Just (ParserError err))
+
+asciiOf :: Char -> Byte
+asciiOf c = fromIntegral (ord c)
+
+asciiSOH :: Byte
+asciiSOH = 0x01 -- SOH character
+
+isDigitByte :: Byte -> Bool
+isDigitByte byte = byte >= asciiOf '0' && byte <= asciiOf '9'
+
+parseTag :: Vec MaxTagLength Byte -> Index MaxTagLength -> Tag
+parseTag tagDigits len =
+ foldl (\acc d -> acc * 10 + fromIntegral (d - asciiOf '0')) 0 (take len tagDigits)
+
+parseChecksum :: Vec MaxValueLength Byte -> Index MaxValueLength -> Unsigned 16
+parseChecksum valueBytes len =
+ foldl (\acc d -> acc * 10 + fromIntegral (d - asciiOf '0')) 0 (take len valueBytes)
diff --git a/hashtbl/src/stack.yaml b/hashtbl/src/stack.yaml
new file mode 100644
index 00000000..58702d5b
--- /dev/null
+++ b/hashtbl/src/stack.yaml
@@ -0,0 +1,9 @@
+resolver: lts-21.20
+
+extra-deps:
+- clash-ghc-1.8.1@sha256:3bab304fa5584f3541650bddd01160f2710b9ced52e52c06481a91ac73d71bb8,9753
+- clash-lib-1.8.1@sha256:17d78e786dedf16a76394cd5813372870a3d70a1a4c7f964309f126b800e90f6,15693
+- clash-prelude-1.8.1@sha256:c3fbb9f6b8e74140fb3d5c4d59ec84cfe4a53e9f8520e606c187cfc04b149065,17626
+- clash-prelude-hedgehog-1.8.1@sha256:9ec3aa3f8195481f5ce4942b34a49c97dd132dd1c8f1fa58aeecbd82c2602e86,1410
+- concurrent-supply-0.1.8@sha256:80b658533141660818d0781b8c8fb9a8cf69b987fcfbab782dc788bfc7df4846,1627
+- prettyprinter-interp-0.2.0.0@sha256:69c339a95b265dab9b3478ca19ec96952b6b472bd0ff6e2127112a9562362c1d,2086
diff --git a/hashtbl/src/stack.yaml.lock b/hashtbl/src/stack.yaml.lock
new file mode 100644
index 00000000..9bdc941b
--- /dev/null
+++ b/hashtbl/src/stack.yaml.lock
@@ -0,0 +1,54 @@
+# This file was autogenerated by Stack.
+# You should not edit this file by hand.
+# For more information, please see the documentation at:
+# https://docs.haskellstack.org/en/stable/lock_files
+
+packages:
+- completed:
+ hackage: clash-ghc-1.8.1@sha256:3bab304fa5584f3541650bddd01160f2710b9ced52e52c06481a91ac73d71bb8,9753
+ pantry-tree:
+ sha256: 7ed7168cb8383f86eb0f8f97409c0af484ea9b645a0e9fd416115483932ce695
+ size: 5655
+ original:
+ hackage: clash-ghc-1.8.1@sha256:3bab304fa5584f3541650bddd01160f2710b9ced52e52c06481a91ac73d71bb8,9753
+- completed:
+ hackage: clash-lib-1.8.1@sha256:17d78e786dedf16a76394cd5813372870a3d70a1a4c7f964309f126b800e90f6,15693
+ pantry-tree:
+ sha256: 622764296ca18046991406e7e2a2b0ae08485cb440623bfe44cefd896f11a4cb
+ size: 23320
+ original:
+ hackage: clash-lib-1.8.1@sha256:17d78e786dedf16a76394cd5813372870a3d70a1a4c7f964309f126b800e90f6,15693
+- completed:
+ hackage: clash-prelude-1.8.1@sha256:c3fbb9f6b8e74140fb3d5c4d59ec84cfe4a53e9f8520e606c187cfc04b149065,17626
+ pantry-tree:
+ sha256: 189a67c035b1e18188a33ad003f386c2baf15363e55fef35d2546be43d00e213
+ size: 13511
+ original:
+ hackage: clash-prelude-1.8.1@sha256:c3fbb9f6b8e74140fb3d5c4d59ec84cfe4a53e9f8520e606c187cfc04b149065,17626
+- completed:
+ hackage: clash-prelude-hedgehog-1.8.1@sha256:9ec3aa3f8195481f5ce4942b34a49c97dd132dd1c8f1fa58aeecbd82c2602e86,1410
+ pantry-tree:
+ sha256: 886fd3f21d7acdcd86a5e8ff582c903edf8195a22cd38fc04ddcbf7a27f7dd20
+ size: 735
+ original:
+ hackage: clash-prelude-hedgehog-1.8.1@sha256:9ec3aa3f8195481f5ce4942b34a49c97dd132dd1c8f1fa58aeecbd82c2602e86,1410
+- completed:
+ hackage: concurrent-supply-0.1.8@sha256:80b658533141660818d0781b8c8fb9a8cf69b987fcfbab782dc788bfc7df4846,1627
+ pantry-tree:
+ sha256: 8ede0db0bb492f20b2ef34e822ac3e957b31693cd6b7ffd502bec11abcba1955
+ size: 400
+ original:
+ hackage: concurrent-supply-0.1.8@sha256:80b658533141660818d0781b8c8fb9a8cf69b987fcfbab782dc788bfc7df4846,1627
+- completed:
+ hackage: prettyprinter-interp-0.2.0.0@sha256:69c339a95b265dab9b3478ca19ec96952b6b472bd0ff6e2127112a9562362c1d,2086
+ pantry-tree:
+ sha256: 72ec39fe4a40e437e7c0d3efba1f97c4e4e860a7b5503f31d185cef389c9c6e1
+ size: 300
+ original:
+ hackage: prettyprinter-interp-0.2.0.0@sha256:69c339a95b265dab9b3478ca19ec96952b6b472bd0ff6e2127112a9562362c1d,2086
+snapshots:
+- completed:
+ sha256: 5921ddc75f5dd3f197fbc32e1e5676895a8e7b971d4f82ef6b556657801dd18a
+ size: 640054
+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/20.yaml
+ original: lts-21.20
diff --git a/hashtbl/src/tests/Tests/Example/Project.hs b/hashtbl/src/tests/Tests/Example/Project.hs
new file mode 100644
index 00000000..cb05a8a6
--- /dev/null
+++ b/hashtbl/src/tests/Tests/Example/Project.hs
@@ -0,0 +1,50 @@
+module Tests.Example.Project where
+
+import Prelude
+
+import Clash.Hedgehog.Sized.Unsigned
+import Test.Tasty
+import Test.Tasty.TH
+import Test.Tasty.Hedgehog
+
+import qualified Clash.Prelude as C
+import qualified Hedgehog as H
+import qualified Hedgehog.Gen as Gen
+import qualified Hedgehog.Range as Range
+
+-- Import the module containing the @accum@ function
+import Example.Project (accum)
+
+-- Define a Hedgehog property to test the @accum@ function
+prop_accum :: H.Property
+prop_accum = H.property $ do
+
+ -- Simulate for a random duration between 1 and 100 cycles
+ simDuration <- H.forAll (Gen.integral (Range.linear 1 100))
+
+ -- Generate a list of random unsigned numbers.
+ inp <- H.forAll
+ (Gen.list (Range.singleton simDuration)
+ (genUnsigned Range.linearBounded))
+ let
+
+ -- Simulate the @accum@ function for the pre-existing @System@ domain
+ -- and 8 bit unsigned numbers.
+ --
+ -- The (hidden) reset input of @accum@ will be asserted in the first cycle;
+ -- during this cycle it will emit its initial value and the input is
+ -- ignored. So we need to present a dummy input value.
+ simOut = C.sampleN (simDuration + 1) (accum @C.System @8 (C.fromList (0:inp)))
+ -- Calculate the expected output. The first cycle is the initial value, and
+ -- the result of the final input value does not appear because the
+ -- accumulator has 1 cycle latency.
+ expected = 0 : init (scanl (+) 0 inp)
+
+ -- Check that the simulated output matches the expected output
+ simOut H.=== expected
+
+accumTests :: TestTree
+accumTests = $(testGroupGenerator)
+
+main :: IO ()
+main = defaultMain accumTests
diff --git a/hashtbl/src/tests/doctests.hs b/hashtbl/src/tests/doctests.hs
new file mode 100644
index 00000000..f29b0ece
--- /dev/null
+++ b/hashtbl/src/tests/doctests.hs
@@ -0,0 +1,8 @@
+module Main where
+
+import System.Environment (getArgs)
+import Test.DocTest (mainFromCabal)
+
+main :: IO ()
+main = mainFromCabal "punt-engine-haskell-cores" =<< getArgs
+
diff --git a/hashtbl/src/tests/unittests.hs b/hashtbl/src/tests/unittests.hs
new file mode 100644
index 00000000..45055bc2
--- /dev/null
+++ b/hashtbl/src/tests/unittests.hs
@@ -0,0 +1,10 @@
+import Prelude
+
+import Test.Tasty
+
+import qualified Tests.Example.Project
+
+main :: IO ()
+main = defaultMain $ testGroup "."
+ [ Tests.Example.Project.accumTests
+ ]