.gitignore

@@ -1,2 +0,0 @@
-examples/**/*.bin
-examples/**/*.txt

LICENSE

@@ -1,661 +0,0 @@
-                    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/>.

Makefile

@@ -1,15 +0,0 @@
-examples: profile session helloworld validate
-
-.PHONY: examples
-
-profile:
-	bash examples/compile.bash examples/profile
-
-session:
-	bash examples/compile.bash examples/session
-
-helloworld:
-	bash examples/compile.bash examples/helloworld
-
-validate:
-	bash examples/compile.bash examples/validate

README.md

@@ -1,63 +1,27 @@
-# vise: A Constrained Size Output Virtual Machine
+# festive: A Constrained Size Output Virtual Machine
 
 An attempt at defining a small VM to handle menu interaction for size-constrained clients and servers.
 
-
-## Rationale
-
 Original motivation was to create a simple templating renderer for USSD clients, combined with an agnostic data-retrieval reference that may conceal any level of complexity.
 
 
-## Features
-
-### Implemented
-
-* Define and enforce max output size for every individual output.
-* Allow one single data entry to fill remaining available size capacity.
-* An assembly-like mini-language to define:
-    - external code execution.
-    - input validation and routing.
-    - menu definitions.
-    - flow control.
-    - exception handling.
-* templated output from results of external code execution.
-* generate and navigate pages where data symbol contents are too long to display on a single page.
-* pluggable function design for handling external code execution calls.
-
-
-### Pending
-
-* Node Walking Audit Tool (NWAT) to ensure all nodes produce output within constraints.
-* Input generator engine for the NWAT.
-* State error flag debugger representation, builtin as well as user-defined.
-* Stepwise debug view on log/stderr of state mutations.
-* Toolset to assist bootstrapping/recovering (failed) state from spec.
-
-
-### Possibly useful
-
-* Breakpoints.
-* Key/value database reference example.
-* Same-page catch with dedicated error string to prepend to template
-
 
 ## Opcodes
 
-The VM defines the following opcode symbols, alphabetically:
+The VM defines the following opcode symbols:
 
-* `CATCH <symbol> <signal>` - Jump to symbol if signal is set (see `signals` below). If match, has same side-effect as move.
+* `CATCH <symbol> <signal>` - Jump to symbol if signal is set (see `signals` below).
-* `CROAK <signal>` - Clear state and restart execution from top if signal is set (see `signals` below). If match, has same side-effect as move.
+* `CROAK <signal>` - Clear state and restart execution from top if signal is set (see `signals` below).
+* `LOAD <symbol> <size>` - Execute the code symbol `symbol` and cache the data, constrained to the given `size`. Can be exposed with `MAP` within scope, 
+* `RELOAD <symbol>` - Execute a code symbol already loaded by `LOAD` and cache the data, constrained to the previously given `size` for the same symbol. 
+* `MAP <symbol>` - Expose a code symbol previously loaded by `LOAD` to the rendering client. Roughly corresponds to the `global` directive in Python.
+* `MOVE <symbol>` - Create a new execution frame, invalidating all previous `MAP` calls. More detailed: After a `MOVE` call, a `BACK` call will return to the same execution frame, with the same symbols available, but all `MAP` calls will have to be repeated.
 * `HALT` - Stop execution. The remaining bytecode (typically, the routing code for the node) is returned to the invoking function.
 * `INCMP <arg> <symbol>` - Compare registered input to `arg`. If match, it has the same side-effects as `MOVE`. In addition, any consecutive `INCMP` matches will be ignored until `HALT` is called.
-* `LOAD <symbol> <size>` - Execute the code symbol `symbol` and cache the data, constrained to the given `size`. Can be exposed with `MAP` within scope.  See "External code" below.
+* `MSIZE <max> <min>` - Set min and max display size of menu part to `num` bytes.
-* `MAP <symbol>` - Expose a code symbol previously loaded by `LOAD` to the rendering client. Roughly corresponds to the `global` directive in Python.
-* `MNEXT <choice> <display>` - Define how to display the choice for advancing when browsing menu.
 * `MOUT <choice> <display>` - Add menu display entry. Each entry should have a matching `INCMP` whose `arg` matches `choice`. `display` is a descriptive text of the menu item.
-* `MOVE <symbol>` - Create a new execution frame, invalidating all previous `MAP` calls.
+* `MNEXT <choice> <display>` - Define how to display the choice for advancing when browsing menu.
 * `MPREV <choice> <display>` - Define how to display the choice for returning when browsing menu.
-* `MSEP` -  **Not yet implemented**. Marker for menu page separation. Incompatible with browseable nodes.
-* `MSIZE <max> <min>` - **Not yet implemented**. Set min and max display size of menu part to `num` bytes.
-* `RELOAD <symbol>` - Execute a code symbol already loaded by `LOAD` and cache the data, constrained to the previously given `size` for the same symbol. See "External code" below.
 
 
 ### External code
@@ -70,8 +34,6 @@ Loaded symbols are not automatically exposed to the rendering client. To expose
 
 The associated content of loaded symbols may be refreshed using the `RELOAD` opcode. `RELOAD` only works within the same constraints as `MAP`. However, updated content must be available even if a `MAP` precedes a `RELOAD` within the same frame.
 
-Methods handling `LOAD` symbols have the client input available to them.
-
 
 ### External symbol optimizations
 
@@ -93,8 +55,6 @@ The signal flag arguments should only set a single flag to be tested. If more th
 
 First 8 flags are reserved and used for internal VM operations.
 
-When a signal is caught, the *bytecode buffer is flushed* before the target symbol code is loaded.
-
 
 ### Avoid duplicate menu items
 
@@ -119,19 +79,20 @@ To assist with menu creation, a few batch operation symbols have been made avail
 
 The fixed-size output is generated using a templating language, and a combination of one or more _max size_ properties, and an optional _sink_ property that will attempt to consume all remaining capacity of the rendered template.
 
-In this example
+For example, in this example
 
 - `maxOutputSize` is 256 bytes long.
 - `template` is 120 bytes long.
 - param `one` has max size 10 but uses 5.
 - param `two` has max size 20 but uses 12.
 - param `three` is a _sink_.
-- rendered menu is 15 bytes long.
 
-The renderer may use up to `256 - 120 - 5 - 12 - 15 = 104` bytes from the _sink_ when rendering the output.
+The renderer may use up to `256 - 120 - 5 - 12 = 119` bytes from the _sink_ when rendering the output.
 
 
-### Menu browsing
+### Menu rendering
+
+The menu is appended to the template output.
 
 A max size can be set for the menu, which will count towards the space available for the _template sink_.
 
@@ -156,8 +117,6 @@ Multipage outputs, like listings, are handled using the _sink_ output constraint
 
 ### Languages support
 
-**Not yet implemented**
-
 Language for rendering is determined at the top-level state.
 
 Lookups dependent on language are prefixed by either `ISO 639-1` or `ISO 639-3` language codes, followed by `:`.
@@ -181,19 +140,19 @@ Currently the following rules apply for encoding in version `0`:
 
 ## Reference implementation
 
-This repository provides a `golang` reference implementation for the `vise` concept.
+This repository provides a `golang` reference implementation for the `festive` concept.
+
+In this reference implementation some constraints apply
 
 
 ### Structure
 
-- `asm`: Assembly parser and compiler.
+_TODO_: `state` will be separated into `cache` and `session`.
-- `cache`: Holds and manages all loaded content.
+
-- `engine`: Outermost interface. Orchestrates execution of bytecode against input. 
-- `persist`: Interface and reference implementation of `state` and `cache` persistence across asynchronous vm executions.
-- `render`: Renders menu and templates, and enforces output size constraints.
-- `resource`: Retrieves data and bytecode from external symbols, and retrieves templates.
-- `state`: Holds the bytecode buffer, error states and navigation states.
 - `vm`: Defines instructions, and applies transformations according to the instructions.
+- `state`: Holds the code cache, contents cache aswell as error tates from code execution.
+- `resource`: Retrieves data and bytecode from external symbols, and retrieves and renders templates.
+- `engine`: Outermost interface. Orchestrates execution of bytecode against input. 
 
 
 ### Template rendering
@@ -203,28 +162,6 @@ Template rendering is done using the `text/template` faciilty in the `golang` st
 It expects all replacement symbols to be available at time of rendering, and has no tolerance for missing ones.
 
 
-## Runtime engine
-
-The runtime engine:
-
-* Validates client input
-* Runs VM with client input
-* Renders result
-* Restarts execution from top if the vm has nothing more to do.
-
-There are two flavors of the engine:
-
-* `engine.Loop` - class used for continuous, in-memory interaction with the vm (e.g. terminal).
-* `engine.RunPersisted` - method which combines single vm executions with persisted state (e.g. http).
-
-
-### Client identification
-
-The `engine.Config` struct defines a property `SessionId` which is added to the `context.Context` passed through entire engine vm call roundtrip.
-
-This is used to identify the caller, and thus defines a top-level storage key under which data entries should be retrieved.
-
-
 ## Bytecode examples
 
 (Minimal, WIP)
@@ -243,7 +180,7 @@ This is used to identify the caller, and thus defines a top-level storage key un
 
 ## Assembly examples
 
-See `testdata/*.vis`
+See `testdata/*.fst`
 
 
 ## Development tools
@@ -253,14 +190,14 @@ Located in the `dev/` directory.
 
 ### Test data generation
 
-`go run ./dev/gendata/ <directory>`
+`go run ./dev/testdata/ <directory>`
 
 Outputs bytecodes and templates for test data scenarios used in `engine` unit tests.
 
 
 ### Interactive runner
 
-`go run ./dev/interactive [-d <data_directory>] [--root <root_symbol>] [--session-id <session_id>]`
+`go run ./dev [-d <data_directory>] [--root <root_symbol>]`
 
 Creates a new interactive session using `engine.DefaultEngine`, starting execution at symbol `root_symbol`
 
@@ -270,8 +207,6 @@ If `data_directory` is not set, current directory will be used.
 
 if `root_symbol` is not set, the symbol `root` will be used.
 
-if `session_id` is set, mutable data will be stored and retrieved keyed by the given identifer (if implemented).
-
 
 ### Assembler
 
@@ -286,20 +221,3 @@ Will output bytecode on STDOUT generated from a valid assembly file.
 
 Will list all the instructions on STDOUT from a valid binary file.
 
-
-## Interactive case examples
-
-Found in `examples/`.
-
-Be sure to `make examples` before running them.
-
-Can be run with e.g. `go run ./examples/<case> [...]`
-
-The available options are the same as for the `dev/interactive` tool.
-
-Contents of the case directory:
-
-* `*.vis` - assembly code.
-* `*.bin` - bytecode for each node symbol (only available after make).
-* `*.txt.orig` - default contents of a single data entry.
-* `*.txt` - current contents of a single data entry (only available after make).

asm/doc.go

@@ -1,2 +0,0 @@
-// Package asm parses and compiles vise assembly code to bytecode.
-package asm

cache/doc.go

@@ -1,2 +0,0 @@
-// Package cache is a memory store for key-value pairs for all loaded symbols available for output.
-package cache

dev/asm/doc.go

@@ -1,2 +0,0 @@
-// Executable asm compiles festival assembly code to bytecode instructions.
-package main

dev/disasm/doc.go

@@ -1,2 +0,0 @@
-// Executable disasm generates festival assembly code from bytecode instructions.
-package main

dev/gendata/doc.go

@@ -1,2 +0,0 @@
-// Execution gendata output testdata provisions compatible with resource.FsResource to a filesystem directory.
-package main

dev/interactive/doc.go

@@ -1,2 +0,0 @@
-// Executable interactive runs the Engine execution loop against interactive client input in the terminal.
-package main

dev/interactive/main.go

@@ -1,45 +0,0 @@
-package main
-
-import (
-	"context"
-	"flag"
-	"fmt"
-	"os"
-
-	"git.grassecon.net/kamikazechaser/vise/engine"
-)
-
-func main() {
-	var dir string
-	var root string
-	var size uint
-	//var sessionId string
-	flag.StringVar(&dir, "d", ".", "resource dir to read from")
-	flag.UintVar(&size, "s", 0, "max size of output")
-	flag.StringVar(&root, "root", "root", "entry point symbol")
-	//flag.StringVar(&sessionId, "session-id", "default", "session id")
-	flag.Parse()
-	fmt.Fprintf(os.Stderr, "starting session at symbol '%s' using resource dir: %s\n", root, dir)
-
-	ctx := context.Background()
-	en := engine.NewSizedEngine(dir, uint32(size))
-	cont, err := en.Init(ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "engine init exited with error: %v\n", err)
-		os.Exit(1)
-	}
-	if !cont {
-		_, err = en.WriteResult(os.Stdout, ctx)
-		if err != nil {
-			fmt.Fprintf(os.Stderr, "dead init write error: %v\n", err)
-			os.Exit(1)
-		}
-		os.Stdout.Write([]byte{0x0a})
-		os.Exit(0)
-	}
-	err = engine.Loop(&en, os.Stdin, os.Stdout, ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "loop exited with error: %v\n", err)
-		os.Exit(1)
-	}
-}

engine/default.go

@@ -1,34 +0,0 @@
-package engine
-
-import (
-	"context"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-// NewDefaultEngine is a convenience function to instantiate a filesystem-backed engine with no output constraints.
-func NewDefaultEngine(dir string) Engine {
-	st := state.NewState(0)
-	rs := resource.NewFsResource(dir)
-	ca := cache.NewCache()
-	cfg := Config{
-		Root: "root",
-	}
-	ctx := context.TODO()
-	return NewEngine(cfg, &st, &rs, ca, ctx)
-}
-
-// NewSizedEngine is a convenience function to instantiate a filesystem-backed engine with a specified output constraint.
-func NewSizedEngine(dir string, size uint32) Engine {
-	st := state.NewState(0)
-	rs := resource.NewFsResource(dir)
-	ca := cache.NewCache()
-	cfg := Config{
-		OutputSize: size,
-		Root:       "root",
-	}
-	ctx := context.TODO()
-	return NewEngine(cfg, &st, &rs, ca, ctx)
-}

engine/doc.go

@@ -1,2 +0,0 @@
-// Package engine orchestrates client input with vm execution.
-package engine

engine/engine.go

@@ -1,183 +0,0 @@
-package engine
-
-import (
-	"context"
-	"fmt"
-	"io"
-	"log"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/render"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-	"git.grassecon.net/kamikazechaser/vise/vm"
-)
-
-// Config globally defines behavior of all components driven by the engine.
-type Config struct {
-	OutputSize uint32 // Maximum size of output from a single rendered page
-	SessionId  string
-	Root       string
-	FlagCount  uint32
-	CacheSize  uint32
-}
-
-// Engine is an execution engine that handles top-level errors when running client inputs against code in the bytecode buffer.
-type Engine struct {
-	st    *state.State
-	rs    resource.Resource
-	ca    cache.Memory
-	vm    *vm.Vm
-	root  string
-	initd bool
-}
-
-// NewEngine creates a new Engine
-func NewEngine(cfg Config, st *state.State, rs resource.Resource, ca cache.Memory, ctx context.Context) Engine {
-	var szr *render.Sizer
-	if cfg.OutputSize > 0 {
-		szr = render.NewSizer(cfg.OutputSize)
-	}
-	ctx = context.WithValue(ctx, "sessionId", cfg.SessionId)
-	engine := Engine{
-		st: st,
-		rs: rs,
-		ca: ca,
-		vm: vm.NewVm(st, rs, ca, szr),
-	}
-	engine.root = cfg.Root
-
-	return engine
-}
-
-// Init must be explicitly called before using the Engine instance.
-//
-// It loads and executes code for the start node.
-func (en *Engine) Init(ctx context.Context) (bool, error) {
-	if en.initd {
-		log.Printf("already initialized")
-		return true, nil
-	}
-	sym := en.root
-	if sym == "" {
-		return false, fmt.Errorf("start sym empty")
-	}
-	inSave, _ := en.st.GetInput()
-	err := en.st.SetInput([]byte{})
-	if err != nil {
-		return false, err
-	}
-	b := vm.NewLine(nil, vm.MOVE, []string{sym}, nil, nil)
-	log.Printf("start new init VM run with code %x", b)
-	b, err = en.vm.Run(b, ctx)
-	if err != nil {
-		return false, err
-	}
-
-	log.Printf("ended init VM run with code %x", b)
-	en.st.SetCode(b)
-	err = en.st.SetInput(inSave)
-	if err != nil {
-		return false, err
-	}
-	return len(b) > 0, nil
-}
-
-// Exec processes user input against the current state of the virtual machine environment.
-//
-// If successfully executed, output of the last execution is available using the WriteResult call.
-//
-// A bool return valus of false indicates that execution should be terminated. Calling Exec again has undefined effects.
-//
-// Fails if:
-// - input is formally invalid (too long etc)
-// - no current bytecode is available
-// - input processing against bytcode failed
-func (en *Engine) Exec(input []byte, ctx context.Context) (bool, error) {
-	var err error
-	if en.st.Moves == 0 {
-		cont, err := en.Init(ctx)
-		if err != nil {
-			return false, err
-		}
-		return cont, nil
-	}
-	err = vm.ValidInput(input)
-	if err != nil {
-		return true, err
-	}
-	err = en.st.SetInput(input)
-	if err != nil {
-		return false, err
-	}
-
-	log.Printf("new execution with input '%s' (0x%x)", input, input)
-	code, err := en.st.GetCode()
-	if err != nil {
-		return false, err
-	}
-	if len(code) == 0 {
-		return false, fmt.Errorf("no code to execute")
-	}
-
-	log.Printf("start new VM run with code %x", code)
-	code, err = en.vm.Run(code, ctx)
-	if err != nil {
-		return false, err
-	}
-	log.Printf("ended VM run with code %x", code)
-
-	v, err := en.st.MatchFlag(state.FLAG_TERMINATE, false)
-	if err != nil {
-		return false, err
-	}
-	if v {
-		if len(code) > 0 {
-			log.Printf("terminated with code remaining: %x", code)
-		}
-		return false, err
-	}
-
-	en.st.SetCode(code)
-	if len(code) == 0 {
-		log.Printf("runner finished with no remaining code")
-		_, err = en.reset(ctx)
-		return false, err
-	}
-
-	return true, nil
-}
-
-// WriteResult writes the output of the last vm execution to the given writer.
-//
-// Fails if
-// - required data inputs to the template are not available.
-// - the template for the given node point is note available for retrieval using the resource.Resource implementer.
-// - the supplied writer fails to process the writes.
-func (en *Engine) WriteResult(w io.Writer, ctx context.Context) (int, error) {
-	r, err := en.vm.Render(ctx)
-	if err != nil {
-		return 0, err
-	}
-	return io.WriteString(w, r)
-}
-
-// start execution over at top node while keeping current state of client error flags.
-func (en *Engine) reset(ctx context.Context) (bool, error) {
-	var err error
-	var isTop bool
-	for !isTop {
-		isTop, err = en.st.Top()
-		if err != nil {
-			return false, err
-		}
-		_, err = en.st.Up()
-		if err != nil {
-			return false, err
-		}
-		en.ca.Pop()
-	}
-	en.st.Restart()
-	en.initd = false
-	return en.Init(ctx)
-}

engine/engine_test.go

@@ -1,187 +0,0 @@
-package engine
-
-import (
-	"bytes"
-	"context"
-	"fmt"
-	"io/ioutil"
-	"path"
-	"testing"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-	"git.grassecon.net/kamikazechaser/vise/testdata"
-)
-
-var (
-	dataGenerated bool   = false
-	dataDir       string = testdata.DataDir
-)
-
-type FsWrapper struct {
-	*resource.FsResource
-	st *state.State
-}
-
-func NewFsWrapper(path string, st *state.State) FsWrapper {
-	rs := resource.NewFsResource(path)
-	wr := FsWrapper{
-		&rs,
-		st,
-	}
-	wr.AddLocalFunc("one", wr.one)
-	wr.AddLocalFunc("inky", wr.inky)
-	wr.AddLocalFunc("pinky", wr.pinky)
-	return wr
-}
-
-func (fs FsWrapper) one(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	return resource.Result{
-		Content: "one",
-	}, nil
-}
-
-func (fs FsWrapper) inky(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	return resource.Result{
-		Content: "tinkywinky",
-	}, nil
-}
-
-func (fs FsWrapper) pinky(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	r := fmt.Sprintf("xyzzy: %x", input)
-	return resource.Result{
-		Content: r,
-	}, nil
-}
-
-func (fs FsWrapper) GetCode(sym string) ([]byte, error) {
-	sym += ".bin"
-	fp := path.Join(fs.Path, sym)
-	r, err := ioutil.ReadFile(fp)
-	return r, err
-}
-
-func generateTestData(t *testing.T) {
-	if dataGenerated {
-		return
-	}
-	var err error
-	dataDir, err = testdata.Generate()
-	if err != nil {
-		t.Fatal(err)
-	}
-}
-
-func TestEngineInit(t *testing.T) {
-	var err error
-	generateTestData(t)
-	ctx := context.TODO()
-	st := state.NewState(17)
-	rs := NewFsWrapper(dataDir, &st)
-	ca := cache.NewCache().WithCacheSize(1024)
-
-	en := NewEngine(Config{
-		Root: "root",
-	}, &st, &rs, ca, ctx)
-
-	_, err = en.Init(ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	w := bytes.NewBuffer(nil)
-	_, err = en.WriteResult(w, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	b := w.Bytes()
-	expect_str := `hello world
-1:do the foo
-2:go to the bar`
-
-	if !bytes.Equal(b, []byte(expect_str)) {
-		t.Fatalf("expected:\n\t%s\ngot:\n\t%s\n", expect_str, b)
-	}
-
-	input := []byte("1")
-	_, err = en.Exec(input, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	r, _ := st.Where()
-	if r != "foo" {
-		t.Fatalf("expected where-string 'foo', got %s", r)
-	}
-	w = bytes.NewBuffer(nil)
-	_, err = en.WriteResult(w, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	b = w.Bytes()
-	expect := `this is in foo
-
-it has more lines
-0:to foo
-1:go bar
-2:see long`
-
-	if !bytes.Equal(b, []byte(expect)) {
-		t.Fatalf("expected\n\t%s\ngot:\n\t%s\n", expect, b)
-	}
-}
-
-func TestEngineExecInvalidInput(t *testing.T) {
-	generateTestData(t)
-	ctx := context.TODO()
-	st := state.NewState(17)
-	rs := NewFsWrapper(dataDir, &st)
-	ca := cache.NewCache().WithCacheSize(1024)
-
-	en := NewEngine(Config{
-		Root: "root",
-	}, &st, &rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	_, err = en.Exec([]byte("_foo"), ctx)
-	if err == nil {
-		t.Fatalf("expected fail on invalid input")
-	}
-}
-
-func TestEngineResumeTerminated(t *testing.T) {
-	generateTestData(t)
-	ctx := context.TODO()
-	st := state.NewState(17)
-	rs := NewFsWrapper(dataDir, &st)
-	ca := cache.NewCache().WithCacheSize(1024)
-
-	en := NewEngine(Config{
-		Root: "root",
-	}, &st, &rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	_, err = en.Exec([]byte("1"), ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	_, err = en.Exec([]byte("1"), ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	location, idx := st.Where()
-	if location != "root" {
-		t.Fatalf("expected 'root', got %s", location)
-	}
-	if idx != 0 {
-		t.Fatalf("expected idx '0', got %v", idx)
-	}
-}

engine/loop_test.go

@@ -1,129 +0,0 @@
-package engine
-
-import (
-	"bytes"
-	"context"
-	"fmt"
-	"log"
-	"strings"
-	"testing"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-func TestLoopTop(t *testing.T) {
-	generateTestData(t)
-	ctx := context.TODO()
-	st := state.NewState(0)
-	rs := resource.NewFsResource(dataDir)
-	ca := cache.NewCache().WithCacheSize(1024)
-
-	cfg := Config{
-		Root: "root",
-	}
-	en := NewEngine(cfg, &st, &rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	input := []string{
-		"2",
-		"j",
-		"1",
-	}
-	inputStr := strings.Join(input, "\n")
-	inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
-	outputBuf := bytes.NewBuffer(nil)
-	log.Printf("running with input: %s", inputBuf.Bytes())
-
-	err = Loop(&en, inputBuf, outputBuf, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	location, _ := st.Where()
-	if location != "foo" {
-		fmt.Errorf("expected location 'foo', got %s", location)
-	}
-}
-
-func TestLoopBackForth(t *testing.T) {
-	generateTestData(t)
-	ctx := context.TODO()
-	st := state.NewState(0)
-	rs := resource.NewFsResource(dataDir)
-	ca := cache.NewCache().WithCacheSize(1024)
-
-	cfg := Config{
-		Root: "root",
-	}
-	en := NewEngine(cfg, &st, &rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	input := []string{
-		"1",
-		"0",
-		"1",
-		"0",
-	}
-	inputStr := strings.Join(input, "\n")
-	inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
-	outputBuf := bytes.NewBuffer(nil)
-	log.Printf("running with input: %s", inputBuf.Bytes())
-
-	err = Loop(&en, inputBuf, outputBuf, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-}
-
-func TestLoopBrowse(t *testing.T) {
-	generateTestData(t)
-	ctx := context.TODO()
-	st := state.NewState(0)
-	rs := resource.NewFsResource(dataDir)
-	ca := cache.NewCache().WithCacheSize(1024)
-
-	cfg := Config{
-		OutputSize: 68,
-		Root:       "root",
-	}
-	en := NewEngine(cfg, &st, &rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	input := []string{
-		"1",
-		"2",
-		"00",
-		"11",
-		"00",
-	}
-	inputStr := strings.Join(input, "\n")
-	inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
-	outputBuf := bytes.NewBuffer(nil)
-	log.Printf("running with input: %s", inputBuf.Bytes())
-
-	err = Loop(&en, inputBuf, outputBuf, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	location, idx := st.Where()
-	if location != "long" {
-		fmt.Errorf("expected location 'long', got %s", location)
-	}
-	if idx != 1 {
-		fmt.Errorf("expected idx 1, got %v", idx)
-	}
-}

engine/persist.go

@@ -1,50 +0,0 @@
-package engine
-
-import (
-	"context"
-	"io"
-
-	"git.grassecon.net/kamikazechaser/vise/persist"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-)
-
-// RunPersisted performs a single vm execution from client input using a persisted state.
-//
-// State is first loaded from storage. The vm is initialized with the state and executed. The new state is then saved to storage.
-//
-// The resulting output of the execution will be written to the provided writer.
-//
-// The state is identified by the SessionId member of the Config. Before first execution, the caller must ensure that an
-// initialized state actually is available for the identifier, otherwise the method will fail.
-//
-// It will also fail if execution by the underlying Engine fails.
-func RunPersisted(cfg Config, rs resource.Resource, pr persist.Persister, input []byte, w io.Writer, ctx context.Context) error {
-	err := pr.Load(cfg.SessionId)
-	if err != nil {
-		return err
-	}
-
-	en := NewEngine(cfg, pr.GetState(), rs, pr.GetMemory(), ctx)
-
-	c, err := en.WriteResult(w, ctx)
-	if err != nil {
-		return err
-	}
-	err = pr.Save(cfg.SessionId)
-	if err != nil {
-		return err
-	}
-	if c > 0 {
-		return err
-	}
-
-	_, err = en.Exec(input, ctx)
-	if err != nil {
-		return err
-	}
-	_, err = en.WriteResult(w, ctx)
-	if err != nil {
-		return err
-	}
-	return pr.Save(cfg.SessionId)
-}

engine/persist_test.go

@@ -1,73 +0,0 @@
-package engine
-
-import (
-	"context"
-	"io/ioutil"
-	"os"
-	"testing"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/persist"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-func TestPersist(t *testing.T) {
-	generateTestData(t)
-	cfg := Config{
-		OutputSize: 83,
-		SessionId:  "xyzzy",
-		Root:       "root",
-	}
-	rs := NewFsWrapper(dataDir, nil)
-
-	persistDir, err := ioutil.TempDir("", "vise_engine_persist")
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	st := state.NewState(3)
-	ca := cache.NewCache().WithCacheSize(1024)
-	pr := persist.NewFsPersister(persistDir).WithContent(&st, ca)
-
-	w := os.Stdout
-	ctx := context.TODO()
-
-	st = state.NewState(cfg.FlagCount)
-	ca = cache.NewCache()
-	ca = ca.WithCacheSize(cfg.CacheSize)
-	pr = persist.NewFsPersister(persistDir).WithContent(&st, ca)
-	err = pr.Save(cfg.SessionId)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	pr = persist.NewFsPersister(persistDir)
-	inputs := []string{
-		"", // trigger init, will not exec
-		"1",
-		"2",
-		"00",
-	}
-	for _, v := range inputs {
-		err = RunPersisted(cfg, rs, pr, []byte(v), w, ctx)
-		if err != nil {
-			t.Fatal(err)
-		}
-	}
-
-	pr = persist.NewFsPersister(persistDir)
-	err = pr.Load(cfg.SessionId)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	stAfter := pr.GetState()
-	location, idx := stAfter.Where()
-	if location != "long" {
-		t.Fatalf("expected 'long', got %s", location)
-	}
-	if idx != 1 {
-		t.Fatalf("expected '1', got %v", idx)
-	}
-
-}

examples/compile.bash

@@ -1,13 +0,0 @@
-for f in $(ls $1/*.vis); do
-	b=$(basename $f)
-	b=${b%.*}
-	go run ./dev/asm $1/$b.vis > $1/$b.bin
-done
-
-for f in $(ls $1/*.txt.orig); do
-	b=$(basename $f)
-	b=${b%.*}
-	#go run ./dev/asm $1/$b.vis > $1/$b.bin
-	echo $b
-	cp -v $f $1/$b
-done

examples/helloworld/que.txt.orig

@@ -1 +0,0 @@
-world

examples/helloworld/root

@@ -1 +0,0 @@
-hello, {{.que}}!

examples/helloworld/root.vis

@@ -1,2 +0,0 @@
-LOAD que 5
-MAP que

examples/profile/entry_email

@@ -1,2 +0,0 @@
-Your email is now: {{.myemail}}
-Enter new email.

examples/profile/entry_email.vis

@@ -1,5 +0,0 @@
-MAP myemail
-MOUT 0 "abort"
-HALT
-INCMP 0 _
-INCMP * entry_email_save 

examples/profile/entry_email_save.vis

@@ -1,3 +0,0 @@
-LOAD do_email_save 1
-RELOAD myemail
-MOVE _

examples/profile/entry_name

@@ -1,2 +0,0 @@
-Name is currently: {{.myname}}
-Enter new name.

examples/profile/entry_name.vis

@@ -1,5 +0,0 @@
-MAP myname
-MOUT 0 "abort"
-HALT
-INCMP 0 _
-INCMP * entry_name_save 

examples/profile/entry_name_save.vis

@@ -1,3 +0,0 @@
-LOAD do_name_save 1
-RELOAD myname
-MOVE _

examples/profile/identified

@@ -1,3 +0,0 @@
-You are identified as:
-Name: {{.myname}}
-Email: {{.myemail}}

examples/profile/identified.vis

@@ -1,2 +0,0 @@
-MAP myname
-MAP myemail

examples/profile/main.go

@@ -1,139 +0,0 @@
-package main
-
-import (
-	"context"
-	"flag"
-	"fmt"
-	"io/ioutil"
-	"log"
-	"os"
-	"path"
-
-	testdataloader "github.com/peteole/testdata-loader"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/engine"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-const (
-	USERFLAG_IDENTIFIED = iota + state.FLAG_USERSTART
-	USERFLAG_HAVENAME
-	USERFLAG_HAVEEMAIL
-)
-
-var (
-	baseDir     = testdataloader.GetBasePath()
-	scriptDir   = path.Join(baseDir, "examples", "profile")
-	emptyResult = resource.Result{}
-)
-
-type profileResource struct {
-	*resource.FsResource
-	st          *state.State
-	haveEntered bool
-}
-
-func newProfileResource(st *state.State, rs *resource.FsResource) *profileResource {
-	return &profileResource{
-		rs,
-		st,
-		false,
-	}
-}
-
-func (pr *profileResource) checkEntry() error {
-	log.Printf("%v %v", USERFLAG_IDENTIFIED, USERFLAG_HAVENAME)
-	if pr.haveEntered {
-		return nil
-	}
-	one, err := pr.st.GetFlag(USERFLAG_HAVENAME)
-	if err != nil {
-		return err
-	}
-	two, err := pr.st.GetFlag(USERFLAG_HAVEEMAIL)
-	if err != nil {
-		return err
-	}
-	if one && two {
-		_, err = pr.st.SetFlag(USERFLAG_IDENTIFIED)
-		if err != nil {
-			return err
-		}
-		pr.haveEntered = true
-	}
-	return nil
-}
-
-func (pr profileResource) nameSave(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	log.Printf("writing name to file")
-	fp := path.Join(scriptDir, "myname.txt")
-	err := ioutil.WriteFile(fp, input, 0600)
-	if err != nil {
-		return emptyResult, err
-	}
-	changed, err := pr.st.SetFlag(USERFLAG_HAVENAME)
-	if err != nil {
-		return emptyResult, err
-	}
-	if changed {
-		pr.checkEntry()
-	}
-	return emptyResult, err
-}
-
-func (pr profileResource) emailSave(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	log.Printf("writing email to file")
-	fp := path.Join(scriptDir, "myemail.txt")
-	err := ioutil.WriteFile(fp, input, 0600)
-	if err != nil {
-		return emptyResult, err
-	}
-	changed, err := pr.st.SetFlag(USERFLAG_HAVEEMAIL)
-	if err != nil {
-		return emptyResult, err
-	}
-	if changed {
-		pr.checkEntry()
-	}
-	return resource.Result{}, err
-}
-
-func main() {
-	var dir string
-	var root string
-	var size uint
-	var sessionId string
-	flag.UintVar(&size, "s", 0, "max size of output")
-	flag.StringVar(&root, "root", "root", "entry point symbol")
-	flag.StringVar(&sessionId, "session-id", "default", "session id")
-	flag.Parse()
-	fmt.Fprintf(os.Stderr, "starting session at symbol '%s' using resource dir: %s\n", root, dir)
-
-	st := state.NewState(3)
-	rsf := resource.NewFsResource(scriptDir)
-	rs := newProfileResource(&st, &rsf)
-	rs.AddLocalFunc("do_name_save", rs.nameSave)
-	rs.AddLocalFunc("do_email_save", rs.emailSave)
-	ca := cache.NewCache()
-	cfg := engine.Config{
-		Root:       "root",
-		SessionId:  sessionId,
-		OutputSize: uint32(size),
-	}
-	ctx := context.Background()
-	en := engine.NewEngine(cfg, &st, rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "engine init fail: %v\n", err)
-		os.Exit(1)
-	}
-
-	err = engine.Loop(&en, os.Stdin, os.Stdout, ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "loop exited with error: %v\n", err)
-		os.Exit(1)
-	}
-}

examples/profile/myemail.txt.orig

@@ -1 +0,0 @@
-(not set)

examples/profile/myname.txt.orig

@@ -1 +0,0 @@
-(not set)

examples/profile/root

@@ -1 +0,0 @@
-Please input profile data

examples/profile/root.vis

@@ -1,5 +0,0 @@
-LOAD myname 64
-LOAD myemail 64
-CATCH identified 8 0
-DOWN entry_name 0 "name"
-DOWN entry_email 1 "email"

examples/session/input

@@ -1,2 +0,0 @@
-hey hey hey
-your data is {{.do_save}}

examples/session/input.vis

@@ -1,4 +0,0 @@
-MAP do_save
-HALT
-RELOAD do_save
-INCMP * .

examples/session/main.go

@@ -1,86 +0,0 @@
-package main
-
-import (
-	"context"
-	"flag"
-	"fmt"
-	"io/ioutil"
-	"log"
-	"os"
-	"path"
-
-	testdataloader "github.com/peteole/testdata-loader"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/engine"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-var (
-	baseDir     = testdataloader.GetBasePath()
-	scriptDir   = path.Join(baseDir, "examples", "session")
-	emptyResult = resource.Result{}
-)
-
-func save(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	sessionId := ctx.Value("SessionId").(string)
-	sessionDir := path.Join(scriptDir, sessionId)
-	err := os.MkdirAll(sessionDir, 0700)
-	if err != nil {
-		return emptyResult, err
-	}
-	fp := path.Join(sessionDir, "data.txt")
-	if len(input) > 0 {
-		log.Printf("write data %s session %s", input, sessionId)
-		err = ioutil.WriteFile(fp, input, 0600)
-		if err != nil {
-			return emptyResult, err
-		}
-	}
-	r, err := ioutil.ReadFile(fp)
-	if err != nil {
-		err = ioutil.WriteFile(fp, []byte("(not set)"), 0600)
-		if err != nil {
-			return emptyResult, err
-		}
-	}
-	return resource.Result{
-		Content: string(r),
-	}, nil
-}
-
-func main() {
-	var root string
-	var size uint
-	var sessionId string
-	flag.UintVar(&size, "s", 0, "max size of output")
-	flag.StringVar(&root, "root", "root", "entry point symbol")
-	flag.StringVar(&sessionId, "session-id", "default", "session id")
-	flag.Parse()
-	fmt.Fprintf(os.Stderr, "starting session at symbol '%s' using resource dir: %s\n", root, scriptDir)
-
-	st := state.NewState(0)
-	rs := resource.NewFsResource(scriptDir)
-	rs.AddLocalFunc("do_save", save)
-	ca := cache.NewCache()
-	cfg := engine.Config{
-		Root:       "root",
-		SessionId:  sessionId,
-		OutputSize: uint32(size),
-	}
-	ctx := context.Background()
-	ctx = context.WithValue(ctx, "SessionId", sessionId)
-	en := engine.NewEngine(cfg, &st, rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "engine init fail: %v\n", err)
-		os.Exit(1)
-	}
-	err = engine.Loop(&en, os.Stdin, os.Stdout, ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "loop exited with error: %v\n", err)
-		os.Exit(1)
-	}
-}

examples/session/root.vis

@@ -1,2 +0,0 @@
-LOAD do_save 0
-MOVE input

examples/validate/end

@@ -1,2 +0,0 @@
-You made it.
-Any input to go again.

examples/validate/end.vis

@@ -1,3 +0,0 @@
-HALT
-LOAD again 0
-INCMP * _

examples/validate/main.go

@@ -1,84 +0,0 @@
-package main
-
-import (
-	"context"
-	"flag"
-	"fmt"
-	"os"
-	"path"
-
-	testdataloader "github.com/peteole/testdata-loader"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/engine"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-var (
-	baseDir     = testdataloader.GetBasePath()
-	scriptDir   = path.Join(baseDir, "examples", "validate")
-	emptyResult = resource.Result{}
-)
-
-const (
-	USERFLAG_HAVESOMETHING = state.FLAG_USERSTART
-)
-
-type verifyResource struct {
-	*resource.FsResource
-	st *state.State
-}
-
-func (vr *verifyResource) verify(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	var err error
-	if string(input) == "something" {
-		_, err = vr.st.SetFlag(USERFLAG_HAVESOMETHING)
-	}
-	return resource.Result{
-		Content: "",
-	}, err
-}
-
-func (vr *verifyResource) again(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	var err error
-	_, err = vr.st.ResetFlag(USERFLAG_HAVESOMETHING)
-	return resource.Result{}, err
-}
-
-func main() {
-	var root string
-	var size uint
-	var sessionId string
-	flag.UintVar(&size, "s", 0, "max size of output")
-	flag.StringVar(&root, "root", "root", "entry point symbol")
-	flag.StringVar(&sessionId, "session-id", "default", "session id")
-	flag.Parse()
-	fmt.Fprintf(os.Stderr, "starting session at symbol '%s' using resource dir: %s\n", root, scriptDir)
-
-	st := state.NewState(1)
-	rsf := resource.NewFsResource(scriptDir)
-	rs := verifyResource{&rsf, &st}
-	rs.AddLocalFunc("verifyinput", rs.verify)
-	rs.AddLocalFunc("again", rs.again)
-	ca := cache.NewCache()
-	cfg := engine.Config{
-		Root:       "root",
-		SessionId:  sessionId,
-		OutputSize: uint32(size),
-	}
-	ctx := context.Background()
-	ctx = context.WithValue(ctx, "SessionId", sessionId)
-	en := engine.NewEngine(cfg, &st, rs, ca, ctx)
-	var err error
-	_, err = en.Init(ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "engine init fail: %v\n", err)
-		os.Exit(1)
-	}
-	err = engine.Loop(&en, os.Stdin, os.Stdout, ctx)
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "loop exited with error: %v\n", err)
-		os.Exit(1)
-	}
-}

examples/validate/root

@@ -1 +0,0 @@
-Please write "something"

examples/validate/root.vis

@@ -1,6 +0,0 @@
-LOAD verifyinput 0
-MAP verifyinput
-HALT
-RELOAD verifyinput
-CATCH . 8 1
-MOVE end

go.mod

@@ -1,11 +0,0 @@
-module git.grassecon.net/kamikazechaser/vise
-
-go 1.20
-
-require (
-	github.com/alecthomas/participle/v2 v2.0.0
-	github.com/fxamacker/cbor/v2 v2.4.0
-	github.com/peteole/testdata-loader v0.3.0
-)
-
-require github.com/x448/float16 v0.8.4 // indirect

go/asm/asm.go

@@ -13,15 +13,14 @@ import (
 	"github.com/alecthomas/participle/v2"
 	"github.com/alecthomas/participle/v2/lexer"
 
-	"git.grassecon.net/kamikazechaser/vise/vm"
+	"git.defalsify.org/festive/vm"
 )
 
-// Asm assembles bytecode from the vise assembly mini-language.
+
 type Asm struct {
 	Instructions []*Instruction `@@*`
 }
 
-// Arg holds all parsed argument elements of a single line of assembly code.
 type Arg struct {
 	Sym *string `(@Sym Whitespace?)?`
 	Size *uint32 `(@Size Whitespace?)?`
@@ -92,14 +91,9 @@ func parseTwoSym(b *bytes.Buffer, arg Arg) (int, error) {
 		selector = strconv.FormatUint(uint64(*arg.Size), 10)
 		sym = *arg.Selector
 	} else if arg.Selector != nil {
-		if *arg.Sym == "*" {
-			sym = *arg.Selector
-			selector = *arg.Sym
-		} else {
 		sym = *arg.Sym
 		selector = *arg.Selector
 	}
-	}
 
 	n, err := writeSym(b, selector)
 	rn += n
@@ -220,7 +214,6 @@ func parseOne(op vm.Opcode, instruction *Instruction, w io.Writer) (int, error)
 	return flush(b, w)
 }
 
-// String implements the String interface.
 func (a Arg) String() string {
 	s := "[Arg]"
 	if a.Sym != nil {
@@ -242,14 +235,12 @@ func (a Arg) String() string {
 	return fmt.Sprintf(s)
 }
 
-// Instruction represents one full line of assembly code.
 type Instruction struct {
 	OpCode string `@Ident`
 	OpArg Arg `(Whitespace @@)?`
 	Comment string `Comment? EOL`
 }
 
-// String implement the String interface.
 func (i Instruction) String() string {
 	return fmt.Sprintf("%s %s", i.OpCode, i.OpArg)
 }
@@ -259,7 +250,7 @@ var (
 		{"Comment", `(?:#)[^\n]*`},
 		{"Ident", `^[A-Z]+`},
 		{"Size", `[0-9]+`},
-		{"Sym", `[a-zA-Z_\*\.][a-zA-Z0-9_]*`},
+		{"Sym", `[a-zA-Z_][a-zA-Z0-9_]*`},
 		{"Whitespace", `[ \t]+`},
 		{"EOL", `[\n\r]+`},
 		{"Quote", `["']`},
@@ -301,9 +292,6 @@ func writeDisplay(w *bytes.Buffer, s string) (int, error) {
 	return w.WriteString(s)
 }
 func writeSize(w *bytes.Buffer, n uint32) (int, error) {
-	if n == 0 {
-		return w.Write([]byte{0x01, 0x00})
-	}
 	bn := [4]byte{}
 	sz := numSize(n)
 	if sz > 4 {
@@ -315,20 +303,17 @@ func writeSize(w *bytes.Buffer, n uint32) (int, error) {
 	return w.Write(bn[c:])
 }
 
-// Batcher handles assembly commands that generates multiple instructions, such as menu navigation commands.
 type Batcher struct {
 	menuProcessor MenuProcessor
 	inMenu bool
 }
 
-// NewBatcher creates a new Batcher objcet.
 func NewBatcher(mp MenuProcessor) Batcher {
 	return Batcher{
 		menuProcessor: NewMenuProcessor(),
 	}
 }
 
-// MenuExit generates the instructions for the batch and writes them to the given io.Writer.
 func(bt *Batcher) MenuExit(w io.Writer) (int, error) {
 	if !bt.inMenu {
 		return 0, nil
@@ -338,7 +323,6 @@ func (bt *Batcher) MenuExit(w io.Writer) (int, error) {
 	return w.Write(b)
 }
 
-// MenuAdd adds a new menu instruction to the batcher.
 func(bt *Batcher) MenuAdd(w io.Writer, code string, arg Arg) (int, error) {
 	bt.inMenu = true
 	var selector string
@@ -359,12 +343,10 @@ func (bt *Batcher) MenuAdd(w io.Writer, code string, arg Arg) (int, error) {
 	return 0, err
 }
 
-// Exit is a synonym for MenuExit
 func(bt *Batcher) Exit(w io.Writer) (int, error) {
 	return bt.MenuExit(w)
 }
 
-// Parse one or more lines of assembly code, and write assembled bytecode to the provided writer.
 func Parse(s string, w io.Writer) (int, error) {
 	rd := strings.NewReader(s)
 	ast, err := asmParser.Parse("file", rd)
@@ -372,7 +354,9 @@ func Parse(s string, w io.Writer) (int, error) {
 		return 0, err
 	}
 
-	batch := Batcher{}
+	batch := Batcher{
+		
+	}
 
 	var rn int
 	for _, v := range ast.Instructions {

go/asm/asm_test.go

@@ -7,9 +7,10 @@ import (
 	"log"
 	"testing"
 
-	"git.grassecon.net/kamikazechaser/vise/vm"
+	"git.defalsify.org/festive/vm"
 )
 
+
 func TestParserInit(t *testing.T) {
 	var b []byte
 	b = vm.NewLine(b, vm.HALT, nil, nil, nil)

go/asm/menu.go

@@ -3,10 +3,9 @@ package asm
 import (
 	"fmt"
 
-	"git.grassecon.net/kamikazechaser/vise/vm"
+	"git.defalsify.org/festive/vm"
 )
 
-// BatchCode defines quasi-opcodes that expand to mulitple individual vm instructions.
 type BatchCode uint16
 
 const (
@@ -33,22 +32,15 @@ type menuItem struct {
 	target string
 }
 
-// MenuProcessor handles code lines with BatchCode quasi-opcodes that control menu generation.
-//
-// It creates vm instructions for display of menu and handling of input on either size of a vm.HALT instruction.
 type MenuProcessor struct {
 	items []menuItem
 	size uint32
 }
 
-// NewMenuProcessor creates a new MenuProcessor object.
 func NewMenuProcessor() MenuProcessor {
 	return MenuProcessor{}
 }
 
-// Add a menu batch instruction to be processed.
-//
-// Instructions will be rendered in the order in which they have been added.
 func(mp *MenuProcessor) Add(bop string, choice string, display string, target string) error {
 	bopCode := batchCode[bop]
 	if bopCode == 0 {
@@ -67,7 +59,6 @@ func (mp *MenuProcessor) Add(bop string, choice string, display string, target s
 	return nil
 }
 
-// ToLines returns the generated bytecode from the added menu batch instructions.
 func (mp *MenuProcessor) ToLines() []byte {
 	preLines := []byte{}
 	postLines := []byte{}

go/asm/menu_test.go

@@ -3,9 +3,10 @@ package asm
 import (
 	"testing"
 
-	"git.grassecon.net/kamikazechaser/vise/vm"
+	"git.defalsify.org/festive/vm"
 )
 
+
 func TestMenuInterpreter(t *testing.T) {
 	m := NewMenuProcessor()
 	err := m.Add("DOWN", "0", "inky", "foo")

go/cache/cache.go

@@ -5,20 +5,23 @@ import (
 	"log"
 )
 
-// Cache stores loaded content, enforcing size limits and keeping track of size usage.
 type Cache struct {
 	CacheSize uint32 // Total allowed cumulative size of values (not code) in cache
 	CacheUseSize uint32 // Currently used bytes by all values (not code) in cache
 	Cache []map[string]string // All loaded cache items
-	Sizes map[string]uint16 // Size limits for all loaded symbols.
+	//CacheMap map[string]string // Mapped
+	//outputSize uint32 // Max size of output
+	sizes map[string]uint16 // Size limits for all loaded symbols.
+	//sink *string
 }
 
 // NewCache creates a new ready-to-use cache object
 func NewCache() *Cache {
 	ca := &Cache{
 		Cache: []map[string]string{make(map[string]string)},
-		Sizes: make(map[string]uint16),
+		sizes: make(map[string]uint16),
 	}
+	//ca.resetCurrent()
 	return ca
 }
 
@@ -51,23 +54,20 @@ func(ca *Cache) Add(key string, value string, sizeLimit uint16) error {
 		}
 		return fmt.Errorf("key %v already defined in frame %v", key, checkFrame)
 	}
-	var sz uint32
+	sz := ca.checkCapacity(value)
-	if len(value) > 0 {
-		sz = ca.checkCapacity(value)
 	if sz == 0 {
 		return fmt.Errorf("Cache capacity exceeded %v of %v", ca.CacheUseSize + sz, ca.CacheSize)
 	}
-	}
 	log.Printf("add key %s value size %v limit %v", key, sz, sizeLimit)
 	ca.Cache[len(ca.Cache)-1][key] = value
 	ca.CacheUseSize += sz
-	ca.Sizes[key] = sizeLimit
+	ca.sizes[key] = sizeLimit
 	return nil
 }
 
 // ReservedSize returns the maximum byte size available for the given symbol.
 func(ca *Cache) ReservedSize(key string) (uint16, error) {
-	v, ok := ca.Sizes[key]
+	v, ok := ca.sizes[key]
 	if !ok {
 		return 0, fmt.Errorf("unknown symbol: %s", key)
 	}
@@ -83,8 +83,8 @@ func(ca *Cache) ReservedSize(key string) (uint16, error) {
 // - value is longer than size limit
 // - replacing value exceeds cumulative cache capacity
 func(ca *Cache) Update(key string, value string) error {
-	sizeLimit := ca.Sizes[key]
+	sizeLimit := ca.sizes[key]
-	if ca.Sizes[key] > 0 {
+	if ca.sizes[key] > 0 {
 		l := uint16(len(value))
 		if l > sizeLimit {
 			return fmt.Errorf("update value length %v exceeds value size limit %v", l, sizeLimit)
@@ -97,6 +97,9 @@ func(ca *Cache) Update(key string, value string) error {
 	r := ca.Cache[checkFrame][key]
 	l := uint32(len(r))
 	ca.Cache[checkFrame][key] = ""
+	//if ca.CacheMap[key] != "" {
+	//	ca.CacheMap[key] = value
+	//}
 	ca.CacheUseSize -= l
 	sz := ca.checkCapacity(value)
 	if sz == 0 {
@@ -110,9 +113,6 @@ func(ca *Cache) Update(key string, value string) error {
 	return nil
 }
 
-// Get the content currently loaded for a single key, loaded at any level.
-//
-// Fails if key has not been loaded.
 func(ca *Cache) Get(key string) (string, error) {
 	i := ca.frameOf(key)
 	r, ok := ca.Cache[i][key]
@@ -136,6 +136,7 @@ func(ca *Cache) Reset() {
 func (ca *Cache) Push() error {
 	m := make(map[string]string)
 	ca.Cache = append(ca.Cache, m)
+	//ca.resetCurrent()
 	return nil
 }
 

go/cache/memory.go

@@ -1,6 +1,5 @@
 package cache
 
-// Memory defines the interface for store of a symbol mapped content store.
 type Memory interface {
 	Add(key string, val string, sizeLimit uint16) error
 	Update(key string, val string) error

go/dev/asm/asm.go

@@ -6,11 +6,11 @@ import (
 	"log"
 	"os"
 
-	"git.grassecon.net/kamikazechaser/vise/asm"
+	"git.defalsify.org/festive/asm"
 )
 
 func main() {
-	if len(os.Args) < 2 {
+	if (len(os.Args) < 2) {
 		os.Exit(1)
 	}
 	fp := os.Args[1]

go/dev/disasm/main.go

@@ -2,14 +2,14 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
+	"io/ioutil"
 
-	"git.grassecon.net/kamikazechaser/vise/vm"
+	"git.defalsify.org/festive/vm"
 )
 
 func main() {
-	if len(os.Args) < 2 {
+	if (len(os.Args) < 2) {
 		os.Exit(1)
 	}
 	fp := os.Args[1]

go/dev/interactive.go

@@ -0,0 +1,27 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"os"
+
+	"git.defalsify.org/festive/engine"
+)
+
+func main() {
+	var dir string
+	var root string
+	flag.StringVar(&dir, "d", ".", "resource dir to read from")
+	flag.StringVar(&root, "root", "root", "entry point symbol")
+	flag.Parse()
+	fmt.Fprintf(os.Stderr, "starting session at symbol '%s' using resource dir: %s\n", root, dir)
+
+	ctx := context.Background()
+	en := engine.NewDefaultEngine(dir)
+	err := engine.Loop(&en, root, ctx, os.Stdin, os.Stdout)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "loop exited with error: %v", err)
+		os.Exit(1)
+	}
+}

go/dev/testdata/generate_testdata.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 
-	"git.grassecon.net/kamikazechaser/vise/testdata"
+	"git.defalsify.org/festive/testdata"
 )
 
 func main() {

go/engine/default.go

@@ -0,0 +1,14 @@
+package engine
+
+import (
+	"git.defalsify.org/festive/cache"
+	"git.defalsify.org/festive/resource"
+	"git.defalsify.org/festive/state"
+)
+
+func NewDefaultEngine(dir string) Engine {
+	st := state.NewState(0)
+	rs := resource.NewFsResource(dir)
+	ca := cache.NewCache()
+	return NewEngine(&st, &rs, ca)
+}

go/engine/engine.go

@@ -0,0 +1,123 @@
+package engine
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"log"
+
+	"git.defalsify.org/festive/cache"
+	"git.defalsify.org/festive/resource"
+	"git.defalsify.org/festive/state"
+	"git.defalsify.org/festive/vm"
+)
+
+//type Config struct {
+//	FlagCount uint32
+//	CacheSize uint32
+//}
+
+// Engine is an execution engine that handles top-level errors when running user inputs against currently exposed bytecode.
+type Engine struct {
+	st *state.State
+	rs resource.Resource
+	ca cache.Memory
+	vm *vm.Vm
+}
+
+// NewEngine creates a new Engine
+func NewEngine(st *state.State, rs resource.Resource, ca cache.Memory) Engine {
+	engine := Engine{
+		st: st,
+		rs: rs,
+		ca: ca,
+		vm: vm.NewVm(st, rs, ca, nil),
+	}
+	return engine
+}
+
+// Init must be explicitly called before using the Engine instance.
+//
+// It loads and executes code for the start node.
+func(en *Engine) Init(sym string, ctx context.Context) error {
+	err := en.st.SetInput([]byte{})
+	if err != nil {
+		return err
+	}
+	b := vm.NewLine(nil, vm.MOVE, []string{sym}, nil, nil)
+	b, err = en.vm.Run(b, ctx)
+	if err != nil {
+		return err
+	}
+	en.st.SetCode(b)
+	return nil
+}
+
+// Exec processes user input against the current state of the virtual machine environment.
+//
+// If successfully executed, output of the last execution is available using the WriteResult call.
+// 
+// A bool return valus of false indicates that execution should be terminated. Calling Exec again has undefined effects.
+//
+// Fails if:
+// - input is formally invalid (too long etc)
+// - no current bytecode is available
+// - input processing against bytcode failed
+func (en *Engine) Exec(input []byte, ctx context.Context) (bool, error) {
+	err := vm.ValidInput(input)
+	if err != nil {
+		return true, err
+	}
+	err = en.st.SetInput(input)
+	if err != nil {
+		return false, err
+	}
+
+	log.Printf("new execution with input '%s' (0x%x)", input, input)
+	code, err := en.st.GetCode()
+	if err != nil {
+		return false, err
+	}
+	if len(code) == 0 {
+		return false, fmt.Errorf("no code to execute")
+	}
+	code, err = en.vm.Run(code, ctx)
+	if err != nil {
+		return false, err
+	}
+
+	v, err := en.st.MatchFlag(state.FLAG_TERMINATE, false)
+	if err != nil {
+		return false, err
+	}
+	if v {
+		if len(code) > 0 {
+			log.Printf("terminated with code remaining: %x", code)
+		}
+		return false, nil
+	}
+
+	en.st.SetCode(code)
+	if len(code) == 0 {
+		log.Printf("runner finished with no remaining code")
+		return false, nil
+	}
+
+	return true, nil
+}
+
+// WriteResult writes the output of the last vm execution to the given writer.
+//
+// Fails if
+// - required data inputs to the template are not available.
+// - the template for the given node point is note available for retrieval using the resource.Resource implementer.
+// - the supplied writer fails to process the writes.
+func(en *Engine) WriteResult(w io.Writer) error {
+	//location, idx := en.st.Where()
+	r, err := en.vm.Render()
+	if err != nil {
+		return err
+	}
+	_, err = io.WriteString(w, r)
+	return err
+}

go/engine/engine_test.go

@@ -0,0 +1,139 @@
+package engine
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"io/ioutil"
+	"path"
+	"testing"
+
+	"git.defalsify.org/festive/cache"
+	"git.defalsify.org/festive/resource"
+	"git.defalsify.org/festive/state"
+	"git.defalsify.org/festive/testdata"
+)
+
+var (
+	dataGenerated bool = false
+	dataDir string = testdata.DataDir
+)
+
+type FsWrapper struct {
+	*resource.FsResource
+	st *state.State
+}
+
+func NewFsWrapper(path string, st *state.State) FsWrapper {
+	rs := resource.NewFsResource(path)
+	return FsWrapper {
+		&rs, 
+		st,
+	}
+}
+
+func(fs FsWrapper) one(sym string, ctx context.Context) (string, error) {
+	return "one", nil
+}
+
+func(fs FsWrapper) inky(sym string, ctx context.Context) (string, error) {
+	return "tinkywinky", nil
+}
+
+func(fs FsWrapper) FuncFor(sym string) (resource.EntryFunc, error) {
+	switch sym {
+	case "one":
+		return fs.one, nil
+	case "inky":
+		return fs.inky, nil
+	}
+	return nil, fmt.Errorf("function for %v not found", sym)
+}
+
+func(fs FsWrapper) GetCode(sym string) ([]byte, error) {
+	sym += ".bin"
+	fp := path.Join(fs.Path, sym)
+	r, err := ioutil.ReadFile(fp)
+	return r, err
+}
+
+func generateTestData(t *testing.T) {
+	if dataGenerated {
+		return
+	}
+	var err error
+	dataDir, err = testdata.Generate()
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestEngineInit(t *testing.T) {
+	generateTestData(t)
+	ctx := context.TODO()
+	st := state.NewState(17)
+	rs := NewFsWrapper(dataDir, &st)
+	ca := cache.NewCache().WithCacheSize(1024)
+	
+	en := NewEngine(&st, &rs, ca)
+	err := en.Init("root", ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	w := bytes.NewBuffer(nil)
+	err = en.WriteResult(w)
+	if err != nil {
+		t.Fatal(err)
+	}
+	b := w.Bytes()
+	expect_str := `hello world
+1:do the foo
+2:go to the bar`
+
+	if !bytes.Equal(b, []byte(expect_str)) {
+		t.Fatalf("expected:\n\t%s\ngot:\n\t%s\n", expect_str, b)
+	}
+
+	input := []byte("1")
+	_, err = en.Exec(input, ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+	r, _ := st.Where()
+	if r != "foo" {
+		t.Fatalf("expected where-string 'foo', got %s", r)
+	}
+	w = bytes.NewBuffer(nil)
+	err = en.WriteResult(w)
+	if err != nil {
+		t.Fatal(err)
+	}
+	b = w.Bytes()
+	expect := `this is in foo
+
+it has more lines
+0:to foo
+1:go bar`
+	if !bytes.Equal(b, []byte(expect)) {
+		t.Fatalf("expected\n\t%s\ngot:\n\t%s\n", expect, b)
+	}
+}
+
+func TestEngineExecInvalidInput(t *testing.T) {
+	generateTestData(t)
+	ctx := context.TODO()
+	st := state.NewState(17)
+	rs := NewFsWrapper(dataDir, &st)
+	ca := cache.NewCache().WithCacheSize(1024)
+
+	en := NewEngine(&st, &rs, ca)
+	err := en.Init("root", ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+	_, err = en.Exec([]byte("_foo"), ctx)
+	if err == nil {
+		t.Fatalf("expected fail on invalid input")
+	}
+}

go/engine/loop.go

@@ -2,6 +2,7 @@ package engine
 
 import (
 	"bufio"
+	"bytes"
 	"context"
 	"fmt"
 	"io"
@@ -9,22 +10,15 @@ import (
 	"strings"
 )
 
-// Loop starts an engine execution loop with the given symbol as the starting node.
+func Loop(en *Engine, startSym string, ctx context.Context, reader io.Reader, writer io.Writer) error {
-//
+	err := en.Init(startSym, ctx)
-// The root reads inputs from the provided reader, one line at a time.
-//
-// It will execute until running out of bytecode in the buffer.
-//
-// Any error not handled by the engine will terminate the oop and return an error.
-//
-// Rendered output is written to the provided writer.
-func Loop(en *Engine, reader io.Reader, writer io.Writer, ctx context.Context) error {
-	var err error
-	_, err = en.WriteResult(writer, ctx)
 	if err != nil {
-		return err
+		return fmt.Errorf("cannot init: %v\n", err)
 	}
-	writer.Write([]byte{0x0a})
+
+	b := bytes.NewBuffer(nil)
+	en.WriteResult(b)
+	fmt.Println(b.String())
 
 	running := true
 	bufReader := bufio.NewReader(reader)
@@ -42,12 +36,12 @@ func Loop(en *Engine, reader io.Reader, writer io.Writer, ctx context.Context) e
 		if err != nil {
 			return fmt.Errorf("unexpected termination: %v\n", err)
 		}
-		_, err = en.WriteResult(writer, ctx)
+		//b := bytes.NewBuffer(nil)
+		err = en.WriteResult(writer)
 		if err != nil {
 			return err
 		}
 		writer.Write([]byte{0x0a})
-
 	}
 	return nil
 }

go/engine/loop_test.go

@@ -0,0 +1,44 @@
+package engine
+
+import (
+	"bytes"
+	"context"
+	"log"
+	"strings"
+	"testing"
+
+	"git.defalsify.org/festive/cache"
+	"git.defalsify.org/festive/resource"
+	"git.defalsify.org/festive/state"
+)
+
+func TestLoopCorrect(t *testing.T) {
+	generateTestData(t)
+	ctx := context.TODO()
+	st := state.NewState(0)
+	//rs := NewFsWrapper(dataDir, &st)
+	rs := resource.NewFsResource(dataDir)
+	ca := cache.NewCache().WithCacheSize(1024)
+	
+	en := NewEngine(&st, &rs, ca)
+	err := en.Init("root", ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	input := []string{
+		"1",
+		"0",
+		"1",
+		"0",
+		}		
+	inputStr := strings.Join(input, "\n")
+	inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
+	outputBuf := bytes.NewBuffer(nil)
+	log.Printf("running with input: %s", inputBuf.Bytes())
+
+	err = Loop(&en, "root", ctx, inputBuf, outputBuf)
+	if err != nil {
+		t.Fatal(err)
+	}
+}

go/go.mod

@@ -0,0 +1,8 @@
+module git.defalsify.org/festive
+
+go 1.20
+
+require (
+	github.com/alecthomas/participle/v2 v2.0.0
+	github.com/peteole/testdata-loader v0.3.0
+)

go/render/menu.go

@@ -4,17 +4,6 @@ import (
 	"fmt"
 )
 
-// BrowseError is raised when browsing outside the page range of a rendered node.
-type BrowseError struct {
-	Idx uint16
-	PageCount uint16
-}
-
-// Error implements the Error interface.
-func(err *BrowseError) Error() string {
-	return fmt.Sprintf("index is out of bounds: %v", err.Idx)
-}
-
 // BrowseConfig defines the availability and display parameters for page browsing.
 type BrowseConfig struct {
 	NextAvailable bool
@@ -37,14 +26,13 @@ func DefaultBrowseConfig() BrowseConfig {
 	}
 }
 
-// Menu renders menus. May be included in a Page object to render menus for pages.
 type Menu struct {
-	menu [][2]string // selector and title for menu items.
+	menu [][2]string
-	browse BrowseConfig // browse definitions.
+	browse BrowseConfig
-	pageCount uint16 // number of pages the menu should represent.
+	pageCount uint16
-	canNext bool // availability flag for the "next" browse option.
+	canNext bool
-	canPrevious bool // availability flag for the "previous" browse option.
+	canPrevious bool
-	outputSize uint16 // maximum size constraint for the menu.
+	outputSize uint16
 }
 
 // NewMenu creates a new Menu with an explicit page count.
@@ -64,11 +52,6 @@ func(m *Menu) WithOutputSize(outputSize uint16) *Menu {
 	return m
 }
 
-// GetOutputSize returns the defined heuristic menu size.
-func(m *Menu) GetOutputSize() uint32 {
-	return uint32(m.outputSize)
-}
-
 // WithBrowseConfig defines the criteria for page browsing.
 func(m *Menu) WithBrowseConfig(cfg BrowseConfig) *Menu {
 	m.browse = cfg
@@ -86,11 +69,6 @@ func(m *Menu) Put(selector string, title string) error {
 	return nil
 }
 
-// ReservedSize returns the maximum render byte size of the menu.
-func(m *Menu) ReservedSize() uint16 {
-	return m.outputSize
-}
-
 // Render returns the full current state of the menu as a string.
 //
 // After this has been executed, the state of the menu will be empty.
@@ -129,8 +107,7 @@ func(m *Menu) applyPage(idx uint16) error {
 		}
 		return nil
 	} else if idx >= m.pageCount {
-		return &BrowseError{Idx: idx, PageCount: m.pageCount}
+		return fmt.Errorf("index %v out of bounds (%v)", idx, m.pageCount)
-		//return fmt.Errorf("index %v out of bounds (%v)", idx, m.pageCount)
 	}
 	
 	m.reset()
@@ -168,7 +145,6 @@ func(m *Menu) shiftMenu() (string, string, error) {
 	return r[0], r[1], nil
 }
 
-// prepare menu object for re-use.
 func(m *Menu) reset() {
 	if m.browse.NextAvailable {
 		m.canNext = true
@@ -179,3 +155,6 @@ func(m *Menu) reset() {
 }
 
 
+func(m *Menu) ReservedSize() uint16 {
+	return m.outputSize
+}

go/render/page.go

@@ -7,21 +7,20 @@ import (
 	"strings"
 	"text/template"
 
-	"git.grassecon.net/kamikazechaser/vise/cache"
+	"git.defalsify.org/festive/cache"
-	"git.grassecon.net/kamikazechaser/vise/resource"
+	"git.defalsify.org/festive/resource"
 )
 
-// Page exectues output rendering into pages constrained by size.
 type Page struct {
-	cacheMap map[string]string // Mapped content symbols
+	cacheMap map[string]string // Mapped
-	cache    cache.Memory      // Content store.
+	cache cache.Memory
-	resource resource.Resource // Symbol resolver.
+	resource resource.Resource
-	menu     *Menu             // Menu rendererer.
+	menu *Menu
-	sink     *string           // Content symbol rendered by dynamic size.
+	sink *string
-	sizer    *Sizer            // Process size constraints.
+	sinkSize uint16
+	sizer *Sizer
 }
 
-// NewPage creates a new Page object.
 func NewPage(cache cache.Memory, rs resource.Resource) *Page {
 	return &Page{
 		cache: cache,
@@ -30,7 +29,6 @@ func NewPage(cache cache.Memory, rs resource.Resource) *Page {
 	}
 }
 
-// WithMenu sets a menu renderer for the page.
 func(pg *Page) WithMenu(menu *Menu) *Page {
 	pg.menu = menu
 	if pg.sizer != nil {
@@ -39,7 +37,6 @@ func (pg *Page) WithMenu(menu *Menu) *Page {
 	return pg
 }
 
-// WithSizer sets a size constraints definition for the page.
 func(pg *Page) WithSizer(sizer *Sizer) *Page {
 	pg.sizer = sizer
 	if pg.menu != nil {
@@ -48,7 +45,7 @@ func (pg *Page) WithSizer(sizer *Sizer) *Page {
 	return pg
 }
 
-// Usage returns size used by values and menu, and remaining size available
+// Size returns size used by values and menu, and remaining size available
 func(pg *Page) Usage() (uint32, uint32, error) {
 	var l int
 	var c uint16
@@ -63,9 +60,11 @@ func (pg *Page) Usage() (uint32, uint32, error) {
 	}
 	r := uint32(l)
 	rsv := uint32(c)-r
+	log.Printf("size before %v %v", r, c)
 	if pg.menu != nil {
 		r += uint32(pg.menu.ReservedSize())
 	}
+	log.Printf("size after %v %v", r, c)
 	return r, rsv, nil
 }
 
@@ -96,12 +95,10 @@ func (pg *Page) Map(key string) error {
 			return err
 		}
 	}
-	log.Printf("mapped %s", key)
+	log.Printf("page map is now: %v", pg.cacheMap)
 	return nil
 }
 
-// Val gets the mapped content for the given symbol.
-//
 // Fails if key is not mapped.
 func(pg *Page) Val(key string) (string, error) {
 	r := pg.cacheMap[key]
@@ -111,7 +108,7 @@ func (pg *Page) Val(key string) (string, error) {
 	return r, nil
 }
 
-// Sizes returned the actual used bytes by each mapped symbol.
+// Moved from cache, MAP should hook to this object
 func(pg *Page) Sizes() (map[string]uint16, error) {
 	sizes := make(map[string]uint16)
 	var haveSink bool
@@ -126,11 +123,12 @@ func (pg *Page) Sizes() (map[string]uint16, error) {
 			}
 			haveSink = true
 		}
+		pg.sinkSize = l
 	}
 	return sizes, nil
 }
 
-// RenderTemplate is an adapter to implement the builtin golang text template renderer as resource.RenderTemplate.
+// DefaultRenderTemplate is an adapter to implement the builtin golang text template renderer as resource.RenderTemplate.
 func(pg *Page) RenderTemplate(sym string, values map[string]string, idx uint16) (string, error) {
 	tpl, err := pg.resource.GetTemplate(sym)
 	if err != nil {
@@ -159,28 +157,7 @@ func (pg *Page) RenderTemplate(sym string, values map[string]string, idx uint16)
 	return b.String(), err
 }
 
-// Render renders the current mapped content and menu state against the template associated with the symbol.
-func (pg *Page) Render(sym string, idx uint16) (string, error) {
-	var err error
-
-	values, err := pg.prepare(sym, pg.cacheMap, idx)
-	if err != nil {
-		return "", err
-	}
-
-	return pg.render(sym, values, idx)
-}
-
-// Reset prepared the Page object for re-use.
-//
-// It clears mappings and removes the sink definition.
-func (pg *Page) Reset() {
-	pg.sink = nil
-	pg.cacheMap = make(map[string]string)
-}
-
 // render menu and all syms except sink, split sink into display chunks
-// TODO: Function too long, split up
 func(pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[string]string, error) {
 	var sink string
 
@@ -214,51 +191,23 @@ func (pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[s
 	if err != nil {
 		return nil, err
 	}
-	// remaining includes core menu
+
 	remaining, ok := pg.sizer.Check(s)
 	if !ok {
 		return nil, fmt.Errorf("capacity exceeded")
 	}
 
-	var menuSizes [4]uint32 // mainSize, prevsize, nextsize, nextsize+prevsize
+	log.Printf("%v bytes available for sink split", remaining)
-	if pg.menu != nil {
-		cfg := pg.menu.GetBrowseConfig()
-		tmpm := NewMenu().WithBrowseConfig(cfg)
-		v, err := tmpm.Render(0)
-		if err != nil {
-			return nil, err
-		}
-		menuSizes[0] = uint32(len(v))
-		tmpm = tmpm.WithPageCount(2)
-		v, err = tmpm.Render(0)
-		if err != nil {
-			return nil, err
-		}
-		menuSizes[1] = uint32(len(v)) - menuSizes[0]
-		v, err = tmpm.Render(1)
-		if err != nil {
-			return nil, err
-		}
-		menuSizes[2] = uint32(len(v)) - menuSizes[0]
-		menuSizes[3] = menuSizes[1] + menuSizes[2]
-	}
-
-	log.Printf("%v bytes available for sink split before navigation", remaining)
 
 	l := 0
 	var count uint16
 	tb := strings.Builder{}
 	rb := strings.Builder{}
 
-	netRemaining := remaining - 1
-	if len(sinkValues) > 1 {
-		netRemaining -= menuSizes[1] - 1
-	}
-
 	for i, v := range sinkValues {
-		l += len(v)
 		log.Printf("processing sinkvalue %v: %s", i, v)
-		if uint32(l) > netRemaining-1 {
+		l += len(v)
+		if uint32(l) > remaining {
 			if tb.Len() == 0 {
 				return nil, fmt.Errorf("capacity insufficient for sink field %v", i)
 			}
@@ -268,14 +217,10 @@ func (pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[s
 			pg.sizer.AddCursor(c)
 			tb.Reset()
 			l = 0
-			if count == 0 {
-				netRemaining -= menuSizes[2]
-			}
 			count += 1
 		}
 		if tb.Len() > 0 {
 			tb.WriteByte(byte(0x00))
-			l += 1
 		}
 		tb.WriteString(v)
 	}
@@ -301,7 +246,6 @@ func (pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[s
 	return noSinkValues, nil
 }
 
-// render template, menu (if it exists), and audit size constraint (if it exists).
 func(pg *Page) render(sym string, values map[string]string, idx uint16) (string, error) {
 	var ok bool
 	r := ""
@@ -311,8 +255,12 @@ func (pg *Page) render(sym string, values map[string]string, idx uint16) (string
 	}
 	log.Printf("rendered %v bytes for template", len(s))
 	r += s
-
+	if pg.sizer != nil {
-	if pg.menu != nil {
+		_, ok = pg.sizer.Check(r)
+		if !ok {
+			return "", fmt.Errorf("limit exceeded: %v", pg.sizer)
+		}
+	}
 	s, err = pg.menu.Render(idx)
 	if err != nil {
 		return "", err
@@ -321,8 +269,6 @@ func (pg *Page) render(sym string, values map[string]string, idx uint16) (string
 	if len(s) > 0 {
 		r += "\n" + s
 	}
-	}
-
 	if pg.sizer != nil {
 		_, ok = pg.sizer.Check(r)
 		if !ok {
@@ -331,3 +277,21 @@ func (pg *Page) render(sym string, values map[string]string, idx uint16) (string
 	}
 	return r, nil
 }
+
+func(pg *Page) Render(sym string, idx uint16) (string, error) {
+	var err error
+
+	values, err := pg.prepare(sym, pg.cacheMap, idx)
+	if err != nil {
+		return "", err
+	}
+
+	log.Printf("nosink %v", values)
+	return pg.render(sym, values, idx)
+}
+
+func(pg *Page) Reset() {
+	pg.sink = nil
+	pg.sinkSize = 0
+	//pg.cacheMap = make(map[string]string)
+}

go/render/page_test.go

@@ -3,9 +3,10 @@ package render
 import (
 	"testing"
 
-	"git.grassecon.net/kamikazechaser/vise/cache"
+	"git.defalsify.org/festive/cache"
 )
 
+
 func TestPageCurrentSize(t *testing.T) {
 	t.Skip("usage is not in use, and it is unclear how it should be calculated")
 	ca := cache.NewCache()

go/render/render.go

@@ -0,0 +1 @@
+package render

go/render/size.go

@@ -7,17 +7,15 @@ import (
 	"strings"
 )
 
-// Sizer splits dynamic contents into individual segments for browseable pages.
 type Sizer struct {
-	outputSize uint32 // maximum output for a single page.
+	outputSize uint32
-	menuSize uint16 // actual menu size for the dynamic page being sized
+	menuSize uint16
-	memberSizes map[string]uint16 // individual byte sizes of all content to be rendered by template.
+	memberSizes map[string]uint16
-	totalMemberSize uint32 // total byte size of all content to be rendered by template (sum of memberSizes)
+	totalMemberSize uint32
-	crsrs []uint32 // byte offsets in the sink content for browseable pages indices.
+	crsrs []uint32
-	sink string // sink symbol.
+	sink string
 }
 
-// NewSizer creates a new Sizer object with the given output size constraint.
 func NewSizer(outputSize uint32) *Sizer {
 	return &Sizer{
 		outputSize: outputSize,
@@ -25,13 +23,11 @@ func NewSizer(outputSize uint32) *Sizer {
 	}
 }
 
-// WithMenuSize sets the size of the menu being used in the rendering context.
 func(szr *Sizer) WithMenuSize(menuSize uint16) *Sizer {
 	szr.menuSize = menuSize
 	return szr
 }
 
-// Set adds a content symbol in the state it will be used by the renderer.
 func(szr *Sizer) Set(key string, size uint16) error {
 	szr.memberSizes[key] = size
 	if size == 0 {
@@ -41,13 +37,12 @@ func(szr *Sizer) Set(key string, size uint16) error {
 	return nil
 }
 
-// Check audits whether the rendered string is within the output size constraint of the sizer.
 func(szr *Sizer) Check(s string) (uint32, bool) {
+	log.Printf("sizercheck %s", s)
 	l := uint32(len(s))
 	if szr.outputSize > 0 {
 		if l > szr.outputSize {
 			log.Printf("sizer check fails with length %v: %s", l, szr)
-			log.Printf("sizer contents:\n%s", s)
 			return 0, false
 		}
 		l = szr.outputSize - l
@@ -55,7 +50,6 @@ func(szr *Sizer) Check(s string) (uint32, bool) {
 	return l, true
 }
 
-// String implements the String interface.
 func(szr *Sizer) String() string {
 	var diff uint32
 	if szr.outputSize > 0 {
@@ -64,9 +58,6 @@ func(szr *Sizer) String() string {
 	return fmt.Sprintf("output: %v, member: %v, menu: %v, diff: %v", szr.outputSize, szr.totalMemberSize, szr.menuSize, diff)
 }
 
-// Size gives the byte size of content for a single symbol.
-//
-// Fails if the symbol has not been registered using Set
 func(szr *Sizer) Size(s string) (uint16, error) {
 	r, ok := szr.memberSizes[s]
 	if !ok {
@@ -75,20 +66,11 @@ func(szr *Sizer) Size(s string) (uint16, error) {
 	return r, nil
 }
 
-// Menusize returns the currently defined menu size.
-func(szr *Sizer) MenuSize() uint16 {
-	return szr.menuSize
-}
-
-// AddCursor adds a pagination cursor for the paged sink content.
 func(szr *Sizer) AddCursor(c uint32) {
 	log.Printf("added cursor: %v", c)
 	szr.crsrs = append(szr.crsrs, c)
 }
 
-// GetAt the paged symbols for the current page index.
-//
-// Fails if index requested is out of range.
 func(szr *Sizer) GetAt(values map[string]string, idx uint16) (map[string]string, error) {
 	if szr.sink == "" {
 		return values, nil
@@ -102,6 +84,7 @@ func(szr *Sizer) GetAt(values map[string]string, idx uint16) (map[string]string,
 			c := szr.crsrs[idx]
 			v = v[c:]
 			nl := strings.Index(v, "\n")
+			log.Printf("k %v v %v c %v nl %v", k, v, c, nl)
 			if nl > 0 {
 				v = v[:nl]
 			}

go/render/size_test.go

@@ -0,0 +1,169 @@
+package render
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	"git.defalsify.org/festive/state"
+	"git.defalsify.org/festive/resource"
+	"git.defalsify.org/festive/cache"
+)
+
+type TestSizeResource struct {
+	*resource.MenuResource
+}
+
+func getTemplate(sym string) (string, error) {
+	var tpl string
+	switch sym {
+	case "small":
+		tpl = "one {{.foo}} two {{.bar}} three {{.baz}}"
+	case "toobig":
+		tpl = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus in mattis lorem. Aliquam erat volutpat. Ut vitae metus."
+	case "pages":
+		tpl = "one {{.foo}} two {{.bar}} three {{.baz}}\n{{.xyzzy}}"
+	}
+	return tpl, nil
+}
+
+func funcFor(sym string) (resource.EntryFunc, error) {
+	switch sym {
+	case "foo":
+		return getFoo, nil
+	case "bar":
+		return getBar, nil
+	case "baz":
+		return getBaz, nil
+	case "xyzzy":
+		return getXyzzy, nil
+	}
+	return nil, fmt.Errorf("unknown func: %s", sym)
+}
+
+func getFoo(sym string, ctx context.Context) (string, error) {
+	return "inky", nil
+}
+
+func getBar(sym string, ctx context.Context) (string, error) {
+	return "pinky", nil
+}
+
+func getBaz(sym string, ctx context.Context) (string, error) {
+	return "blinky", nil
+}
+
+func getXyzzy(sym string, ctx context.Context) (string, error) {
+	return "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve", nil
+}
+
+func TestSizeCheck(t *testing.T) {
+	szr := NewSizer(16)
+	l, ok := szr.Check("foobar")
+	if !ok {
+		t.Fatalf("expected ok")
+	}
+	if l != 10 {
+		t.Fatalf("expected 10, got %v", l)
+	}
+
+	l, ok = szr.Check("inkypinkyblinkyclyde")
+	if ok {
+		t.Fatalf("expected not ok")
+	}
+	if l != 0 {
+		t.Fatalf("expected 0, got %v", l)
+	}
+}
+
+func TestSizeLimit(t *testing.T) {
+	st := state.NewState(0)
+	ca := cache.NewCache()
+	mn := NewMenu().WithOutputSize(32)
+	mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
+	rs := TestSizeResource{
+		mrs,
+	}
+	szr := NewSizer(128)
+	pg := NewPage(ca, rs).WithMenu(mn).WithSizer(szr)
+	ca.Push()
+	st.Down("test")
+	ca.Add("foo", "inky", 4)
+	ca.Add("bar", "pinky", 10)
+	ca.Add("baz", "blinky", 0)
+	pg.Map("foo")
+	pg.Map("bar")
+	pg.Map("baz")
+
+	mn.Put("1", "foo the foo")
+	mn.Put("2", "go to bar")
+
+	var err error
+	_, err = pg.Render("small", 0)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	_, err = pg.Render("toobig", 0)
+	if err == nil {
+		t.Fatalf("expected size exceeded")
+	}
+}
+
+func TestSizePages(t *testing.T) {
+	st := state.NewState(0)
+	ca := cache.NewCache()
+	mn := NewMenu().WithOutputSize(32)
+	mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
+	rs := TestSizeResource{
+		mrs,	
+	}
+	szr := NewSizer(128)
+	pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
+	ca.Push()
+	st.Down("test")
+	ca.Add("foo", "inky", 4)
+	ca.Add("bar", "pinky", 10)
+	ca.Add("baz", "blinky", 20)
+	ca.Add("xyzzy", "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve", 0)
+	pg.Map("foo")
+	pg.Map("bar")
+	pg.Map("baz")
+	pg.Map("xyzzy")
+
+	mn.Put("1", "foo the foo")
+	mn.Put("2", "go to bar")
+
+	r, err := pg.Render("pages",  0)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expect := `one inky two pinky three blinky
+inky pinky
+blinky clyde sue
+tinkywinky dipsy
+lala poo
+1:foo the foo
+2:go to bar`
+
+
+	if r != expect {
+		t.Fatalf("expected:\n\t%s\ngot:\n\t%s\n", expect, r)
+	}
+	r, err = pg.Render("pages", 1)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expect = `one inky two pinky three blinky
+one two three four five six seven
+eight nine ten
+eleven twelve
+1:foo the foo
+2:go to bar`
+	if r != expect {
+		t.Fatalf("expected:\n\t%s\ngot:\n\t%s\n", expect, r)
+	}
+
+}

go/resource/fs.go

@@ -39,19 +39,12 @@ func(fs FsResource) GetCode(sym string) ([]byte, error) {
 	return ioutil.ReadFile(fp)
 }
 
-func(fs *FsResource) AddLocalFunc(sym string, fn EntryFunc) {
-	if fs.fns == nil {
-		fs.fns = make(map[string]EntryFunc)
-	}
-	fs.fns[sym] = fn
-}
-
 func(fs FsResource) FuncFor(sym string) (EntryFunc, error) {
 	fn, ok := fs.fns[sym]
 	if ok {
 		return fn, nil
 	}
-	_, err := fs.getFuncNoCtx(sym, nil)
+	_, err := fs.getFuncNoCtx(sym)
 	if err != nil {
 		return nil, fmt.Errorf("unknown sym: %s", sym)
 	}
@@ -62,20 +55,18 @@ func(fs FsResource) String() string {
 	return fmt.Sprintf("fs resource at path: %s", fs.Path)
 }
 
-func(fs FsResource) getFunc(sym string, input []byte, ctx context.Context) (Result, error) {
+func(fs FsResource) getFunc(sym string, ctx context.Context) (string, error) {
-	return fs.getFuncNoCtx(sym, input)
+	return fs.getFuncNoCtx(sym)
 }
 
-func(fs FsResource) getFuncNoCtx(sym string, input []byte) (Result, error) {
+func(fs FsResource) getFuncNoCtx(sym string) (string, error) {
 	fb := sym + ".txt"
 	fp := path.Join(fs.Path, fb)
 	log.Printf("getfunc search dir %s %s for %s", fs.Path, fp, sym)
 	r, err := ioutil.ReadFile(fp)
 	if err != nil {
-		return Result{}, fmt.Errorf("failed getting data for sym '%s': %v", sym, err)
+		return "", fmt.Errorf("failed getting data for sym '%s': %v", sym, err)
 	}
 	s := string(r)
-	return Result{
+	return strings.TrimSpace(s), nil
-		Content: strings.TrimSpace(s),
-	}, nil
 }

go/resource/resource.go

@@ -4,15 +4,8 @@ import (
 	"context"
 )
 
-// Result contains the results of an external code operation.
-type Result struct {
-	Content string // content value for symbol after execution.
-	FlagSet []uint32 // request caller to set error flags at given indices.
-	FlagReset []uint32 // request caller to reset error flags at given indices.
-}
-
 // EntryFunc is a function signature for retrieving value for a key
-type EntryFunc func(sym string, input []byte, ctx context.Context) (Result, error)
+type EntryFunc func(sym string, ctx context.Context) (string, error)
 type CodeFunc func(sym string) ([]byte, error)
 type TemplateFunc func(sym string) (string, error)
 type FuncForFunc func(sym string) (EntryFunc, error)
@@ -24,9 +17,6 @@ type Resource interface {
 	FuncFor(sym string) (EntryFunc, error) // Resolve symbol content point for.
 }
 
-// MenuResource contains the base definition for building Resource implementations.
-//
-// TODO: Rename to BaseResource
 type MenuResource struct {
 	sinkValues []string
 	codeFunc CodeFunc
@@ -57,17 +47,14 @@ func(m *MenuResource) WithTemplateGetter(templateGetter TemplateFunc) *MenuResou
 	return m
 }
 
-// FuncFor implements Resource interface
 func(m *MenuResource) FuncFor(sym string) (EntryFunc, error) {
 	return m.funcFunc(sym)
 }
 
-// GetCode implements Resource interface
 func(m *MenuResource) GetCode(sym string) ([]byte, error) {
 	return m.codeFunc(sym)
 }
 
-// GetTemplate implements Resource interface
 func(m *MenuResource) GetTemplate(sym string) (string, error) {
 	return m.templateFunc(sym)
 }

go/resource/resource_test.go

@@ -37,27 +37,18 @@ func funcFor(sym string) (EntryFunc, error) {
 	return nil, fmt.Errorf("unknown func: %s", sym)
 }
 
-func get(sym string, input []byte, ctx context.Context) (Result, error) {
+func get(sym string, ctx context.Context) (string, error) {
 	switch sym {
 	case "foo":
-		return Result{
+		return "inky", nil
-			Content: "inky",
-		}, nil
 	case "bar":
-		return Result{
+		return "pinky", nil
-			Content: "pinky",
-		}, nil
 	case "baz":
-		return Result{
+		return "blinky", nil
-			Content: "blinky",
-		}, nil
 	}
-	return Result{}, fmt.Errorf("unknown sym: %s", sym)
+	return "", fmt.Errorf("unknown sym: %s", sym)
 }
 
-func getXyzzy(sym string, input []byte, ctx context.Context) (Result, error) {
+func getXyzzy(sym string, ctx context.Context) (string, error) {
-	r := "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve"
+	return "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve", nil
-	return Result{
-		Content: r,
-	}, nil
 }

go/resource/state.go

@@ -1,7 +1,7 @@
 package resource
 
 import (
-	"git.grassecon.net/kamikazechaser/vise/state"
+	"git.defalsify.org/festive/state"
 )
 
 type StateResource struct {

go/resource/state_test.go

@@ -3,7 +3,7 @@ package resource
 import (
 	"testing"
 
-	"git.grassecon.net/kamikazechaser/vise/state"
+	"git.defalsify.org/festive/state"
 )
 
 func TestStateResourceInit(t *testing.T) {

go/state/flag.go

@@ -0,0 +1,8 @@
+package state
+
+const (
+	FLAG_READIN = 1
+	FLAG_INMATCH = 2
+	FLAG_TERMINATE = 3
+	FLAG_DIRTY = 4
+)

go/state/state.go

@@ -6,13 +6,6 @@ import (
 	"strings"
 )
 
-type IndexError struct {
-}
-
-func(err *IndexError) Error() string {
-	return fmt.Sprintf("already at first index")
-}
-
 // State holds the command stack, error condition of a unique execution session.
 //
 // It also holds cached values for all results of executed symbols.
@@ -29,25 +22,25 @@ func(err *IndexError) Error() string {
 //
 // 8 first flags are reserved.
 type State struct {
-	Code []byte // Pending bytecode to execute
-	ExecPath []string // Command symbols stack
-	BitSize uint32 // size of (32-bit capacity) bit flag byte array
-	SizeIdx uint16
 	Flags []byte // Error state
-	Moves uint32 // Number of times navigation has been performed
 	input []byte // Last input
+	code []byte // Pending bytecode to execute
+	execPath []string // Command symbols stack
+	arg *string // Optional argument. Nil if not set.
+	bitSize uint32 // size of (32-bit capacity) bit flag byte array
+	sizeIdx uint16
 }
 
 // number of bytes necessary to represent a bitfield of the given size.
-func toByteSize(BitSize uint32) uint8 {
+func toByteSize(bitSize uint32) uint8 {
-	if BitSize == 0 {
+	if bitSize == 0 {
 		return 0
 	}
-	n := BitSize % 8
+	n := bitSize % 8
 	if n > 0 {
-		BitSize += (8 - n)
+		bitSize += (8 - n)
 	}
-	return uint8(BitSize / 8)
+	return uint8(bitSize / 8)
 }
 
 // Retrieve the state of a state flag
@@ -58,12 +51,12 @@ func getFlag(bitIndex uint32, bitField []byte) bool {
 	return (b & (1 << localBitIndex)) > 0
 }
 
-// NewState creates a new State object with BitSize number of error condition states in ADDITION to the 8 builtin flags.
+// NewState creates a new State object with bitSize number of error condition states in ADDITION to the 8 builtin flags.
-func NewState(BitSize uint32) State {
+func NewState(bitSize uint32) State {
 	st := State{
-		BitSize: BitSize + 8,
+		bitSize: bitSize + 8,
 	}
-	byteSize := toByteSize(BitSize + 8)
+	byteSize := toByteSize(bitSize + 8)
 	if byteSize > 0 {
 		st.Flags = make([]byte, byteSize) 
 	} else {
@@ -78,8 +71,8 @@ func NewState(BitSize uint32) State {
 //
 // Fails if bitindex is out of range.
 func(st *State) SetFlag(bitIndex uint32) (bool, error) {
-	if bitIndex + 1 > st.BitSize {
+	if bitIndex + 1 > st.bitSize {
-		return false, fmt.Errorf("bit index %v is out of range of bitfield size %v", bitIndex, st.BitSize)
+		return false, fmt.Errorf("bit index %v is out of range of bitfield size %v", bitIndex, st.bitSize)
 	}
 	r := getFlag(bitIndex, st.Flags)
 	if r {
@@ -99,8 +92,8 @@ func(st *State) SetFlag(bitIndex uint32) (bool, error) {
 //
 // Fails if bitindex is out of range.
 func(st *State) ResetFlag(bitIndex uint32) (bool, error) {
-	if bitIndex + 1 > st.BitSize {
+	if bitIndex + 1 > st.bitSize {
-		return false, fmt.Errorf("bit index %v is out of range of bitfield size %v", bitIndex, st.BitSize)
+		return false, fmt.Errorf("bit index %v is out of range of bitfield size %v", bitIndex, st.bitSize)
 	}
 	r := getFlag(bitIndex, st.Flags)
 	if !r {
@@ -117,15 +110,15 @@ func(st *State) ResetFlag(bitIndex uint32) (bool, error) {
 //
 // Fails if bit field index is out of range.
 func(st *State) GetFlag(bitIndex uint32) (bool, error) {
-	if bitIndex + 1 > st.BitSize {
+	if bitIndex + 1 > st.bitSize {
-		return false, fmt.Errorf("bit index %v is out of range of bitfield size %v", bitIndex, st.BitSize)
+		return false, fmt.Errorf("bit index %v is out of range of bitfield size %v", bitIndex, st.bitSize)
 	}
 	return getFlag(bitIndex, st.Flags), nil
 }
 
 // FlagBitSize reports the amount of bits available in the bit field index.
 func(st *State) FlagBitSize() uint32 {
-	return st.BitSize
+	return st.bitSize
 }
 
 // FlagBitSize reports the amount of bits available in the bit field index.
@@ -158,7 +151,7 @@ func(st *State) MatchFlag(sig uint32, invertMatch bool) (bool, error) {
 // If the given byte slice is too small for the bit field bitsize, the check will terminate at end-of-data without error.
 func(st *State) GetIndex(flags []byte) bool {
 	var globalIndex uint32
-	if st.BitSize == 0 {
+	if st.bitSize == 0 {
 		return false
 	}
 	if len(flags) == 0 {
@@ -168,7 +161,7 @@ func(st *State) GetIndex(flags []byte) bool {
 	var localIndex uint8
 	l := uint8(len(flags))
 	var i uint32
-	for i = 0; i < st.BitSize; i++ {
+	for i = 0; i < st.bitSize; i++ {
 		testVal := flags[byteIndex] & (1 << localIndex)
 		if (testVal & st.Flags[byteIndex]) > 0 {
 			return true
@@ -189,56 +182,50 @@ func(st *State) GetIndex(flags []byte) bool {
 
 // Where returns the current active rendering symbol.
 func(st *State) Where() (string, uint16) {
-	if len(st.ExecPath) == 0 {
+	if len(st.execPath) == 0 {
 		return "", 0
 	}
-	l := len(st.ExecPath)
+	l := len(st.execPath)
-	return st.ExecPath[l-1], st.SizeIdx
+	return st.execPath[l-1], st.sizeIdx
 }
 
 // Next moves to the next sink page index.
 func(st *State) Next() (uint16, error) {
-	if len(st.ExecPath) == 0 {
+	if len(st.execPath) == 0 {
 		return 0, fmt.Errorf("state root node not yet defined")
 	}
-	st.SizeIdx += 1
+	st.sizeIdx += 1
 	s, idx := st.Where()
 	log.Printf("next page for %s: %v", s, idx)
-	st.Moves += 1
+	return st.sizeIdx, nil
-	return st.SizeIdx, nil
-}
-
-func(st *State) Same() {
-	st.Moves += 1
 }
 
 // Previous moves to the next sink page index.
 //
 // Fails if try to move beyond index 0.
 func(st *State) Previous() (uint16, error) {
-	if len(st.ExecPath) == 0 {
+	if len(st.execPath) == 0 {
 		return 0, fmt.Errorf("state root node not yet defined")
 	}
-	if st.SizeIdx == 0 {
+	if st.sizeIdx == 0 {
-		return 0, &IndexError{} // ("already at first index")
+		return 0, fmt.Errorf("already at first index")
 	}
-	st.SizeIdx -= 1
+	st.sizeIdx -= 1
 	s, idx := st.Where()
 	log.Printf("previous page for %s: %v", s, idx)
-	st.Moves += 1
+	return st.sizeIdx, nil
-	return st.SizeIdx, nil
 }
 
 // Sides informs the caller which index page options will currently succeed.
 //
 // Two values are returned, for the "next" and "previous" options in that order. A false value means the option is not available in the current state.
 func(st *State) Sides() (bool, bool) {
-	if len(st.ExecPath) == 0 {
+	if len(st.execPath) == 0 {
 		return false, false
 	}
 	next := true
-	log.Printf("sides %v", st.SizeIdx)
+	log.Printf("sides %v", st.sizeIdx)
-	if st.SizeIdx == 0 {
+	if st.sizeIdx == 0 {
 		return next, false	
 	}
 	return next, true
@@ -248,19 +235,18 @@ func(st *State) Sides() (bool, bool) {
 //
 // Fails if first Down() was never called.
 func(st *State) Top() (bool, error) {
-	if len(st.ExecPath) == 0 {
+	if len(st.execPath) == 0 {
 		return false, fmt.Errorf("state root node not yet defined")
 	}
-	return len(st.ExecPath) == 1, nil
+	return len(st.execPath) == 1, nil
 }
 
 // Down adds the given symbol to the command stack.
 //
 // Clears mapping and sink.
 func(st *State) Down(input string) error {
-	st.ExecPath = append(st.ExecPath, input)
+	st.execPath = append(st.execPath, input)
-	st.SizeIdx = 0
+	st.sizeIdx = 0
-	st.Moves += 1
 	return nil
 }
 
@@ -272,30 +258,29 @@ func(st *State) Down(input string) error {
 //
 // Fails if called at top frame.
 func(st *State) Up() (string, error) {
-	l := len(st.ExecPath)
+	l := len(st.execPath)
 	if l == 0 {
 		return "", fmt.Errorf("exit called beyond top frame")
 	}
-	log.Printf("execpath before %v", st.ExecPath)
+	log.Printf("execpath before %v", st.execPath)
-	st.ExecPath = st.ExecPath[:l-1]
+	st.execPath = st.execPath[:l-1]
 	sym := ""
-	if len(st.ExecPath) > 0 {
+	if len(st.execPath) > 0 {
-		sym = st.ExecPath[len(st.ExecPath)-1]
+		sym = st.execPath[len(st.execPath)-1]
 	}
-	st.SizeIdx = 0
+	st.sizeIdx = 0
-	log.Printf("execpath after %v", st.ExecPath)
+	log.Printf("execpath after %v", st.execPath)
-	st.Moves += 1
 	return sym, nil
 }
 
 // Depth returns the current call stack depth.
 func(st *State) Depth() uint8 {
-	return uint8(len(st.ExecPath)-1)
+	return uint8(len(st.execPath)-1)
 }
 
 // Appendcode adds the given bytecode to the end of the existing code.
 func(st *State) AppendCode(b []byte) error {
-	st.Code = append(st.Code, b...)
+	st.code = append(st.code, b...)
 	log.Printf("code changed to 0x%x", b)
 	return nil
 }
@@ -303,13 +288,13 @@ func(st *State) AppendCode(b []byte) error {
 // SetCode replaces the current bytecode with the given bytecode.
 func(st *State) SetCode(b []byte) {
 	log.Printf("code set to 0x%x", b)
-	st.Code = b
+	st.code = b
 }
 
 // Get the remaning cached bytecode
 func(st *State) GetCode() ([]byte, error) {
-	b := st.Code
+	b := st.code
-	st.Code = []byte{}
+	st.code = []byte{}
 	return b, nil
 }
 
@@ -331,22 +316,10 @@ func(st *State) SetInput(input []byte) error {
 	return nil
 }
 
-// Reset re-initializes the state to run from top node with accumulated client state.
+func(st *State) Reset() error {
-func(st *State) Restart() error {
-	st.resetBaseFlags()
-	st.Moves = 0
-	st.SizeIdx = 0
-	st.input = []byte{}
 	return nil
 }
 
-// String implements String interface
 func(st State) String() string {
-	return fmt.Sprintf("moves %v idx %v flags: 0x%x path: %s", st.Moves, st.SizeIdx, st.Flags, strings.Join(st.ExecPath, "/"))
+	return fmt.Sprintf("path: %s", strings.Join(st.execPath, "/"))
 }
-
-// initializes all flags not in control of client.
-func(st *State) resetBaseFlags() {
-	st.Flags[0] = 0
-}
-

go/state/state_test.go

@@ -21,7 +21,7 @@ func TestNewState(t *testing.T) {
 	}
 }
 
-func TestStateflags(t *testing.T) {
+func TestStateFlags(t *testing.T) {
 	st := NewState(9)
 	v, err := st.GetFlag(2)
 	if err != nil {

go/testdata/testdata.go

@@ -8,7 +8,7 @@ import (
 
 	testdataloader "github.com/peteole/testdata-loader"
 
-	"git.grassecon.net/kamikazechaser/vise/vm"
+	"git.defalsify.org/festive/vm"
 )
 
 type genFunc func() error
@@ -66,12 +66,11 @@ func foo() error {
 	b := []byte{}
 	b = vm.NewLine(b, vm.MOUT, []string{"0", "to foo"}, nil, nil)
 	b = vm.NewLine(b, vm.MOUT, []string{"1", "go bar"}, nil, nil)
-	b = vm.NewLine(b, vm.MOUT, []string{"2", "see long"}, nil, nil)
 	b = vm.NewLine(b, vm.LOAD, []string{"inky"}, []byte{20}, nil)
 	b = vm.NewLine(b, vm.HALT, nil, nil, nil)
 	b = vm.NewLine(b, vm.INCMP, []string{"0", "_"}, nil, nil)
 	b = vm.NewLine(b, vm.INCMP, []string{"1", "baz"}, nil, nil)
-	b = vm.NewLine(b, vm.INCMP, []string{"2", "long"}, nil, nil)
+	//b = vm.NewLine(b, vm.CATCH, []string{"_catch"}, []byte{1}, []uint8{1})
 
 	data := make(map[string]string)
 	data["inky"] = "one"
@@ -107,35 +106,6 @@ func baz() error {
 	return out("baz", b, tpl, nil)
 }
 
-func long() error {
-	b := []byte{}
-	b = vm.NewLine(b, vm.MOUT, []string{"0", "back"}, nil, nil)
-	b = vm.NewLine(b, vm.MNEXT, []string{"00", "nexxt"}, nil, nil)
-	b = vm.NewLine(b, vm.MPREV, []string{"11", "prevvv"}, nil, nil)
-	b = vm.NewLine(b, vm.LOAD, []string{"longdata"}, []byte{0x00}, nil)
-	b = vm.NewLine(b, vm.MAP, []string{"longdata"}, nil, nil)
-	b = vm.NewLine(b, vm.HALT, nil, nil, nil)
-	b = vm.NewLine(b, vm.INCMP, []string{"0", "_"}, nil, nil)
-	b = vm.NewLine(b, vm.INCMP, []string{"00", ">"}, nil, nil)
-	b = vm.NewLine(b, vm.INCMP, []string{"11", "<"}, nil, nil)
-
-	tpl := `data
-{{.longdata}}`
-
-	data := make(map[string]string)
-	data["longdata"] = `INKY 12
-PINKY 5555
-BLINKY 3t7
-CLYDE 11
-TINKYWINKY 22
-DIPSY 666
-LALA 111
-POO 222
-`
-
-	return out("long", b, tpl, data)
-}
-
 func defaultCatch() error {
 	b := []byte{}
 	b = vm.NewLine(b, vm.MOUT, []string{"0", "back"}, nil, nil)
@@ -153,7 +123,7 @@ func generate() error {
 		return err
 	}
 
-	fns := []genFunc{root, foo, bar, baz, long, defaultCatch}
+	fns := []genFunc{root, foo, bar, baz, defaultCatch}
 	for _, fn := range fns {
 		err = fn()
 		if err != nil {
@@ -163,11 +133,8 @@ func generate() error {
 	return nil
 }
 
-// Generate outputs bytecode, templates and content symbols to a temporary directory.
-//
-// This directory can in turn be used as data source for the the resource.FsResource object.
 func Generate() (string, error) {
-	dir, err := ioutil.TempDir("", "vise_testdata_")
+	dir, err := ioutil.TempDir("", "festive_testdata_")
 	if err != nil {
 		return "", err
 	}
@@ -177,11 +144,6 @@ func Generate() (string, error) {
 	return dir, err
 }
 
-// Generate outputs bytecode, templates and content symbols to a specified directory.
-//
-// The directory must exist, and must not have been used already in the same code execution.
-//
-// This directory can in turn be used as data source for the the resource.FsResource object.
 func GenerateTo(dir string) error {
 	if dirLock {
 		return fmt.Errorf("directory already overridden")

go/vm/input.go

@@ -5,17 +5,18 @@ import (
 	"fmt"
 	"regexp"
 
-	"git.grassecon.net/kamikazechaser/vise/cache"
+	"git.defalsify.org/festive/cache"
-	"git.grassecon.net/kamikazechaser/vise/state"
+	"git.defalsify.org/festive/state"
 )
 
 var (
 	inputRegexStr = "^[a-zA-Z0-9].*$"
 	inputRegex = regexp.MustCompile(inputRegexStr)
-	ctrlRegexStr  = "^[><_^.]$"
+	ctrlRegexStr = "^[><_^]$"
 	ctrlRegex = regexp.MustCompile(ctrlRegexStr)
 	symRegexStr = "^[a-zA-Z0-9][a-zA-Z0-9_]+$"
 	symRegex = regexp.MustCompile(symRegexStr)
+
 )
 
 // CheckInput validates the given byte string as client input.
@@ -136,10 +137,6 @@ func applyTarget(target []byte, st *state.State, ca cache.Memory, ctx context.Co
 				return sym, idx, err
 			}
 		}
-	case '.':
-		st.Same()
-		location, idx := st.Where()
-		return location, idx, nil
 	default:
 		sym = string(target)
 		err := st.Down(sym)

go/vm/runner.go

@@ -5,23 +5,22 @@ import (
 	"fmt"
 	"log"
 
-	"git.grassecon.net/kamikazechaser/vise/cache"
+	"git.defalsify.org/festive/cache"
-	"git.grassecon.net/kamikazechaser/vise/render"
+	"git.defalsify.org/festive/render"
-	"git.grassecon.net/kamikazechaser/vise/resource"
+	"git.defalsify.org/festive/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
+	"git.defalsify.org/festive/state"
 )
 
-// Vm holds sub-components mutated by the vm execution.
 type Vm struct {
-	st    *state.State      // Navigation and error states.
+	st *state.State
-	rs    resource.Resource // Retrieves content, code, and templates for symbols.
+	rs resource.Resource
-	ca    cache.Memory      // Loaded content.
+	pg *render.Page
-	mn    *render.Menu      // Menu component of page.
+	ca cache.Memory
-	sizer *render.Sizer     // Apply size constraints to output.
+	mn *render.Menu
-	pg    *render.Page      // Render outputs with menues to size constraints.
+	sizer *render.Sizer
 }
 
-// NewVm creates a new Vm.
+
 func NewVm(st *state.State, rs resource.Resource, ca cache.Memory, sizer *render.Sizer) *Vm {
 	vmi := &Vm{
 		st: st,
@@ -31,20 +30,20 @@ func NewVm(st *state.State, rs resource.Resource, ca cache.Memory, sizer *render
 		sizer: sizer,
 	}
 	vmi.Reset()
-	log.Printf("vm created with state: %v", st)
 	return vmi
 }
 
-// Reset re-initializes sub-components for output rendering.
 func(vmi *Vm) Reset() {
 	vmi.mn = render.NewMenu()
 	vmi.pg.Reset()
-	vmi.pg = vmi.pg.WithMenu(vmi.mn)
+	vmi.pg = vmi.pg.WithMenu(vmi.mn) //render.NewPage(vmi.ca, vmi.rs).WithMenu(vmi.mn)
 	if vmi.sizer != nil {
 		vmi.pg = vmi.pg.WithSizer(vmi.sizer)	
 	}
 }
 
+//type Runner func(instruction []byte, st state.State, rs resource.Resource, ctx context.Context) (state.State, []byte, error)
+
 // Run extracts individual op codes and arguments and executes them.
 //
 // Each step may update the state.
@@ -61,24 +60,6 @@ func (vm *Vm) Run(b []byte, ctx context.Context) ([]byte, error) {
 			log.Printf("terminate set! bailing!")
 			return []byte{}, nil
 		}
-		//vm.st.ResetBaseFlags()
-		_, err = vm.st.ResetFlag(state.FLAG_TERMINATE)
-		if err != nil {
-			panic(err)
-		}
-
-		waitChange, err := vm.st.ResetFlag(state.FLAG_WAIT)
-		if err != nil {
-			panic(err)
-		}
-		if waitChange {
-			log.Printf("waitchange")
-			_, err = vm.st.ResetFlag(state.FLAG_INMATCH)
-			if err != nil {
-				panic(err)
-			}
-		}
-
 		_, err = vm.st.SetFlag(state.FLAG_DIRTY)
 		if err != nil {
 			panic(err)
@@ -167,6 +148,7 @@ func (vm *Vm) RunDeadCheck(b []byte, ctx context.Context) ([]byte, error) {
 		return b, nil
 	}
 
+
 	log.Printf("no code remaining but not terminating")
 	location, _ := vm.st.Where()
 	if location == "" {
@@ -191,29 +173,12 @@ func (vm *Vm) RunCatch(b []byte, ctx context.Context) ([]byte, error) {
 	}
 	r, err := vm.st.MatchFlag(sig, mode)
 	if err != nil {
-		var perr error
-		_, perr = vm.st.SetFlag(state.FLAG_TERMINATE)
-		if perr != nil {
-			panic(perr)
-		}
-		log.Printf("terminate set")
 		return b, err
 	}
 	if r {
-		//b = append(bh, b...)
+		log.Printf("catch at flag %v, moving to %v", sig, sym) //bitField, d)
-		//vm.st.Down(sym)
+		vm.st.Down(sym)
-		//vm.ca.Push()
+		b = []byte{}
-		actualSym, _, err := applyTarget([]byte(sym), vm.st, vm.ca, ctx)
-		if err != nil {
-			return b, err
-		}
-		log.Printf("catch at flag %v, moving to '%v' ('%v')", sig, sym, actualSym)
-		sym = actualSym
-		bh, err := vm.rs.GetCode(sym)
-		if err != nil {
-			return b, err
-		}
-		b = bh
 	} 
 	return b, nil
 }
@@ -230,7 +195,7 @@ func (vm *Vm) RunCroak(b []byte, ctx context.Context) ([]byte, error) {
 	}
 	if r {
 		log.Printf("croak at flag %v, purging and moving to top", sig)
-		vm.Reset()
+		vm.st.Reset()
 		vm.pg.Reset()
 		vm.ca.Reset()
 		b = []byte{}
@@ -244,7 +209,8 @@ func (vm *Vm) RunLoad(b []byte, ctx context.Context) ([]byte, error) {
 	if err != nil {
 		return b, err
 	}
-	r, err := vm.refresh(sym, vm.rs, ctx)
+
+	r, err := refresh(sym, vm.rs, ctx)
 	if err != nil {
 		return b, err
 	}
@@ -259,7 +225,7 @@ func (vm *Vm) RunReload(b []byte, ctx context.Context) ([]byte, error) {
 		return b, err
 	}
 
-	r, err := vm.refresh(sym, vm.rs, ctx)
+	r, err := refresh(sym, vm.rs, ctx)
 	if err != nil {
 		return b, err
 	}
@@ -291,21 +257,19 @@ func (vm *Vm) RunMove(b []byte, ctx context.Context) ([]byte, error) {
 	if err != nil {
 		return b, err
 	}
-	log.Printf("loaded code for %s: %x", sym, code)
+	log.Printf("loaded additional code: %x", code)
 	b = append(b, code...)
-	vm.Reset()
 	return b, nil
 }
 
 // RunIncmp executes the INCMP opcode
-// TODO: create state transition table and simplify flow
 func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 	sym, target, b, err := ParseInCmp(b)
 	if err != nil {
 		return b, err
 	}
 
-	reading, err := vm.st.GetFlag(state.FLAG_READIN)
+	change, err := vm.st.SetFlag(state.FLAG_READIN)
 	if err != nil {
 		panic(err)
 	}
@@ -314,31 +278,29 @@ func (vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 		panic(err)
 	}
 	if have {
-		if reading {
+		if change {
-			log.Printf("ignoring input %s, already have match", sym)
+			_, err = vm.st.ResetFlag(state.FLAG_INMATCH)
-			return b, nil
-		}
-	} else {
-		_, err = vm.st.SetFlag(state.FLAG_READIN)
 			if err != nil {
 				panic(err)
 			}
+		} else {
+			return b, nil
+		}
 	}
 	input, err := vm.st.GetInput()
 	if err != nil {
 		return b, err
 	}
-	log.Printf("testing sym %s input %s", sym, input)
+	log.Printf("sym is %s", sym)
-
+	if sym == "*" {
-	if !have && sym == "*" {
 		log.Printf("input wildcard match ('%s'), target '%s'", input, target)
 	} else {
 		if sym != string(input) {
-			log.Printf("foo")
 			return b, nil
 		}
 		log.Printf("input match for '%s', target '%s'", input, target)
 	}
+
 	_, err = vm.st.SetFlag(state.FLAG_INMATCH)
 	if err != nil {
 		panic(err)
@@ -348,28 +310,15 @@ func (vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 		panic(err)
 	}
 
-	newTarget, _, err := applyTarget([]byte(target), vm.st, vm.ca, ctx)
+	target, _, err = applyTarget([]byte(target), vm.st, vm.ca, ctx)
-
-	_, ok := err.(*state.IndexError)
-	if ok {
-		_, err = vm.st.SetFlag(state.FLAG_READIN)
 	if err != nil {
-			panic(err)
-		}
-		return b, nil
-	} else if err != nil {
 		return b, err
 	}
 
-	target = newTarget
-
-	vm.Reset()
-
 	code, err := vm.rs.GetCode(target)
 	if err != nil {
 		return b, err
 	}
-	log.Printf("bar")
 	log.Printf("loaded additional code for target '%s': %x", target, code)
 	b = append(b, code...)
 	return b, err
@@ -383,12 +332,7 @@ func (vm *Vm) RunHalt(b []byte, ctx context.Context) ([]byte, error) {
 		return b, err
 	}
 	log.Printf("found HALT, stopping")
-
+	return b, err
-	_, err = vm.st.SetFlag(state.FLAG_WAIT)
-	if err != nil {
-		panic(err)
-	}
-	return b, nil
 }
 
 // RunMSize executes the MSIZE opcode
@@ -436,34 +380,25 @@ func (vm *Vm) RunMPrev(b []byte, ctx context.Context) ([]byte, error) {
        return b, nil
 }
 
-// Render wraps output rendering, and handles error when attempting to browse beyond the rendered page count.
+func(vm *Vm) Render() (string, error) {
-func (vm *Vm) Render(ctx context.Context) (string, error) {
 	changed, err := vm.st.ResetFlag(state.FLAG_DIRTY)
 	if err != nil {
 		panic(err)	
 	}
 	if !changed {
-		return "", nil
+		log.Printf("Render called when not dirty, please investigate.")
 	}
 	sym, idx := vm.st.Where()
 	r, err := vm.pg.Render(sym, idx)
-	var ok bool
-	_, ok = err.(*render.BrowseError)
-	if ok {
-		vm.Reset()
-		b := NewLine(nil, MOVE, []string{"_catch"}, nil, nil)
-		vm.Run(b, ctx)
-		sym, idx := vm.st.Where()
-		r, err = vm.pg.Render(sym, idx)
-	}
 	if err != nil {
 		return "", err
 	}
+	vm.Reset()
 	return r, nil
 }
 
 // retrieve data for key
-func (vm *Vm) refresh(key string, rs resource.Resource, ctx context.Context) (string, error) {
+func refresh(key string, rs resource.Resource, ctx context.Context) (string, error) {
 	fn, err := rs.FuncFor(key)
 	if err != nil {
 		return "", err
@@ -471,35 +406,6 @@ func (vm *Vm) refresh(key string, rs resource.Resource, ctx context.Context) (st
 	if fn == nil {
 		return "", fmt.Errorf("no retrieve function for external symbol %v", key)
 	}
-	input, _ := vm.st.GetInput()
+	return fn(key, ctx)
-	r, err := fn(key, input, ctx)
-	if err != nil {
-		log.Printf("loadfail %v", err)
-		var perr error
-		_, perr = vm.st.SetFlag(state.FLAG_LOADFAIL)
-		if perr != nil {
-			panic(err)
-		}
-		return "", err
-	}
-	for _, flag := range r.FlagSet {
-		if !state.IsWriteableFlag(flag) {
-			continue
-		}
-		_, err = vm.st.SetFlag(flag)
-		if err != nil {
-			panic(err)
-		}
-	}
-	for _, flag := range r.FlagReset {
-		if !state.IsWriteableFlag(flag) {
-			continue
-		}
-		_, err = vm.st.ResetFlag(flag)
-		if err != nil {
-			panic(err)
-		}
 }
 
-	return r.Content, err
-}

go/vm/runner_test.go

@@ -7,10 +7,10 @@ import (
 	"log"
 	"testing"
 	
-	"git.grassecon.net/kamikazechaser/vise/cache"
+	"git.defalsify.org/festive/cache"
-	"git.grassecon.net/kamikazechaser/vise/render"
+	"git.defalsify.org/festive/render"
-	"git.grassecon.net/kamikazechaser/vise/resource"
+	"git.defalsify.org/festive/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
+	"git.defalsify.org/festive/state"
 )
 
 var dynVal = "three"
@@ -18,48 +18,18 @@ var dynVal = "three"
 type TestResource struct {
 	resource.MenuResource
 	state *state.State
-	RootCode []byte
 }
 
-func getOne(sym string, input []byte, ctx context.Context) (resource.Result, error) {
+func getOne(sym string, ctx context.Context) (string, error) {
-	return resource.Result{
+	return "one", nil
-		Content: "one",
-	}, nil
 }
 
-func getTwo(sym string, input []byte, ctx context.Context) (resource.Result, error) {
+func getTwo(sym string, ctx context.Context) (string, error) {
-	return resource.Result{
+	return "two", nil
-		Content: "two",
-	}, nil
 }
 
-func getDyn(sym string, input []byte, ctx context.Context) (resource.Result, error) {
+func getDyn(sym string, ctx context.Context) (string, error) {
-	return resource.Result{
+	return dynVal, nil
-		Content: dynVal,
-	}, nil
-}
-
-func getEcho(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	r := fmt.Sprintf("echo: %s", input)
-	return resource.Result{
-		Content: r,
-	}, nil
-}
-
-func setFlag(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	s := fmt.Sprintf("ping")
-	r := resource.Result{
-		Content: s,
-	}
-	if len(input) > 0 {
-		r.FlagSet = append(r.FlagSet, uint32(input[0]))
-	}
-	if len(input) > 1 {
-		r.FlagReset = append(r.FlagReset, uint32(input[1]))
-	}
-	log.Printf("setflag %v", r)
-	return r, nil
-
 }
 
 type TestStatefulResolver struct {
@@ -80,8 +50,6 @@ func (r TestResource) GetTemplate(sym string) (string, error) {
 		return "root", nil
 	case "_catch":
 		return "aiee", nil
-	case "flagCatch":
-		return "flagiee", nil
 	}
 	panic(fmt.Sprintf("unknown symbol %s", sym))
 	return "", fmt.Errorf("unknown symbol %s", sym)
@@ -97,35 +65,21 @@ func (r TestResource) FuncFor(sym string) (resource.EntryFunc, error) {
 		return getDyn, nil
 	case "arg":
 		return r.getInput, nil
-	case "echo":
-		return getEcho, nil
-	case "setFlagOne":
-		return setFlag, nil
 	}
 	return nil, fmt.Errorf("invalid function: '%s'", sym)
 }
 
-func (r TestResource) getInput(sym string, input []byte, ctx context.Context) (resource.Result, error) {
+func(r TestResource) getInput(sym string, ctx context.Context) (string, error) {
 	v, err := r.state.GetInput()
-	return resource.Result{
+	return string(v), err
-		Content: string(v),
-	}, err
 }
 
 func(r TestResource) GetCode(sym string) ([]byte, error) {
 	var b []byte
-	switch sym {
+	if sym == "_catch" {
-	case "_catch":
 		b = NewLine(b, MOUT, []string{"0", "repent"}, nil, nil)
 		b = NewLine(b, HALT, nil, nil, nil)
-	case "flagCatch":
-		b = NewLine(b, MOUT, []string{"0", "repent"}, nil, nil)
-		b = NewLine(b, HALT, nil, nil, nil)
-		b = NewLine(b, MOVE, []string{"_"}, nil, nil)
-	case "root":
-		b = r.RootCode
 	}
-
 	return b, nil
 }
 
@@ -158,17 +112,16 @@ func TestRunLoadRender(t *testing.T) {
 	st.Down("bar")
 
 	var err error
-	ctx := context.TODO()
 	b := NewLine(nil, LOAD, []string{"one"}, []byte{0x0a}, nil)
 	b = NewLine(b, MAP, []string{"one"}, nil, nil)
 	b = NewLine(b, LOAD, []string{"two"}, []byte{0x0a}, nil)
 	b = NewLine(b, MAP, []string{"two"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
-	b, err = vm.Run(b, ctx)
+	b, err = vm.Run(b, context.TODO())
 	if err != nil {
 		t.Fatal(err)
 	}
-	r, err := vm.Render(ctx)
+	r, err := vm.Render()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -180,17 +133,17 @@ func TestRunLoadRender(t *testing.T) {
 	b = NewLine(nil, LOAD, []string{"two"}, []byte{0x0a}, nil)
 	b = NewLine(b, MAP, []string{"two"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
-	b, err = vm.Run(b, ctx)
+	b, err = vm.Run(b, context.TODO())
 	if err != nil {
 		t.Fatal(err)
 	}
 	b = NewLine(nil, MAP, []string{"one"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
-	_, err = vm.Run(b, ctx)
+	_, err = vm.Run(b, context.TODO())
 	if err != nil {
 		t.Fatal(err)
 	}
-	r, err = vm.Render(ctx)
+	r, err = vm.Render()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -206,12 +159,11 @@ func TestRunMultiple(t *testing.T) {
 	ca := cache.NewCache()
 	vm := NewVm(&st, &rs, ca, nil)
 
-	ctx := context.TODO()
 	b := NewLine(nil, MOVE, []string{"test"}, nil, nil)
 	b = NewLine(b, LOAD, []string{"one"}, []byte{0x00}, nil)
 	b = NewLine(b, LOAD, []string{"two"}, []byte{42}, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
-	b, err := vm.Run(b, ctx)
+	b, err := vm.Run(b, context.TODO())
 	if err != nil {
 		t.Error(err)
 	}
@@ -227,16 +179,15 @@ func TestRunReload(t *testing.T) {
 	szr := render.NewSizer(128)
 	vm := NewVm(&st, &rs, ca, szr)
 
-	ctx := context.TODO()
 	b := NewLine(nil, MOVE, []string{"root"}, nil, nil)
 	b = NewLine(b, LOAD, []string{"dyn"}, nil, []uint8{0})
 	b = NewLine(b, MAP, []string{"dyn"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
-	_, err := vm.Run(b, ctx)
+	_, err := vm.Run(b, context.TODO())
 	if err != nil {
 		t.Fatal(err)
 	}
-	r, err := vm.Render(ctx)
+	r, err := vm.Render()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -246,7 +197,7 @@ func TestRunReload(t *testing.T) {
 	dynVal = "baz"
 	b = NewLine(nil, RELOAD, []string{"dyn"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
-	_, err = vm.Run(b, ctx)
+	_, err = vm.Run(b, context.TODO())
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -359,14 +310,12 @@ func TestRunMenu(t *testing.T) {
 
 	var err error
 
-	ctx := context.TODO()
-
 	b := NewLine(nil, MOVE, []string{"foo"}, nil, nil)
 	b = NewLine(b, MOUT, []string{"0", "one"}, nil, nil)
 	b = NewLine(b, MOUT, []string{"1", "two"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
 
-	b, err = vm.Run(b, ctx)
+	b, err = vm.Run(b, context.TODO())
 	if err != nil {
 		t.Error(err)	
 	}
@@ -375,7 +324,7 @@ func TestRunMenu(t *testing.T) {
 		t.Errorf("expected empty remainder, got length %v: %v", l, b)
 	}
 	
-	r, err := vm.Render(ctx)
+	r, err := vm.Render()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -394,14 +343,12 @@ func TestRunMenuBrowse(t *testing.T) {
 
 	var err error
 
-	ctx := context.TODO()
-
 	b := NewLine(nil, MOVE, []string{"foo"}, nil, nil)
 	b = NewLine(b, MOUT, []string{"0", "one"}, nil, nil)
 	b = NewLine(b, MOUT, []string{"1", "two"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
 
-	b, err = vm.Run(b, ctx)
+	b, err = vm.Run(b, context.TODO())
 	if err != nil {
 		t.Error(err)	
 	}
@@ -410,7 +357,7 @@ func TestRunMenuBrowse(t *testing.T) {
 		t.Errorf("expected empty remainder, got length %v: %v", l, b)
 	}
 	
-	r, err := vm.Render(ctx)
+	r, err := vm.Render()
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -429,6 +376,7 @@ func TestRunReturn(t *testing.T) {
 	var err error
 
 	st.Down("root")
+	st.SetInput([]byte("0"))
 	b := NewLine(nil, INCMP, []string{"0", "bar"}, nil, nil)
 	b = NewLine(b, HALT, nil, nil, nil)
 	b = NewLine(b, INCMP, []string{"1", "_"}, nil, nil)
@@ -436,7 +384,6 @@ func TestRunReturn(t *testing.T) {
 
 	ctx := context.TODO()
 
-	st.SetInput([]byte("0"))
 	b, err = vm.Run(b, ctx)
 	if err != nil {
 		t.Fatal(err)
@@ -455,130 +402,3 @@ func TestRunReturn(t *testing.T) {
 		t.Fatalf("expected location 'root', got '%s'", location)
 	}
 }
-
-func TestRunLoadInput(t *testing.T) {
-	st := state.NewState(5)
-	rs := TestResource{}
-	ca := cache.NewCache()
-	vm := NewVm(&st, &rs, ca, nil)
-
-	var err error
-
-	st.Down("root")
-	st.SetInput([]byte("foobar"))
-
-	b := NewLine(nil, LOAD, []string{"echo"}, []byte{0x00}, nil)
-	b = NewLine(b, HALT, nil, nil, nil)
-
-	ctx := context.TODO()
-
-	b, err = vm.Run(b, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	r, err := ca.Get("echo")
-	if err != nil {
-		t.Fatal(err)
-	}
-	if r != "echo: foobar" {
-		t.Fatalf("expected 'echo: foobar', got %s", r)
-	}
-}
-
-func TestInputBranch(t *testing.T) {
-	st := state.NewState(5)
-	rs := TestResource{}
-	ca := cache.NewCache()
-	vm := NewVm(&st, &rs, ca, nil)
-
-	var err error
-
-	st.Down("root")
-
-	b := NewLine(nil, LOAD, []string{"setFlagOne"}, []byte{0x00}, nil)
-	b = NewLine(b, RELOAD, []string{"setFlagOne"}, nil, nil)
-	b = NewLine(b, CATCH, []string{"flagCatch"}, []byte{8}, []uint8{0})
-	b = NewLine(b, CATCH, []string{"one"}, []byte{9}, []uint8{0})
-	rs.RootCode = b
-
-	//b = NewLine(b, RELOAD, []string{"setFlagOne"}, nil, nil)
-	//b = NewLine(b, CATCH, []string{"flagCatch"}, []byte{8}, []uint8{0})
-
-	ctx := context.TODO()
-
-	st.SetInput([]byte{0x08})
-	b, err = vm.Run(b, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	location, _ := st.Where()
-	if location != "flagCatch" {
-		t.Fatalf("expected 'flagCatch', got %s", location)
-	}
-
-	st.SetInput([]byte{0x09, 0x08})
-	b, err = vm.Run(b, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-	location, _ = st.Where()
-	if location != "one" {
-		t.Fatalf("expected 'one', got %s", location)
-	}
-}
-
-func TestInputIgnore(t *testing.T) {
-	st := state.NewState(5)
-	rs := TestResource{}
-	ca := cache.NewCache()
-	vm := NewVm(&st, &rs, ca, nil)
-
-	var err error
-
-	st.Down("root")
-
-	b := NewLine(nil, INCMP, []string{"foo", "one"}, nil, nil)
-	b = NewLine(b, INCMP, []string{"bar", "two"}, nil, nil)
-	b = NewLine(b, HALT, nil, nil, nil)
-
-	ctx := context.TODO()
-
-	st.SetInput([]byte("foo"))
-	b, err = vm.Run(b, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	location, _ := st.Where()
-	if location != "one" {
-		t.Fatalf("expected 'one', got %s", location)
-	}
-}
-
-func TestInputIgnoreWildcard(t *testing.T) {
-	st := state.NewState(5)
-	rs := TestResource{}
-	ca := cache.NewCache()
-	vm := NewVm(&st, &rs, ca, nil)
-
-	var err error
-
-	st.Down("root")
-
-	b := NewLine(nil, INCMP, []string{"foo", "one"}, nil, nil)
-	b = NewLine(b, INCMP, []string{"*", "two"}, nil, nil)
-
-	ctx := context.TODO()
-
-	st.SetInput([]byte("foo"))
-	b, err = vm.Run(b, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	location, _ := st.Where()
-	if location != "one" {
-		t.Fatalf("expected 'one', got %s", location)
-	}
-}

persist/doc.go

@@ -1,2 +0,0 @@
-// Package persist enables persistent storage of the execution state.
-package persist

persist/fs.go

@@ -1,86 +0,0 @@
-package persist
-
-import (
-	"io/ioutil"
-	"log"
-	"path"
-	"path/filepath"
-
-	"github.com/fxamacker/cbor/v2"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-// FsPersister is an implementation of Persister that saves state to the file system.
-type FsPersister struct {
-	State  *state.State
-	Memory *cache.Cache
-	dir    string
-}
-
-// NewFsPersister creates a new FsPersister.
-//
-// The filesystem store will be at the given directory. The directory must exist.
-func NewFsPersister(dir string) *FsPersister {
-	fp, err := filepath.Abs(dir)
-	if err != nil {
-		panic(err)
-	}
-	return &FsPersister{
-		dir: fp,
-	}
-}
-
-// WithContent sets a current State and Cache object.
-//
-// This method is normally called before Serialize / Save.
-func (p *FsPersister) WithContent(st *state.State, ca *cache.Cache) *FsPersister {
-	p.State = st
-	p.Memory = ca
-	return p
-}
-
-// GetState implements the Persister interface.
-func (p *FsPersister) GetState() *state.State {
-	return p.State
-}
-
-// GetState implements the Persister interface.
-func (p *FsPersister) GetMemory() cache.Memory {
-	return p.Memory
-}
-
-// GetState implements the Persister interface.
-func (p *FsPersister) Serialize() ([]byte, error) {
-	return cbor.Marshal(p)
-}
-
-// GetState implements the Persister interface.
-func (p *FsPersister) Deserialize(b []byte) error {
-	err := cbor.Unmarshal(b, p)
-	return err
-}
-
-// GetState implements the Persister interface.
-func (p *FsPersister) Save(key string) error {
-	b, err := p.Serialize()
-	if err != nil {
-		return err
-	}
-	fp := path.Join(p.dir, key)
-	log.Printf("saved key %v state %x", key, p.State.Code)
-	return ioutil.WriteFile(fp, b, 0600)
-}
-
-// GetState implements the Persister interface.
-func (p *FsPersister) Load(key string) error {
-	fp := path.Join(p.dir, key)
-	b, err := ioutil.ReadFile(fp)
-	if err != nil {
-		return err
-	}
-	err = p.Deserialize(b)
-	log.Printf("loaded key %v state %x", key, p.State.Code)
-	return err
-}

persist/fs_test.go

@@ -1,106 +0,0 @@
-package persist
-
-import (
-	"bytes"
-	"io/ioutil"
-	"log"
-	"reflect"
-	"testing"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/state"
-	"git.grassecon.net/kamikazechaser/vise/vm"
-)
-
-func TestSerializeState(t *testing.T) {
-	st := state.NewState(12)
-	st.Down("foo")
-	st.Down("bar")
-	st.Down("baz")
-	st.Next()
-	st.Next()
-
-	b := vm.NewLine(nil, vm.LOAD, []string{"foo"}, []byte{42}, nil)
-	b = vm.NewLine(b, vm.HALT, nil, nil, nil)
-	st.SetCode(b)
-
-	ca := cache.NewCache().WithCacheSize(1024)
-	ca.Add("inky", "pinky", 13)
-	ca.Add("blinky", "clyde", 42)
-
-	pr := NewFsPersister(".").WithContent(&st, ca)
-	v, err := pr.Serialize()
-	if err != nil {
-		t.Error(err)
-	}
-	log.Printf("v %b", v)
-
-	prnew := NewFsPersister(".")
-	err = prnew.Deserialize(v)
-	if err != nil {
-		t.Fatal(err)
-	}
-	if !reflect.DeepEqual(prnew.State.ExecPath, pr.State.ExecPath) {
-		t.Fatalf("expected %s, got %s", prnew.State.ExecPath, pr.State.ExecPath)
-	}
-	if !bytes.Equal(prnew.State.Code, pr.State.Code) {
-		t.Fatalf("expected %x, got %x", prnew.State.Code, pr.State.Code)
-	}
-	if prnew.State.BitSize != pr.State.BitSize {
-		t.Fatalf("expected %v, got %v", prnew.State.BitSize, pr.State.BitSize)
-	}
-	if prnew.State.SizeIdx != pr.State.SizeIdx {
-		t.Fatalf("expected %v, got %v", prnew.State.SizeIdx, pr.State.SizeIdx)
-	}
-	if !reflect.DeepEqual(prnew.Memory, pr.Memory) {
-		t.Fatalf("expected %v, got %v", prnew.Memory, pr.Memory)
-	}
-}
-
-func TestSaveLoad(t *testing.T) {
-	st := state.NewState(12)
-	st.Down("foo")
-	st.Down("bar")
-	st.Down("baz")
-	st.Next()
-	st.Next()
-
-	b := vm.NewLine(nil, vm.LOAD, []string{"foo"}, []byte{42}, nil)
-	b = vm.NewLine(b, vm.HALT, nil, nil, nil)
-	st.SetCode(b)
-
-	ca := cache.NewCache().WithCacheSize(1024)
-	ca.Add("inky", "pinky", 13)
-	ca.Add("blinky", "clyde", 42)
-
-	dir, err := ioutil.TempDir("", "vise_persist")
-	if err != nil {
-		t.Error(err)
-	}
-	pr := NewFsPersister(dir).WithContent(&st, ca)
-	err = pr.Save("xyzzy")
-	if err != nil {
-		t.Error(err)
-	}
-
-	prnew := NewFsPersister(dir)
-	err = prnew.Load("xyzzy")
-	if err != nil {
-		t.Error(err)
-	}
-	if !reflect.DeepEqual(prnew.State.ExecPath, pr.State.ExecPath) {
-		t.Fatalf("expected %s, got %s", prnew.State.ExecPath, pr.State.ExecPath)
-	}
-	if !bytes.Equal(prnew.State.Code, pr.State.Code) {
-		t.Fatalf("expected %x, got %x", prnew.State.Code, pr.State.Code)
-	}
-	if prnew.State.BitSize != pr.State.BitSize {
-		t.Fatalf("expected %v, got %v", prnew.State.BitSize, pr.State.BitSize)
-	}
-	if prnew.State.SizeIdx != pr.State.SizeIdx {
-		t.Fatalf("expected %v, got %v", prnew.State.SizeIdx, pr.State.SizeIdx)
-	}
-	if !reflect.DeepEqual(prnew.Memory, pr.Memory) {
-		t.Fatalf("expected %v, got %v", prnew.Memory, pr.Memory)
-	}
-}

persist/persist.go

@@ -1,16 +0,0 @@
-package persist
-
-import (
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-// Persister interface defines the methods needed for a component that can store the execution state to a storage location.
-type Persister interface {
-	Serialize() ([]byte, error) // Output serializes representation of the state.
-	Deserialize(b []byte) error // Restore state from a serialized state.
-	Save(key string) error      // Serialize and commit the state representation to persisted storage.
-	Load(key string) error      // Load the state representation from persisted storage and Deserialize.
-	GetState() *state.State     // Get the currently loaded State object.
-	GetMemory() cache.Memory    // Get the currently loaded Cache object.
-}

render/doc.go

@@ -1,2 +0,0 @@
-// Package render handles output size constraints and paginated rendering of contents and menus against templates.
-package render

render/size_test.go

@@ -1,251 +0,0 @@
-package render
-
-import (
-	"context"
-	"fmt"
-	"testing"
-
-	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.grassecon.net/kamikazechaser/vise/state"
-)
-
-type TestSizeResource struct {
-	*resource.MenuResource
-}
-
-func getTemplate(sym string) (string, error) {
-	var tpl string
-	switch sym {
-	case "small":
-		tpl = "one {{.foo}} two {{.bar}} three {{.baz}}"
-	case "toobig":
-		tpl = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus in mattis lorem. Aliquam erat volutpat. Ut vitae metus."
-	case "pages":
-		tpl = "one {{.foo}} two {{.bar}} three {{.baz}}\n{{.xyzzy}}"
-	}
-	return tpl, nil
-}
-
-func funcFor(sym string) (resource.EntryFunc, error) {
-	switch sym {
-	case "foo":
-		return getFoo, nil
-	case "bar":
-		return getBar, nil
-	case "baz":
-		return getBaz, nil
-	case "xyzzy":
-		return getXyzzy, nil
-	}
-	return nil, fmt.Errorf("unknown func: %s", sym)
-}
-
-func getFoo(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	return resource.Result{
-		Content: "inky",
-	}, nil
-}
-
-func getBar(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	return resource.Result{
-		Content: "pinky",
-	}, nil
-}
-
-func getBaz(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	return resource.Result{
-		Content: "blinky",
-	}, nil
-}
-
-func getXyzzy(sym string, input []byte, ctx context.Context) (resource.Result, error) {
-	return resource.Result{
-		Content: "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve",
-	}, nil
-}
-
-func TestSizeCheck(t *testing.T) {
-	szr := NewSizer(16)
-	l, ok := szr.Check("foobar")
-	if !ok {
-		t.Fatalf("expected ok")
-	}
-	if l != 10 {
-		t.Fatalf("expected 10, got %v", l)
-	}
-
-	l, ok = szr.Check("inkypinkyblinkyclyde")
-	if ok {
-		t.Fatalf("expected not ok")
-	}
-	if l != 0 {
-		t.Fatalf("expected 0, got %v", l)
-	}
-}
-
-func TestSizeLimit(t *testing.T) {
-	st := state.NewState(0)
-	ca := cache.NewCache()
-	mn := NewMenu().WithOutputSize(32)
-	mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
-	rs := TestSizeResource{
-		mrs,
-	}
-	szr := NewSizer(128)
-	pg := NewPage(ca, rs).WithMenu(mn).WithSizer(szr)
-	ca.Push()
-	st.Down("test")
-	err := ca.Add("foo", "inky", 4)
-	if err != nil {
-		t.Fatal(err)
-	}
-	err = ca.Add("bar", "pinky", 10)
-	if err != nil {
-		t.Fatal(err)
-	}
-	err = ca.Add("baz", "blinky", 0)
-	if err != nil {
-		t.Fatal(err)
-	}
-	err = pg.Map("foo")
-	if err != nil {
-		t.Fatal(err)
-	}
-	err = pg.Map("bar")
-	if err != nil {
-		t.Fatal(err)
-	}
-	err = pg.Map("baz")
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	mn.Put("1", "foo the foo")
-	mn.Put("2", "go to bar")
-
-	_, err = pg.Render("small", 0)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	_, err = pg.Render("toobig", 0)
-	if err == nil {
-		t.Fatalf("expected size exceeded")
-	}
-}
-
-func TestSizePages(t *testing.T) {
-	st := state.NewState(0)
-	ca := cache.NewCache()
-	mn := NewMenu().WithOutputSize(32)
-	mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
-	rs := TestSizeResource{
-		mrs,
-	}
-	szr := NewSizer(128)
-	pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
-	ca.Push()
-	st.Down("test")
-	ca.Add("foo", "inky", 4)
-	ca.Add("bar", "pinky", 10)
-	ca.Add("baz", "blinky", 20)
-	ca.Add("xyzzy", "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve", 0)
-	pg.Map("foo")
-	pg.Map("bar")
-	pg.Map("baz")
-	pg.Map("xyzzy")
-
-	mn.Put("1", "foo the foo")
-	mn.Put("2", "go to bar")
-
-	r, err := pg.Render("pages", 0)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	expect := `one inky two pinky three blinky
-inky pinky
-blinky clyde sue
-tinkywinky dipsy
-lala poo
-1:foo the foo
-2:go to bar`
-
-	if r != expect {
-		t.Fatalf("expected:\n\t%x\ngot:\n\t%x\n", expect, r)
-	}
-	r, err = pg.Render("pages", 1)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	expect = `one inky two pinky three blinky
-one two three four five six seven
-eight nine ten
-eleven twelve
-1:foo the foo
-2:go to bar`
-	if r != expect {
-		t.Fatalf("expected:\n\t%s\ngot:\n\t%s\n", expect, r)
-	}
-
-}
-
-func TestManySizes(t *testing.T) {
-	for i := 60; i < 160; i++ {
-		st := state.NewState(0)
-		ca := cache.NewCache()
-		mn := NewMenu().WithOutputSize(32)
-		mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
-		rs := TestSizeResource{
-			mrs,
-		}
-		szr := NewSizer(uint32(i))
-		pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
-		ca.Push()
-		st.Down("pages")
-		ca.Add("foo", "inky", 10)
-		ca.Add("bar", "pinky", 10)
-		ca.Add("baz", "blinky", 10)
-		ca.Add("xyzzy", "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve", 0)
-		pg.Map("foo")
-		pg.Map("bar")
-		pg.Map("baz")
-		pg.Map("xyzzy")
-		_, err := pg.Render("pages", 0)
-		if err != nil {
-			t.Fatal(err)
-		}
-	}
-}
-
-func TestManySizesMenued(t *testing.T) {
-	for i := 60; i < 160; i++ {
-		st := state.NewState(0)
-		ca := cache.NewCache()
-		mn := NewMenu().WithOutputSize(32)
-		mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
-		rs := TestSizeResource{
-			mrs,
-		}
-		szr := NewSizer(uint32(i))
-		pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
-		ca.Push()
-		st.Down("pages")
-		ca.Add("foo", "inky", 10)
-		ca.Add("bar", "pinky", 10)
-		ca.Add("baz", "blinky", 10)
-		ca.Add("xyzzy", "inky pinky\nblinky clyde sue\ntinkywinky dipsy\nlala poo\none two three four five six seven\neight nine ten\neleven twelve", 0)
-		pg.Map("foo")
-		pg.Map("bar")
-		pg.Map("baz")
-		pg.Map("xyzzy")
-		mn.Put("0", "yay")
-		mn.Put("12", "nay")
-		_, err := pg.Render("pages", 0)
-		if err != nil {
-			t.Fatal(err)
-		}
-	}
-}

resource/doc.go

@@ -1,2 +0,0 @@
-// Package resource interfaces retrieval of bytecode, output templates and external code execution.
-package resource

state/flag.go

@@ -1,24 +0,0 @@
-package state
-
-const (
-	FLAG_READIN = iota
-	FLAG_INMATCH 
-	FLAG_TERMINATE 
-	FLAG_DIRTY
-	FLAG_WAIT
-	FLAG_LOADFAIL
-	FLAG_USERSTART = 8
-)
-
-func IsWriteableFlag(flag uint32) bool {
-	if flag > 7 {
-		return true
-	}
-	//if flag & FLAG_WRITEABLE > 0 {
-	//	return true	
-	//}
-	return false
-}
-
-type FlagDebugger struct {
-}

vm/doc.go

@@ -1,2 +0,0 @@
-// Package vm handles the line-by-line execution of vise bytecode.
-package vm