--- /dev/null
+# Ignore anything ending in local
+*local
+
+# Disregard ignore rules for example files
+!*.example
\ No newline at end of file
--- /dev/null
+GNU LESSER GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms
+and conditions of version 3 of the GNU General Public License, supplemented
+by the additional permissions listed below.
+
+0. Additional Definitions.
+
+As used herein, “this License” refers to version 3 of the GNU Lesser General
+Public License, and the “GNU GPL” refers to version 3 of the
+GNU General Public License.
+
+“The Library” refers to a covered work governed by this License, other than
+an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided by the
+Library, but which is not otherwise based on the Library. Defining a subclass
+of a class defined by the Library is deemed a mode of using an interface
+provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an Application
+with the Library. The particular version of the Library with which the
+Combined Work was made is also called the “Linked Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the Corresponding
+Source for the Combined Work, excluding any source code for portions of the
+Combined Work that, considered in isolation, are based on the Application,
+and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the object code
+and/or source code for the Application, including any data and utility programs
+needed for reproducing the Combined Work from the Application, but excluding
+the System Libraries of the Combined Work.
+
+1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without
+being bound by section 3 of the GNU GPL.
+
+2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility
+refers to a function or data to be supplied by an Application that uses the
+facility (other than as an argument passed when the facility is invoked),
+then you may convey a copy of the modified version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the function or
+ data, the facility still operates, and performs whatever part of its
+ purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of this
+ License applicable to that copy.
+
+3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header
+file that is part of the Library. You may convey such object code under terms
+of your choice, provided that, if the incorporated material is not limited to
+numerical parameters, data structure layouts and accessors, or small macros,
+inline functions and templates (ten or fewer lines in length),
+you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the Library
+ is used in it and that the Library and its use are covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL
+ and this license document.
+
+4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together,
+effectively do not restrict modification of the portions of the Library
+contained in the Combined Work and reverse engineering for debugging such
+modifications, if you also do each of the following:
+
+ a) Give prominent notice with each copy of the Combined Work that the
+ Library is used in it and that the Library and its use are covered
+ by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and
+ this license document.
+
+ c) For a Combined Work that displays copyright notices during execution,
+ include the copyright notice for the Library among these notices, as well
+ as a reference directing the user to the copies of the GNU GPL
+ and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form suitable
+ for, and under terms that permit, the user to recombine or relink
+ the Application with a modified version of the Linked Version to
+ produce a modified Combined Work, in the manner specified by section 6
+ of the GNU GPL for conveying Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time a
+ copy of the Library already present on the user's computer system,
+ and (b) will operate properly with a modified version of the Library
+ that is interface-compatible with the Linked Version.
+
+ e) Provide Installation Information, but only if you would otherwise be
+ required to provide such information under section 6 of the GNU GPL, and
+ only to the extent that such information is necessary to install and
+ execute a modified version of the Combined Work produced by recombining
+ or relinking the Application with a modified version of the Linked Version.
+ (If you use option 4d0, the Installation Information must accompany the
+ Minimal Corresponding Source and Corresponding Application Code. If you
+ use option 4d1, you must provide the Installation Information in the
+ manner specified by section 6 of the GNU GPL for
+ conveying Corresponding Source.)
+
+5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side by
+side in a single library together with other library facilities that are not
+Applications and are not covered by this License, and convey such a combined
+library under terms of your choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based on
+ the Library, uncombined with any other library facilities, conveyed under
+ the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it is a
+ work based on the Library, and explaining where to find the accompanying
+ uncombined form of the same work.
+
+6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the
+GNU Lesser 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 Library as you
+received it specifies that a certain numbered version of the GNU Lesser
+General Public License “or any later version” applies to it, you have the
+option of following the terms and conditions either of that published version
+or of any later version published by the Free Software Foundation. If the
+Library as you received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser General
+Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether
+future versions of the GNU Lesser General Public License shall apply, that
+proxy's public statement of acceptance of any version is permanent
+authorization for you to choose that version for the Library.
\ No newline at end of file
--- /dev/null
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <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 General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ {{ project }} Copyright (C) {{ year }} {{ organization }}
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
--- /dev/null
+# Make a Site Today (Mast) Web Engine
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package main
+
+import (
+ "html/template"
+ "net/http"
+
+ "git.earlybird.gay/mast-engine/page"
+ "git.earlybird.gay/mast-engine/part"
+ "git.earlybird.gay/mast-engine/render"
+)
+
+func mkList(args ...string) template.HTML {
+ out := template.HTML("<ul>")
+ for _, arg := range args {
+ out += template.HTML("<li>" + arg + "</li>")
+ }
+ out += template.HTML("</ul>")
+ return out
+}
+
+var testPage = page.New("test-page", "example-page.html",
+ page.Includes(testPart),
+ page.OnLoad(func(data render.Data) error {
+ data.Set("message", "hello from test-page!")
+ return nil
+ }),
+ page.Pretty(" "),
+)
+var testPart = part.New("test-part", "example-part.html",
+ part.Funcs(template.FuncMap{
+ "mkList": mkList,
+ }),
+ part.OnLoad(func(data render.Data) error {
+ data.Set("message", "hello from test-part!")
+ return nil
+ }),
+)
+
+func main() {
+ http.ListenAndServe("0.0.0.0:3000", testPage)
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package engine
+
+import (
+ "net/http"
+)
+
+type App struct {
+ http.ServeMux
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package ex01
+
+import (
+ "git.earlybird.gay/mast-engine/examples/parts"
+ "git.earlybird.gay/mast-engine/page"
+)
+
+var Page = page.New("ex01", "page.html", page.Includes(parts.ExampleNav))
--- /dev/null
+<!DOCTYPE html>
+<html>
+ <header>
+ <title>Example 1</title>
+ </header>
+ <body>
+ <h1>Basic Page</h1>
+ <p>This is a static page. Hooray.</p>
+
+ <!-- Ignore me!! I'll be explained in a second! -->
+ <example-nav>
+ <a href="ex02" slot="next">Parts</a>
+ </example-nav>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package ex02
+
+import (
+ "git.earlybird.gay/mast-engine/examples/parts"
+ "git.earlybird.gay/mast-engine/page"
+ "git.earlybird.gay/mast-engine/part"
+)
+
+var section = part.New("my-section", "section.html")
+
+// Use *.Includes to include a part as a dependency.
+var Page = page.New("ex02", "page.html", page.Includes(section, parts.ExampleNav))
--- /dev/null
+<!DOCTYPE html>
+<html>
+ <header>
+ <title>Example 2</title>
+ </header>
+ <body>
+ <h1>Page with Parts</h1>
+ <p>This page uses "parts" to create sections on the page. Parts are
+ HTML blocks that you can re-use.
+ </p>
+ </body>
+ <my-section>
+ <h2>Section</h2>
+ <p>This is inner HTML for a my-section "part". It replaces the slot tag
+ in the part.
+ </p>
+ </my-section>
+
+ <example-nav>
+ <a href="ex01" slot="previous">Pages</a>
+ <a href="ex03" slot="next">Slots</a>
+ </example-nav>
+</html>
\ No newline at end of file
--- /dev/null
+<template>
+ <section>
+ <!-- Slots are where the inner HTML of the part goes when rendered. -->
+ <slot></slot>
+ </section>
+</template>
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package ex03
+
+import (
+ "git.earlybird.gay/mast-engine/examples/parts"
+ "git.earlybird.gay/mast-engine/page"
+ "git.earlybird.gay/mast-engine/part"
+)
+
+var section = part.New("my-section", "section.html")
+
+// Use *.Includes to include a part as a dependency.
+var Page = page.New("ex03", "page.html", page.Includes(section, parts.ExampleNav))
--- /dev/null
+<!DOCTYPE html>
+<html>
+ <header>
+ <title>Example 3</title>
+ </header>
+ <body>
+ <h1>Page with Parts</h1>
+ <p>This page uses "parts" to create sections on the page. Parts are
+ HTML blocks that you can re-use.
+ </p>
+ </body>
+ <!-- Use named slots to choose where HTML goes in the part. -->
+ <my-section>
+ <h2 slot="header">Section with Named Slots</h2>
+ <p slot="content">Use the slot tag to fill in named slots.</p>
+ <p slot="content">You can do this with multiple HTML elements!</p>
+ </my-section>
+ <!-- Slots left empty have default HTML; see section.html for details! -->
+ <my-section/>
+ <my-section>
+ <h2 slot="header">Section with a Subsection</h2>
+ <p slot="content">You can also include parts inside parts.</p>
+ <my-section slot="content">
+ <h3 slot="header">Subsection</h3>
+ <p slot="content">This my-section is a subsection!</p>
+ </my-section>
+ </my-section>
+
+ <example-nav>
+ <a href="ex02" slot="previous">Parts</a>
+ <a href="ex04" slot="next">Go Templates</a>
+ </example-nav>
+</html>
\ No newline at end of file
--- /dev/null
+<template>
+ <section>
+ <!-- Slots are where the inner HTML of the part goes when rendered. -->
+ <slot name="header">
+ <h2>Section</h2>
+ </slot>
+ <slot name="content">
+ <p>When no HTML is provided for a slot, it uses the HTML provided
+ in the template.
+ </p>
+ </slot>
+ </section>
+</template>
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package ex04
+
+import (
+ "text/template"
+
+ "git.earlybird.gay/mast-engine/examples/parts"
+ "git.earlybird.gay/mast-engine/page"
+ "git.earlybird.gay/mast-engine/render"
+)
+
+var Page = page.New("ex04", "page.html",
+ page.OnLoad(func(data render.Data) error {
+ data.Set("message", "Hello, Hastur!")
+ return nil
+ }),
+ page.Funcs(template.FuncMap{
+ "reverse": func(s string) string {
+ out := make([]byte, len(s))
+ for i := range (len(s) + 1) / 2 {
+ j := len(s) - i - 1
+ out[i] = s[j]
+ out[j] = s[i]
+ }
+ return string(out)
+ },
+ }),
+ page.Includes(parts.ExampleNav),
+)
--- /dev/null
+<!DOCTYPE html>
+<html>
+ <header>
+ <title>Example 4</title>
+ </header>
+ <body>
+ <h1>Template Data</h1>
+ <p>Let's step back to talk about template data. Go provides templates
+ using "handlebars" notation to create server-side behavior on your
+ pages. For example, on this page, {{ `{{ .message }}` }} is
+ "{{ .message }}".
+ </p>
+ <p>You can also add functions, if the ones provided do not do everything
+ you need. On this page, {{ `{{ reverse "hello" }}`}} is
+ "{{ reverse "hello" }}".
+ </p>
+ <pre><code>var index = page.New("index", "index.html",
+ page.OnLoad(func(data render.Data) error {
+ data.Set("message", "Hello, Hastur!")
+ return nil
+ }),
+ page.Funcs(template.FuncMap{
+ "reverse": func(s string) string {
+ out := make([]byte, len(s))
+ for i := range (len(s) + 1) / 2 {
+ j := len(s) - i - 1
+ out[i] = s[j]
+ out[j] = s[i]
+ }
+ return string(out)
+ },
+ }),
+)</code></pre>
+
+ <example-nav>
+ <a href="ex03" slot="previous">Slots</a>
+ </example-nav>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package ex06
+
+import (
+ "errors"
+ "strings"
+
+ "git.earlybird.gay/mast-engine/examples/parts"
+ "git.earlybird.gay/mast-engine/page"
+ "git.earlybird.gay/mast-engine/part"
+ "git.earlybird.gay/mast-engine/render"
+)
+
+type exampleStruct struct {
+ Data string
+}
+
+var Page = page.New("ex01", "page.html",
+ page.OnLoad(func(data render.Data) error {
+ // This sets .some.really.nested.Data to "hello!".
+ // Bit of a silly example, but it shows the point.
+ data.Set("some", map[string]any{
+ "really": map[string]any{
+ "nested": exampleStruct{
+ Data: "hello, nested data!",
+ },
+ },
+ })
+ return nil
+ }),
+ page.Includes(parts.ExampleNav, messagePrinter),
+)
+var messagePrinter = part.New("message-printer", "message-printer.html",
+ part.OnLoad(func(data render.Data) error {
+ message, ok := data.Get("message").(string)
+ if !ok {
+ return errors.New("no message set")
+ }
+ data.Set("transformedMessage", strings.ToUpper(message))
+ return nil
+ }),
+)
--- /dev/null
+<template>
+ <p>{{ .message }}</p>
+ <p>{{ .transformedMessage }}</p>
+</template>
\ No newline at end of file
--- /dev/null
+<!DOCTYPE html>
+<html>
+ <header>
+ <title>Example 6</title>
+ </header>
+ <body>
+ <h1>Passing Data to Parts</h1>
+ <p>Sometimes, you may want to provide more data to a part than just the
+ HTML to include. To do this, write attributes on the part that start
+ with a colon ":".
+ </p>
+ <p>You can even do this with template fields by starting with a ".".
+ Unfortunately, full template pipelines aren't supported this way
+ right now. You can only pass a string or a value contained in the
+ parent data.
+ </p>
+
+ <message-printer :message="hello"></message-printer>
+ <message-printer :message=".some.really.nested.Data"></message-printer>
+
+ <example-nav>
+ <a href="ex02" slot="next">Parts</a>
+ </example-nav>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+module git.earlybird.gay/mast-engine/examples
+
+go 1.22.4
+
+require git.earlybird.gay/mast-engine v0.0.0
+
+require golang.org/x/net v0.27.0 // indirect
+
+replace git.earlybird.gay/mast-engine => ..
--- /dev/null
+golang.org/x/net v0.27.0 h1:5K3Njcw06/l2y9vpGCSdcxWOYHOUk3dVNGDXN+FvAys=
+golang.org/x/net v0.27.0/go.mod h1:dDi0PyhWNoiUOrAS8uXv/vnScO4wnHQO4mj9fn/RytE=
--- /dev/null
+<!DOCTYPE html>
+<html>
+ <header>
+ <title>Hastur Engine Examples</title>
+ </header>
+ <body>
+ <h1>Hastur Engine Examples</h1>
+ <p>This is a set of examples for usage of the Hastur Web Engine!</p>
+ <h2>Links</h2>
+ <ol>
+ <li><a href="/ex01">Pages</a></li>
+ <li><a href="/ex02">Parts</a></li>
+ <li><a href="/ex03">Slots</a></li>
+ <li><a href="/ex04">Go Templates</a></li>
+ <li>N/A</li>
+ <li><a href="/ex06">Passing Data to Parts</a></li>
+ </ol>
+ </body>
+</html>
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package main
+
+import (
+ "net/http"
+
+ "git.earlybird.gay/mast-engine/examples/ex01-pages"
+ "git.earlybird.gay/mast-engine/examples/ex02-parts"
+ "git.earlybird.gay/mast-engine/examples/ex03-slots"
+ "git.earlybird.gay/mast-engine/examples/ex04-templates"
+ "git.earlybird.gay/mast-engine/examples/ex06-data"
+ "git.earlybird.gay/mast-engine/page"
+)
+
+var index = page.New("index", "index.html")
+
+func main() {
+ mux := new(http.ServeMux)
+ mux.Handle("GET /{$}", index)
+ mux.Handle("GET /ex01", ex01.Page)
+ mux.Handle("GET /ex02", ex02.Page)
+ mux.Handle("GET /ex03", ex03.Page)
+ mux.Handle("GET /ex04", ex04.Page)
+ mux.Handle("GET /ex06", ex06.Page)
+
+ http.ListenAndServe("0.0.0.0:3000", mux)
+}
--- /dev/null
+<template>
+ <slot name="style">
+ <style>
+ example-nav nav {
+ display: grid;
+ grid-template-columns: 1fr 1fr;
+ border-radius: 5px;
+ background-color: lightgray;
+ width: fit-content;
+ }
+ example-nav > nav > span {
+ padding: 10px 2rem;
+ display: flex;
+ gap: .4rem;
+ justify-content: center;
+ }
+ </style>
+ </slot>
+ <nav>
+ <span>Previous: <slot name="previous">None</slot></span>
+ <span>Next: <slot name="next">None</slot></span>
+ <span style="grid-column: span 2;"><a href="/">Back to Overview</a></span>
+ </nav>
+</template>
\ No newline at end of file
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package parts
+
+import "git.earlybird.gay/mast-engine/part"
+
+var ExampleNav = part.New("example-nav", "example-nav.html")
--- /dev/null
+module git.earlybird.gay/mast-engine
+
+go 1.22.0
+
+require golang.org/x/net v0.27.0
--- /dev/null
+golang.org/x/net v0.27.0 h1:5K3Njcw06/l2y9vpGCSdcxWOYHOUk3dVNGDXN+FvAys=
+golang.org/x/net v0.27.0/go.mod h1:dDi0PyhWNoiUOrAS8uXv/vnScO4wnHQO4mj9fn/RytE=
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package htmltree
+
+import "golang.org/x/net/html"
+
+func GetAttr(n *html.Node, name string) string {
+ for _, attr := range n.Attr {
+ if attr.Key == name {
+ return attr.Val
+ }
+ }
+ return ""
+}
+
+func SetAttr(n *html.Node, name string, value string) {
+ for i, attr := range n.Attr {
+ if attr.Key == name {
+ n.Attr = append(n.Attr[:i], n.Attr[i+1:]...)
+ }
+ }
+ n.Attr = append(n.Attr, html.Attribute{Key: name, Val: value})
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package htmltree
+
+import (
+ "fmt"
+ "regexp"
+ "strings"
+
+ "golang.org/x/net/html"
+)
+
+func Walk(root *html.Node, f func(*html.Node) (bool, error)) error {
+ var node, child *html.Node
+ var siblings []*html.Node
+ var stop bool
+ var err error
+
+ node = root
+
+ for node != nil && err == nil {
+ child = node.FirstChild
+ if node.NextSibling != nil {
+ siblings = append(siblings, node.NextSibling)
+ }
+ stop, err = f(node)
+
+ if !stop && child != nil {
+ node = child
+ child = nil
+ } else if nextSibling := len(siblings) - 1; nextSibling != -1 {
+ node = siblings[nextSibling]
+ siblings = siblings[:nextSibling]
+ } else {
+ node = nil
+ }
+ }
+ return err
+}
+
+func Print(root *html.Node) {
+ Walk(root, func(n *html.Node) (bool, error) {
+ fmt.Printf("%p: %+v\n", n, n)
+ return false, nil
+ })
+}
+
+func doctype(n *html.Node) bool {
+ return n.Type == html.DoctypeNode
+}
+
+func comment(n *html.Node) bool {
+ return n.Type == html.CommentNode
+}
+
+func template(n *html.Node) bool {
+ return n.Type == html.TextNode && strings.HasPrefix(n.Data, "{{")
+}
+
+func elem(n *html.Node) bool {
+ return n.Type == html.ElementNode || comment(n) || template(n)
+}
+
+var unindentRegexp = regexp.MustCompile(`^\n\s*`)
+var despaceRegexp = regexp.MustCompile(`\n\s*`)
+
+func Minify() func(root *html.Node) {
+ return func(root *html.Node) {
+ Walk(root, func(n *html.Node) (bool, error) {
+ if n.Type == html.ElementNode && n.Data == "pre" {
+ return true, nil
+ }
+ if n.Type == html.TextNode {
+ n.Data = unindentRegexp.ReplaceAllString(n.Data, "")
+ n.Data = despaceRegexp.ReplaceAllString(n.Data, " ")
+ if n.PrevSibling == nil {
+ n.Data = strings.TrimLeft(n.Data, " \t")
+ }
+ if n.NextSibling == nil {
+ n.Data = strings.TrimRight(n.Data, " \t")
+ }
+ // Remove empty nodes
+ if n.Data == "" {
+ n.Parent.RemoveChild(n)
+ }
+ }
+ return false, nil
+ })
+ }
+}
+
+func spacer(indent string, depth int) *html.Node {
+ return &html.Node{
+ Type: html.TextNode,
+ Data: "\n" + strings.Repeat(indent, depth),
+ }
+}
+
+func pad(n *html.Node, indent string, depth int) {
+ if depth == 0 {
+ return
+ }
+ n.InsertBefore(spacer(indent, depth), n.FirstChild)
+ n.InsertBefore(spacer(indent, depth-1), nil)
+}
+
+func newline(n *html.Node, indent string, depth int) {
+ if n.Parent == nil {
+ return
+ }
+ n.Parent.InsertBefore(spacer(indent, depth), n.NextSibling)
+}
+
+func Prettify(indent string) func(root *html.Node) {
+ return func(root *html.Node) {
+ Minify()(root)
+
+ var prettify func(n *html.Node, depth int)
+
+ prettify = func(n *html.Node, depth int) {
+ if n == nil {
+ return
+ }
+ if elem(n) && n.Data == "pre" {
+ return
+ }
+ if n.NextSibling != nil && (elem(n) || doctype(n)) && elem(n.NextSibling) {
+ newline(n, indent, depth-1)
+ }
+ if n.FirstChild != nil && elem(n.FirstChild) {
+ pad(n, indent, depth)
+ }
+
+ prettify(n.FirstChild, depth+1)
+ prettify(n.NextSibling, depth)
+ }
+
+ prettify(root, 0)
+ }
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package include
+
+import (
+ "errors"
+ "runtime"
+ "slices"
+ "strings"
+)
+
+var ErrNoEligibleCaller = errors.New("no eligible caller on the stack")
+var ErrNoRuntimeAccess = errors.New("couldn't access the runtime")
+
+var callStackNotEligible = []string{
+ "runtime",
+ "git.earlybird.gay/mast-engine/include",
+}
+
+func isNotEligible(caller string, ignorePackages []string) bool {
+ return slices.ContainsFunc(callStackNotEligible, func(notEligible string) bool {
+ return strings.HasPrefix(caller, notEligible+".")
+ }) || slices.ContainsFunc(ignorePackages, func(notEligible string) bool {
+ return strings.HasPrefix(caller, notEligible+".")
+ })
+}
+
+// getCallStackButt gets the calling file, ignoring any file in an ignored
+// package.
+func getCallStackButt(ignorePackages []string) (string, error) {
+ skip := 0
+ for {
+ callers := make([]uintptr, 10)
+ count := runtime.Callers(skip, callers)
+ frames := runtime.CallersFrames(callers)
+ for frame, more := frames.Next(); more; {
+ // If getCallStackButt gets called from main, use the runtime to
+ // determine what module main is in.
+ if isNotEligible(frame.Function, ignorePackages) {
+ frame, more = frames.Next()
+ } else {
+ return frame.File, nil
+ }
+ }
+ if count < 10 {
+ break
+ }
+ }
+
+ return "", ErrNoEligibleCaller
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package include
+
+import (
+ "errors"
+ "fmt"
+ "io"
+ "os"
+ "path"
+ "runtime/debug"
+ "strings"
+)
+
+var (
+ ErrNoRuntime = errors.New("could not access runtime for caller info")
+ ErrNoGoPath = errors.New("GOPATH is unset")
+ ErrFileNotAllowedInMain = errors.New("include.File can't be called in package main")
+)
+
+type Opener interface {
+ Open() (io.ReadCloser, error)
+}
+
+type OpenerFunc func() (io.ReadCloser, error)
+
+func (opener OpenerFunc) Open() (io.ReadCloser, error) {
+ return opener()
+}
+
+// dependencies maps module names to module paths (name@version).
+var modPaths map[string]string
+
+func initSource() (err error) {
+ err = readModPaths()
+ if err != nil {
+ return
+ }
+ return
+}
+
+// readDependencies reads the name and version of all module dependencies and
+// stores them as a map of module name -> module path.
+func readModPaths() error {
+ buildInfo, ok := debug.ReadBuildInfo()
+ if !ok {
+ return ErrNoRuntime
+ }
+ goPath := os.Getenv("GOPATH")
+ if goPath == "" {
+ return ErrNoGoPath
+ }
+ workingPath, err := os.Getwd()
+ if err != nil {
+ return err
+ }
+ modPaths = make(map[string]string)
+ for _, dep := range buildInfo.Deps {
+ modPaths[dep.Path] = path.Join(goPath, fmt.Sprintf("%s@%s", dep.Path, dep.Version))
+ }
+ thisModPath := buildInfo.Main.Path
+ modPaths[thisModPath] = workingPath
+ return nil
+}
+
+// getPackagePath gets a path to a package on the filesystem based on its name.
+func getPackagePath(packageName string) (filepath string) {
+ for modName, modPath := range modPaths {
+ if packPath, ok := strings.CutPrefix(packageName, modName); ok {
+ return path.Join(modPath, packPath)
+ }
+ }
+ return
+}
+
+// openSource opens a file in package packageName on the filesystem.
+func openSource(packageName string, filepath string) (r io.ReadCloser, err error) {
+ ppath := getPackagePath(packageName)
+ if ppath == "" {
+ err = errors.New("tried to get source for unknown package " + packageName)
+ return
+ }
+ absPath := path.Join(ppath, filepath)
+ r, err = os.Open(absPath)
+ return
+}
+
+// File returns an Opener that Opens() a file relative to the calling package.
+func File(relativePath string, ignorePackages ...string) Opener {
+ var root string
+ var alwaysErr error
+ caller, err := getCallStackButt(ignorePackages)
+ if err != nil {
+ alwaysErr = err
+ } else {
+ root = path.Dir(caller)
+ }
+ return OpenerFunc(func() (io.ReadCloser, error) {
+ if alwaysErr != nil {
+ return nil, alwaysErr
+ }
+ return os.Open(path.Join(root, relativePath))
+ })
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package compile
+
+import (
+ "errors"
+ "fmt"
+ "html/template"
+ "maps"
+ "strings"
+
+ "git.earlybird.gay/mast-engine/htmltree"
+ "git.earlybird.gay/mast-engine/include"
+ "git.earlybird.gay/mast-engine/render"
+ "golang.org/x/net/html"
+)
+
+type Source interface {
+ Name() string
+ File() include.Opener
+ TemplateFuncs() template.FuncMap
+ OnLoad() render.OnLoadFunc
+ Includes() []Source
+}
+
+type Sources map[string]Source
+
+func mapSources(dst Sources, slice []Source) {
+ for _, source := range slice {
+ dst[source.Name()] = source
+ mapSources(dst, source.Includes())
+ }
+}
+
+type Result struct {
+ TemplateRaw string
+ TemplateFuncs template.FuncMap
+ TemplateDataLoader render.Loader
+}
+
+func insertSubSource(subSource Source, context *html.Node) (*computeNode, error) {
+ insertedId := render.ID()
+ computedName := fmt.Sprintf("%s_%s", snakeCase(subSource.Name()), insertedId)
+ // ===== CONTEXT PREPROCESSING =====
+ // Raise any fields pre-existing in the context to .parent.field.
+ raiseFields := make([]string, 0)
+ htmltree.Walk(context.FirstChild, func(n *html.Node) (bool, error) {
+ raiseFields = append(raiseFields, replaceTemplateFields(n)...)
+ return false, nil
+ })
+ // Remove :data attributes from the root of context, and prepare them
+ // to be used as data for the computeNode.
+ asData := removeDataAttrs(context)
+ // ===== SUBSOURCE PROCESSING =====
+ // Parse the subSource in the context of context.
+ // Require that subSource be contained in a template.
+ reader, err := subSource.File().Open()
+ if err != nil {
+ return nil, err
+ }
+ innerHTML, err := html.ParseFragment(reader, context)
+ if err != nil {
+ return nil, err
+ }
+ root := innerHTML[0]
+ if root.Type != html.ElementNode || root.Data != "template" {
+ return nil, errors.New("fragments must be contained in a template")
+ }
+
+ // Walk the tree to do a couple of things:
+ // - Replace template functions with namespaced functions.
+ // - Find slots in the subSource.
+ slots := make(map[string]*html.Node)
+ usedSlot := make(map[string]bool)
+ htmltree.Walk(root, func(n *html.Node) (bool, error) {
+ // Replace template functions with namespaced functions.
+ replaceTemplateFuncs(subSource, n)
+ // Find slots in the subSource.
+ if n.Type == html.ElementNode && n.Data == "slot" {
+ slotName := htmltree.GetAttr(n, "name")
+ if _, ok := slots[slotName]; ok {
+ return true, fmt.Errorf("found multiple slots named '%s'", slotName)
+ } else {
+ slots[slotName] = n
+ usedSlot[slotName] = false
+ }
+ }
+ return false, nil
+ })
+
+ // Mix stuff from the context into the template using slots...
+ n := context.FirstChild
+ for n != nil {
+ next := n.NextSibling
+ context.RemoveChild(n)
+ // Do not slot any non-slottable nodes, or comments, because I do not
+ // like them
+ if n.Type == html.CommentNode {
+ n = next
+ continue
+ }
+ slotName := htmltree.GetAttr(n, "slot")
+ slot := slots[slotName]
+ if slot != nil {
+ slot.Parent.InsertBefore(n, slot)
+ usedSlot[slotName] = true
+ } else {
+ root.AppendChild(n)
+ }
+ n = next
+ }
+
+ // ...then move content from the template to the context...
+ n = root.FirstChild
+ for n != nil {
+ next := n.NextSibling
+ root.RemoveChild(n)
+ context.AppendChild(n)
+ n = next
+ }
+
+ // ...then remove any slots that were used.
+ // For slots that aren't used, move up their data first.
+ htmltree.Walk(context, func(n *html.Node) (bool, error) {
+ if n.Type == html.ElementNode && n.Data == "slot" {
+ slotName := htmltree.GetAttr(n, "name")
+ slot := slots[slotName]
+ used := usedSlot[slotName]
+ if !used {
+ n = slot.FirstChild
+ for n != nil {
+ next := n.NextSibling
+ slot.RemoveChild(n)
+ slot.Parent.InsertBefore(n, slot)
+ n = next
+ }
+ }
+ slot.Parent.RemoveChild(slot)
+ }
+ return false, nil
+ })
+
+ // Generate a computeNode for this part.
+ compute := &computeNode{
+ name: computedName,
+ compute: subSource.OnLoad(),
+ asDataFromParent: asData,
+ raiseFromParent: raiseFields,
+ }
+
+ // Set ID and computed context, then generate a function that fulfills it
+ htmltree.SetAttr(context, "id", insertedId)
+ context.InsertBefore(&html.Node{
+ Type: html.TextNode,
+ Data: fmt.Sprintf("{{- with .computed.%s }}", computedName),
+ }, context.FirstChild)
+ context.InsertBefore(&html.Node{
+ Type: html.TextNode,
+ Data: "{{ end -}}",
+ }, nil)
+ return compute, nil
+}
+
+func Compile(root Source, transform ...func(root *html.Node)) (Result, error) {
+ var result Result
+ reader, err := root.File().Open()
+ if err != nil {
+ return result, err
+ }
+ document, err := html.Parse(reader)
+ if err != nil {
+ return result, err
+ }
+
+ fullDependencies := make(Sources)
+ mapSources(fullDependencies, root.Includes())
+ computeRoot := &computeNode{
+ name: "root",
+ compute: root.OnLoad(),
+ }
+
+ // gather global template funcs
+ // Start with the root's template, then add template funcs for all subsource
+ // with a namespace
+ templateFuncs := maps.Clone(root.TemplateFuncs())
+
+ var process func(n *html.Node, c *computeNode) error
+ process = func(n *html.Node, c *computeNode) error {
+ childComputeNode := c
+ siblingComputeNode := c
+ if n.Type == html.ElementNode {
+ if subSource, ok := fullDependencies[n.Data]; ok {
+ // Add template funcs
+ for fname, f := range subSource.TemplateFuncs() {
+ templateFuncs[snakeCase(n.Data)+"_"+fname] = f
+ }
+ // Parse HTML fragment and replace the content of the node with it
+ computeSubSource, err := insertSubSource(subSource, n)
+ if err != nil {
+ return err
+ }
+ c.children = append(c.children, computeSubSource)
+ childComputeNode = computeSubSource
+ }
+ }
+ var procErr error
+ if n.FirstChild != nil {
+ procErr = errors.Join(procErr, process(n.FirstChild, childComputeNode))
+ }
+ if n.NextSibling != nil {
+ procErr = errors.Join(procErr, process(n.NextSibling, siblingComputeNode))
+ }
+ return procErr
+ }
+ err = process(document, computeRoot)
+ if err != nil {
+ return result, err
+ }
+
+ for _, tf := range transform {
+ tf(document)
+ }
+
+ buf := new(strings.Builder)
+ err = html.Render(buf, document)
+ if err != nil {
+ return result, err
+ }
+ result = Result{
+ TemplateRaw: html.UnescapeString(buf.String()),
+ TemplateFuncs: templateFuncs,
+ TemplateDataLoader: computeRoot,
+ }
+ return result, err
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package compile
+
+import (
+ "fmt"
+ "net/http"
+ "reflect"
+ "strings"
+
+ "git.earlybird.gay/mast-engine/render"
+)
+
+type computeNode struct {
+ name string
+ compute render.OnLoadFunc
+ asDataFromParent map[string]string
+ raiseFromParent []string
+ children []*computeNode
+}
+
+func (root *computeNode) Compute(r *http.Request) (render.Data, error) {
+ impose := func(cData, pData render.Data, raise []string) {
+ for _, key := range raise {
+ cData.Set(key, pData.Get(key))
+ }
+ }
+ var f func(n *computeNode, data render.Data) error
+ f = func(n *computeNode, data render.Data) error {
+ n.compute(data)
+ computedData := make(render.Data)
+ for _, child := range n.children {
+ childData := render.NewData(r)
+ // Stuff here is available to the OnLoad AND renderer:
+ // Assign all data from parent
+ for dataKey, rawOrIdentifier := range child.asDataFromParent {
+ // Assume raw...
+ var val any = rawOrIdentifier
+ // ...but treat as an identifier if starts with .
+ if rawOrIdentifier[0] == '.' {
+ val = getVarFromData(data, rawOrIdentifier)
+ if val == nil {
+ return fmt.Errorf("key %s not found in passed data", rawOrIdentifier)
+ }
+ }
+ childData.Set(dataKey, val)
+ }
+ // Raise parent variables to the "parent" var
+ childParentData := make(render.Data)
+ impose(childParentData, data, child.raiseFromParent)
+ childData.Set("parent", childParentData)
+ if child.name != "" {
+ computedData.Set(child.name, childData)
+ }
+ f(child, childData)
+ // Stuff here is ONLY available to the renderer:
+ }
+ data.Set("computed", computedData)
+ return nil
+ }
+
+ data := render.NewData(r)
+ return data, f(root, data)
+}
+
+// Get a variable from data.
+// key must be of the form .x.y.z, and will try to get that value from data.
+func getVarFromData(data render.Data, key string) any {
+ var val any = data
+ keyStack := strings.Split(key, ".")[1:]
+
+findKey:
+ for val != nil && len(keyStack) > 0 {
+ key = keyStack[0]
+ keyStack = keyStack[1:]
+ refV := reflect.ValueOf(val)
+ refT := refV.Type()
+ refK := refT.Kind()
+
+ switch refK {
+ case reflect.Struct:
+ field := refV.FieldByName(key)
+ if !field.IsValid() {
+ val = nil
+ } else {
+ val = field.Interface()
+ }
+ case reflect.Map:
+ field := refV.MapIndex(reflect.ValueOf(key))
+ if !field.IsValid() {
+ val = nil
+ } else {
+ val = field.Interface()
+ }
+ default:
+ break findKey
+ }
+ }
+
+ return val
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package compile
+
+import "strings"
+
+// EXTREMELY lazy snake caser
+func snakeCase(s string) string {
+ return strings.ToLower(strings.Replace(s, "-", "_", -1))
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package compile
+
+import (
+ "regexp"
+ "strings"
+
+ "git.earlybird.gay/mast-engine/htmltree"
+ "golang.org/x/net/html"
+)
+
+const (
+ tokenOpenTemplate = "{{"
+ tokenCloseTemplate = "}}"
+)
+
+var funcRegexp = regexp.MustCompile(`^[a-zA-Z]\w*$`)
+var fieldRegexp = regexp.MustCompile(`^(?:.[a-zA-Z]\w*)+$`)
+
+func isFunc(token string) bool {
+ return funcRegexp.MatchString(token)
+}
+
+func isField(token string) bool {
+ return fieldRegexp.MatchString(token)
+}
+
+func replaceTemplateFuncs(source Source, n *html.Node) {
+ var done, inTemplate bool
+ var datas []string
+ var sets []func(string)
+
+ switch n.Type {
+ case html.TextNode:
+ datas = append(datas, n.Data)
+ sets = append(sets, func(s string) {
+ n.Data = s
+ })
+ case html.ElementNode:
+ for _, attr := range n.Attr {
+ datas = append(datas, attr.Val)
+ sets = append(sets, func(s string) {
+ htmltree.SetAttr(n, attr.Key, s)
+ })
+ }
+ }
+ for i, data := range datas {
+ var output []string
+ for {
+ endToken := strings.Index(data, " ")
+ if endToken == -1 {
+ endToken = len(data)
+ done = true
+ }
+ token := data[:endToken]
+
+ // Track when we're in a template using open/close brackets
+ if token == tokenOpenTemplate {
+ inTemplate = true
+ }
+ if token == tokenCloseTemplate {
+ inTemplate = false
+ }
+ // If we're in a template and found a function identifier, replace it
+ // with a namespaced version
+ if inTemplate && isFunc(token) {
+ // Skip anything that the target source doesn't have as a templatefunc
+ if _, ok := source.TemplateFuncs()[token]; ok {
+ token = snakeCase(source.Name()) + "_" + token
+ }
+ }
+
+ output = append(output, token)
+ if done {
+ break
+ }
+ data = data[endToken+1:]
+ }
+ sets[i](strings.Join(output, " "))
+ }
+}
+
+// Sets template fields (.field) in any template strings in this node to
+// .parent.field.
+// Returns a list of raised fields.
+func replaceTemplateFields(n *html.Node) []string {
+ var done, inTemplate, inAttrs bool
+ var datas []string
+ var isDataAttr []bool
+ var sets []func(string)
+ var raised []string
+
+ switch n.Type {
+ case html.TextNode:
+ datas = append(datas, n.Data)
+ sets = append(sets, func(s string) {
+ n.Data = s
+ })
+ case html.ElementNode:
+ inAttrs = true
+ for _, attr := range n.Attr {
+ datas = append(datas, attr.Val)
+ isDataAttr = append(isDataAttr, attr.Key[0] == ':')
+ sets = append(sets, func(s string) {
+ htmltree.SetAttr(n, attr.Key, s)
+ })
+ }
+ }
+ for i, data := range datas {
+ var output []string
+ for {
+ endToken := strings.Index(data, " ")
+ if endToken == -1 {
+ endToken = len(data)
+ done = true
+ }
+ token := data[:endToken]
+
+ // Track when we're in a template using open/close brackets
+ if token == tokenOpenTemplate {
+ inTemplate = true
+ }
+ if token == tokenCloseTemplate {
+ inTemplate = false
+ }
+ // If we're in a template and found a function identifier, replace it
+ // with a namespaced version
+ if inTemplate && isField(token) ||
+ inAttrs && isDataAttr[i] {
+ raised = append(raised, strings.Split(token, ".")[1])
+ token = ".parent" + token
+ }
+
+ output = append(output, token)
+ if done {
+ break
+ }
+ data = data[endToken+1:]
+ }
+ sets[i](strings.Join(output, " "))
+ }
+
+ return raised
+}
+
+// Removes data attributes :name.
+// Returns a map attr->val of the removed data attributes (: removed).
+func removeDataAttrs(n *html.Node) map[string]string {
+ if n.Type != html.ElementNode {
+ return nil
+ }
+ dataAttrs := make(map[string]string)
+ for i := 0; i < len(n.Attr); {
+ attr := n.Attr[i]
+ if attr.Key[0] == ':' {
+ dataAttrs[attr.Key[1:]] = attr.Val
+ n.Attr = append(n.Attr[:i], n.Attr[i+1:]...)
+ } else {
+ i++
+ }
+ }
+ return dataAttrs
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package page
+
+import (
+ "html/template"
+
+ "git.earlybird.gay/mast-engine/htmltree"
+ "git.earlybird.gay/mast-engine/include"
+ "git.earlybird.gay/mast-engine/internal/compile"
+ "git.earlybird.gay/mast-engine/part"
+ "git.earlybird.gay/mast-engine/render"
+)
+
+type Page struct {
+ name string
+ source include.Opener
+ raw string
+
+ parts []*part.Part
+ onLoad render.OnLoadFunc
+ indent string
+
+ template *template.Template
+ templateFuncs template.FuncMap
+ templateLoad render.Loader
+}
+
+type Config func(*Page)
+
+func Funcs(funcs template.FuncMap) Config {
+ return func(p *Page) {
+ for name, f := range funcs {
+ p.templateFuncs[name] = f
+ }
+ }
+}
+
+func Includes(parts ...*part.Part) Config {
+ return func(p *Page) {
+ p.parts = parts
+ }
+}
+
+func OnLoad(f func(data render.Data) error) Config {
+ return func(p *Page) {
+ p.onLoad = f
+ }
+}
+
+func Pretty(indent string) Config {
+ return func(p *Page) {
+ p.indent = indent
+ }
+}
+
+func New(name string, source string, optional ...func(*Page)) *Page {
+ p := new(Page)
+ // Assign basic parameters
+ p.name = name
+ p.source = include.File(source, "git.earlybird.gay/mast-engine/page")
+ p.onLoad = func(d render.Data) error {
+ return nil
+ }
+ p.templateFuncs = make(template.FuncMap)
+ // Run optional arguments
+ for _, of := range optional {
+ of(p)
+ }
+ // parse
+ // compile from assembled sources
+ sourceTransform := htmltree.Minify()
+ if p.indent != "" {
+ sourceTransform = htmltree.Prettify(p.indent)
+ }
+ result, err := compile.Compile(p, sourceTransform)
+ if err != nil {
+ panic(err)
+ }
+ p.raw = result.TemplateRaw
+ p.templateLoad = result.TemplateDataLoader
+
+ // templatize
+ p.template, err = template.New(p.name).
+ Funcs(result.TemplateFuncs).
+ Parse(result.TemplateRaw)
+ if err != nil {
+ panic(err)
+ }
+ return p
+}
+
+// Getters
+// These are mostly to implement interfaces that make pages usable around the
+// project.
+
+func (p *Page) Name() string {
+ return p.name
+}
+
+func (p *Page) File() include.Opener {
+ return p.source
+}
+
+func (p *Page) TemplateFuncs() template.FuncMap {
+ return p.templateFuncs
+}
+
+func (p *Page) OnLoad() render.OnLoadFunc {
+ return p.onLoad
+}
+
+func (p *Page) Includes() []compile.Source {
+ cast := make([]compile.Source, len(p.parts))
+ for i, child := range p.parts {
+ cast[i] = child
+ }
+ return cast
+}
+
+func (p *Page) Raw() string {
+ return p.raw
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package page
+
+import (
+ "net/http"
+)
+
+func (p *Page) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+ data, err := p.templateLoad.Compute(r)
+ if err != nil {
+ panic(err)
+ }
+ err = p.template.Execute(w, data)
+ if err != nil {
+ panic(err)
+ }
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package part
+
+import (
+ "text/template"
+
+ "git.earlybird.gay/mast-engine/include"
+ "git.earlybird.gay/mast-engine/internal/compile"
+ "git.earlybird.gay/mast-engine/render"
+)
+
+type Part struct {
+ name string
+ source include.Opener
+
+ parts []*Part
+ onLoad render.OnLoadFunc
+ templateFuncs template.FuncMap
+}
+
+type Config func(*Part)
+
+func Funcs(funcs template.FuncMap) Config {
+ return func(p *Part) {
+ for name, f := range funcs {
+ p.templateFuncs[name] = f
+ }
+ }
+}
+
+func Includes(parts ...*Part) Config {
+ return func(p *Part) {
+ p.parts = parts
+ }
+}
+
+func OnLoad(f func(data render.Data) error) Config {
+ return func(p *Part) {
+ p.onLoad = f
+ }
+}
+
+func New(name string, source string, optional ...func(*Part)) *Part {
+ p := new(Part)
+ // Assign basic parameters
+ p.name = name
+ p.source = include.File(source, "git.earlybird.gay/mast-engine/part")
+ p.onLoad = func(d render.Data) error {
+ return nil
+ }
+ p.templateFuncs = make(template.FuncMap)
+ // Run optional arguments
+ for _, of := range optional {
+ of(p)
+ }
+ return p
+}
+
+func (p *Part) Name() string {
+ return p.name
+}
+
+func (p *Part) File() include.Opener {
+ return p.source
+}
+
+func (p *Part) TemplateFuncs() template.FuncMap {
+ return p.templateFuncs
+}
+
+func (p *Part) OnLoad() render.OnLoadFunc {
+ return p.onLoad
+}
+
+func (p *Part) Includes() []compile.Source {
+ cast := make([]compile.Source, len(p.parts))
+ for i, child := range p.parts {
+ cast[i] = child
+ }
+ return cast
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package part
+
+type Parts []*Part
+
+func (p Parts) GetChild(i int) *Part {
+ if i >= 0 && i < len(p) {
+ return p[i]
+ }
+ return nil
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package render
+
+import (
+ "net/http"
+ "regexp"
+)
+
+var keyRegexp = regexp.MustCompile(`^[a-zA-Z]\w+$`)
+
+type Data map[string]any
+
+func NewData(r *http.Request) Data {
+ d := make(Data)
+ d.Set("request", r)
+ return d
+}
+
+func (d Data) Get(key string) any {
+ return d[key]
+}
+
+// Set sets key to value.
+// Any key may only be set *once*. Trying to set it again will panic.
+func (d Data) Set(key string, value any) {
+ if !keyRegexp.MatchString(key) {
+ panic("key " + key + " is not valid")
+ }
+ if _, ok := d[key]; ok {
+ panic("key " + key + " already set")
+ }
+ d[key] = value
+}
+
+type OnLoadFunc func(Data) error
+type Loader interface {
+ Compute(r *http.Request) (Data, error)
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package render
+
+import "math/rand/v2"
+
+const charset = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+
+func ID() string {
+ id := make([]byte, 8)
+ id[0] = charset[rand.Int()%52]
+ for i := range 7 {
+ id[i+1] = charset[rand.Int()%62]
+ }
+ return string(id)
+}
--- /dev/null
+// Copyright (C) 2024 early (LGPL)
+package engine
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ "net/http"
+ "os"
+ "os/signal"
+ "sync"
+ "syscall"
+)
+
+func Run(handler http.Handler) error {
+ fmt.Println("starting app")
+
+ wg := new(sync.WaitGroup)
+ errc := make(chan error, 1)
+
+ // Start main HTTP server
+ serv := new(http.Server)
+ serv.Addr = "0.0.0.0:3000"
+ serv.Handler = handler
+ wg.Add(1)
+ go func() {
+ err := serv.ListenAndServe()
+ if !errors.Is(err, http.ErrServerClosed) {
+ errc <- err
+ }
+ wg.Done()
+ }()
+ fmt.Println("app available")
+
+ // Listening channel for interrupts
+ sigc := make(chan os.Signal, 1)
+ signal.Notify(sigc, syscall.SIGINT, syscall.SIGTERM)
+
+ // Await a reason to terminate application
+ wg.Add(1)
+ go func() {
+ await:
+ for {
+ select {
+ case sig := <-sigc:
+ fmt.Println("received OS signal, shutting down", "signal", sig.String())
+ break await
+ case err := <-errc:
+ fmt.Println("application encountered a fatal error", "detail", err.Error())
+ break await
+ }
+ }
+ // This may have happened already, but we need to be sure.
+ serv.Shutdown(context.Background())
+ wg.Done()
+ }()
+
+ wg.Wait()
+ fmt.Println("application shut down")
+ return nil
+}
projects / today / commitdiff