From 1ff241a74eeedd53d9d3b25a475ab55156876600 Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Sat, 2 Oct 2021 15:12:57 -0700 Subject: [PATCH] Initial Commit --- .gitignore | 2 + LICENSE | 621 ++++++++++++++++++++++++++++++++++++++++ README.md | 27 ++ amu.go | 61 ++++ ast/ast.go | 160 +++++++++++ cmd/amu/main.go | 52 ++++ cmd/amulive/accel.go | 35 +++ cmd/amulive/file.go | 142 +++++++++ cmd/amulive/main.go | 308 ++++++++++++++++++++ formatter/html/html.go | 264 +++++++++++++++++ go.mod | 22 ++ go.sum | 71 +++++ internal/stack/stack.go | 64 +++++ parser/code.go | 85 ++++++ parser/common.go | 55 ++++ parser/heading.go | 31 ++ parser/image.go | 86 ++++++ parser/list.go | 143 +++++++++ parser/para.go | 223 +++++++++++++++ parser/parser.go | 197 +++++++++++++ scanner/scanner.go | 294 +++++++++++++++++++ test.amu | 57 ++++ 22 files changed, 3000 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 amu.go create mode 100644 ast/ast.go create mode 100644 cmd/amu/main.go create mode 100644 cmd/amulive/accel.go create mode 100644 cmd/amulive/file.go create mode 100644 cmd/amulive/main.go create mode 100644 formatter/html/html.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 internal/stack/stack.go create mode 100644 parser/code.go create mode 100644 parser/common.go create mode 100644 parser/heading.go create mode 100644 parser/image.go create mode 100644 parser/list.go create mode 100644 parser/para.go create mode 100644 parser/parser.go create mode 100644 scanner/scanner.go create mode 100644 test.amu diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..451fcd2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/amu +/amulive \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ed990f8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,621 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..42a6dad --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# AMU + +AMU is a human readable markup language I made for my own uses and to learn. It is the first lexer and parser that I have written by hand. + +--- + +### Purpose + +The purpose of this project is to create a markup language for my own use. I will use this primarily for quickly writing simple documents, for example, taking notes in class or doing some quick homework. It fulfills all my needs and I will add things as I need them. There are functions for extensibility when adding a new thing to parse is not justified. + +--- + +### Usage + +This repo is a library for parsing AMU. It can be imported and used like any other go library. In `cmd`, there are binaries for interacting with AMU. `cmd/amu` contains a command line program that takes a file with AMU or reads from stdin and outputs HTML. In `cmd/amulive`, there is a Gtk app that provides a real-time preview of the document on the right with a text box on the left. + +--- + +### Syntax + +The syntax for most of AMU's features can be seen in test.amu in this repo. + +--- + +### Performance + +Timing this program using the test file, I consistently get 4ms run time on my XPS 13. This is much faster than the projects I have made before for a similar purpose, although it is likely unnoticeable for most people. \ No newline at end of file diff --git a/amu.go b/amu.go new file mode 100644 index 0000000..41a3203 --- /dev/null +++ b/amu.go @@ -0,0 +1,61 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +// Package amu provides convenience functions for converting amu source to HTML +package amu + +import ( + "bytes" + "io" + "strings" + + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/formatter/html" + "go.arsenm.dev/amu/parser" +) + +// Funcs stores functions for use in amu +var Funcs = ast.FuncMap{} + +// ToHTML parses the contents of r and formats it as HTML +func ToHTML(r io.Reader) (string, error) { + // Create new AMU parser + p := parser.New(r) + + // Parse into AST + AST, err := p.Parse() + if err != nil { + return "", err + } + + // Create new HTML formatter with AST and Funcs + formatter := html.NewFormatter(AST, Funcs) + + // Return formatted source + return formatter.Format(), nil +} + +// StringToHTML parses s and formats it as HTML +func StringToHTML(s string) (string, error) { + return ToHTML(strings.NewReader(s)) +} + +// BytesToHTML parses the contents of b and formats it as HTML +func BytesToHTML(b []byte) (string, error) { + return ToHTML(bytes.NewReader(b)) +} diff --git a/ast/ast.go b/ast/ast.go new file mode 100644 index 0000000..704bb39 --- /dev/null +++ b/ast/ast.go @@ -0,0 +1,160 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +package ast + +import "fmt" + +// FormatType represents the type of +// formatting to be done on a string +type FormatType int + +const ( + FormatTypeBold FormatType = iota + FormatTypeItalic + FormatTypeMath + FormatTypeCode + FormatTypeStrike +) + +// AST is the root of the Abstract Syntax Tree for AMU +type AST struct { + Entries []Entry +} + +// Entry represents a single entry in the AST +type Entry struct { + Heading *Heading + Image *Image + List *List + Code *Code + Para *Para + Break *Break + Hline *Hline +} + +// Break represents a line break +type Break struct{} + +// Hline represents a horizontal line +type Hline struct{} + +// Heading represents a heading +type Heading struct { + Level int + Content *Para +} + +// Image represents an image with alternate text +// in case it fails to load and a clickable link +type Image struct { + Alternate string + Source string + Link string +} + +// List represents a list of items +type List struct { + Type string + Items []ListItem +} + +// ListItem represents an item +// with a level in a list +type ListItem struct { + Level int + Content []*Para +} + +// Code represents source code to be +// highlighted. +type Code struct { + Language string + Style string + Text string +} + +// Para represents a paragraph +type Para struct { + Fragments []ParaFragment +} + +// ParaFragment represents parts of +// a paragraph which may or may not +// be text +type ParaFragment struct { + Word *string + Whitespace *string + Punct *string + Link *Link + Format *Format + Func *Func +} + +// Link represents a hyperlink +type Link struct { + Link string + Text string +} + +// Format represents formatted text +type Format struct { + Types []FormatType + Text string +} + +// Func represents a function call +type Func struct { + Name string + Args []string +} + +// Funcs represents a place from which to retrieve +// functions for calls +type Funcs interface { + Set(string, func([]string) string) + Get(string) (func([]string) string, error) + Run(string, []string) string +} + +// FuncMap is an implementation of Funcs using a map +type FuncMap map[string]func([]string) string + +// Set adds a fucntion to the map +func (fm FuncMap) Set(name string, fn func([]string) string) { + fm[name] = fn +} + +// Get gets a function from the map +func (fm FuncMap) Get(name string) (func([]string) string, error) { + // Get function + fn, ok := fm[name] + // If does not exist + if !ok { + // Return error + return nil, fmt.Errorf("func %s does not exist", name) + } + // Return function + return fn, nil +} + +// Run runs a function in the map +func (fm FuncMap) Run(name string, args []string) string { + // Return output of function + return fm[name](args) +} diff --git a/cmd/amu/main.go b/cmd/amu/main.go new file mode 100644 index 0000000..689b464 --- /dev/null +++ b/cmd/amu/main.go @@ -0,0 +1,52 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +package main + +import ( + "fmt" + "log" + "os" + + "go.arsenm.dev/amu" +) + +func main() { + var src *os.File + // Get source file based on arguments + if len(os.Args) < 2 { + src = os.Stdin + } else { + // Open file in first argument + file, err := os.Open(os.Args[1]) + if err != nil { + log.Fatalln(err) + } + // Set source to file + src = file + } + + // Convert source to HTML + html, err := amu.ToHTML(src) + if err != nil { + log.Fatalln(err) + } + + // Print output HTML + fmt.Println(html) +} \ No newline at end of file diff --git a/cmd/amulive/accel.go b/cmd/amulive/accel.go new file mode 100644 index 0000000..a2fcde9 --- /dev/null +++ b/cmd/amulive/accel.go @@ -0,0 +1,35 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +package main + +import "github.com/gotk3/gotk3/gtk" + +type AccelGroup struct { + *gtk.AccelGroup +} + +func NewAccel() (*AccelGroup, error) { + gtkAg, err := gtk.AccelGroupNew() + return &AccelGroup{AccelGroup: gtkAg}, err +} + +func (ag *AccelGroup) Add(acc string, f interface{}) { + key, mods := gtk.AcceleratorParse(acc) + ag.Connect(key, mods, gtk.ACCEL_VISIBLE, f) +} \ No newline at end of file diff --git a/cmd/amulive/file.go b/cmd/amulive/file.go new file mode 100644 index 0000000..e1b29d8 --- /dev/null +++ b/cmd/amulive/file.go @@ -0,0 +1,142 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +package main + +import ( + "io/ioutil" + "os" + + "github.com/gotk3/gotk3/gtk" + sourceview "github.com/linuxerwang/sourceview3" +) + +// saveFile opens a file selection dialog if the file has not already +// been saved and saves the current buffer contents at the chosen filename +func saveFile(win gtk.IWindow, buf *sourceview.SourceBuffer) error { + // If no opened file + if openedFile == "" { + // Create new file chooser dialog with two buttons + fcd, err := gtk.FileChooserDialogNewWith2Buttons( + "Save", + win, + gtk.FILE_CHOOSER_ACTION_SAVE, + "Cancel", + gtk.RESPONSE_CANCEL, + "Save", + gtk.RESPONSE_APPLY, + ) + if err != nil { + return err + } + // Do not destroy dialog with parent + fcd.SetDestroyWithParent(false) + // Create new file filter + amuFilter, err := gtk.FileFilterNew() + if err != nil { + return err + } + // Add pattern to filter + amuFilter.AddPattern("*.amu") + // Add filter to dialog + fcd.AddFilter(amuFilter) + // Run dialog + fcdRt := fcd.Run() + if fcdRt == gtk.RESPONSE_APPLY { + // Set openedFile to chosen filename + openedFile = fcd.GetFilename() + } else { + // Destroy dialog + fcd.Destroy() + // Return no error + return nil + } + // Destroy dialog + fcd.Destroy() + } + + // Create chosen file + file, err := os.Create(openedFile) + if err != nil { + return err + } + // Get text from source buffer + amu, err := buf.GetText(buf.GetStartIter(), buf.GetEndIter(), true) + if err != nil { + return err + } + // Wtite text to file + _, err = file.Write([]byte(amu)) + if err != nil { + return err + } + // Set buffer modified to false + buf.SetModified(false) + return nil +} + +// openFile loads the contents of the chosen file into the buffer +func openFile(win gtk.IWindow, buf *sourceview.SourceBuffer) error { + // Create new file chooser dialog with two buttons + fcd, err := gtk.FileChooserDialogNewWith2Buttons( + "Open", + win, + gtk.FILE_CHOOSER_ACTION_SAVE, + "Cancel", + gtk.RESPONSE_CANCEL, + "Open", + gtk.RESPONSE_APPLY, + ) + if err != nil { + return err + } + // Do not destroy dialog with parent + fcd.SetDestroyWithParent(false) + // Create new file filter + amuFilter, err := gtk.FileFilterNew() + if err != nil { + return err + } + // Add pattern to file filter + amuFilter.AddPattern("*.amu") + // Add file filter to dialog + fcd.AddFilter(amuFilter) + // Run dialog + respType := fcd.Run() + if respType == gtk.RESPONSE_APPLY { + // Set openedFile to chosen filename + openedFile = fcd.GetFilename() + } else { + // Destroy dialog + fcd.Destroy() + // Return no error + return nil + } + // Destroy dialog + fcd.Destroy() + // Read opened file + data, err := ioutil.ReadFile(openedFile) + if err != nil { + return err + } + // Set text in buffer + buf.SetText(string(data)) + // Set buffer modified to false + buf.SetModified(false) + return nil +} diff --git a/cmd/amulive/main.go b/cmd/amulive/main.go new file mode 100644 index 0000000..781245b --- /dev/null +++ b/cmd/amulive/main.go @@ -0,0 +1,308 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +package main + +import ( + //"fmt" + + "encoding/json" + "fmt" + "io/ioutil" + "os" + "runtime" + "strings" + + "github.com/gotk3/gotk3/glib" + "github.com/gotk3/gotk3/gtk" + sourceview "github.com/linuxerwang/sourceview3" + "github.com/pkg/browser" + "github.com/rs/zerolog" + "github.com/rs/zerolog/log" + "github.com/sourcegraph/go-webkit2/webkit2" + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/formatter/html" + "go.arsenm.dev/amu/parser" +) + +func init() { + log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr}) +} + +var head = ` + + + + +` + +const document = ` + +%s +%s +` + +var openedFile string + +func main() { + // Lock goroutine to current thread for Gtk + runtime.LockOSThread() + + // Initialize Gtk + gtk.Init(nil) + + // Create new Gtk window + window, err := gtk.WindowNew(gtk.WINDOW_TOPLEVEL) + if err != nil { + log.Fatal().Err(err).Msg("Unable to create window") + } + // Set window title + window.SetTitle("AMULive") + // Stop Gtk main loop when window destroyed + window.Connect("destroy", gtk.MainQuit) + + // Create new horizontal box layout with 6px padding + layout, err := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 6) + if err != nil { + log.Fatal().Err(err).Msg("Unable to create box") + } + // Add layout to window + window.Add(layout) + + // Create new scrolled winfow + textScrollWindow, err := gtk.ScrolledWindowNew(nil, nil) + if err != nil { + log.Fatal().Err(err).Msg("Unable to create scrolled window") + } + // Create new source view + srcView, err := sourceview.SourceViewNew() + if err != nil { + log.Fatal().Err(err).Msg("Unable to create text virw") + } + // Set tab width to 4 + srcView.SetProperty("tab-width", uint(4)) + // Set auto indent to true + srcView.SetProperty("auto-indent", true) + // Set show line numbers to true + srcView.SetShowLineNumbers(true) + // Set left margin to 8 (separates text from line numbers) + srcView.SetLeftMargin(8) + // Set monospace to true + srcView.SetMonospace(true) + // Set wrap mode to wrap word char (3) + srcView.SetWrapMode(gtk.WRAP_WORD_CHAR) + // Add text to scrolled window + textScrollWindow.Add(srcView) + // Add scrolled window to layout with no padding + layout.PackStart(textScrollWindow, true, true, 0) + + // Get source view style context + styleCtx, err := srcView.GetStyleContext() + if err != nil { + log.Fatal().Err(err).Msg("Unable to get style context of text view") + } + // Get style background color + bgCol, err := styleCtx.GetProperty("background-color", gtk.STATE_FLAG_NORMAL) + if err != nil { + log.Fatal().Err(err).Msg("Unable to get background-color property of style context") + } + // Get style foreground color + fgCol := styleCtx.GetColor(gtk.STATE_FLAG_NORMAL) + // Expand head tag template + head = fmt.Sprintf(head, fgCol, bgCol) + + // Create new webview + webkit := webkit2.NewWebView() + // Enable devtools in webview + webkit.Settings().SetProperty("enable-developer-extras", true) + // Load empty base HTML document + webkit.LoadHTML(fmt.Sprintf(document, head, ""), "amu") + // Add webview to layout with no padding + layout.PackStart(webkit, true, true, 0) + + // Get source view buffer + srcBuf, err := srcView.GetBuffer() + if err != nil { + log.Fatal().Err(err).Msg("Error getting buffer from text view") + } + + // On source view change + srcBuf.Connect("changed", func() { + loadAMU(srcBuf, webkit) + }) + + // On load change + webkit.Connect("load-changed", func(_ *glib.Object, le webkit2.LoadEvent) { + switch le { + case webkit2.LoadStarted, webkit2.LoadCommitted, webkit2.LoadRedirected: + // Get current webview URL + curURL := webkit.URI() + // If url is not "amu" + if curURL != "amu" { + // Stop loading + webkit.RunJavaScript("window.stop();", nil) + // Open URL in browser concurrently + go browser.OpenURL(curURL) + // Load base HTML + webkit.LoadHTML(fmt.Sprintf(document, head, ""), "amu") + } + case webkit2.LoadFinished: + // If URL is "amu" + if webkit.URI() == "amu" { + // Load AMU from source buffer + loadAMU(srcBuf, webkit) + } + } + }) + + // Create new accelerator group + accelGroup, err := NewAccel() + if err != nil { + log.Fatal().Err(err).Msg("Error creating accelerator group") + } + + // Set Ctrl+P to print via JavaScript + accelGroup.Add("p", func() { + webkit.RunJavaScript("window.print();", nil) + }) + + // Set Ctrl+S to save file + accelGroup.Add("s", func() { + err := saveFile(window, srcBuf) + if err != nil { + log.Error().Err(err).Msg("Error saving file") + } + }) + + // Set Ctrl+O to open file + accelGroup.Add("o", func() { + err := openFile(window, srcBuf) + if err != nil { + log.Error().Err(err).Msg("Error opening file") + } + }) + + // Add underlying gtk accelerator group to window + window.AddAccelGroup(accelGroup.AccelGroup) + + // On window delete event + window.Connect("delete-event", func() bool { + // If source buffer not modified + if !srcBuf.GetModified() { + // Close window + return false + } + // Create confirmation dialog + dlg := gtk.MessageDialogNew( + window, + gtk.DIALOG_MODAL, + gtk.MESSAGE_WARNING, + gtk.BUTTONS_YES_NO, + "Are you sure you want to close?\nYou have unsaved changes.", + ) + // Run confirmation dialog and get response + respType := dlg.Run() + dlg.Close() + switch respType { + case gtk.RESPONSE_YES: + return false + case gtk.RESPONSE_NO: + return true + } + return true + }) + + if len(os.Args) > 1 { + openedFile = os.Args[1] + data, err := ioutil.ReadFile(openedFile) + if err != nil { + log.Fatal().Err(err).Msg("Error opening start file") + } + srcBuf.SetText(string(data)) + srcBuf.SetModified(false) + } + + window.SetDefaultSize(800, 600) + window.ShowAll() + gtk.Main() +} + +func loadAMU(srcBuf *sourceview.SourceBuffer, webkit *webkit2.WebView) { + // Get all text in buffer + src, err := srcBuf.GetText(srcBuf.GetStartIter(), srcBuf.GetEndIter(), true) + if err != nil { + log.Error().Err(err).Msg("Error getting amu source from text view") + return + } + + p := parser.New(strings.NewReader(src)) + AST, err := p.Parse() + if err != nil { + log.Error().Err(err).Msg("Error parsing amu source") + return + } + + formatter := html.NewFormatter(AST, ast.FuncMap{}) + + // Execute source from buffer + html := formatter.Format() + + // Generate full HTML document and encode as JSON for JavaScript + data, err := json.Marshal(html) + if err != nil { + log.Error().Err(err).Msg("Error marshaling string as JSON") + return + } + + // Update webview document + webkit.RunJavaScript(fmt.Sprintf(`document.body.innerHTML = %s; renderMathInElement(document.body);`, data), nil) +} diff --git a/formatter/html/html.go b/formatter/html/html.go new file mode 100644 index 0000000..58093fa --- /dev/null +++ b/formatter/html/html.go @@ -0,0 +1,264 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +package html + +import ( + "bytes" + "fmt" + "strings" + + "github.com/alecthomas/chroma" + "github.com/alecthomas/chroma/formatters/html" + "github.com/alecthomas/chroma/lexers" + "github.com/alecthomas/chroma/styles" + "go.arsenm.dev/amu/ast" +) + +// HTMLFormatter formats an AMU AST into HTML source +type HTMLFormatter struct { + Funcs ast.Funcs + ast *ast.AST + out *bytes.Buffer +} + +// NewFormatter creates a new HTML formatter using the proided AST and functions +func NewFormatter(ast *ast.AST, funcs ast.Funcs) *HTMLFormatter { + return &HTMLFormatter{ast: ast, Funcs: funcs, out: &bytes.Buffer{}} +} + +// formatPara formats a paragraph from the AST into HTML +func (h *HTMLFormatter) formatPara(para *ast.Para, includeTags bool) { + // If tags are to be included + if includeTags { + // Write opening p tag to buffer + h.out.WriteString("

") + } + // For every fragment in paragraph + for _, fragment := range para.Fragments { + if fragment.Word != nil { + // Write word to buffer + h.out.WriteString(*fragment.Word) + } else if fragment.Whitespace != nil { + // Write whitespace to buffer + h.out.WriteString(*fragment.Whitespace) + } else if fragment.Punct != nil { + // Write punctuatuon to buffer + h.out.WriteString(*fragment.Punct) + } else if fragment.Format != nil { + // For every format type, write appropriate opening tag to buffer + for _, ftype := range fragment.Format.Types { + if ftype == ast.FormatTypeBold { + h.out.WriteString("") + } + if ftype == ast.FormatTypeItalic { + h.out.WriteString("") + } + if ftype == ast.FormatTypeCode { + h.out.WriteString("") + } + if ftype == ast.FormatTypeStrike { + h.out.WriteString(``) + } + if ftype == ast.FormatTypeMath { + h.out.WriteString(`\(`) + } + } + + // Write format text to buffer + h.out.WriteString(fragment.Format.Text) + + // For every format type, write appropriate closing tag to buffer in reverse + for i := len(fragment.Format.Types) - 1; i >= 0; i-- { + ftype := fragment.Format.Types[i] + if ftype == ast.FormatTypeBold { + h.out.WriteString("") + } + if ftype == ast.FormatTypeItalic { + h.out.WriteString("") + } + if ftype == ast.FormatTypeCode { + h.out.WriteString("") + } + if ftype == ast.FormatTypeStrike { + h.out.WriteString(``) + } + if ftype == ast.FormatTypeMath { + h.out.WriteString(`\)`) + } + } + } else if fragment.Func != nil { + // Attempt to get requested function + fn, err := h.Funcs.Get(fragment.Func.Name) + if err != nil { + // Write error text to function + h.out.WriteString("Error running function: " + err.Error()) + // Continue to next AST entry + continue + } + // Write output of function to buffer + h.out.WriteString(fn(fragment.Func.Args)) + } else if fragment.Link != nil { + // Write link to buffer + fmt.Fprintf(h.out, `%s`, fragment.Link.Link, fragment.Link.Text) + } + } + // If tags are to be included + if includeTags { + // Write closing p tag to buffer + h.out.WriteString("

") + } +} + +// Format formats the provided AST into an HTML string +func (h *HTMLFormatter) Format() string { + // For every entry in AST + for _, entry := range h.ast.Entries { + if entry.Heading != nil { + // Write opening heading tag + fmt.Fprintf(h.out, "", entry.Heading.Level) + // Format paragraph with heading content without tags + h.formatPara(entry.Heading.Content, false) + // Write closing heading tag + fmt.Fprintf(h.out, "", entry.Heading.Level) + } else if entry.Para != nil { + // Format paragraph with tags + h.formatPara(entry.Para, true) + } else if entry.Image != nil { + // If image link exists + if entry.Image.Link != "" { + // Write opening link tag + fmt.Fprintf(h.out, ``, entry.Image.Link) + } + // Weite image tag + fmt.Fprintf(h.out, `%s`, entry.Image.Source, entry.Image.Alternate) + // If image link exists + if entry.Image.Link != "" { + // Write closing link tag + h.out.WriteString("") + } + } else if entry.List != nil { + var openTag, closeTag string + // Set opening and closing tags depending on list type + switch entry.List.Type { + case "unordered": + openTag = "
    " + closeTag = "
" + case "ordered": + openTag = "
    " + closeTag = "
" + default: + // Write unknown list type + h.out.WriteString("unknown list type " + entry.List.Type) + // Continue to next entry + continue + } + + // Create variables for keeping track of list state + lastLevel := 0 + openLists := 0 + + for _, item := range entry.List.Items { + if item.Level > lastLevel { + // Get amount of lists to open + amtOpen := item.Level - lastLevel + // Increment openLists by amount + openLists += amtOpen + // Write opening tag the amount of times required + h.out.WriteString(strings.Repeat(openTag, amtOpen)) + // Set lastLevel + lastLevel = item.Level + } else if item.Level < lastLevel { + // Get amount of lists to close + amtClose := lastLevel - item.Level + // DEcrement openLists by amount + openLists -= amtClose + // Write closing tag the amount of times required + h.out.WriteString(strings.Repeat(closeTag, amtClose)) + // Set lastLevel + lastLevel = item.Level + } + // If content exists + if len(item.Content) > 0 { + // Write opening list item tag to output + h.out.WriteString("
  • ") + // Format content as paragraph + h.formatPara(item.Content[0], true) + // Write closing list item tag to output + h.out.WriteString("
    • ") + // For every line other than the first + for _, line := range item.Content[1:] { + // Format content as paragraph + h.formatPara(line, true) + } + } + } + + // Close all open lists + h.out.WriteString(strings.Repeat(closeTag, openLists)) + } else if entry.Code != nil { + // Get lexer for provided language + lexer := lexers.Get(entry.Code.Language) + if lexer == nil { + lexer = lexers.Fallback + } + // Coalesce lexer tokens + lexer = chroma.Coalesce(lexer) + // Tokenise provided source using lexer + iterator, err := lexer.Tokenise(nil, entry.Code.Text) + if err != nil { + h.out.WriteString("Error tokenising code: " + err.Error()) + continue + } + + // Create new HTML formatter + formatter := html.New( + html.Standalone(false), + html.WithLineNumbers(true), + html.LineNumbersInTable(true), + ) + + // If no style + if entry.Code.Style == "" { + // Set style to monokai + entry.Code.Style = "monokai" + } + + // Get provided style + chromaStyle := styles.Get(entry.Code.Style) + + // Create buffer + buf := &bytes.Buffer{} + // Format source code, writing output to buffer + err = formatter.Format(buf, chromaStyle, iterator) + if err != nil { + h.out.WriteString("Error formatting code: " + err.Error()) + continue + } + + // Write buffer contents to output + buf.WriteTo(h.out) + } else if entry.Break != nil { + // Write break tag to output + h.out.WriteString("
    ") + } + } + + // Return contents of output buffer + return h.out.String() +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..7ff8183 --- /dev/null +++ b/go.mod @@ -0,0 +1,22 @@ +module go.arsenm.dev/amu + +go 1.17 + +replace github.com/sqs/gojs => github.com/jbuchbinder/gojs v0.0.0-20201127163838-89502fae67f4 + +require ( + github.com/alecthomas/chroma v0.9.2 + github.com/gotk3/gotk3 v0.6.1 + github.com/linuxerwang/sourceview3 v0.1.1 + github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 + github.com/rs/zerolog v1.25.0 + github.com/sourcegraph/go-webkit2 v0.0.0-20170811231113-ade305cf91f4 +) + +require ( + github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142 // indirect + github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964 // indirect + github.com/dlclark/regexp2 v1.4.0 // indirect + github.com/sqs/gojs v0.0.0-20170522041006-12d0b3282819 // indirect + golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..93f6cea --- /dev/null +++ b/go.sum @@ -0,0 +1,71 @@ +github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38 h1:smF2tmSOzy2Mm+0dGI2AIUHY+w0BUc+4tn40djz7+6U= +github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38/go.mod h1:r7bzyVFMNntcxPZXK3/+KdruV1H5KSlyVY0gc+NgInI= +github.com/alecthomas/chroma v0.9.2 h1:yU1sE2+TZbLIQPMk30SolL2Hn53SR/Pv750f7qZ/XMs= +github.com/alecthomas/chroma v0.9.2/go.mod h1:eMuEnpA18XbG/WhOWtCzJHS7WqEtDAI+HxdwoW0nVSk= +github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721 h1:JHZL0hZKJ1VENNfmXvHbgYlbUOvpzYzvy2aZU5gXVeo= +github.com/alecthomas/colour v0.0.0-20160524082231-60882d9e2721/go.mod h1:QO9JBoKquHd+jz9nshCh40fOfO+JzsoXy8qTHF68zU0= +github.com/alecthomas/kong v0.2.4/go.mod h1:kQOmtJgV+Lb4aj+I2LEn40cbtawdWJ9Y8QLq+lElKxE= +github.com/alecthomas/repr v0.0.0-20180818092828-117648cd9897/go.mod h1:xTS7Pm1pD1mvyM075QCDSRqH6qRLXylzS24ZTpRiSzQ= +github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142 h1:8Uy0oSf5co/NZXje7U1z8Mpep++QJOldL2hs/sBQf48= +github.com/alecthomas/repr v0.0.0-20210801044451-80ca428c5142/go.mod h1:2kn6fqh/zIyPLmm3ugklbEi5hg5wS435eygvNfaDQL8= +github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964 h1:y5HC9v93H5EPKqaS1UYVg1uYah5Xf51mBfIoWehClUQ= +github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964/go.mod h1:Xd9hchkHSWYkEqJwUGisez3G1QY8Ryz0sdWrLPMGjLk= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E= +github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/gotk3/gotk3 v0.0.0-20210514043925-3f44af595c5e/go.mod h1:/hqFpkNa9T3JgNAE2fLvCdov7c5bw//FHNZrZ3Uv9/Q= +github.com/gotk3/gotk3 v0.6.1 h1:GJ400a0ecEEWrzjBvzBzH+pB/esEMIGdB9zPSmBdoeo= +github.com/gotk3/gotk3 v0.6.1/go.mod h1:/hqFpkNa9T3JgNAE2fLvCdov7c5bw//FHNZrZ3Uv9/Q= +github.com/jbuchbinder/gojs v0.0.0-20201127163838-89502fae67f4 h1:0cIfW0SWNMpeUONWDo3cG1CSUhqu2GyKFC7tnnpa5as= +github.com/jbuchbinder/gojs v0.0.0-20201127163838-89502fae67f4/go.mod h1:cth1DsIzyWvX90S/s98OP82pxNp/UY8WC0hzgC4fS0g= +github.com/linuxerwang/sourceview3 v0.1.1 h1:6I08q6waOgtucFLLsRundA37YKNSKLmpzHG1/mAVEuQ= +github.com/linuxerwang/sourceview3 v0.1.1/go.mod h1:SSaLbLMqtZw1lg4f/aW+Gf3CnqHtpxbEXTZs56L6mQ8= +github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= +github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY= +github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 h1:KoWmjvw+nsYOo29YJK9vDA65RGE3NrOnUtO7a+RF9HU= +github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8/go.mod h1:HKlIX3XHQyzLZPlr7++PzdhaXEj94dEiJgZDTsxEqUI= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= +github.com/rs/zerolog v1.25.0 h1:Rj7XygbUHKUlDPcVdoLyR91fJBsduXj5fRxyqIQj/II= +github.com/rs/zerolog v1.25.0/go.mod h1:7KHcEGe0QZPOm2IE4Kpb5rTh6n1h2hIgS5OOnu1rUaI= +github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ= +github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= +github.com/sourcegraph/go-webkit2 v0.0.0-20170811231113-ade305cf91f4 h1:/GZIprdcSTZ1ScZXIb0EYTgCt2izmqDXAKFQGszWbcE= +github.com/sourcegraph/go-webkit2 v0.0.0-20170811231113-ade305cf91f4/go.mod h1:MeIulxHy//0+TzvJV9+kG4UZCNb8f8WIR/rU2CrnTQI= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200413165638-669c56c373c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71 h1:X/2sJAybVknnUnV7AD2HdT6rm2p5BP6eH2j+igduWgk= +golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/internal/stack/stack.go b/internal/stack/stack.go new file mode 100644 index 0000000..80cfa0c --- /dev/null +++ b/internal/stack/stack.go @@ -0,0 +1,64 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +// Package stack implements a simple stack using go slices. +package stack + +import "reflect" + +// Stack is a LIFO stack using slices for storage +type Stack struct { + items []interface{} +} + +// Create a new stack +func New() *Stack { + return &Stack{} +} + +// Add a value to the end of the stack +func (s *Stack) Push(val interface{}) { + // Add element to slice + s.items = append(s.items, val) +} + +// Remove the value on the end of the stack and return it. +func (s *Stack) Pop() interface{} { + // Get index of last element + n := s.Size() - 1 + // Get last item in slice + item := s.items[n] + // Set element to zero value + s.items[n] = reflect.Zero(reflect.TypeOf(item)).Interface() + // Remove element + s.items = s.items[:n] + return item +} + +// Return value on the end of the stack without removing +func (s *Stack) Peek() interface{} { + // Get index of last element + n := s.Size() - 1 + // Return last element + return s.items[n] +} + +// Get the amount of items on the stack +func (s *Stack) Size() int { + return len(s.items) +} diff --git a/parser/code.go b/parser/code.go new file mode 100644 index 0000000..535ba8b --- /dev/null +++ b/parser/code.go @@ -0,0 +1,85 @@ +package parser + +import ( + "bytes" + + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/scanner" +) + +func (p *Parser) parseCode(tok scanner.Token, lit string) *ast.Code { + // Create new code + code := &ast.Code{} + + // If token is not WORD or literal is not "=list" + if tok != scanner.WORD || lit != "=code" { + // Return nil as this code is invalid + return nil + } + + // Scan token + tok, lit = p.scan() + + // If token is not PUNCT or literal is not "[" + if tok != scanner.PUNCT || lit != "[" { + // Unscan token + p.unscan() + // Return nil as this code is invalid + return nil + } + + // Parse argument list + args := p.parseArgs() + + // If 1 or more arguments provided + if len(args) >= 1 { + // Set language to first argument + code.Language = args[0] + } + // If 2 or more arguments provided + if len(args) >= 2 { + // Set style to second argument + code.Style = args[1] + } + + // Create buffer for text + textBuf := &bytes.Buffer{} + + for { + // Scan token + tok, lit = p.scan() + + // If end of file + if tok == scanner.EOF { + // Return whatever waS parsed so far + return code + } + + // If token is WORD and lit is "=end" + if tok == scanner.WORD && lit == "=end" { + // Scan token + tok, lit = p.scan() + // If token is not PUNCT and literal is not "[" + if tok != scanner.PUNCT && lit != "[" { + // Return nil as this is not a valid code + return nil + } + // Scan token + tok, lit = p.scan() + // If token is not PUNCT and literal is not "]" + if tok != scanner.PUNCT && lit != "]" { + // Return nil as this is not a valid code + return nil + } + break + } + + // Write literal to text buffer + textBuf.WriteString(lit) + } + + // Set code text to contents of text buffer + code.Text = textBuf.String() + + return code +} diff --git a/parser/common.go b/parser/common.go new file mode 100644 index 0000000..bae31a1 --- /dev/null +++ b/parser/common.go @@ -0,0 +1,55 @@ +package parser + +import ( + "bytes" + + "go.arsenm.dev/amu/scanner" +) + +// Attempt to parse an argument list (comma-separated) +func (p *Parser) parseArgs() []string { + // Create buffer for arguments + argBuf := &bytes.Buffer{} + // Create new line slice for arguments + var args []string + +parseLoop: + for { + // Scan token + tok, lit := p.scan() + + // If end of file + if tok == scanner.EOF { + // Return nil as this is an invalid argument list + return nil + } + + switch tok { + case scanner.WORD: + // Write word to argument buffer + argBuf.WriteString(lit) + case scanner.WS: + // Write whitespace to argument buffer + argBuf.WriteString(lit) + case scanner.PUNCT: + // If literal is "]" + if lit == "]" { + // If length of argument is greater than 0 + if argBuf.Len() > 0 { + // Add current argument to slice + args = append(args, argBuf.String()) + } + // Stop parsing + break parseLoop + } else if lit == "," { + // Add argument to slice + args = append(args, argBuf.String()) + // Reset buffer + argBuf.Reset() + } + } + } + + // Return parsed arguments + return args +} diff --git a/parser/heading.go b/parser/heading.go new file mode 100644 index 0000000..1233bef --- /dev/null +++ b/parser/heading.go @@ -0,0 +1,31 @@ +package parser + +import ( + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/scanner" +) + +// Attempt to parse heading +func (p *Parser) parseHeading() *ast.Heading { + // Scan token + tok, lit := p.scan() + + // Set level to length of HEADING token + level := len(lit) + + // If token is not HEADING or level is greater than 6 + if tok != scanner.HEADING || level > 6 { + // Return nil as this is not a valid heading + return nil + } + + // Parse para until one newline enocountered + para := p.parsePara(1) + // If successful + if para != nil { + return &ast.Heading{Level: level, Content: para} + } + + // Return nil as this is not a valid heading + return nil +} diff --git a/parser/image.go b/parser/image.go new file mode 100644 index 0000000..9142197 --- /dev/null +++ b/parser/image.go @@ -0,0 +1,86 @@ +package parser + +import ( + "bytes" + "strings" + + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/scanner" +) + +// parseImage attempts to parse an image +func (p *Parser) parseImage() *ast.Image { + // Create new image + img := &ast.Image{} + + // Create buffers for image properties + altBuf := &bytes.Buffer{} + srcBuf := &bytes.Buffer{} + linkBuf := &bytes.Buffer{} + // Set current buffer to alt text buffer + currentBuf := altBuf + + // Scan token + tok, lit := p.scan() + // If token is not PUNCT or literal is not "[" + if tok != scanner.PUNCT || lit != "[" { + // Return nil as this is not a valid image + return nil + } + + // Declare variable for last literal + var lastLit string + +parseLoop: + for { + // Scan token + tok, lit := p.scan() + + switch tok { + case scanner.WORD: + // Write word to current buffer + currentBuf.WriteString(lit) + case scanner.WS: + // Write whitespace to current buffer + currentBuf.WriteString(lit) + case scanner.PUNCT: + // If last literal is "]" and current is "(" + if lastLit == "]" && lit == "(" { + // Set current buffer to source buffer + currentBuf = srcBuf + // Continue to next token + continue + } + // If last literal is ")" and current is "{" + if lastLit == ")" && lit == "{" { + // Set current buffer to link buffer + currentBuf = linkBuf + // Continue to next token + continue + } + // If current literal is "}" and current buffer is link buffer + if lit == "}" && currentBuf == linkBuf { + // Stop parsing + break parseLoop + } + + // If literal does not contain any of the restrict characters + if !strings.ContainsAny(lit, "()[]{}") { + // Write literal to current buffer + currentBuf.WriteString(lit) + } + case scanner.EOL, scanner.EOF: + // Return nil as this is not a valid link + return nil + } + // Set last literal + lastLit = lit + } + + // Set image properties + img.Alternate = altBuf.String() + img.Source = srcBuf.String() + img.Link = linkBuf.String() + + return img +} diff --git a/parser/list.go b/parser/list.go new file mode 100644 index 0000000..783852e --- /dev/null +++ b/parser/list.go @@ -0,0 +1,143 @@ +package parser + +import ( + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/scanner" +) + +// parseList attempts to parse a list +func (p *Parser) parseList(tok scanner.Token, lit string) *ast.List { + // Create new list + list := &ast.List{} + + // If token is not WORD or literal is not "=list" + if tok != scanner.WORD || lit != "=list" { + // Return nil as this list is invalid + return nil + } + + tok, lit = p.scan() + + // If token is not PUNCT or literal is not "[" + if tok != scanner.PUNCT || lit != "[" { + // Return nil as this list is invalid + return nil + } + + tok, lit = p.scan() + + // If token is not WORD (the name of the function) + if tok != scanner.WORD { + // Return nil as this list is invalid + return nil + } + + list.Type = lit + + tok, lit = p.scan() + + // If token is not PUNCT or literal is not "]" + if tok != scanner.PUNCT || lit != "]" { + // Return nil as this list is invalid + return nil + } + +parseLoop: + for { + // If end of file + if tok == scanner.EOF { + // Return whatever was parsed so far + return list + } + + // Create new list item at level 0 + item := ast.ListItem{Level: 0} + + for { + // Scan token + tok, lit = p.scan() + + // If end of file + if tok == scanner.EOF { + // Return whatever was parsed so far + return list + } + + // If token is not punctuation or literal is not "." + if tok != scanner.PUNCT || lit != "." { + // Break out of loop as this is the end of level + break + } + + // Increment item level + item.Level++ + } + + for tok != scanner.PUNCT && lit != "." { + // If token is WORD and literal is "=end" + if tok == scanner.WORD && lit == "=end" { + // Scan token + tok, lit = p.scan() + // If token is not PUNCT and literal is not "[" + if tok != scanner.PUNCT && lit != "[" { + // Return nil as this is not a valid list + return nil + } + // Scan token + tok, lit = p.scan() + // If token is not PUNCT and literal is not "]" + if tok != scanner.PUNCT && lit != "]" { + // Return nil as this is not a valid list + return nil + } + // Add item to list + list.Items = append(list.Items, item) + // Stop parsing + break parseLoop + } + + // If end of file + if tok == scanner.EOF { + // Return whatever was parsed so far + return list + } + + // Unscan character as it will be required for para + p.unscan() + // Attempt to parse para until one newline encountered + para := p.parsePara(1) + if para == nil { + break + } + // Add para to item content + item.Content = append(item.Content, para) + + // Scan token for next loop + tok, lit = p.scan() + + // if end of line + if tok == scanner.EOL { + // Scan again + tok, lit = p.scan() + } + } + + // If token is part of level + if tok == scanner.PUNCT && lit == "." { + // Unscan for next level loop + p.unscan() + } + + // If no content in item + if len(item.Content) == 0 { + // Continue to next item + continue + } + + // Add item to list items + list.Items = append(list.Items, item) + } + + // Return lists + return list +} diff --git a/parser/para.go b/parser/para.go new file mode 100644 index 0000000..14e6042 --- /dev/null +++ b/parser/para.go @@ -0,0 +1,223 @@ +package parser + +import ( + "bytes" + "strings" + + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/scanner" +) + +// parsePara attempts to parse a paragraph until untilEOLAmt +// newlines are encountered +func (p *Parser) parsePara(untilEOLAmt int) *ast.Para { + // Create new empty para + para := &ast.Para{} + +parseLoop: + for { + // Scan token + tok, lit := p.scan() + + switch tok { + case scanner.WS: + // Add whitespace to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Whitespace: &lit}) + case scanner.PUNCT: + if lit == "[" { + // Attempt to parse link + link, _ := p.parseLink() + // If successful + if link != nil { + // Add link to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Link: link}) + // Continue to next token + continue + } + } + // Add punctuation to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Punct: &lit}) + case scanner.WORD: + if strings.HasPrefix(lit, "+") { + // Attempt to parse function + function := p.parseFunc(tok, lit) + // If successful + if function != nil { + // Add function to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Func: function}) + // Continue to next token + continue + } + } + // Add word to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Word: &lit}) + case scanner.FORMAT: + // Create new nil slice of ast.FormatType + var types []ast.FormatType + if strings.HasPrefix(lit, "_") { + // Remove leading and trailing "_" + lit = strings.Trim(lit, "_") + // Add italic format to slice + types = append(types, ast.FormatTypeItalic) + } + if strings.HasPrefix(lit, "*") { + // Remove leading and trailing "*" + lit = strings.Trim(lit, "*") + // Add bold format to slice + types = append(types, ast.FormatTypeBold) + } + if strings.HasPrefix(lit, "$") { + // Remove leading and trailing "$" + lit = strings.Trim(lit, "$") + // Add math format to slice + types = append(types, ast.FormatTypeMath) + } + if strings.HasPrefix(lit, "`") { + // Remove leading and trailing "`" + lit = strings.Trim(lit, "`") + // Add code format to slice + types = []ast.FormatType{ast.FormatTypeCode} + } + if strings.HasPrefix(lit, "~") { + // Remove leading and trailing "~" + lit = strings.Trim(lit, "~") + // Add strike format to slice + types = []ast.FormatType{ast.FormatTypeStrike} + } + // Add format to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Format: &ast.Format{ + Types: types, + Text: lit, + }}) + case scanner.EOL: + // If untilEOLAmt or more newlines encountered + if strings.Count(lit, "\n") >= untilEOLAmt { + // Stop parsing + break parseLoop + } + // Add EOL to para + para.Fragments = append(para.Fragments, ast.ParaFragment{Whitespace: &lit}) + case scanner.EOF: + // Stop parsing + break parseLoop + } + } + + // If nothing in para + if len(para.Fragments) == 0 { + // Return nothing + return nil + } + + return para +} + +// parseFunc appempts to parse a function call +func (p *Parser) parseFunc(tok scanner.Token, lit string) *ast.Func { + // Create new function + function := &ast.Func{} + + // If the token is not a word or does not have a prefix of "+" + if tok != scanner.WORD || !strings.HasPrefix(lit, "+") { + // Return nil as this is an invalid function call + return nil + } + + // Set function name to literal, trimming "+" prefix + function.Name = strings.TrimPrefix(lit, "+") + + // Scan token + tok, lit = p.scan() + + // If token is not punctuatuion or is not "[" + if tok != scanner.PUNCT || lit != "[" { + // Unscan token + p.unscan() + // Return nil as this is an invalid function call + return nil + } + + // Parse arguments + function.Args = p.parseArgs() + + return function +} + +// Attempt to parse link +func (p *Parser) parseLink() (*ast.Link, bool) { + // Create new link + link := &ast.Link{} + + // Initialize buffers for link properties + textBuf := &bytes.Buffer{} + linkBuf := &bytes.Buffer{} + // Set current buffer to text buffer + currentBuf := textBuf + + // Declare variable for last literal + var lastLit string + + // Define variable for amount of scans performed + amtScans := 0 +parseLoop: + for { + // Scan token + tok, lit := p.scan() + // Increment amtScans + amtScans++ + + switch tok { + case scanner.WORD: + // Write word to current buffer + currentBuf.WriteString(lit) + case scanner.WS: + // Write word to current buffer + currentBuf.WriteString(lit) + case scanner.PUNCT: + // If closing bracket found but no text stored + if lit == "]" && currentBuf.Len() == 0 { + // Unscan token + p.unscan() + // Return nil as this is an invalid link + return nil, false + } + // If last literal is "]" and current is "(" + if lastLit == "]" && lit == "(" { + // Switch current buffer to link buffer + currentBuf = linkBuf + // Continue to next token + continue + } + // If literal is ")" + if lit == ")" { + // Stop parsing + break parseLoop + } + // If literal is not "]" + if lit != "]" { + // Write literal to current buffer + currentBuf.WriteString(lit) + } + case scanner.EOL, scanner.EOF: + // Unscan all performed scans + p.unscanMulti(amtScans) + // Return nil as this is an invalid link + return nil, false + } + + // Set last literal + lastLit = lit + } + + // If no text + if textBuf.Len() == 0 { + // Use link as text + textBuf.WriteString(linkBuf.String()) + } + + // Set properties + link.Text = textBuf.String() + link.Link = linkBuf.String() + + return link, false +} diff --git a/parser/parser.go b/parser/parser.go new file mode 100644 index 0000000..fdfa5d1 --- /dev/null +++ b/parser/parser.go @@ -0,0 +1,197 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +// Package parser provides a parser for AMU source code +package parser + +import ( + "io" + "strings" + + "go.arsenm.dev/amu/ast" + "go.arsenm.dev/amu/internal/stack" + "go.arsenm.dev/amu/scanner" +) + +// Parser parses tokens from scanner.Scanner into an AST +type Parser struct { + s *scanner.Scanner + buf *buffer +} + +// New creates a new parser using a new scanner with the +// provided reader +func New(r io.Reader) *Parser { + return &Parser{s: scanner.New(r), buf: newBuffer()} +} + +// NewWithScanner creates a new parser using the provided scanner +func NewWithScanner(s *scanner.Scanner) *Parser { + return &Parser{s: s, buf: newBuffer()} +} + +// scan scans a single token from the underlying scanner.Scanner +func (p *Parser) scan() (scanner.Token, string) { + // If at least one unscan + if p.buf.unscans > 0 { + // Get token and literal from buffer + tok, lit := p.buf.pop() + // Decrement unscans + p.buf.unscans-- + // Return buffered token and literal + return tok, lit + } + + // Scan token and literal from scanner + tok, lit := p.s.Scan() + + // Add token and literal to buffer + p.buf.push(tok, lit) + + // Return token and literal + return tok, lit +} + +// unscan unscans a single token +func (p *Parser) unscan() { + // Increment unscans + p.buf.unscans++ +} + +// unscanMulti unscans multiple tokens +func (p *Parser) unscanMulti(amt int) { + // Increment unscans by amt + p.buf.unscans += amt +} + +// buffer stores tokens and literals for unreads +type buffer struct { + tok *stack.Stack + lit *stack.Stack + unscans int +} + +// newBuffer creates a new buffer, initializing stacks +func newBuffer() *buffer { + return &buffer{ + tok: stack.New(), + lit: stack.New(), + } +} + +// push adds a token and literal to the buffer +func (b *buffer) push(tok scanner.Token, lit string) { + // Add token to buffer + b.tok.Push(tok) + // Add literal to buffer + b.lit.Push(lit) +} + +// pop removes a token from the buffer and returns it +func (b *buffer) pop() (scanner.Token, string) { + if b.tok.Size() > 0 { + tok := b.tok.Pop() + lit := b.lit.Pop() + return tok.(scanner.Token), lit.(string) + } + return scanner.EOF, "" +} + +func (b *buffer) peek() (scanner.Token, string) { + if b.tok.Size() > 0 { + tok := b.tok.Peek() + lit := b.lit.Peek() + return tok.(scanner.Token), lit.(string) + } + return scanner.EOF, "" +} + +// Parse parses the input into an AST +func (p *Parser) Parse() (*ast.AST, error) { + // Create new AST + AST := &ast.AST{} + +parseLoop: + for { + // Scan token + tok, lit := p.scan() + + switch tok { + case scanner.HEADING: + p.unscan() + // Attempt to parse heading + heading := p.parseHeading() + // If successful + if heading != nil { + // Add heading to the AST + AST.Entries = append(AST.Entries, ast.Entry{Heading: heading}) + } + case scanner.WS, scanner.WORD, scanner.FORMAT, scanner.PUNCT: + if tok == scanner.PUNCT && lit == "!" { + // Attempt to parse image + img := p.parseImage() + // If successful + if img != nil { + // Add image to AST + AST.Entries = append(AST.Entries, ast.Entry{Image: img}) + // Continue to next token + continue + } + } else if tok == scanner.WORD && lit == "=list" { + // Attempt to parse list + list := p.parseList(tok, lit) + // If successful + if list != nil { + // Add list to AST + AST.Entries = append(AST.Entries, ast.Entry{List: list}) + // Continue to next token + continue + } + } else if tok == scanner.WORD && lit == "=code" { + // Attempt to parse code + code := p.parseCode(tok, lit) + // If successful + if code != nil { + // Add code to AST + AST.Entries = append(AST.Entries, ast.Entry{Code: code}) + // Continue to next token + continue + } + } + // Unscan token as it will be needed for parsing para + p.unscan() + // Attempt to parse paragraph until 2 newlines encountered + para := p.parsePara(2) + if para != nil { + AST.Entries = append(AST.Entries, ast.Entry{Para: para}) + } + case scanner.EOL: + // If 2 or more newlines encountered + if strings.Count(lit, "\n") >= 2 { + // Add break to AST + AST.Entries = append(AST.Entries, ast.Entry{Break: &ast.Break{}}) + } + case scanner.EOF: + // Stop parsing + break parseLoop + } + } + + // Return filled AST + return AST, nil +} diff --git a/scanner/scanner.go b/scanner/scanner.go new file mode 100644 index 0000000..0a3a050 --- /dev/null +++ b/scanner/scanner.go @@ -0,0 +1,294 @@ +/* + AMU: Custom simple markup language + Copyright (C) 2021 Arsen Musayelyan + + 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 . +*/ + +// Package scanner provides a scanner and tokenizer for AMU source code +package scanner + +import ( + "bufio" + "bytes" + "io" + "unicode" +) + +// Token represents a lexer token +type Token int + +const ( + EOF Token = iota + EOL + WS + WORD + HEADING + FORMAT + PUNCT +) + +var eof rune = 0 + +// String converts a token into a string. +func (t Token) String() string { + switch t { + case EOF: + return "EOF" + case EOL: + return "EOL" + case WS: + return "WS" + case WORD: + return "WORD" + case HEADING: + return "HEADING" + case FORMAT: + return "FORMAT" + case PUNCT: + return "PUNCT" + default: + return "unknown" + } +} + +// Scanner implements a lexer for AMU source code. +type Scanner struct { + reader *bufio.Reader +} + +// New creates a new Scanner. +func New(r io.Reader) *Scanner { + + switch r := r.(type) { + case *bufio.Reader: + return &Scanner{reader: r} + case *bufio.ReadWriter: + return &Scanner{reader: r.Reader} + default: + return &Scanner{reader: bufio.NewReader(r)} + } +} + +// read reads a single rule from the underlying bufio.Reader +func (s *Scanner) read() rune { + // Read rune from reader + char, _, err := s.reader.ReadRune() + if err != nil { + return eof + } + return char +} + +// unread unreads the last read rune from +// the underlying bufio.Reader +func (s *Scanner) unread() { + _ = s.reader.UnreadRune() +} + +// scanHeading attempts to scan a HEADING token +func (s *Scanner) scanHeading() (Token, string) { + + // Create new buffer for token literal + buf := &bytes.Buffer{} + // Write first character to buffer + buf.WriteRune(s.read()) + + for { + // Read character + char := s.read() + if char == eof { + break + } else if char != '#' && !unicode.IsSpace(char) { + // Unread character as this is not a valid heading + s.unread() + // Return literal as a WORD token + return WORD, buf.String() + } else if char != '#' { + // Unread character as this is the end of the heading literal + s.unread() + break + } else { + // Write character to buffer + buf.WriteRune(char) + } + } + + // If level more than 6 + if buf.Len() > 6 { + // Return literal as a WORD token as this is not a valid heading + return WORD, buf.String() + } + + // Return HEADING token + return HEADING, buf.String() +} + +// isEOL checks if char is an end of line character +func isEOL(char rune) bool { + return char == '\n' || char == '\r' +} + +// scanEOL scans an EOL token +func (s *Scanner) scanEOL() (Token, string) { + // Create new buffer for token literal + buf := &bytes.Buffer{} + // Write first character to buffer + buf.WriteRune(s.read()) + + for { + // Read character + char := s.read() + if char == eof { + break + } else if !isEOL(char) { + // Unread character as this is the beginning of the next line + s.unread() + break + } else { + // Write character to buffer + buf.WriteRune(char) + } + } + + // Return EOL token + return EOL, buf.String() +} + +// scanWord scans a WORD token +func (s *Scanner) scanWord() (Token, string) { + // Create new buffer for token literal + buf := &bytes.Buffer{} + // Write first character to buffer + buf.WriteRune(s.read()) + + for { + // Read character + char := s.read() + if char == eof { + break + } else if unicode.IsSpace(char) || unicode.IsPunct(char) { + // Unread as this is the end of the word + s.unread() + break + } + // Write character to buffer + buf.WriteRune(char) + } + + // Return WORD token + return WORD, buf.String() +} + +// scanWhitespace scans a WS token +func (s *Scanner) scanWhitespace() (Token, string) { + // Create new buffer for token literal + buf := &bytes.Buffer{} + // Write first character to the buffer + buf.WriteRune(s.read()) + + for { + // Read character + char := s.read() + if char == eof { + break + } else if !unicode.IsSpace(char) || isEOL(char) { + // Unread as this is the end of the whitespace + s.unread() + break + } else { + // Write character to buffer + buf.WriteRune(char) + } + } + + // Return WS token + return WS, buf.String() +} + +// isFormatRune checks whether char is a +// format character +func isFormatRune(char rune) bool { + return char == '*' || + char == '_' || + char == '$' || + char == '`' || + char == '~' +} + +// scanFormat scans a FORMAT token +func (s *Scanner) scanFormat() (Token, string) { + // Store format rule for use later + formatRune := s.read() + // Create new buffer for token literal + buf := &bytes.Buffer{} + // Write first character to buffer + buf.WriteRune(formatRune) + + for { + // Read character + char := s.read() + if char == eof { + break + } else if isEOL(char) { + // Unread as this is not a valid format + s.unread() + // Return literal as WORD token + return WORD, buf.String() + } else if char == formatRune { + // Write character to buffer + buf.WriteRune(char) + // Stop scanning as this is the end of the format + break + } else { + // Write character to buffer + buf.WriteRune(char) + } + } + + // Return FORMAt token + return FORMAT, buf.String() +} + +// scanPunct scans a PUNCT token +func (s *Scanner) scanPunct() (Token, string) { + return PUNCT, string(s.read()) +} + +// Scan scans a single token from the input +func (s *Scanner) Scan() (Token, string) { + // read character + char := s.read() + + // Unread character as it will be + // needed by future functions + s.unread() + + // Run appropriate scan function and return result + if isEOL(char) { + return s.scanEOL() + } else if unicode.IsSpace(char) { + return s.scanWhitespace() + } else if char == '#' { + return s.scanHeading() + } else if isFormatRune(char) { + return s.scanFormat() + } else if unicode.IsPunct(char) { + return s.scanPunct() + } else if char != eof { + return s.scanWord() + } else { + return EOF, "" + } +} diff --git a/test.amu b/test.amu new file mode 100644 index 0000000..da06de3 --- /dev/null +++ b/test.amu @@ -0,0 +1,57 @@ ++hdr[Beginning,Middle,End] + +# T1 _thing_ + +###### T2 + +*Bold* _Italic_ _*BoldItalic*_ + +[Google](https://google.com) Search + +~strike~ + +$\frac{1}{2} \LaTeX$ + +![Clouds](https://www.metaweather.com/static/img/weather/hc.svg){} + +![Generic badge](https://img.shields.io/badge/--.svg){https://shields.io/} + +Some `inline code` + +=code[go,dracula] +// Code with dracula theme +package main + +import "fmt" + +func main() { + fmt.Println("Hello, World") +} +=end[] + +=code[go] +// Code with no theme (monokai default) +package main + +import "fmt" + +func main() { + fmt.Println("Hello, World") +} +=end[] + +$\cancel{test}$ + +=list[unordered] +. Level 1 + Testing +... Level 3 +. Back to level 1 +=end[] + +=list[ordered] +. Level 1 + Testing +... Level 3 +. Back to level 1 +=end[] \ No newline at end of file