Compare commits
10 Commits
bf1d634474
...
d8ef336919
Author | SHA1 | Date | |
---|---|---|---|
d8ef336919 | |||
|
194522fd95 | ||
|
afb3ff3a36 | ||
|
100f7f3b48 | ||
|
1e80d37b73 | ||
|
2aa5214b2b | ||
|
4a0f141ad8 | ||
|
9b8f882155 | ||
|
f8b9ee32eb | ||
|
f06bca7abf |
661
LICENSE
Normal file
661
LICENSE
Normal file
@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
13
Makefile
13
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
|
||||
|
78
README.md
78
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).
|
||||
* `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.
|
||||
* `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). If match, has same side-effect as move.
|
||||
* `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.
|
||||
* `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.
|
||||
* `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.
|
||||
* `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).
|
||||
|
37
asm/asm.go
37
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 `@@*`
|
||||
@ -24,11 +23,11 @@ type Asm struct {
|
||||
|
||||
// Arg holds all parsed argument elements of a single line of assembly code.
|
||||
type Arg struct {
|
||||
Sym *string `(@Sym Whitespace?)?`
|
||||
Size *uint32 `(@Size Whitespace?)?`
|
||||
Flag *uint8 `(@Size Whitespace?)?`
|
||||
Sym *string `(@Sym Whitespace?)?`
|
||||
Size *uint32 `(@Size Whitespace?)?`
|
||||
Flag *uint8 `(@Size Whitespace?)?`
|
||||
Selector *string `(@Sym Whitespace?)?`
|
||||
Desc *string `(Quote ((@Sym | @Size) @Whitespace?)+ Quote Whitespace?)?`
|
||||
Desc *string `(Quote ((@Sym | @Size) @Whitespace?)+ Quote Whitespace?)?`
|
||||
}
|
||||
|
||||
func flush(b *bytes.Buffer, w io.Writer) (int, error) {
|
||||
@ -163,12 +162,12 @@ func parseOne(op vm.Opcode, instruction *Instruction, w io.Writer) (int, error)
|
||||
a := instruction.OpArg
|
||||
var n_buf int
|
||||
var n_out int
|
||||
|
||||
|
||||
b := bytes.NewBuffer(nil)
|
||||
|
||||
n, err := writeOpcode(b, op)
|
||||
n_buf += n
|
||||
if err != nil {
|
||||
if err != nil {
|
||||
return n_out, err
|
||||
}
|
||||
|
||||
@ -245,8 +244,8 @@ func (a Arg) String() string {
|
||||
|
||||
// Instruction represents one full line of assembly code.
|
||||
type Instruction struct {
|
||||
OpCode string `@Ident`
|
||||
OpArg Arg `(Whitespace @@)?`
|
||||
OpCode string `@Ident`
|
||||
OpArg Arg `(Whitespace @@)?`
|
||||
Comment string `Comment? EOL`
|
||||
}
|
||||
|
||||
@ -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", `["']`},
|
||||
@ -273,7 +272,7 @@ var (
|
||||
|
||||
func numSize(n uint32) int {
|
||||
v := math.Log2(float64(n))
|
||||
return int((v / 8) + 1)
|
||||
return int((v / 8) + 1)
|
||||
}
|
||||
|
||||
func writeOpcode(w *bytes.Buffer, op vm.Opcode) (int, error) {
|
||||
@ -312,14 +311,14 @@ func writeSize(w *bytes.Buffer, n uint32) (int, error) {
|
||||
}
|
||||
w.Write([]byte{byte(sz)})
|
||||
binary.BigEndian.PutUint32(bn[:], n)
|
||||
c := 4-sz
|
||||
c := 4 - sz
|
||||
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
|
||||
inMenu bool
|
||||
}
|
||||
|
||||
// NewBatcher creates a new Batcher objcet.
|
||||
@ -330,7 +329,7 @@ func NewBatcher(mp MenuProcessor) Batcher {
|
||||
}
|
||||
|
||||
// MenuExit generates the instructions for the batch and writes them to the given io.Writer.
|
||||
func(bt *Batcher) MenuExit(w io.Writer) (int, error) {
|
||||
func (bt *Batcher) MenuExit(w io.Writer) (int, error) {
|
||||
if !bt.inMenu {
|
||||
return 0, nil
|
||||
}
|
||||
@ -340,7 +339,7 @@ func(bt *Batcher) MenuExit(w io.Writer) (int, error) {
|
||||
}
|
||||
|
||||
// MenuAdd adds a new menu instruction to the batcher.
|
||||
func(bt *Batcher) MenuAdd(w io.Writer, code string, arg Arg) (int, error) {
|
||||
func (bt *Batcher) MenuAdd(w io.Writer, code string, arg Arg) (int, error) {
|
||||
bt.inMenu = true
|
||||
var selector string
|
||||
var sym string
|
||||
@ -361,7 +360,7 @@ func(bt *Batcher) MenuAdd(w io.Writer, code string, arg Arg) (int, error) {
|
||||
}
|
||||
|
||||
// Exit is a synonym for MenuExit
|
||||
func(bt *Batcher) Exit(w io.Writer) (int, error) {
|
||||
func (bt *Batcher) Exit(w io.Writer) (int, error) {
|
||||
return bt.MenuExit(w)
|
||||
}
|
||||
|
||||
@ -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 {
|
||||
|
@ -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)
|
||||
@ -236,7 +235,7 @@ func TestParserWriteMultiple(t *testing.T) {
|
||||
if n != n_expect {
|
||||
t.Fatalf("expected total %v bytes output, got %v", n_expect, n)
|
||||
}
|
||||
|
||||
|
||||
rb := r.Bytes()
|
||||
if !bytes.Equal(rb, r_expect) {
|
||||
t.Fatalf("expected result:\n\t%v, got:\n\t%x", r_expect_hex, rb)
|
||||
|
34
asm/menu.go
34
asm/menu.go
@ -3,42 +3,42 @@ 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.
|
||||
type BatchCode uint16
|
||||
|
||||
const (
|
||||
_MENU_OFFSET = 256
|
||||
MENU_DOWN = _MENU_OFFSET
|
||||
MENU_UP = _MENU_OFFSET + 1
|
||||
MENU_NEXT = _MENU_OFFSET + 2
|
||||
_MENU_OFFSET = 256
|
||||
MENU_DOWN = _MENU_OFFSET
|
||||
MENU_UP = _MENU_OFFSET + 1
|
||||
MENU_NEXT = _MENU_OFFSET + 2
|
||||
MENU_PREVIOUS = _MENU_OFFSET + 3
|
||||
)
|
||||
|
||||
var (
|
||||
batchCode = map[string]BatchCode{
|
||||
"DOWN": MENU_DOWN,
|
||||
"UP": MENU_UP,
|
||||
"NEXT": MENU_NEXT,
|
||||
"DOWN": MENU_DOWN,
|
||||
"UP": MENU_UP,
|
||||
"NEXT": MENU_NEXT,
|
||||
"PREVIOUS": MENU_PREVIOUS,
|
||||
}
|
||||
)
|
||||
|
||||
type menuItem struct {
|
||||
code BatchCode
|
||||
choice string
|
||||
code BatchCode
|
||||
choice string
|
||||
display string
|
||||
target string
|
||||
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
|
||||
size uint32
|
||||
}
|
||||
|
||||
// NewMenuProcessor creates a new MenuProcessor object.
|
||||
@ -49,7 +49,7 @@ func NewMenuProcessor() 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 {
|
||||
func (mp *MenuProcessor) Add(bop string, choice string, display string, target string) error {
|
||||
bopCode := batchCode[bop]
|
||||
if bopCode == 0 {
|
||||
return fmt.Errorf("unknown menu instruction: %v", bop)
|
||||
@ -58,10 +58,10 @@ func(mp *MenuProcessor) Add(bop string, choice string, display string, target st
|
||||
return fmt.Errorf("target is only valid for DOWN")
|
||||
}
|
||||
m := menuItem{
|
||||
code: bopCode,
|
||||
choice: choice,
|
||||
code: bopCode,
|
||||
choice: choice,
|
||||
display: display,
|
||||
target: target,
|
||||
target: target,
|
||||
}
|
||||
mp.items = append(mp.items, m)
|
||||
return nil
|
||||
|
@ -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")
|
||||
|
@ -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]
|
||||
|
@ -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]
|
||||
|
@ -4,7 +4,7 @@ import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"git.defalsify.org/vise/testdata"
|
||||
"git.grassecon.net/kamikazechaser/vise/testdata"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
@ -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)
|
||||
|
@ -3,13 +3,13 @@ package engine
|
||||
import (
|
||||
"context"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
"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, error) {
|
||||
func NewDefaultEngine(dir string) Engine {
|
||||
st := state.NewState(0)
|
||||
rs := resource.NewFsResource(dir)
|
||||
ca := cache.NewCache()
|
||||
@ -21,13 +21,13 @@ 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()
|
||||
cfg := Config{
|
||||
OutputSize: size,
|
||||
Root: "root",
|
||||
Root: "root",
|
||||
}
|
||||
ctx := context.TODO()
|
||||
return NewEngine(cfg, &st, &rs, ca, ctx)
|
||||
|
@ -6,34 +6,34 @@ import (
|
||||
"io"
|
||||
"log"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/render"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.defalsify.org/vise/vm"
|
||||
"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
|
||||
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
|
||||
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, 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)
|
||||
@ -45,49 +45,48 @@ func NewEngine(cfg Config, st *state.State, rs resource.Resource, ca cache.Memor
|
||||
ca: ca,
|
||||
vm: vm.NewVm(st, rs, ca, szr),
|
||||
}
|
||||
engine.root = cfg.Root
|
||||
return engine, nil
|
||||
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(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
|
||||
}
|
||||
if len(b) == 0 {
|
||||
return fmt.Errorf("no code left after init, that's just useless and sad")
|
||||
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 err
|
||||
return false, err
|
||||
}
|
||||
en.initd = true
|
||||
return nil
|
||||
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:
|
||||
@ -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 true, nil
|
||||
}
|
||||
return cont, 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
|
||||
}
|
||||
|
||||
@ -157,7 +154,7 @@ func (en *Engine) Exec(input []byte, ctx context.Context) (bool, error) {
|
||||
// - 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) {
|
||||
func (en *Engine) WriteResult(w io.Writer, ctx context.Context) (int, error) {
|
||||
r, err := en.vm.Render(ctx)
|
||||
if err != nil {
|
||||
return 0, 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)
|
||||
}
|
||||
|
@ -8,15 +8,15 @@ import (
|
||||
"path"
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.defalsify.org/vise/testdata"
|
||||
"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
|
||||
dataGenerated bool = false
|
||||
dataDir string = testdata.DataDir
|
||||
)
|
||||
|
||||
type FsWrapper struct {
|
||||
@ -26,8 +26,8 @@ type FsWrapper struct {
|
||||
|
||||
func NewFsWrapper(path string, st *state.State) FsWrapper {
|
||||
rs := resource.NewFsResource(path)
|
||||
wr := FsWrapper {
|
||||
&rs,
|
||||
wr := FsWrapper{
|
||||
&rs,
|
||||
st,
|
||||
}
|
||||
wr.AddLocalFunc("one", wr.one)
|
||||
@ -36,26 +36,26 @@ func NewFsWrapper(path string, st *state.State) FsWrapper {
|
||||
return wr
|
||||
}
|
||||
|
||||
func(fs FsWrapper) one(sym string, input []byte, ctx context.Context) (resource.Result, error) {
|
||||
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) {
|
||||
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) {
|
||||
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) {
|
||||
func (fs FsWrapper) GetCode(sym string) ([]byte, error) {
|
||||
sym += ".bin"
|
||||
fp := path.Join(fs.Path, sym)
|
||||
r, err := ioutil.ReadFile(fp)
|
||||
@ -80,15 +80,12 @@ func TestEngineInit(t *testing.T) {
|
||||
st := state.NewState(17)
|
||||
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, err := NewEngine(Config{
|
||||
en := NewEngine(Config{
|
||||
Root: "root",
|
||||
}, &st, &rs, ca, ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = en.Init("root", ctx)
|
||||
var err error
|
||||
_, err = en.Init(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 {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = en.Init("root", ctx)
|
||||
var err error
|
||||
_, err = en.Init(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
@ -8,9 +8,9 @@ import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/resource"
|
||||
"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)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = en.Init("root", ctx)
|
||||
en := NewEngine(cfg, &st, &rs, ca, ctx)
|
||||
var err error
|
||||
_, err = en.Init(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@ -36,7 +34,7 @@ func TestLoopTop(t *testing.T) {
|
||||
"2",
|
||||
"j",
|
||||
"1",
|
||||
}
|
||||
}
|
||||
inputStr := strings.Join(input, "\n")
|
||||
inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
|
||||
outputBuf := bytes.NewBuffer(nil)
|
||||
@ -58,15 +56,13 @@ func TestLoopBackForth(t *testing.T) {
|
||||
st := state.NewState(0)
|
||||
rs := resource.NewFsResource(dataDir)
|
||||
ca := cache.NewCache().WithCacheSize(1024)
|
||||
|
||||
|
||||
cfg := Config{
|
||||
Root: "root",
|
||||
}
|
||||
en, err := NewEngine(cfg, &st, &rs, ca, ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = en.Init("root", ctx)
|
||||
en := NewEngine(cfg, &st, &rs, ca, ctx)
|
||||
var err error
|
||||
_, err = en.Init(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@ -76,7 +72,7 @@ func TestLoopBackForth(t *testing.T) {
|
||||
"0",
|
||||
"1",
|
||||
"0",
|
||||
}
|
||||
}
|
||||
inputStr := strings.Join(input, "\n")
|
||||
inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
|
||||
outputBuf := bytes.NewBuffer(nil)
|
||||
@ -97,13 +93,11 @@ func TestLoopBrowse(t *testing.T) {
|
||||
|
||||
cfg := Config{
|
||||
OutputSize: 68,
|
||||
Root: "root",
|
||||
Root: "root",
|
||||
}
|
||||
en, err := NewEngine(cfg, &st, &rs, ca, ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = en.Init("root", ctx)
|
||||
en := NewEngine(cfg, &st, &rs, ca, ctx)
|
||||
var err error
|
||||
_, err = en.Init(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@ -114,7 +108,7 @@ func TestLoopBrowse(t *testing.T) {
|
||||
"00",
|
||||
"11",
|
||||
"00",
|
||||
}
|
||||
}
|
||||
inputStr := strings.Join(input, "\n")
|
||||
inputBuf := bytes.NewBuffer(append([]byte(inputStr), 0x0a))
|
||||
outputBuf := bytes.NewBuffer(nil)
|
||||
|
@ -4,8 +4,8 @@ import (
|
||||
"context"
|
||||
"io"
|
||||
|
||||
"git.defalsify.org/vise/persist"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"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.
|
||||
@ -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)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
en := NewEngine(cfg, pr.GetState(), rs, pr.GetMemory(), ctx)
|
||||
|
||||
c, err := en.WriteResult(w, ctx)
|
||||
if err != nil {
|
||||
|
@ -6,17 +6,17 @@ import (
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/persist"
|
||||
"git.defalsify.org/vise/state"
|
||||
"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",
|
||||
SessionId: "xyzzy",
|
||||
Root: "root",
|
||||
}
|
||||
rs := NewFsWrapper(dataDir, nil)
|
||||
|
||||
@ -40,14 +40,14 @@ func TestPersist(t *testing.T) {
|
||||
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 {
|
||||
|
1
examples/helloworld/que.txt.orig
Normal file
1
examples/helloworld/que.txt.orig
Normal file
@ -0,0 +1 @@
|
||||
world
|
1
examples/helloworld/root
Normal file
1
examples/helloworld/root
Normal file
@ -0,0 +1 @@
|
||||
hello, {{.que}}!
|
2
examples/helloworld/root.vis
Normal file
2
examples/helloworld/root.vis
Normal file
@ -0,0 +1,2 @@
|
||||
LOAD que 5
|
||||
MAP que
|
@ -11,27 +11,27 @@ import (
|
||||
|
||||
testdataloader "github.com/peteole/testdata-loader"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/engine"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
"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 + 8
|
||||
USERFLAG_HAVENAME
|
||||
USERFLAG_IDENTIFIED = iota + state.FLAG_USERSTART
|
||||
USERFLAG_HAVENAME
|
||||
USERFLAG_HAVEEMAIL
|
||||
)
|
||||
|
||||
var (
|
||||
baseDir = testdataloader.GetBasePath()
|
||||
scriptDir = path.Join(baseDir, "examples", "profile")
|
||||
baseDir = testdataloader.GetBasePath()
|
||||
scriptDir = path.Join(baseDir, "examples", "profile")
|
||||
emptyResult = resource.Result{}
|
||||
)
|
||||
|
||||
type profileResource struct {
|
||||
*resource.FsResource
|
||||
st *state.State
|
||||
st *state.State
|
||||
haveEntered bool
|
||||
}
|
||||
|
||||
@ -43,7 +43,8 @@ func newProfileResource(st *state.State, rs *resource.FsResource) *profileResour
|
||||
}
|
||||
}
|
||||
|
||||
func(pr *profileResource) checkEntry() error {
|
||||
func (pr *profileResource) checkEntry() error {
|
||||
log.Printf("%v %v", USERFLAG_IDENTIFIED, USERFLAG_HAVENAME)
|
||||
if pr.haveEntered {
|
||||
return nil
|
||||
}
|
||||
@ -65,7 +66,7 @@ func(pr *profileResource) checkEntry() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func(pr profileResource) nameSave(sym string, input []byte, ctx context.Context) (resource.Result, error) {
|
||||
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)
|
||||
@ -82,7 +83,7 @@ func(pr profileResource) nameSave(sym string, input []byte, ctx context.Context)
|
||||
return emptyResult, err
|
||||
}
|
||||
|
||||
func(pr profileResource) emailSave(sym string, input []byte, ctx context.Context) (resource.Result, error) {
|
||||
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)
|
||||
@ -117,14 +118,16 @@ func main() {
|
||||
rs.AddLocalFunc("do_email_save", rs.emailSave)
|
||||
ca := cache.NewCache()
|
||||
cfg := engine.Config{
|
||||
Root: "root",
|
||||
SessionId: sessionId,
|
||||
Root: "root",
|
||||
SessionId: sessionId,
|
||||
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)
|
||||
}
|
||||
|
||||
|
0
examples/session/data.txt.orig
Normal file
0
examples/session/data.txt.orig
Normal file
2
examples/session/input
Normal file
2
examples/session/input
Normal file
@ -0,0 +1,2 @@
|
||||
hey hey hey
|
||||
your data is {{.do_save}}
|
4
examples/session/input.vis
Normal file
4
examples/session/input.vis
Normal file
@ -0,0 +1,4 @@
|
||||
MAP do_save
|
||||
HALT
|
||||
RELOAD do_save
|
||||
INCMP * .
|
86
examples/session/main.go
Normal file
86
examples/session/main.go
Normal file
@ -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)
|
||||
}
|
||||
}
|
2
examples/session/root.vis
Normal file
2
examples/session/root.vis
Normal file
@ -0,0 +1,2 @@
|
||||
LOAD do_save 0
|
||||
MOVE input
|
2
examples/validate/end
Normal file
2
examples/validate/end
Normal file
@ -0,0 +1,2 @@
|
||||
You made it.
|
||||
Any input to go again.
|
3
examples/validate/end.vis
Normal file
3
examples/validate/end.vis
Normal file
@ -0,0 +1,3 @@
|
||||
HALT
|
||||
LOAD again 0
|
||||
INCMP * _
|
84
examples/validate/main.go
Normal file
84
examples/validate/main.go
Normal file
@ -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)
|
||||
}
|
||||
}
|
1
examples/validate/root
Normal file
1
examples/validate/root
Normal file
@ -0,0 +1 @@
|
||||
Please write "something"
|
6
examples/validate/root.vis
Normal file
6
examples/validate/root.vis
Normal file
@ -0,0 +1,6 @@
|
||||
LOAD verifyinput 0
|
||||
MAP verifyinput
|
||||
HALT
|
||||
RELOAD verifyinput
|
||||
CATCH . 8 1
|
||||
MOVE end
|
2
go.mod
2
go.mod
@ -1,4 +1,4 @@
|
||||
module git.defalsify.org/vise
|
||||
module git.grassecon.net/kamikazechaser/vise
|
||||
|
||||
go 1.20
|
||||
|
||||
|
@ -5,17 +5,18 @@ import (
|
||||
"log"
|
||||
"path"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/fxamacker/cbor/v2"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/state"
|
||||
"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
|
||||
State *state.State
|
||||
Memory *cache.Cache
|
||||
dir string
|
||||
dir string
|
||||
}
|
||||
|
||||
// NewFsPersister creates a new FsPersister.
|
||||
@ -34,35 +35,35 @@ func NewFsPersister(dir string) *FsPersister {
|
||||
// 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 {
|
||||
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 {
|
||||
func (p *FsPersister) GetState() *state.State {
|
||||
return p.State
|
||||
}
|
||||
|
||||
// GetState implements the Persister interface.
|
||||
func(p *FsPersister) GetMemory() cache.Memory {
|
||||
func (p *FsPersister) GetMemory() cache.Memory {
|
||||
return p.Memory
|
||||
}
|
||||
|
||||
// GetState implements the Persister interface.
|
||||
func(p *FsPersister) Serialize() ([]byte, error) {
|
||||
func (p *FsPersister) Serialize() ([]byte, error) {
|
||||
return cbor.Marshal(p)
|
||||
}
|
||||
|
||||
// GetState implements the Persister interface.
|
||||
func(p *FsPersister) Deserialize(b []byte) error {
|
||||
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 {
|
||||
func (p *FsPersister) Save(key string) error {
|
||||
b, err := p.Serialize()
|
||||
if err != nil {
|
||||
return err
|
||||
@ -73,7 +74,7 @@ func(p *FsPersister) Save(key string) error {
|
||||
}
|
||||
|
||||
// GetState implements the Persister interface.
|
||||
func(p *FsPersister) Load(key string) error {
|
||||
func (p *FsPersister) Load(key string) error {
|
||||
fp := path.Join(p.dir, key)
|
||||
b, err := ioutil.ReadFile(fp)
|
||||
if err != nil {
|
||||
|
@ -7,9 +7,9 @@ import (
|
||||
"reflect"
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.defalsify.org/vise/vm"
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
"git.grassecon.net/kamikazechaser/vise/vm"
|
||||
)
|
||||
|
||||
func TestSerializeState(t *testing.T) {
|
||||
@ -39,7 +39,7 @@ func TestSerializeState(t *testing.T) {
|
||||
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)
|
||||
}
|
||||
|
@ -1,17 +1,16 @@
|
||||
package persist
|
||||
|
||||
import (
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/state"
|
||||
"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.
|
||||
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.
|
||||
}
|
||||
|
||||
|
@ -7,31 +7,31 @@ import (
|
||||
"strings"
|
||||
"text/template"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/resource"
|
||||
)
|
||||
|
||||
// Page exectues output rendering into pages constrained by size.
|
||||
type Page struct {
|
||||
cacheMap map[string]string // Mapped content symbols
|
||||
cache cache.Memory // Content store.
|
||||
cache cache.Memory // Content store.
|
||||
resource resource.Resource // Symbol resolver.
|
||||
menu *Menu // Menu rendererer.
|
||||
sink *string // Content symbol rendered by dynamic size.
|
||||
sizer *Sizer // Process size constraints.
|
||||
menu *Menu // Menu rendererer.
|
||||
sink *string // Content symbol rendered by dynamic size.
|
||||
sizer *Sizer // Process size constraints.
|
||||
}
|
||||
|
||||
// NewPage creates a new Page object.
|
||||
func NewPage(cache cache.Memory, rs resource.Resource) *Page {
|
||||
return &Page{
|
||||
cache: cache,
|
||||
cache: cache,
|
||||
cacheMap: make(map[string]string),
|
||||
resource: rs,
|
||||
}
|
||||
}
|
||||
|
||||
// WithMenu sets a menu renderer for the page.
|
||||
func(pg *Page) WithMenu(menu *Menu) *Page {
|
||||
func (pg *Page) WithMenu(menu *Menu) *Page {
|
||||
pg.menu = menu
|
||||
if pg.sizer != nil {
|
||||
pg.sizer = pg.sizer.WithMenuSize(pg.menu.ReservedSize())
|
||||
@ -40,7 +40,7 @@ func(pg *Page) WithMenu(menu *Menu) *Page {
|
||||
}
|
||||
|
||||
// WithSizer sets a size constraints definition for the page.
|
||||
func(pg *Page) WithSizer(sizer *Sizer) *Page {
|
||||
func (pg *Page) WithSizer(sizer *Sizer) *Page {
|
||||
pg.sizer = sizer
|
||||
if pg.menu != nil {
|
||||
pg.sizer = pg.sizer.WithMenuSize(pg.menu.ReservedSize())
|
||||
@ -49,7 +49,7 @@ func(pg *Page) WithSizer(sizer *Sizer) *Page {
|
||||
}
|
||||
|
||||
// Usage returns size used by values and menu, and remaining size available
|
||||
func(pg *Page) Usage() (uint32, uint32, error) {
|
||||
func (pg *Page) Usage() (uint32, uint32, error) {
|
||||
var l int
|
||||
var c uint16
|
||||
for k, v := range pg.cacheMap {
|
||||
@ -62,7 +62,7 @@ func(pg *Page) Usage() (uint32, uint32, error) {
|
||||
log.Printf("v %x %v %v %v %v", []byte(v), len(v), l, sz, c)
|
||||
}
|
||||
r := uint32(l)
|
||||
rsv := uint32(c)-r
|
||||
rsv := uint32(c) - r
|
||||
if pg.menu != nil {
|
||||
r += uint32(pg.menu.ReservedSize())
|
||||
}
|
||||
@ -74,7 +74,7 @@ func(pg *Page) Usage() (uint32, uint32, error) {
|
||||
// After this, Val() will return the value for the key, and Size() will include the value size and limitations in its calculations.
|
||||
//
|
||||
// Only one symbol with no size limitation may be mapped at the current level.
|
||||
func(pg *Page) Map(key string) error {
|
||||
func (pg *Page) Map(key string) error {
|
||||
v, err := pg.cache.Get(key)
|
||||
if err != nil {
|
||||
return err
|
||||
@ -103,7 +103,7 @@ func(pg *Page) Map(key string) error {
|
||||
// Val gets the mapped content for the given symbol.
|
||||
//
|
||||
// Fails if key is not mapped.
|
||||
func(pg *Page) Val(key string) (string, error) {
|
||||
func (pg *Page) Val(key string) (string, error) {
|
||||
r := pg.cacheMap[key]
|
||||
if len(r) == 0 {
|
||||
return "", fmt.Errorf("key %v not mapped", key)
|
||||
@ -112,7 +112,7 @@ func(pg *Page) Val(key string) (string, error) {
|
||||
}
|
||||
|
||||
// Sizes returned the actual used bytes by each mapped symbol.
|
||||
func(pg *Page) Sizes() (map[string]uint16, error) {
|
||||
func (pg *Page) Sizes() (map[string]uint16, error) {
|
||||
sizes := make(map[string]uint16)
|
||||
var haveSink bool
|
||||
for k, _ := range pg.cacheMap {
|
||||
@ -131,7 +131,7 @@ func(pg *Page) Sizes() (map[string]uint16, error) {
|
||||
}
|
||||
|
||||
// RenderTemplate 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) {
|
||||
func (pg *Page) RenderTemplate(sym string, values map[string]string, idx uint16) (string, error) {
|
||||
tpl, err := pg.resource.GetTemplate(sym)
|
||||
if err != nil {
|
||||
return "", err
|
||||
@ -145,13 +145,12 @@ func(pg *Page) RenderTemplate(sym string, values map[string]string, idx uint16)
|
||||
return "", fmt.Errorf("sizer needed for indexed render")
|
||||
}
|
||||
log.Printf("render for index: %v", idx)
|
||||
|
||||
|
||||
tp, err := template.New("tester").Option("missingkey=error").Parse(tpl)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
|
||||
b := bytes.NewBuffer([]byte{})
|
||||
err = tp.Execute(b, values)
|
||||
if err != nil {
|
||||
@ -161,7 +160,7 @@ func(pg *Page) RenderTemplate(sym string, values map[string]string, idx uint16)
|
||||
}
|
||||
|
||||
// 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) {
|
||||
func (pg *Page) Render(sym string, idx uint16) (string, error) {
|
||||
var err error
|
||||
|
||||
values, err := pg.prepare(sym, pg.cacheMap, idx)
|
||||
@ -175,14 +174,14 @@ func(pg *Page) Render(sym string, idx uint16) (string, error) {
|
||||
// Reset prepared the Page object for re-use.
|
||||
//
|
||||
// It clears mappings and removes the sink definition.
|
||||
func(pg *Page) Reset() {
|
||||
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) {
|
||||
func (pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[string]string, error) {
|
||||
var sink string
|
||||
|
||||
if pg.sizer == nil {
|
||||
@ -204,7 +203,7 @@ func(pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[st
|
||||
}
|
||||
noSinkValues[k] = v
|
||||
}
|
||||
|
||||
|
||||
if sink == "" {
|
||||
log.Printf("no sink found for sym %s", sym)
|
||||
return values, nil
|
||||
@ -259,7 +258,7 @@ func(pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[st
|
||||
for i, v := range sinkValues {
|
||||
l += len(v)
|
||||
log.Printf("processing sinkvalue %v: %s", i, v)
|
||||
if uint32(l) > netRemaining - 1 {
|
||||
if uint32(l) > netRemaining-1 {
|
||||
if tb.Len() == 0 {
|
||||
return nil, fmt.Errorf("capacity insufficient for sink field %v", i)
|
||||
}
|
||||
@ -303,7 +302,7 @@ func(pg *Page) prepare(sym string, values map[string]string, idx uint16) (map[st
|
||||
}
|
||||
|
||||
// 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) {
|
||||
func (pg *Page) render(sym string, values map[string]string, idx uint16) (string, error) {
|
||||
var ok bool
|
||||
r := ""
|
||||
s, err := pg.RenderTemplate(sym, values, idx)
|
||||
@ -332,4 +331,3 @@ func(pg *Page) render(sym string, values map[string]string, idx uint16) (string,
|
||||
}
|
||||
return r, nil
|
||||
}
|
||||
|
||||
|
@ -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()
|
||||
|
@ -5,9 +5,9 @@ import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/resource"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
)
|
||||
|
||||
type TestSizeResource struct {
|
||||
@ -141,7 +141,7 @@ func TestSizePages(t *testing.T) {
|
||||
mn := NewMenu().WithOutputSize(32)
|
||||
mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
|
||||
rs := TestSizeResource{
|
||||
mrs,
|
||||
mrs,
|
||||
}
|
||||
szr := NewSizer(128)
|
||||
pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
|
||||
@ -159,7 +159,7 @@ func TestSizePages(t *testing.T) {
|
||||
mn.Put("1", "foo the foo")
|
||||
mn.Put("2", "go to bar")
|
||||
|
||||
r, err := pg.Render("pages", 0)
|
||||
r, err := pg.Render("pages", 0)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
@ -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)
|
||||
}
|
||||
@ -200,7 +199,7 @@ func TestManySizes(t *testing.T) {
|
||||
mn := NewMenu().WithOutputSize(32)
|
||||
mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
|
||||
rs := TestSizeResource{
|
||||
mrs,
|
||||
mrs,
|
||||
}
|
||||
szr := NewSizer(uint32(i))
|
||||
pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
|
||||
@ -228,7 +227,7 @@ func TestManySizesMenued(t *testing.T) {
|
||||
mn := NewMenu().WithOutputSize(32)
|
||||
mrs := resource.NewMenuResource().WithEntryFuncGetter(funcFor).WithTemplateGetter(getTemplate)
|
||||
rs := TestSizeResource{
|
||||
mrs,
|
||||
mrs,
|
||||
}
|
||||
szr := NewSizer(uint32(i))
|
||||
pg := NewPage(ca, rs).WithSizer(szr).WithMenu(mn)
|
||||
|
@ -1,7 +1,7 @@
|
||||
package resource
|
||||
|
||||
import (
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
)
|
||||
|
||||
type StateResource struct {
|
||||
@ -14,13 +14,13 @@ func ToStateResource(rs Resource) *StateResource {
|
||||
}
|
||||
|
||||
func NewStateResource(st *state.State) *StateResource {
|
||||
return &StateResource {
|
||||
return &StateResource{
|
||||
NewMenuResource(),
|
||||
st,
|
||||
}
|
||||
}
|
||||
|
||||
func(sr *StateResource) WithState(st *state.State) *StateResource {
|
||||
func (sr *StateResource) WithState(st *state.State) *StateResource {
|
||||
if sr.st != nil {
|
||||
panic("state already set")
|
||||
}
|
||||
|
@ -3,7 +3,7 @@ package resource
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
)
|
||||
|
||||
func TestStateResourceInit(t *testing.T) {
|
||||
|
@ -1,11 +1,13 @@
|
||||
package state
|
||||
|
||||
const (
|
||||
FLAG_READIN = 1
|
||||
FLAG_INMATCH = 2
|
||||
FLAG_TERMINATE = 3
|
||||
FLAG_DIRTY = 4
|
||||
FLAG_LOADFAIL = 5
|
||||
FLAG_READIN = iota
|
||||
FLAG_INMATCH
|
||||
FLAG_TERMINATE
|
||||
FLAG_DIRTY
|
||||
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 {
|
||||
}
|
||||
|
@ -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.
|
||||
|
5
testdata/testdata.go
vendored
5
testdata/testdata.go
vendored
@ -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
|
||||
@ -16,7 +16,7 @@ type genFunc func() error
|
||||
var (
|
||||
BaseDir = testdataloader.GetBasePath()
|
||||
DataDir = ""
|
||||
dirLock = false
|
||||
dirLock = false
|
||||
)
|
||||
|
||||
func out(sym string, b []byte, tpl string, data map[string]string) 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.
|
||||
|
23
vm/input.go
23
vm/input.go
@ -5,18 +5,17 @@ import (
|
||||
"fmt"
|
||||
"regexp"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
)
|
||||
|
||||
var (
|
||||
inputRegexStr = "^[a-zA-Z0-9].*$"
|
||||
inputRegex = regexp.MustCompile(inputRegexStr)
|
||||
ctrlRegexStr = "^[><_^]$"
|
||||
ctrlRegex = regexp.MustCompile(ctrlRegexStr)
|
||||
symRegexStr = "^[a-zA-Z0-9][a-zA-Z0-9_]+$"
|
||||
symRegex = regexp.MustCompile(symRegexStr)
|
||||
|
||||
inputRegex = regexp.MustCompile(inputRegexStr)
|
||||
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.
|
||||
@ -61,7 +60,7 @@ func valid(target []byte) bool {
|
||||
ok = true
|
||||
}
|
||||
}
|
||||
return ok
|
||||
return ok
|
||||
}
|
||||
|
||||
// CheckTarget tests whether the navigation state transition is available in the current state.
|
||||
@ -76,7 +75,7 @@ func CheckTarget(target []byte, st *state.State) (bool, error) {
|
||||
switch target[0] {
|
||||
case '_':
|
||||
topOk, err := st.Top()
|
||||
if err!= nil {
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return topOk, nil
|
||||
@ -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)
|
||||
|
175
vm/runner.go
175
vm/runner.go
@ -5,42 +5,43 @@ import (
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/render"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/render"
|
||||
"git.grassecon.net/kamikazechaser/vise/resource"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
)
|
||||
|
||||
// Vm holds sub-components mutated by the vm execution.
|
||||
type Vm struct {
|
||||
st *state.State // Navigation and error states.
|
||||
rs resource.Resource // Retrieves content, code, and templates for symbols.
|
||||
ca cache.Memory // Loaded content.
|
||||
mn *render.Menu // Menu component of page.
|
||||
sizer *render.Sizer // Apply size constraints to output.
|
||||
pg *render.Page // Render outputs with menues to size constraints.
|
||||
st *state.State // Navigation and error states.
|
||||
rs resource.Resource // Retrieves content, code, and templates for symbols.
|
||||
ca cache.Memory // Loaded content.
|
||||
mn *render.Menu // Menu component of page.
|
||||
sizer *render.Sizer // Apply size constraints to output.
|
||||
pg *render.Page // Render outputs with menues to size constraints.
|
||||
}
|
||||
|
||||
// NewVm creates a new Vm.
|
||||
func NewVm(st *state.State, rs resource.Resource, ca cache.Memory, sizer *render.Sizer) *Vm {
|
||||
vmi := &Vm{
|
||||
st: st,
|
||||
rs: rs,
|
||||
ca: ca,
|
||||
pg: render.NewPage(ca, rs),
|
||||
st: st,
|
||||
rs: rs,
|
||||
ca: ca,
|
||||
pg: render.NewPage(ca, rs),
|
||||
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() {
|
||||
func (vmi *Vm) Reset() {
|
||||
vmi.mn = render.NewMenu()
|
||||
vmi.pg.Reset()
|
||||
vmi.pg = vmi.pg.WithMenu(vmi.mn)
|
||||
if vmi.sizer != nil {
|
||||
vmi.pg = vmi.pg.WithSizer(vmi.sizer)
|
||||
vmi.pg = vmi.pg.WithSizer(vmi.sizer)
|
||||
}
|
||||
}
|
||||
|
||||
@ -49,7 +50,7 @@ func(vmi *Vm) Reset() {
|
||||
// Each step may update the state.
|
||||
//
|
||||
// On error, the remaining instructions will be returned. State will not be rolled back.
|
||||
func(vm *Vm) Run(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) Run(b []byte, ctx context.Context) ([]byte, error) {
|
||||
running := true
|
||||
for running {
|
||||
r, err := vm.st.MatchFlag(state.FLAG_TERMINATE, false)
|
||||
@ -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)
|
||||
@ -126,9 +140,9 @@ func(vm *Vm) Run(b []byte, ctx context.Context) ([]byte, error) {
|
||||
// If there is remaining bytecode, this method is a noop.
|
||||
//
|
||||
// If input has not been matched, a default invalid input page should be generated aswell as a possiblity of return to last screen (or exit).
|
||||
//
|
||||
//
|
||||
// If the termination flag has been set but not yet handled, execution is allowed to terminate.
|
||||
func(vm *Vm) RunDeadCheck(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunDeadCheck(b []byte, ctx context.Context) ([]byte, error) {
|
||||
if len(b) > 0 {
|
||||
return b, nil
|
||||
}
|
||||
@ -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 == "" {
|
||||
@ -164,43 +177,49 @@ func(vm *Vm) RunDeadCheck(b []byte, ctx context.Context) ([]byte, error) {
|
||||
}
|
||||
|
||||
// RunMap executes the MAP opcode
|
||||
func(vm *Vm) RunMap(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunMap(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sym, b, err := ParseMap(b)
|
||||
err = vm.pg.Map(sym)
|
||||
return b, err
|
||||
}
|
||||
|
||||
// RunMap executes the CATCH opcode
|
||||
func(vm *Vm) RunCatch(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunCatch(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sym, sig, mode, b, err := ParseCatch(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
}
|
||||
r, err := vm.st.MatchFlag(sig, mode)
|
||||
if err != nil {
|
||||
_, err = vm.st.SetFlag(state.FLAG_TERMINATE)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
var perr error
|
||||
_, perr = vm.st.SetFlag(state.FLAG_TERMINATE)
|
||||
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
|
||||
}
|
||||
|
||||
// RunMap executes the CROAK opcode
|
||||
func(vm *Vm) RunCroak(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunCroak(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sig, mode, b, err := ParseCroak(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
@ -220,7 +239,7 @@ func(vm *Vm) RunCroak(b []byte, ctx context.Context) ([]byte, error) {
|
||||
}
|
||||
|
||||
// RunLoad executes the LOAD opcode
|
||||
func(vm *Vm) RunLoad(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunLoad(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sym, sz, b, err := ParseLoad(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
@ -234,7 +253,7 @@ func(vm *Vm) RunLoad(b []byte, ctx context.Context) ([]byte, error) {
|
||||
}
|
||||
|
||||
// RunLoad executes the RELOAD opcode
|
||||
func(vm *Vm) RunReload(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunReload(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sym, b, err := ParseReload(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
@ -255,7 +274,7 @@ func(vm *Vm) RunReload(b []byte, ctx context.Context) ([]byte, error) {
|
||||
}
|
||||
|
||||
// RunLoad executes the MOVE opcode
|
||||
func(vm *Vm) RunMove(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunMove(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sym, b, err := ParseMove(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
@ -280,7 +299,7 @@ func(vm *Vm) RunMove(b []byte, ctx context.Context) ([]byte, error) {
|
||||
|
||||
// RunIncmp executes the INCMP opcode
|
||||
// TODO: create state transition table and simplify flow
|
||||
func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
|
||||
sym, target, b, err := ParseInCmp(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
@ -295,12 +314,7 @@ func(vm *Vm) RunInCmp(b []byte, ctx context.Context) ([]byte, error) {
|
||||
panic(err)
|
||||
}
|
||||
if have {
|
||||
if !reading {
|
||||
_, err = vm.st.ResetFlag(state.FLAG_INMATCH)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
} else {
|
||||
if reading {
|
||||
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,37 +360,46 @@ 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
|
||||
}
|
||||
|
||||
// RunHalt executes the HALT opcode
|
||||
func(vm *Vm) RunHalt(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunHalt(b []byte, ctx context.Context) ([]byte, error) {
|
||||
var err error
|
||||
b, err = ParseHalt(b)
|
||||
if err != nil {
|
||||
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
|
||||
func(vm *Vm) RunMSize(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunMSize(b []byte, ctx context.Context) ([]byte, error) {
|
||||
log.Printf("WARNING MSIZE not yet implemented")
|
||||
_, _, b, err := ParseMSize(b)
|
||||
return b, err
|
||||
}
|
||||
|
||||
// RunMOut executes the MOUT opcode
|
||||
func(vm *Vm) RunMOut(b []byte, ctx context.Context) ([]byte, error) {
|
||||
func (vm *Vm) RunMOut(b []byte, ctx context.Context) ([]byte, error) {
|
||||
choice, title, b, err := ParseMOut(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
@ -389,38 +409,38 @@ func(vm *Vm) RunMOut(b []byte, ctx context.Context) ([]byte, error) {
|
||||
}
|
||||
|
||||
// RunMNext executes the MNEXT opcode
|
||||
func(vm *Vm) RunMNext(b []byte, ctx context.Context) ([]byte, error) {
|
||||
selector, display, b, err := ParseMNext(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
}
|
||||
cfg := vm.mn.GetBrowseConfig()
|
||||
cfg.NextSelector = selector
|
||||
cfg.NextTitle = display
|
||||
cfg.NextAvailable = true
|
||||
vm.mn = vm.mn.WithBrowseConfig(cfg)
|
||||
return b, nil
|
||||
func (vm *Vm) RunMNext(b []byte, ctx context.Context) ([]byte, error) {
|
||||
selector, display, b, err := ParseMNext(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
}
|
||||
cfg := vm.mn.GetBrowseConfig()
|
||||
cfg.NextSelector = selector
|
||||
cfg.NextTitle = display
|
||||
cfg.NextAvailable = true
|
||||
vm.mn = vm.mn.WithBrowseConfig(cfg)
|
||||
return b, nil
|
||||
}
|
||||
|
||||
|
||||
// RunMPrev executes the MPREV opcode
|
||||
func(vm *Vm) RunMPrev(b []byte, ctx context.Context) ([]byte, error) {
|
||||
selector, display, b, err := ParseMPrev(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
}
|
||||
cfg := vm.mn.GetBrowseConfig()
|
||||
cfg.PreviousSelector = selector
|
||||
cfg.PreviousTitle = display
|
||||
cfg.PreviousAvailable = true
|
||||
vm.mn = vm.mn.WithBrowseConfig(cfg)
|
||||
return b, nil
|
||||
func (vm *Vm) RunMPrev(b []byte, ctx context.Context) ([]byte, error) {
|
||||
selector, display, b, err := ParseMPrev(b)
|
||||
if err != nil {
|
||||
return b, err
|
||||
}
|
||||
cfg := vm.mn.GetBrowseConfig()
|
||||
cfg.PreviousSelector = selector
|
||||
cfg.PreviousTitle = display
|
||||
cfg.PreviousAvailable = true
|
||||
vm.mn = vm.mn.WithBrowseConfig(cfg)
|
||||
return b, nil
|
||||
}
|
||||
|
||||
// Render wraps output rendering, and handles error when attempting to browse beyond the rendered page count.
|
||||
func(vm *Vm) Render(ctx context.Context) (string, error) {
|
||||
func (vm *Vm) Render(ctx context.Context) (string, error) {
|
||||
changed, err := vm.st.ResetFlag(state.FLAG_DIRTY)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
panic(err)
|
||||
}
|
||||
if !changed {
|
||||
return "", nil
|
||||
@ -443,7 +463,7 @@ func(vm *Vm) Render(ctx context.Context) (string, error) {
|
||||
}
|
||||
|
||||
// retrieve data for key
|
||||
func(vm *Vm) refresh(key string, rs resource.Resource, ctx context.Context) (string, error) {
|
||||
func (vm *Vm) refresh(key string, rs resource.Resource, ctx context.Context) (string, error) {
|
||||
fn, err := rs.FuncFor(key)
|
||||
if err != nil {
|
||||
return "", err
|
||||
@ -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 {
|
||||
|
@ -6,18 +6,18 @@ import (
|
||||
"fmt"
|
||||
"log"
|
||||
"testing"
|
||||
|
||||
"git.defalsify.org/vise/cache"
|
||||
"git.defalsify.org/vise/render"
|
||||
"git.defalsify.org/vise/resource"
|
||||
"git.defalsify.org/vise/state"
|
||||
|
||||
"git.grassecon.net/kamikazechaser/vise/cache"
|
||||
"git.grassecon.net/kamikazechaser/vise/render"
|
||||
"git.grassecon.net/kamikazechaser/vise/resource"
|
||||
"git.grassecon.net/kamikazechaser/vise/state"
|
||||
)
|
||||
|
||||
var dynVal = "three"
|
||||
|
||||
type TestResource struct {
|
||||
resource.MenuResource
|
||||
state *state.State
|
||||
state *state.State
|
||||
RootCode []byte
|
||||
}
|
||||
|
||||
@ -58,7 +58,7 @@ func setFlag(sym string, input []byte, ctx context.Context) (resource.Result, er
|
||||
r.FlagReset = append(r.FlagReset, uint32(input[1]))
|
||||
}
|
||||
log.Printf("setflag %v", r)
|
||||
return r, nil
|
||||
return r, nil
|
||||
|
||||
}
|
||||
|
||||
@ -105,14 +105,14 @@ func (r TestResource) FuncFor(sym string) (resource.EntryFunc, error) {
|
||||
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, input []byte, ctx context.Context) (resource.Result, error) {
|
||||
v, err := r.state.GetInput()
|
||||
return resource.Result{
|
||||
Content: string(v),
|
||||
}, err
|
||||
}
|
||||
|
||||
func(r TestResource) GetCode(sym string) ([]byte, error) {
|
||||
func (r TestResource) GetCode(sym string) ([]byte, error) {
|
||||
var b []byte
|
||||
switch sym {
|
||||
case "_catch":
|
||||
@ -139,13 +139,13 @@ func TestRun(t *testing.T) {
|
||||
b = NewLine(b, HALT, nil, nil, nil)
|
||||
_, err := vm.Run(b, context.TODO())
|
||||
if err != nil {
|
||||
t.Errorf("run error: %v", err)
|
||||
t.Errorf("run error: %v", err)
|
||||
}
|
||||
|
||||
b = []byte{0x01, 0x02}
|
||||
_, err = vm.Run(b, context.TODO())
|
||||
if err == nil {
|
||||
t.Errorf("no error on invalid opcode")
|
||||
t.Errorf("no error on invalid opcode")
|
||||
}
|
||||
}
|
||||
|
||||
@ -289,7 +289,7 @@ func TestRunArg(t *testing.T) {
|
||||
bi = NewLine(bi, HALT, nil, nil, nil)
|
||||
b, err := vm.Run(bi, context.TODO())
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
t.Error(err)
|
||||
}
|
||||
l := len(b)
|
||||
if l != 0 {
|
||||
@ -320,7 +320,7 @@ func TestRunInputHandler(t *testing.T) {
|
||||
var err error
|
||||
_, err = vm.Run(bi, context.TODO())
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
t.Fatal(err)
|
||||
}
|
||||
r, _ := st.Where()
|
||||
if r != "foo" {
|
||||
@ -337,13 +337,13 @@ func TestRunArgInvalid(t *testing.T) {
|
||||
_ = st.SetInput([]byte("foo"))
|
||||
|
||||
var err error
|
||||
|
||||
|
||||
st.Down("root")
|
||||
b := NewLine(nil, INCMP, []string{"bar", "baz"}, nil, nil)
|
||||
|
||||
b, err = vm.Run(b, context.TODO())
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
t.Fatal(err)
|
||||
}
|
||||
r, _ := st.Where()
|
||||
if r != "_catch" {
|
||||
@ -368,13 +368,13 @@ func TestRunMenu(t *testing.T) {
|
||||
|
||||
b, err = vm.Run(b, ctx)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
t.Error(err)
|
||||
}
|
||||
l := len(b)
|
||||
if l != 0 {
|
||||
t.Errorf("expected empty remainder, got length %v: %v", l, b)
|
||||
}
|
||||
|
||||
|
||||
r, err := vm.Render(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@ -403,13 +403,13 @@ func TestRunMenuBrowse(t *testing.T) {
|
||||
|
||||
b, err = vm.Run(b, ctx)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
t.Error(err)
|
||||
}
|
||||
l := len(b)
|
||||
if l != 0 {
|
||||
t.Errorf("expected empty remainder, got length %v: %v", l, b)
|
||||
}
|
||||
|
||||
|
||||
r, err := vm.Render(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@ -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()
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user