namespace: change -> git.grassecon.net/kamikazechaser/vise

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

Makefile

@@ -1,6 +1,15 @@
-examples: profile
+examples: profile session helloworld validate
 
-.PHONY: profile
+.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

@@ -2,27 +2,62 @@
 
 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:
+The VM defines the following opcode symbols, alphabetically:
 
-* `CATCH <symbol> <signal>` - Jump to symbol if signal is set (see `signals` below).
+* `CATCH <symbol> <signal>` - Jump to symbol 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).
+* `CROAK <signal>` - Clear state and restart execution from top if signal is set (see `signals` below). If match, has same side-effect as move.
-* `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.
-* `MSIZE <max> <min>` - Set min and max display size of menu part to `num` bytes.
+* `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.
-* `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.
+* `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.
 * `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
@@ -35,6 +70,8 @@ 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
 
@@ -119,7 +156,7 @@ Multipage outputs, like listings, are handled using the _sink_ output constraint
 
 ### Languages support
 
-**Not yet implemeennted**
+**Not yet implemented**
 
 Language for rendering is determined at the top-level state.
 
@@ -166,7 +203,7 @@ 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
+## Runtime engine
 
 The runtime engine:
 
@@ -181,6 +218,13 @@ There are two flavors of the engine:
 * `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)
@@ -216,7 +260,7 @@ Outputs bytecodes and templates for test data scenarios used in `engine` unit te
 
 ### Interactive runner
 
-`go run ./dev/interactive [-d <data_directory>] [--root <root_symbol>]`
+`go run ./dev/interactive [-d <data_directory>] [--root <root_symbol>] [--session-id <session_id>]`
 
 Creates a new interactive session using `engine.DefaultEngine`, starting execution at symbol `root_symbol`
 
@@ -226,6 +270,8 @@ 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
 
@@ -247,11 +293,13 @@ Found in `examples/`.
 
 Be sure to `make examples` before running them.
 
-Can be run with e.g. `go run ./examples/<case> -s 80`
+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 after make).
+* `*.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 after make).
+* `*.txt` - current contents of a single data entry (only available after make).

asm/asm.go

@@ -13,10 +13,9 @@ import (
 	"github.com/alecthomas/participle/v2"
 	"github.com/alecthomas/participle/v2/lexer"
 
-	"git.defalsify.org/vise/vm"
+	"git.grassecon.net/kamikazechaser/vise/vm"
 )
 
-
 // Asm assembles bytecode from the vise assembly mini-language.
 type Asm struct {
 	Instructions []*Instruction `@@*`
@@ -260,7 +259,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", `["']`},
@@ -373,9 +372,7 @@ func Parse(s string, w io.Writer) (int, error) {
 		return 0, err
 	}
 
-	batch := Batcher{
+	batch := Batcher{}
-		
-	}
 
 	var rn int
 	for _, v := range ast.Instructions {

asm/asm_test.go

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

asm/menu.go

@@ -3,7 +3,7 @@ package asm
 import (
 	"fmt"
 
-	"git.defalsify.org/vise/vm"
+	"git.grassecon.net/kamikazechaser/vise/vm"
 )
 
 // BatchCode defines quasi-opcodes that expand to mulitple individual vm instructions.

asm/menu_test.go

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

dev/asm/main.go

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

dev/disasm/main.go

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

dev/gendata/main.go

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

dev/interactive/main.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"os"
 
-	"git.defalsify.org/vise/engine"
+	"git.grassecon.net/kamikazechaser/vise/engine"
 )
 
 func main() {
@@ -22,11 +22,21 @@ func main() {
 	fmt.Fprintf(os.Stderr, "starting session at symbol '%s' using resource dir: %s\n", root, dir)
 
 	ctx := context.Background()
-	en, err := engine.NewSizedEngine(dir, uint32(size))
+	en := engine.NewSizedEngine(dir, uint32(size))
+	cont, err := en.Init(ctx)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "engine create fail: %v\n", err)
+		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)

engine/default.go

@@ -3,13 +3,13 @@ package engine
 import (
 	"context"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"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, error) {
+func NewDefaultEngine(dir string) Engine {
 	st := state.NewState(0)
 	rs := resource.NewFsResource(dir)
 	ca := cache.NewCache()
@@ -21,7 +21,7 @@ func NewDefaultEngine(dir string) (Engine, error) {
 }
 
 // NewSizedEngine is a convenience function to instantiate a filesystem-backed engine with a specified output constraint.
-func NewSizedEngine(dir string, size uint32) (Engine, error) {
+func NewSizedEngine(dir string, size uint32) Engine {
 	st := state.NewState(0)
 	rs := resource.NewFsResource(dir)
 	ca := cache.NewCache()

engine/engine.go

@@ -6,11 +6,11 @@ import (
 	"io"
 	"log"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/render"
+	"git.grassecon.net/kamikazechaser/vise/render"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
-	"git.defalsify.org/vise/vm"
+	"git.grassecon.net/kamikazechaser/vise/vm"
 )
 
 // Config globally defines behavior of all components driven by the engine.
@@ -33,7 +33,7 @@ type Engine struct {
 }
 
 // NewEngine creates a new Engine
-func NewEngine(cfg Config, st *state.State, rs resource.Resource, ca cache.Memory, ctx context.Context) (Engine, error) {
+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)
@@ -46,42 +46,41 @@ func NewEngine(cfg Config, st *state.State, rs resource.Resource, ca cache.Memor
 		vm: vm.NewVm(st, rs, ca, szr),
 	}
 	engine.root = cfg.Root
-	return engine, 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 {
+func (en *Engine) Init(ctx context.Context) (bool, error) {
 	if en.initd {
 		log.Printf("already initialized")
-		return nil
+		return true, nil
 	}
+	sym := en.root
 	if sym == "" {
-		return fmt.Errorf("start sym empty")
+		return false, fmt.Errorf("start sym empty")
 	}
 	inSave, _ := en.st.GetInput()
 	err := en.st.SetInput([]byte{})
 	if err != nil {
-		return err
+		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 err
+		return false, err
-	}
-	if len(b) == 0 {
-		return fmt.Errorf("no code left after init, that's just useless and sad")
 	}
+
 	log.Printf("ended init VM run with code %x", b)
 	en.st.SetCode(b)
 	err = en.st.SetInput(inSave)
 	if err != nil {
-		return err
+		return false, err
 	}
-	en.initd = true
+	return len(b) > 0, nil
-	return nil
 }
 
 // Exec processes user input against the current state of the virtual machine environment.
@@ -97,13 +96,11 @@ func(en *Engine) Init(sym string, ctx context.Context) error {
 func (en *Engine) Exec(input []byte, ctx context.Context) (bool, error) {
 	var err error
 	if en.st.Moves == 0 {
-		err = en.Init(en.root, ctx)
+		cont, err := en.Init(ctx)
 		if err != nil {
 			return false, err
 		}
-		if len(input) == 0 {
+		return cont, nil
-			return true, nil
-		}
 	}
 	err = vm.ValidInput(input)
 	if err != nil {
@@ -144,7 +141,7 @@ func (en *Engine) Exec(input []byte, ctx context.Context) (bool, error) {
 	en.st.SetCode(code)
 	if len(code) == 0 {
 		log.Printf("runner finished with no remaining code")
-		err = en.reset(ctx)
+		_, err = en.reset(ctx)
 		return false, err
 	}
 
@@ -165,21 +162,22 @@ func(en *Engine) WriteResult(w io.Writer, ctx context.Context) (int, error) {
 	return io.WriteString(w, r)
 }
 
-func(en *Engine) reset(ctx context.Context) error {
+// 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 err
+			return false, err
 		}
 		_, err = en.st.Up()
 		if err != nil {
-			return err
+			return false, err
 		}
 		en.ca.Pop()
 	}
 	en.st.Restart()
 	en.initd = false
-	return en.Init(en.root, ctx)
+	return en.Init(ctx)
 }

engine/engine_test.go

@@ -8,10 +8,10 @@ import (
 	"path"
 	"testing"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
-	"git.defalsify.org/vise/testdata"
+	"git.grassecon.net/kamikazechaser/vise/testdata"
 )
 
 var (
@@ -81,14 +81,11 @@ func TestEngineInit(t *testing.T) {
 	rs := NewFsWrapper(dataDir, &st)
 	ca := cache.NewCache().WithCacheSize(1024)
 
-	en, err := NewEngine(Config{
+	en := NewEngine(Config{
 		Root: "root",
 	}, &st, &rs, ca, ctx)
-	if err != nil {
-		t.Fatal(err)
-	}
 
-	err = en.Init("root", ctx)
+	_, err = en.Init(ctx)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -140,14 +137,11 @@ func TestEngineExecInvalidInput(t *testing.T) {
 	rs := NewFsWrapper(dataDir, &st)
 	ca := cache.NewCache().WithCacheSize(1024)
 
-	
+	en := NewEngine(Config{
-	en, err := NewEngine(Config{
 		Root: "root",
 	}, &st, &rs, ca, ctx)
-	if err != nil {
+	var err error
-		t.Fatal(err)
+	_, err = en.Init(ctx)
-	}
-	err = en.Init("root", ctx)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -164,13 +158,11 @@ func TestEngineResumeTerminated(t *testing.T) {
 	rs := NewFsWrapper(dataDir, &st)
 	ca := cache.NewCache().WithCacheSize(1024)
 
-	en, err := NewEngine(Config{
+	en := NewEngine(Config{
 		Root: "root",
 	}, &st, &rs, ca, ctx)
-	if err != nil {
+	var err error
-		t.Fatal(err)
+	_, err = en.Init(ctx)
-	}
-	err = en.Init("root", ctx)
 	if err != nil {
 		t.Fatal(err)
 	}

engine/loop_test.go

@@ -8,9 +8,9 @@ import (
 	"strings"
 	"testing"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 func TestLoopTop(t *testing.T) {
@@ -23,11 +23,9 @@ func TestLoopTop(t *testing.T) {
 	cfg := Config{
 		Root: "root",
 	}
-	en, err := NewEngine(cfg, &st, &rs, ca, ctx)
+	en := NewEngine(cfg, &st, &rs, ca, ctx)
-	if err != nil {
+	var err error
-		t.Fatal(err)
+	_, err = en.Init(ctx)
-	}
-	err = en.Init("root", ctx)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -62,11 +60,9 @@ func TestLoopBackForth(t *testing.T) {
 	cfg := Config{
 		Root: "root",
 	}
-	en, err := NewEngine(cfg, &st, &rs, ca, ctx)
+	en := NewEngine(cfg, &st, &rs, ca, ctx)
-	if err != nil {
+	var err error
-		t.Fatal(err)
+	_, err = en.Init(ctx)
-	}
-	err = en.Init("root", ctx)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -99,11 +95,9 @@ func TestLoopBrowse(t *testing.T) {
 		OutputSize: 68,
 		Root:       "root",
 	}
-	en, err := NewEngine(cfg, &st, &rs, ca, ctx)
+	en := NewEngine(cfg, &st, &rs, ca, ctx)
-	if err != nil {
+	var err error
-		t.Fatal(err)
+	_, err = en.Init(ctx)
-	}
-	err = en.Init("root", ctx)
 	if err != nil {
 		t.Fatal(err)
 	}

engine/persist.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"io"
 
-	"git.defalsify.org/vise/persist"
+	"git.grassecon.net/kamikazechaser/vise/persist"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
 )
 
 // RunPersisted performs a single vm execution from client input using a persisted state.
@@ -24,10 +24,7 @@ func RunPersisted(cfg Config, rs resource.Resource, pr persist.Persister, input
 		return err
 	}
 
-	en, err := NewEngine(cfg, pr.GetState(), rs, pr.GetMemory(), ctx)
+	en := NewEngine(cfg, pr.GetState(), rs, pr.GetMemory(), ctx)
-	if err != nil {
-		return err
-	}
 
 	c, err := en.WriteResult(w, ctx)
 	if err != nil {

engine/persist_test.go

@@ -6,9 +6,9 @@ import (
 	"os"
 	"testing"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/persist"
+	"git.grassecon.net/kamikazechaser/vise/persist"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 func TestPersist(t *testing.T) {

examples/helloworld/que.txt.orig

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

examples/helloworld/root

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

examples/helloworld/root.vis

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

examples/profile/main.go

@@ -11,14 +11,14 @@ import (
 
 	testdataloader "github.com/peteole/testdata-loader"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/engine"
+	"git.grassecon.net/kamikazechaser/vise/engine"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 const (
-	USERFLAG_IDENTIFIED = iota + 8
+	USERFLAG_IDENTIFIED = iota + state.FLAG_USERSTART
 	USERFLAG_HAVENAME
 	USERFLAG_HAVEEMAIL
 )
@@ -44,6 +44,7 @@ func newProfileResource(st *state.State, rs *resource.FsResource) *profileResour
 }
 
 func (pr *profileResource) checkEntry() error {
+	log.Printf("%v %v", USERFLAG_IDENTIFIED, USERFLAG_HAVENAME)
 	if pr.haveEntered {
 		return nil
 	}
@@ -122,9 +123,11 @@ func main() {
 		OutputSize: uint32(size),
 	}
 	ctx := context.Background()
-	en, err := engine.NewEngine(cfg, &st, rs, ca, ctx)
+	en := engine.NewEngine(cfg, &st, rs, ca, ctx)
+	var err error
+	_, err = en.Init(ctx)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "engine create fail: %v\n", err)
+		fmt.Fprintf(os.Stderr, "engine init fail: %v\n", err)
 		os.Exit(1)
 	}
 

examples/session/input

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

examples/session/input.vis

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

examples/session/main.go

@@ -0,0 +1,86 @@
+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

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

examples/validate/end

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

examples/validate/end.vis

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

examples/validate/main.go

@@ -0,0 +1,84 @@
+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

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

examples/validate/root.vis

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

go.mod

@@ -1,4 +1,4 @@
-module git.defalsify.org/vise
+module git.grassecon.net/kamikazechaser/vise
 
 go 1.20
 

persist/fs.go

@@ -5,10 +5,11 @@ import (
 	"log"
 	"path"
 	"path/filepath"
+
 	"github.com/fxamacker/cbor/v2"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 // FsPersister is an implementation of Persister that saves state to the file system.

persist/fs_test.go

@@ -7,9 +7,9 @@ import (
 	"reflect"
 	"testing"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
-	"git.defalsify.org/vise/vm"
+	"git.grassecon.net/kamikazechaser/vise/vm"
 )
 
 func TestSerializeState(t *testing.T) {

persist/persist.go

@@ -1,8 +1,8 @@
 package persist
 
 import (
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/state"
+	"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.
@@ -14,4 +14,3 @@ type Persister interface {
 	GetState() *state.State     // Get the currently loaded State object.
 	GetMemory() cache.Memory    // Get the currently loaded Cache object.
 }
-

render/page.go

@@ -7,8 +7,8 @@ import (
 	"strings"
 	"text/template"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
 )
 
 // Page exectues output rendering into pages constrained by size.
@@ -151,7 +151,6 @@ func(pg *Page) RenderTemplate(sym string, values map[string]string, idx uint16)
 		return "", err
 	}
 
-
 	b := bytes.NewBuffer([]byte{})
 	err = tp.Execute(b, values)
 	if err != nil {
@@ -332,4 +331,3 @@ func(pg *Page) render(sym string, values map[string]string, idx uint16) (string,
 	}
 	return r, nil
 }
-

render/page_test.go

@@ -3,10 +3,9 @@ package render
 import (
 	"testing"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/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()

render/size_test.go

@@ -5,9 +5,9 @@ import (
 	"fmt"
 	"testing"
 
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 type TestSizeResource struct {
@@ -172,7 +172,6 @@ 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)
 	}

resource/state.go

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

resource/state_test.go

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

state/flag.go

@@ -1,11 +1,13 @@
 package state
 
 const (
-	FLAG_READIN = 1
+	FLAG_READIN = iota
-	FLAG_INMATCH = 2
+	FLAG_INMATCH 
-	FLAG_TERMINATE = 3
+	FLAG_TERMINATE 
-	FLAG_DIRTY = 4
+	FLAG_DIRTY
-	FLAG_LOADFAIL = 5
+	FLAG_WAIT
+	FLAG_LOADFAIL
+	FLAG_USERSTART = 8
 )
 
 func IsWriteableFlag(flag uint32) bool {
@@ -17,3 +19,6 @@ func IsWriteableFlag(flag uint32) bool {
 	//}
 	return false
 }
+
+type FlagDebugger struct {
+}

state/state.go

@@ -208,6 +208,10 @@ func(st *State) Next() (uint16, error) {
 	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.
@@ -338,7 +342,7 @@ func(st *State) Restart() error {
 
 // String implements String interface
 func(st State) String() string {
-	return fmt.Sprintf("moves %v idx %v path: %s", st.Moves, st.SizeIdx, strings.Join(st.ExecPath, "/"))
+	return fmt.Sprintf("moves %v idx %v flags: 0x%x path: %s", st.Moves, st.SizeIdx, st.Flags, strings.Join(st.ExecPath, "/"))
 }
 
 // initializes all flags not in control of client.

testdata/testdata.go

@@ -8,7 +8,7 @@ import (
 
 	testdataloader "github.com/peteole/testdata-loader"
 
-	"git.defalsify.org/vise/vm"
+	"git.grassecon.net/kamikazechaser/vise/vm"
 )
 
 type genFunc func() error
@@ -177,7 +177,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.

vm/input.go

@@ -5,18 +5,17 @@ import (
 	"fmt"
 	"regexp"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/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.
@@ -137,6 +136,10 @@ 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)

vm/runner.go

@@ -5,10 +5,10 @@ import (
 	"fmt"
 	"log"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/render"
+	"git.grassecon.net/kamikazechaser/vise/render"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 // Vm holds sub-components mutated by the vm execution.
@@ -31,6 +31,7 @@ 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
 }
 
@@ -65,6 +66,19 @@ func(vm *Vm) Run(b []byte, ctx context.Context) ([]byte, error) {
 		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)
@@ -153,7 +167,6 @@ 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 == "" {
@@ -178,23 +191,29 @@ func(vm *Vm) RunCatch(b []byte, ctx context.Context) ([]byte, error) {
 	}
 	r, err := vm.st.MatchFlag(sig, mode)
 	if err != nil {
-		_, err = vm.st.SetFlag(state.FLAG_TERMINATE)
+		var perr error
-		if err != nil {
+		_, perr = vm.st.SetFlag(state.FLAG_TERMINATE)
-			panic(err)
+		if perr != nil {
+			panic(perr)
 		}
 		log.Printf("terminate set")
 		return b, err
 	}
 	if r {
-		log.Printf("catch at flag %v, moving to %v", sig, sym) //bitField, d)
+		//b = append(bh, b...)
+		//vm.st.Down(sym)
+		//vm.ca.Push()
+		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 = append(bh, b...)
 		b = bh
-		vm.st.Down(sym)
-		vm.ca.Push()
 	}
 	return b, nil
 }
@@ -295,12 +314,7 @@ func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 		panic(err)
 	}
 	if have {
-		if !reading {
+		if reading {
-			_, err = vm.st.ResetFlag(state.FLAG_INMATCH)
-			if err != nil {
-				panic(err)
-			}
-		} else {
 			log.Printf("ignoring input %s, already have match", sym)
 			return b, nil
 		}
@@ -320,11 +334,11 @@ func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 		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)
@@ -334,13 +348,10 @@ func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 		panic(err)
 	}
 
-	target, _, err = applyTarget([]byte(target), vm.st, vm.ca, ctx)
+	newTarget, _, err := applyTarget([]byte(target), vm.st, vm.ca, ctx)
+
 	_, ok := err.(*state.IndexError)
 	if ok {
-		_, err = vm.st.ResetFlag(state.FLAG_INMATCH)
-		if err != nil {
-			panic(err)
-		}
 		_, err = vm.st.SetFlag(state.FLAG_READIN)
 		if err != nil {
 			panic(err)
@@ -349,12 +360,16 @@ func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
 	} 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
@@ -368,7 +383,12 @@ 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
@@ -454,6 +474,7 @@ func(vm *Vm) refresh(key string, rs resource.Resource, ctx context.Context) (str
 	input, _ := vm.st.GetInput()
 	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 {

vm/runner_test.go

@@ -7,10 +7,10 @@ import (
 	"log"
 	"testing"
 
-	"git.defalsify.org/vise/cache"
+	"git.grassecon.net/kamikazechaser/vise/cache"
-	"git.defalsify.org/vise/render"
+	"git.grassecon.net/kamikazechaser/vise/render"
-	"git.defalsify.org/vise/resource"
+	"git.grassecon.net/kamikazechaser/vise/resource"
-	"git.defalsify.org/vise/state"
+	"git.grassecon.net/kamikazechaser/vise/state"
 )
 
 var dynVal = "three"
@@ -456,7 +456,6 @@ func TestRunReturn(t *testing.T) {
 	}
 }
 
-
 func TestRunLoadInput(t *testing.T) {
 	st := state.NewState(5)
 	rs := TestResource{}
@@ -541,6 +540,7 @@ func TestInputIgnore(t *testing.T) {
 
 	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()