diff options
43 files changed, 3653 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..29b30d3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +# place exclude patterns here + +bin +build diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..0b91ca3 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,7 @@ +#CMake Entry Point +cmake_minimum_required(VERSION 2.6) +project(swg) +set(EXE swg) +set(CMAKE_BUILD_TYPE Debug) +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17") +subdirs(src) @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + swg + Copyright (C) 2022 Gassmann Maël + + 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 <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + swg Copyright (C) 2022 Gassmann Maël + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d6de7df --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# SWG
+
+Static Website Generator.
+
+## Requirements
+
+You will need to have `cmake` installed along with a C++ compiler that supports the C++17 library (Filesystem library is used).
+
+## Compile
+
+Navigate to the project root and create the build folder along with the Makefiles:
+
+```
+mkdir build
+cd build
+cmake ..
+```
+
+You should now be able to compile the project by simply running `make`.
+
+The resulting executable will be located at `build/src/swg`.
+As it is a standalone executable, you could install it by simply copying it in the `/bin` folder:
+
+```
+sudo cp src/swg /bin/swg
+```
+
+## Usage
+
+```
+swg -g source-website
+```
+
+The generation of a static website is done from a folder and file structure, you can see a template [here](https://git.gassm.ch/swg/tree/res/template-website).
+
+## Status
+
+It is still under development, really far from being finished.
+You can take a look at [TODO](TODO.md) to have an idea of what is planned / under development.
+
+## License
+
+Using the [maddy](https://github.com/progsource/maddy) C++ Markdown to HTML header-only parser library developed by Petra Baranski.
+
+This project is licensed under the GPLv3 license. For more information see [LICENSE](LICENSE) file.
@@ -0,0 +1,16 @@ +# TODO +- [X] Different types of text files: + - page + - article + - links +- [X] Different templates: + - header.html + - style.css (depends on what the header requests) + - footer.html + - article_listing.html + - menu_listing.html +- [X] A function that can be called in a page to list articles +- [ ] Actually parse arguments correctly +- [ ] Photo Album generator +- [ ] Clean up the code +- [ ] Document the code further diff --git a/inc/FileAssembler.h b/inc/FileAssembler.h new file mode 100644 index 0000000..3eaab35 --- /dev/null +++ b/inc/FileAssembler.h @@ -0,0 +1,61 @@ +#ifndef FA_H +#define FA_H + +#include <iostream> +#include <string.h> +#include <cctype> +#include <list> +#include <map> +#include <regex> + +using namespace std; + +class FileAssembler{ + +private: + string path; + map<string, string> variables; + map<string, string> templates; + map<string, string> pages; + map<string, string> posts; + list<string> cached_res; + + string get_file_content(string path); + void parse_variables(); + map<string, string> assemble_from_iterator(map<string, string>::iterator it, map<string, string>::iterator end, bool is_post); + string parse(string title, string content, bool is_post); + string parse_arg(string arg_name, string to_parse); + +public: + FileAssembler(string path); + + map<string, string> get_pages(); + map<string, string> get_posts(); + list<string> get_cached_resources(){ + return cached_res; + } + string get_target(){ + string w = variables["website"]; + static std::regex rgx("\\w+\\.\\w+"); + std::smatch match; + if (std::regex_search(w, match, rgx)) + return match[0]; + cerr << "Error: swg: website attribute is badly configured!" << endl; + exit(7); + } + string get_index(){ + if(variables.find("index") == variables.end()){ + return ""; + } + return variables["index"]; + } + + static string lowercase(string s){ + string low = ""; + for (int i = 0; i < s.length(); i++) { + low += tolower(s[i]); + } + return low; + } +}; +#endif diff --git a/inc/maddy/LICENSE b/inc/maddy/LICENSE new file mode 100644 index 0000000..3879e0d --- /dev/null +++ b/inc/maddy/LICENSE @@ -0,0 +1,18 @@ +Copyright 2017, 2018, 2019, 2020 M. Petra Baranski + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/inc/maddy/blockparser.h b/inc/maddy/blockparser.h new file mode 100644 index 0000000..9df4fa6 --- /dev/null +++ b/inc/maddy/blockparser.h @@ -0,0 +1,203 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <sstream> +#include <string> +// windows compatibility includes +#include <cctype> +#include <algorithm> + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * BlockParser + * + * The code expects every child to have the following static function to be + * implemented: + * `static bool IsStartingLine(const std::string& line)` + * + * @class + */ +class BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + BlockParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : result("", std::ios_base::ate | std::ios_base::in | std::ios_base::out) + , childParser(nullptr) + , parseLineCallback(parseLineCallback) + , getBlockParserForLineCallback(getBlockParserForLineCallback) + {} + + /** + * dtor + * + * @method + */ + virtual ~BlockParser() {} + + /** + * AddLine + * + * Adding a line which has to be parsed. + * + * @method + * @param {std::string&} line + * @return {void} + */ + virtual void + AddLine(std::string& line) + { + this->parseBlock(line); + + if (this->isInlineBlockAllowed() && !this->childParser) + { + this->childParser = this->getBlockParserForLine(line); + } + + if (this->childParser) + { + this->childParser->AddLine(line); + + if (this->childParser->IsFinished()) + { + this->result << this->childParser->GetResult().str(); + this->childParser = nullptr; + } + + return; + } + + if (this->isLineParserAllowed()) + { + this->parseLine(line); + } + + this->result << line; + } + + /** + * IsFinished + * + * Check if the BlockParser is done + * + * @method + * @return {bool} + */ + virtual bool IsFinished() const = 0; + + /** + * GetResult + * + * Get the parsed HTML output. + * + * @method + * @return {std::stringstream} + */ + std::stringstream& + GetResult() + { + return this->result; + } + + /** + * Clear + * + * Clear the result to reuse the parser object. + * + * It is only used by one test for now. + * + * @method + * @return {void} + */ + void + Clear() + { + this->result.str(""); + } + +protected: + std::stringstream result; + std::shared_ptr<BlockParser> childParser; + + virtual bool isInlineBlockAllowed() const = 0; + virtual bool isLineParserAllowed() const = 0; + virtual void parseBlock(std::string& line) = 0; + + void + parseLine(std::string& line) + { + if (parseLineCallback) + { + parseLineCallback(line); + } + } + + uint32_t + getIndentationWidth(const std::string& line) const + { + bool hasMetNonSpace = false; + + uint32_t indentation = static_cast<uint32_t>( + std::count_if( + line.begin(), + line.end(), + [&hasMetNonSpace](unsigned char c) + { + if (hasMetNonSpace) + { + return false; + } + + if (std::isspace(c)) + { + return true; + } + + hasMetNonSpace = true; + return false; + } + ) + ); + + return indentation; + } + + std::shared_ptr<BlockParser> + getBlockParserForLine(const std::string& line) + { + if (getBlockParserForLineCallback) + { + return getBlockParserForLineCallback(line); + } + + return nullptr; + } + +private: + std::function<void(std::string&)> parseLineCallback; + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback; +}; // class BlockParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/breaklineparser.h b/inc/maddy/breaklineparser.h new file mode 100644 index 0000000..e3ee6fc --- /dev/null +++ b/inc/maddy/breaklineparser.h @@ -0,0 +1,51 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * BreakLineParser + * + * @class + */ +class BreakLineParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `text\r\n text` + * + * To HTML: `text<br> text` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re(R"((\r\n|\r))"); + static std::string replacement = "<br>"; + + line = std::regex_replace(line, re, replacement); + } +}; // class BreakLineParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/checklistparser.h b/inc/maddy/checklistparser.h new file mode 100644 index 0000000..bfc487c --- /dev/null +++ b/inc/maddy/checklistparser.h @@ -0,0 +1,140 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <regex> +#include <string> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * ChecklistParser + * + * @class + */ +class ChecklistParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + ChecklistParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + {} + + /** + * IsStartingLine + * + * An unordered list starts with `* `. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^- \\[[x| ]\\] .*"); + return std::regex_match(line, re); + } + + /** + * IsFinished + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return true; + } + + bool + isLineParserAllowed() const override + { + return true; + } + + void + parseBlock(std::string& line) override + { + bool isStartOfNewListItem = IsStartingLine(line); + uint32_t indentation = getIndentationWidth(line); + + static std::regex lineRegex("^(- )"); + line = std::regex_replace(line, lineRegex, ""); + + static std::regex emptyBoxRegex("^\\[ \\]"); + static std::string emptyBoxReplacement = "<input type=\"checkbox\"/>"; + line = std::regex_replace(line, emptyBoxRegex, emptyBoxReplacement); + + static std::regex boxRegex("^\\[x\\]"); + static std::string boxReplacement = "<input type=\"checkbox\" checked=\"checked\"/>"; + line = std::regex_replace(line, boxRegex, boxReplacement); + + if (!this->isStarted) + { + line = "<ul class=\"checklist\"><li><label>" + line; + this->isStarted = true; + return; + } + + if (indentation >= 2) + { + line = line.substr(2); + return; + } + + if ( + line.empty() || + line.find("</label></li><li><label>") != std::string::npos || + line.find("</label></li></ul>") != std::string::npos + ) + { + line = "</label></li></ul>" + line; + this->isFinished = true; + return; + } + + if (isStartOfNewListItem) + { + line = "</label></li><li><label>" + line; + } + } + +private: + bool isStarted; + bool isFinished; +}; // class ChecklistParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/codeblockparser.h b/inc/maddy/codeblockparser.h new file mode 100644 index 0000000..2cb4a97 --- /dev/null +++ b/inc/maddy/codeblockparser.h @@ -0,0 +1,137 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <string> +#include <regex> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * CodeBlockParser + * + * From Markdown: 3 times surrounded code (without space in the beginning) + * + * ``` + * ``` + * some code + * ``` + * ``` + * + * To HTML: + * + * ``` + * <pre><code> + * some code + * </code></pre> + * ``` + * + * @class + */ +class CodeBlockParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + CodeBlockParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + {} + + /** + * IsStartingLine + * + * If the line starts with three code signs, then it is a code block. + * + * ``` + * ``` + * ``` + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^(?:`){3}$"); + return std::regex_match(line, re); + } + + /** + * IsFinished + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return false; + } + + bool + isLineParserAllowed() const override + { + return false; + } + + void + parseBlock(std::string& line) override + { + if (line == "```") + { + if (!this->isStarted) + { + line = "<pre><code>\n"; + this->isStarted = true; + this->isFinished = false; + return; + } + else + { + line = "</code></pre>"; + this->isFinished = true; + this->isStarted = false; + return; + } + } + + line += "\n"; + } + +private: + bool isStarted; + bool isFinished; +}; // class CodeBlockParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/emphasizedparser.h b/inc/maddy/emphasizedparser.h new file mode 100644 index 0000000..6838d83 --- /dev/null +++ b/inc/maddy/emphasizedparser.h @@ -0,0 +1,53 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * EmphasizedParser + * + * Has to be used after the `StrongParser`. + * + * @class + */ +class EmphasizedParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `text _text_` + * + * To HTML: `text <em>text</em>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re("(?!.*`.*|.*<code>.*)_(?!.*`.*|.*<\\/code>.*)([^_]*)_(?!.*`.*|.*<\\/code>.*)"); + static std::string replacement = "<em>$1</em>"; + + line = std::regex_replace(line, re, replacement); + } +}; // class EmphasizedParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/headlineparser.h b/inc/maddy/headlineparser.h new file mode 100644 index 0000000..9eafec5 --- /dev/null +++ b/inc/maddy/headlineparser.h @@ -0,0 +1,138 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <string> +#include <regex> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * HeadlineParser + * + * From Markdown: + * + * ``` + * # Headline 1 + * ## Headline 2 + * ### Headline 3 + * #### Headline 4 + * ##### Headline 5 + * ###### Headline 6 + * ``` + * + * To HTML: + * + * ``` + * <h1>Headline 1</h1> + * <h2>Headline 2</h2> + * <h3>Headline 3</h3> + * <h4>Headline 4</h4> + * <h5>Headline 5</h5> + * <h6>Headline 6</h6> + * ``` + * + * @class + */ +class HeadlineParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + HeadlineParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + {} + + /** + * IsStartingLine + * + * If the line starts with 1 - 6 `#`, then it is a headline. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^(?:#){1,6} (.*)"); + return std::regex_match(line, re); + } + + /** + * IsFinished + * + * The headline is always only one line long, so this method always returns + * true. + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return true; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return false; + } + + bool + isLineParserAllowed() const override + { + return false; + } + + void + parseBlock(std::string& line) override + { + static std::vector<std::regex> hlRegex = { + std::regex("^# (.*)") + , std::regex("^(?:#){2} (.*)") + , std::regex("^(?:#){3} (.*)") + , std::regex("^(?:#){4} (.*)") + , std::regex("^(?:#){5} (.*)") + , std::regex("^(?:#){6} (.*)") + }; + static std::vector<std::string> hlReplacement = { + "<h1>$1</h1>" + , "<h2>$1</h2>" + , "<h3>$1</h3>" + , "<h4>$1</h4>" + , "<h5>$1</h5>" + , "<h6>$1</h6>" + }; + + for (uint8_t i = 0; i < 6; ++i) + { + line = std::regex_replace(line, hlRegex[i], hlReplacement[i]); + } + } +}; // class HeadlineParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/horizontallineparser.h b/inc/maddy/horizontallineparser.h new file mode 100644 index 0000000..add6bf1 --- /dev/null +++ b/inc/maddy/horizontallineparser.h @@ -0,0 +1,106 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <string> +#include <regex> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * HorizontalLineParser + * + * From Markdown: `---` + * + * To HTML: `<hr/>` + * + * @class + */ +class HorizontalLineParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + HorizontalLineParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , lineRegex("^---$") + {} + + /** + * IsStartingLine + * + * If the line has exact three dashes `---`, then it is a horizontal line. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^---$"); + return std::regex_match(line, re); + } + + /** + * IsFinished + * + * The horizontal line is always only one line long, so this method always + * returns true. + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return true; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return false; + } + + bool + isLineParserAllowed() const override + { + return false; + } + + void + parseBlock(std::string& line) override + { + static std::string replacement = "<hr/>"; + + line = std::regex_replace(line, lineRegex, replacement); + } + +private: + std::regex lineRegex; +}; // class HorizontalLineParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/htmlparser.h b/inc/maddy/htmlparser.h new file mode 100644 index 0000000..b6845a7 --- /dev/null +++ b/inc/maddy/htmlparser.h @@ -0,0 +1,127 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <string> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * HtmlParser + * + * @class + */ +class HtmlParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + HtmlParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + , isGreaterThanFound(false) + {} + + /** + * IsStartingLine + * + * If the line is starting with `<`, HTML is expected to follow. + * Nothing after that will be parsed, it only is copied. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + return line[0] == '<'; + } + + /** + * IsFinished + * + * `>` followed by an empty line will end the HTML block. + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return false; + } + + bool + isLineParserAllowed() const override + { + return false; + } + + void + parseBlock(std::string& line) override + { + if (!this->isStarted) + { + this->isStarted = true; + } + + if (!line.empty() && line[line.size() - 1] == '>') + { + this->isGreaterThanFound = true; + return; + } + + if (line.empty() && this->isGreaterThanFound) + { + this->isFinished = true; + return; + } + + if (!line.empty() && this->isGreaterThanFound) + { + this->isGreaterThanFound = false; + } + + if (!line.empty()) + { + line += " "; + } + } + +private: + bool isStarted; + bool isFinished; + bool isGreaterThanFound; +}; // class HtmlParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/imageparser.h b/inc/maddy/imageparser.h new file mode 100644 index 0000000..3ac77ae --- /dev/null +++ b/inc/maddy/imageparser.h @@ -0,0 +1,53 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * ImageParser + * + * Has to be used before the `LinkParser`. + * + * @class + */ +class ImageParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `` + * + * To HTML: `<img src="http://example.com/a.png" alt="text"/>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re("\\!\\[([^\\]]*)\\]\\(([^\\]]*)\\)"); + static std::string replacement = "<img src=\"$2\" alt=\"$1\"/>"; + + line = std::regex_replace(line, re, replacement); + } +}; // class ImageParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/inlinecodeparser.h b/inc/maddy/inlinecodeparser.h new file mode 100644 index 0000000..3699501 --- /dev/null +++ b/inc/maddy/inlinecodeparser.h @@ -0,0 +1,51 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * InlineCodeParser + * + * @class + */ +class InlineCodeParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `text `some code`` + * + * To HTML: `text <code>some code</code>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re("`([^`]*)`"); + static std::string replacement = "<code>$1</code>"; + + line = std::regex_replace(line, re, replacement); + } +}; // class InlineCodeParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/italicparser.h b/inc/maddy/italicparser.h new file mode 100644 index 0000000..ed59744 --- /dev/null +++ b/inc/maddy/italicparser.h @@ -0,0 +1,50 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * ItalicParser + * + * @class + */ +class ItalicParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `text *text*` + * + * To HTML: `text <i>text</i>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re("(?!.*`.*|.*<code>.*)\\*(?!.*`.*|.*<\\/code>.*)([^\\*]*)\\*(?!.*`.*|.*<\\/code>.*)"); + static std::string replacement = "<i>$1</i>"; + line = std::regex_replace(line, re, replacement); + } +}; // class ItalicParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/lineparser.h b/inc/maddy/lineparser.h new file mode 100644 index 0000000..55ec759 --- /dev/null +++ b/inc/maddy/lineparser.h @@ -0,0 +1,46 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * LineParser + * + * @class + */ +class LineParser +{ +public: + /** + * dtor + * + * @method + */ + virtual ~LineParser() {} + + /** + * Parse + * + * From Markdown to HTML + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + virtual void Parse(std::string& line) = 0; +}; // class LineParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/linkparser.h b/inc/maddy/linkparser.h new file mode 100644 index 0000000..e382f21 --- /dev/null +++ b/inc/maddy/linkparser.h @@ -0,0 +1,53 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * LinkParser + * + * Has to be used after the `ImageParser`. + * + * @class + */ +class LinkParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `[text](http://example.com)` + * + * To HTML: `<a href="http://example.com">text</a>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re("\\[([^\\]]*)\\]\\(([^\\]]*)\\)"); + static std::string replacement = "<a href=\"$2\">$1</a>"; + + line = std::regex_replace(line, re, replacement); + } +}; // class LinkParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/orderedlistparser.h b/inc/maddy/orderedlistparser.h new file mode 100644 index 0000000..e41d3b1 --- /dev/null +++ b/inc/maddy/orderedlistparser.h @@ -0,0 +1,142 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <regex> +#include <string> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * OrderedListParser + * + * @class + */ +class OrderedListParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + OrderedListParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + {} + + /** + * IsStartingLine + * + * An ordered list starts with `1. `. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^1\\. .*"); + return std::regex_match(line, re); + } + + /** + * IsFinished + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return true; + } + + bool + isLineParserAllowed() const override + { + return true; + } + + void + parseBlock(std::string& line) override + { + bool isStartOfNewListItem = this->isStartOfNewListItem(line); + uint32_t indentation = getIndentationWidth(line); + + static std::regex orderedlineRegex("^[1-9]+[0-9]*\\. "); + line = std::regex_replace(line, orderedlineRegex, ""); + static std::regex unorderedlineRegex("^\\* "); + line = std::regex_replace(line, unorderedlineRegex, ""); + + if (!this->isStarted) + { + line = "<ol><li>" + line; + this->isStarted = true; + return; + } + + if (indentation >= 2) + { + line = line.substr(2); + return; + } + + if ( + line.empty() || + line.find("</li><li>") != std::string::npos || + line.find("</li></ol>") != std::string::npos || + line.find("</li></ul>") != std::string::npos + ) + { + line = "</li></ol>" + line; + this->isFinished = true; + return; + } + + if (isStartOfNewListItem) + { + line = "</li><li>" + line; + } + } + +private: + bool isStarted; + bool isFinished; + + bool + isStartOfNewListItem(const std::string& line) const + { + static std::regex re("^(?:[1-9]+[0-9]*\\. |\\* ).*"); + return std::regex_match(line, re); + } +}; // class OrderedListParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/paragraphparser.h b/inc/maddy/paragraphparser.h new file mode 100644 index 0000000..303e3b0 --- /dev/null +++ b/inc/maddy/paragraphparser.h @@ -0,0 +1,115 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <string> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * ParagraphParser + * + * @class + */ +class ParagraphParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + ParagraphParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + {} + + /** + * IsStartingLine + * + * If the line is not empty, it will be a paragraph. + * + * This block parser has to always run as the last one! + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + return !line.empty(); + } + + /** + * IsFinished + * + * An empty line will end the paragraph. + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return false; + } + + bool + isLineParserAllowed() const override + { + return true; + } + + void + parseBlock(std::string& line) override + { + if (!this->isStarted) + { + line = "<p>" + line + " "; + this->isStarted = true; + return; + } + + if (line.empty()) + { + line += "</p>"; + this->isFinished = true; + return; + } + + line += " "; + } + +private: + bool isStarted; + bool isFinished; +}; // class ParagraphParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/parser.h b/inc/maddy/parser.h new file mode 100644 index 0000000..add4c45 --- /dev/null +++ b/inc/maddy/parser.h @@ -0,0 +1,294 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <memory> +#include <functional> +#include <string> + +#include "maddy/parserconfig.h" + +// BlockParser +#include "maddy/checklistparser.h" +#include "maddy/codeblockparser.h" +#include "maddy/headlineparser.h" +#include "maddy/horizontallineparser.h" +#include "maddy/htmlparser.h" +#include "maddy/orderedlistparser.h" +#include "maddy/paragraphparser.h" +#include "maddy/quoteparser.h" +#include "maddy/tableparser.h" +#include "maddy/unorderedlistparser.h" + +// LineParser +#include "maddy/breaklineparser.h" +#include "maddy/emphasizedparser.h" +#include "maddy/imageparser.h" +#include "maddy/inlinecodeparser.h" +#include "maddy/italicparser.h" +#include "maddy/linkparser.h" +#include "maddy/strikethroughparser.h" +#include "maddy/strongparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * Parser + * + * Transforms Markdown to HTML + * + * @class + */ +class Parser +{ +public: + /** + * ctor + * + * Initializes all `LineParser` + * + * @method + */ + Parser(std::shared_ptr<ParserConfig> config = nullptr) + : config(config) + , breakLineParser(std::make_shared<BreakLineParser>()) + , emphasizedParser(std::make_shared<EmphasizedParser>()) + , imageParser(std::make_shared<ImageParser>()) + , inlineCodeParser(std::make_shared<InlineCodeParser>()) + , italicParser(std::make_shared<ItalicParser>()) + , linkParser(std::make_shared<LinkParser>()) + , strikeThroughParser(std::make_shared<StrikeThroughParser>()) + , strongParser(std::make_shared<StrongParser>()) + {} + + /** + * Parse + * + * @method + * @param {const std::istream&} markdown + * @return {std::string} HTML + */ + std::string + Parse(std::istream& markdown) const + { + std::string result = ""; + std::shared_ptr<BlockParser> currentBlockParser = nullptr; + + for (std::string line; std::getline(markdown, line);) + { + if (!currentBlockParser) + { + currentBlockParser = getBlockParserForLine(line); + } + + if (currentBlockParser) + { + currentBlockParser->AddLine(line); + + if (currentBlockParser->IsFinished()) + { + result += currentBlockParser->GetResult().str(); + currentBlockParser = nullptr; + } + } + } + + // make sure, that all parsers are finished + if (currentBlockParser) + { + std::string emptyLine = ""; + currentBlockParser->AddLine(emptyLine); + if (currentBlockParser->IsFinished()) + { + result += currentBlockParser->GetResult().str(); + currentBlockParser = nullptr; + } + } + + return result; + } + +private: + std::shared_ptr<ParserConfig> config; + std::shared_ptr<BreakLineParser> breakLineParser; + std::shared_ptr<EmphasizedParser> emphasizedParser; + std::shared_ptr<ImageParser> imageParser; + std::shared_ptr<InlineCodeParser> inlineCodeParser; + std::shared_ptr<ItalicParser> italicParser; + std::shared_ptr<LinkParser> linkParser; + std::shared_ptr<StrikeThroughParser> strikeThroughParser; + std::shared_ptr<StrongParser> strongParser; + + // block parser have to run before + void + runLineParser(std::string& line) const + { + // Attention! ImageParser has to be before LinkParser + this->imageParser->Parse(line); + this->linkParser->Parse(line); + + // Attention! StrongParser has to be before EmphasizedParser + this->strongParser->Parse(line); + + if (!this->config || this->config->isEmphasizedParserEnabled) + { + this->emphasizedParser->Parse(line); + } + + this->strikeThroughParser->Parse(line); + + this->inlineCodeParser->Parse(line); + + this->italicParser->Parse(line); + + this->breakLineParser->Parse(line); + } + + std::shared_ptr<BlockParser> + getBlockParserForLine(const std::string& line) const + { + std::shared_ptr<BlockParser> parser; + + if (maddy::CodeBlockParser::IsStartingLine(line)) + { + parser = std::make_shared<maddy::CodeBlockParser>( + nullptr, + nullptr + ); + } + else if (maddy::HeadlineParser::IsStartingLine(line)) + { + parser = std::make_shared<maddy::HeadlineParser>( + nullptr, + nullptr + ); + } + else if (maddy::HorizontalLineParser::IsStartingLine(line)) + { + parser = std::make_shared<maddy::HorizontalLineParser>( + nullptr, + nullptr + ); + } + else if (maddy::QuoteParser::IsStartingLine(line)) + { + parser = std::make_shared<maddy::QuoteParser>( + [this](std::string& line){ this->runLineParser(line); }, + [this](const std::string& line){ return this->getBlockParserForLine(line); } + ); + } + else if (maddy::TableParser::IsStartingLine(line)) + { + parser = std::make_shared<maddy::TableParser>( + [this](std::string& line){ this->runLineParser(line); }, + nullptr + ); + } + else if (maddy::ChecklistParser::IsStartingLine(line)) + { + parser = this->createChecklistParser(); + } + else if (maddy::OrderedListParser::IsStartingLine(line)) + { + parser = this->createOrderedListParser(); + } + else if (maddy::UnorderedListParser::IsStartingLine(line)) + { + parser = this->createUnorderedListParser(); + } + else if ( + this->config && + !this->config->isHTMLWrappedInParagraph && + maddy::HtmlParser::IsStartingLine(line) + ) + { + parser = std::make_shared<maddy::HtmlParser>(nullptr, nullptr); + } + else if (maddy::ParagraphParser::IsStartingLine(line)) + { + parser = std::make_shared<maddy::ParagraphParser>( + [this](std::string& line){ this->runLineParser(line); }, + nullptr + ); + } + + return parser; + } + + std::shared_ptr<BlockParser> + createChecklistParser() const + { + return std::make_shared<maddy::ChecklistParser>( + [this](std::string& line){ this->runLineParser(line); }, + [this](const std::string& line) + { + std::shared_ptr<BlockParser> parser; + + if (maddy::ChecklistParser::IsStartingLine(line)) + { + parser = this->createChecklistParser(); + } + + return parser; + } + ); + } + + std::shared_ptr<BlockParser> + createOrderedListParser() const + { + return std::make_shared<maddy::OrderedListParser>( + [this](std::string& line){ this->runLineParser(line); }, + [this](const std::string& line) + { + std::shared_ptr<BlockParser> parser; + + if (maddy::OrderedListParser::IsStartingLine(line)) + { + parser = this->createOrderedListParser(); + } + else if (maddy::UnorderedListParser::IsStartingLine(line)) + { + parser = this->createUnorderedListParser(); + } + + return parser; + } + ); + } + + std::shared_ptr<BlockParser> + createUnorderedListParser() const + { + return std::make_shared<maddy::UnorderedListParser>( + [this](std::string& line){ this->runLineParser(line); }, + [this](const std::string& line) + { + std::shared_ptr<BlockParser> parser; + + if (maddy::OrderedListParser::IsStartingLine(line)) + { + parser = this->createOrderedListParser(); + } + else if (maddy::UnorderedListParser::IsStartingLine(line)) + { + parser = this->createUnorderedListParser(); + } + + return parser; + } + ); + } +}; // class Parser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/parserconfig.h b/inc/maddy/parserconfig.h new file mode 100644 index 0000000..e1b10ae --- /dev/null +++ b/inc/maddy/parserconfig.h @@ -0,0 +1,31 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * ParserConfig + * + * @class + */ +struct ParserConfig +{ + bool isEmphasizedParserEnabled; + bool isHTMLWrappedInParagraph; + + ParserConfig() + : isEmphasizedParserEnabled(true) + , isHTMLWrappedInParagraph(true) + {} +}; // class ParserConfig + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/quoteparser.h b/inc/maddy/quoteparser.h new file mode 100644 index 0000000..a3b48d0 --- /dev/null +++ b/inc/maddy/quoteparser.h @@ -0,0 +1,165 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <regex> +#include <string> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * QuoteParser + * + * @class + */ +class QuoteParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + QuoteParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + {} + + /** + * IsStartingLine + * + * A quote starts with `> `. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^\\>.*"); + return std::regex_match(line, re); + } + + /** + * AddLine + * + * Adding a line which has to be parsed. + * + * @method + * @param {std::string&} line + * @return {void} + */ + void + AddLine(std::string& line) override + { + if (!this->isStarted) + { + this->result << "<blockquote>"; + this->isStarted = true; + } + + bool finish = false; + if (line.empty()) + { + finish = true; + } + + this->parseBlock(line); + + if (this->isInlineBlockAllowed() && !this->childParser) + { + this->childParser = this->getBlockParserForLine(line); + } + + if (this->childParser) + { + this->childParser->AddLine(line); + + if (this->childParser->IsFinished()) + { + this->result << this->childParser->GetResult().str(); + this->childParser = nullptr; + } + + return; + } + + if (this->isLineParserAllowed()) + { + this->parseLine(line); + } + + if (finish) + { + this->result << "</blockquote>"; + this->isFinished = true; + } + + this->result << line; + } + + /** + * IsFinished + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return true; + } + + bool + isLineParserAllowed() const override + { + return true; + } + + void + parseBlock(std::string& line) override + { + static std::regex lineRegexWithSpace("^\\> "); + line = std::regex_replace(line, lineRegexWithSpace, ""); + static std::regex lineRegexWithoutSpace("^\\>"); + line = std::regex_replace(line, lineRegexWithoutSpace, ""); + + if (!line.empty()) + { + line += " "; + } + } + +private: + bool isStarted; + bool isFinished; +}; // class QuoteParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/strikethroughparser.h b/inc/maddy/strikethroughparser.h new file mode 100644 index 0000000..2640459 --- /dev/null +++ b/inc/maddy/strikethroughparser.h @@ -0,0 +1,51 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * StrikeThroughParser + * + * @class + */ +class StrikeThroughParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `text ~~text~~` + * + * To HTML: `text <s>text</s>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::regex re("(?!.*`.*|.*<code>.*)\\~\\~(?!.*`.*|.*<\\/code>.*)([^\\~]*)\\~\\~(?!.*`.*|.*<\\/code>.*)"); + static std::string replacement = "<s>$1</s>"; + + line = std::regex_replace(line, re, replacement); + } +}; // class StrikeThroughParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/strongparser.h b/inc/maddy/strongparser.h new file mode 100644 index 0000000..589dacc --- /dev/null +++ b/inc/maddy/strongparser.h @@ -0,0 +1,59 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <string> +#include <regex> + +#include "maddy/lineparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * StrongParser + * + * Has to be used before the `EmphasizedParser`. + * + * @class + */ +class StrongParser : public LineParser +{ +public: + /** + * Parse + * + * From Markdown: `text **text** __text__` + * + * To HTML: `text <strong>text</strong> <strong>text</strong>` + * + * @method + * @param {std::string&} line The line to interpret + * @return {void} + */ + void + Parse(std::string& line) override + { + static std::vector<std::regex> res + { + std::regex{"(?!.*`.*|.*<code>.*)\\*\\*(?!.*`.*|.*<\\/code>.*)([^\\*\\*]*)\\*\\*(?!.*`.*|.*<\\/code>.*)"}, + std::regex{"(?!.*`.*|.*<code>.*)__(?!.*`.*|.*<\\/code>.*)([^__]*)__(?!.*`.*|.*<\\/code>.*)"} + }; + static std::string replacement = "<strong>$1</strong>"; + for (const auto& re : res) + { + line = std::regex_replace(line, re, replacement); + } + } +}; // class StrongParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/tableparser.h b/inc/maddy/tableparser.h new file mode 100644 index 0000000..c230cc6 --- /dev/null +++ b/inc/maddy/tableparser.h @@ -0,0 +1,246 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <string> +#include <regex> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * TableParser + * + * For more information, see the docs folder. + * + * @class + */ +class TableParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + TableParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + , currentBlock(0) + , currentRow(0) + {} + + /** + * IsStartingLine + * + * If the line has exact `|table>`, then it is starting the table. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::string matchString("|table>"); + return line == matchString; + } + + /** + * AddLine + * + * Adding a line which has to be parsed. + * + * @method + * @param {std::string&} line + * @return {void} + */ + void + AddLine(std::string& line) override + { + if (!this->isStarted && line == "|table>") + { + this->isStarted = true; + return; + } + + if (this->isStarted) + { + if (line == "- | - | -") + { + ++this->currentBlock; + this->currentRow = 0; + return; + } + + if (line == "|<table") + { + static std::string emptyLine = ""; + this->parseBlock(emptyLine); + this->isFinished = true; + return; + } + + if (this->table.size() < this->currentBlock + 1) + { + this->table.push_back(std::vector<std::vector<std::string>>()); + } + this->table[this->currentBlock].push_back(std::vector<std::string>()); + + std::string segment; + std::stringstream streamToSplit(line); + + while (std::getline(streamToSplit, segment, '|')) + { + this->parseLine(segment); + this->table[this->currentBlock][this->currentRow].push_back(segment); + } + + ++this->currentRow; + } + } + + /** + * IsFinished + * + * A table ends with `|<table`. + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return false; + } + + bool + isLineParserAllowed() const override + { + return true; + } + + void + parseBlock(std::string&) override + { + result << "<table>"; + + bool hasHeader = false; + bool hasFooter = false; + bool isFirstBlock = true; + uint32_t currentBlockNumber = 0; + + if (this->table.size() > 1) + { + hasHeader = true; + } + + if (this->table.size() >= 3) + { + hasFooter = true; + } + + for (const std::vector<std::vector<std::string>>& block : this->table) + { + bool isInHeader = false; + bool isInFooter = false; + ++currentBlockNumber; + + if (hasHeader && isFirstBlock) + { + result << "<thead>"; + isInHeader = true; + } + else if (hasFooter && currentBlockNumber == this->table.size()) + { + result << "<tfoot>"; + isInFooter = true; + } + else + { + result << "<tbody>"; + } + + for (const std::vector<std::string>& row : block) + { + result << "<tr>"; + + for (const std::string& column : row) + { + if (isInHeader) + { + result << "<th>"; + } + else + { + result << "<td>"; + } + + result << column; + + if (isInHeader) + { + result << "</th>"; + } + else + { + result << "</td>"; + } + } + + result << "</tr>"; + } + + if (isInHeader) + { + result << "</thead>"; + } + else if (isInFooter) + { + result << "</tfoot>"; + } + else + { + result << "</tbody>"; + } + + isFirstBlock = false; + } + + result << "</table>"; + } + +private: + bool isStarted; + bool isFinished; + uint32_t currentBlock; + uint32_t currentRow; + std::vector<std::vector<std::vector<std::string>>> table; +}; // class TableParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/inc/maddy/unorderedlistparser.h b/inc/maddy/unorderedlistparser.h new file mode 100644 index 0000000..0c1aa5d --- /dev/null +++ b/inc/maddy/unorderedlistparser.h @@ -0,0 +1,133 @@ +/* + * This project is licensed under the MIT license. For more information see the + * LICENSE file. + */ +#pragma once + +// ----------------------------------------------------------------------------- + +#include <functional> +#include <regex> +#include <string> + +#include "maddy/blockparser.h" + +// ----------------------------------------------------------------------------- + +namespace maddy { + +// ----------------------------------------------------------------------------- + +/** + * UnorderedListParser + * + * @class + */ +class UnorderedListParser : public BlockParser +{ +public: + /** + * ctor + * + * @method + * @param {std::function<void(std::string&)>} parseLineCallback + * @param {std::function<std::shared_ptr<BlockParser>(const std::string& line)>} getBlockParserForLineCallback + */ + UnorderedListParser( + std::function<void(std::string&)> parseLineCallback, + std::function<std::shared_ptr<BlockParser>(const std::string& line)> getBlockParserForLineCallback + ) + : BlockParser(parseLineCallback, getBlockParserForLineCallback) + , isStarted(false) + , isFinished(false) + {} + + /** + * IsStartingLine + * + * An unordered list starts with `* `. + * + * @method + * @param {const std::string&} line + * @return {bool} + */ + static bool + IsStartingLine(const std::string& line) + { + static std::regex re("^[+*-] .*"); + return std::regex_match(line, re); + } + + /** + * IsFinished + * + * @method + * @return {bool} + */ + bool + IsFinished() const override + { + return this->isFinished; + } + +protected: + bool + isInlineBlockAllowed() const override + { + return true; + } + + bool + isLineParserAllowed() const override + { + return true; + } + + void + parseBlock(std::string& line) override + { + bool isStartOfNewListItem = IsStartingLine(line); + uint32_t indentation = getIndentationWidth(line); + + static std::regex lineRegex("^([+*-] )"); + line = std::regex_replace(line, lineRegex, ""); + + if (!this->isStarted) + { + line = "<ul><li>" + line; + this->isStarted = true; + return; + } + + if (indentation >= 2) + { + line = line.substr(2); + return; + } + + if ( + line.empty() || + line.find("</li><li>") != std::string::npos || + line.find("</li></ol>") != std::string::npos || + line.find("</li></ul>") != std::string::npos + ) + { + line = "</li></ul>" + line; + this->isFinished = true; + return; + } + + if (isStartOfNewListItem) + { + line = "</li><li>" + line; + } + } + +private: + bool isStarted; + bool isFinished; +}; // class UnorderedListParser + +// ----------------------------------------------------------------------------- + +} // namespace maddy diff --git a/res/template-website/.config b/res/template-website/.config new file mode 100644 index 0000000..7956dad --- /dev/null +++ b/res/template-website/.config @@ -0,0 +1,3 @@ +author=John Doe +website=https://example.com/ +index=Home diff --git a/res/template-website/pages/Home b/res/template-website/pages/Home new file mode 100644 index 0000000..d35cb13 --- /dev/null +++ b/res/template-website/pages/Home @@ -0,0 +1,3 @@ +## Welcome + +Hi, enjoy my website. diff --git a/res/template-website/pages/Posts b/res/template-website/pages/Posts new file mode 100644 index 0000000..0d1ac2c --- /dev/null +++ b/res/template-website/pages/Posts @@ -0,0 +1 @@ +<ul>$list_post$</ul> diff --git a/res/template-website/pages/link_Projects b/res/template-website/pages/link_Projects new file mode 100644 index 0000000..d74c395 --- /dev/null +++ b/res/template-website/pages/link_Projects @@ -0,0 +1 @@ +https://git.example.com diff --git a/res/template-website/posts/Welcome b/res/template-website/posts/Welcome new file mode 100644 index 0000000..1fb30aa --- /dev/null +++ b/res/template-website/posts/Welcome @@ -0,0 +1,2 @@ +$date(05.10.2021)$ +first post diff --git a/res/template-website/resources/favicon.png b/res/template-website/resources/favicon.png new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/res/template-website/resources/favicon.png diff --git a/res/template-website/resources/style.css b/res/template-website/resources/style.css new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/res/template-website/resources/style.css diff --git a/res/template-website/templates/footer.html b/res/template-website/templates/footer.html new file mode 100644 index 0000000..7fb2bd6 --- /dev/null +++ b/res/template-website/templates/footer.html @@ -0,0 +1,2 @@ + </body> +</html> diff --git a/res/template-website/templates/header.html b/res/template-website/templates/header.html new file mode 100644 index 0000000..1dfcccf --- /dev/null +++ b/res/template-website/templates/header.html @@ -0,0 +1,16 @@ +<!DOCTYPE html> +<html> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="description" content=""> + <meta name="author" content="$author$"> + <title>$author$ - $title$</title> + <link type="image/png" rel="icon" href="$res(favicon.png)$"> + <link rel="stylesheet" href="$res(style.css)$" type="text/css" media="all"> + </head> + <body> + <header> + <h1>$author$</h1> + <ul id="menu">$list_menu$</ul> + </header> diff --git a/res/template-website/templates/menu_listing.html b/res/template-website/templates/menu_listing.html new file mode 100644 index 0000000..9b080c7 --- /dev/null +++ b/res/template-website/templates/menu_listing.html @@ -0,0 +1 @@ +<li><a href="$link$">$title$</a></li> diff --git a/res/template-website/templates/post_listing.html b/res/template-website/templates/post_listing.html new file mode 100644 index 0000000..9f39bda --- /dev/null +++ b/res/template-website/templates/post_listing.html @@ -0,0 +1,2 @@ + +<li><a href="$link$">$title$ - $date$</a></li> diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt new file mode 100644 index 0000000..81f1e7d --- /dev/null +++ b/src/CMakeLists.txt @@ -0,0 +1,13 @@ +cmake_minimum_required(VERSION 2.6) +include_directories(${PROJECT_SOURCE_DIR}/inc) +add_executable( + ${EXE} + main.cpp + FileAssembler.cpp + ) +add_custom_target(run + COMMAND ${EXE} + DEPENDS ${EXE} + WORKING_DIRECTORY ${CMAKE_PROJECT_DIR} + ) +target_link_libraries(${EXE}) diff --git a/src/FileAssembler.cpp b/src/FileAssembler.cpp new file mode 100644 index 0000000..b224a0c --- /dev/null +++ b/src/FileAssembler.cpp @@ -0,0 +1,232 @@ +#include "../inc/FileAssembler.h" +#include "../inc/maddy/parser.h" +#include <filesystem> +#include <iostream> +#include <string.h> +#include <fstream> +#include <sstream> +#include <list> +#include <map> + +using namespace std; +namespace fs = filesystem; + +FileAssembler::FileAssembler(string path): path(path){ + for (const auto & l1 : fs::directory_iterator(path)){ + if(l1.path() == path+".config") + parse_variables(); + else if(l1.path() == path+"templates" || + l1.path() == path+"pages" || + l1.path() == path+"posts"){ + for (const auto & l2 : fs::directory_iterator(l1.path())){ + string content = get_file_content(l2.path()); + stringstream ss; + shared_ptr<maddy::ParserConfig> config = make_shared<maddy::ParserConfig>(); + config->isEmphasizedParserEnabled = true; // default + config->isHTMLWrappedInParagraph = false; + shared_ptr<maddy::Parser> parser = make_shared<maddy::Parser>(config); + if(l1.path() == path+"templates"){ + templates[l2.path().filename()] = content; + }else if(l1.path() == path+"pages"){ + ss.str(content); + if(l2.path().filename().u8string().substr(0, 5) == "link_") // Link + pages[l2.path().filename()] = content.substr(0,content.length()-1); //keeping plaintext link + else + pages[l2.path().filename()] = parser->Parse(ss); //parsing md to html + }else{ + ss.str(content); + posts[l2.path().filename()] = parser->Parse(ss); //parsing md to html + } + } + } + } +} + +void FileAssembler::parse_variables(){ + string to_parse = get_file_content(path+".config"); + size_t pos_eq = 0; + size_t pos_endl = 0; + while ((pos_eq = to_parse.find("=")) != string::npos){ + if((pos_endl = to_parse.find("\n")) == string::npos) + pos_endl = to_parse.length()-1; + string name = to_parse.substr(0, pos_eq); + variables[name] = to_parse.substr(pos_eq+1, pos_endl-(pos_eq+1)); + to_parse.erase(0,pos_endl+1); + } + if(variables.find("website") == variables.end()){ + cerr << "Error: swg: Variable 'website' is not defined." << endl; + exit(3); + } + string url = variables["website"]; + if(url[url.length()-1] != '/') + url += '/'; + variables["website"] = url; +} + +string FileAssembler::get_file_content(string path){ + fstream file; + file.open(path, ios::in); + string content; + if(file.is_open()){ + string l; + while(getline(file, l)) + content += l+"\n"; + file.close(); + } + return content; +} + +map <string, string> FileAssembler::get_pages(){ + return assemble_from_iterator(pages.begin(), pages.end(), false); +} + +map <string, string> FileAssembler::get_posts(){ + return assemble_from_iterator(posts.begin(), posts.end(), true); +} + +map <string, string> FileAssembler::assemble_from_iterator(map<string, string>::iterator it, map<string, string>::iterator end, bool is_post){ + if(templates.find("header.html") == templates.end()){ + cerr << "Error: swg: header.html is not present in the sourced folder." << endl; + exit(2); + } else if(templates.find("footer.html") == templates.end()){ + cerr << "Error: swg: footer.html is not present in the sourced folder." << endl; + exit(2); + }/* else if(templates.find("menu_listing.html") == templates.end()){ + cerr << "Error: swg: menu_listing.html is not present in the sourced folder." << endl; + exit(2); + } else if(templates.find("post_listing.html") == templates.end()){ + cerr << "Error: swg: post_listing.html is not present in the sourced folder." << endl; + exit(2); + }*/ + map<string, string> p_it; + while (it != end){ + if(it->first.substr(0, 5) != "link_"){ // Ignoring link pages + p_it[it->first] = parse(it->first, templates["header.html"] + it->second + templates["footer.html"], is_post); + } + it ++; + } + return p_it; +} + +string FileAssembler::parse(string title, string to_parse, bool is_post){ + string parsed = to_parse; + string url = variables["website"]; + + if(is_post) + variables["link"] = url + "posts/" + lowercase(title) + ".html"; + else{ + if(title == variables["index"]){ + variables["link"] = url + "index.html"; + }else if(title.substr(0, 5) == "link_"){ // Link + variables["link"] = pages[title]; + }else{ + variables["link"] = url + lowercase(title) + ".html"; + } + variables.erase("date"); // we are not doing it if it's a post, because it could be a listing + } + // Parsing variables and functions + size_t pos_first = 0; + size_t pos_second = 0; + while ((pos_first = parsed.find("$")) != string::npos){ + if((pos_second = parsed.find("$", pos_first+1)) == string::npos){ + cerr << "Error: swg: unclosed $ section in " << title << "." << endl; + } + string input = parsed.substr(pos_first+1, pos_second-pos_first-1); + //cout << pos_first << " + " << pos_second << "=" << input << endl; + + string output = ""; + + if(input == "title") //TITLE + if(title.substr(0, 5) == "link_") // Link + output = title.substr(5,title.length()-5); + else + output = title; + + else if(input.substr(0, 5) == "date("){ + variables["date"] = parse_arg("date",to_parse); + output = " "; // I have to fill the variable to erase the $ section + }else if(variables.find(input) != variables.end()) //VARIABLES + output = variables[input]; + + else if(input.substr(0,4) == "res("){ //RESOURCES + string full_path = input.substr(4,input.length()-1-4); + output = url + full_path; + + if(full_path.find("/") != string::npos){ + size_t s; + + string tok; + string last_tok; + + while ((s = full_path.find("/")) != string::npos){ // Adding the path progressively + tok = full_path.substr(0,s-1); + if(find(cached_res.begin(), cached_res.end(), last_tok+tok) == cached_res.end()) + cached_res.push_back(last_tok+tok); // Not found, adding it + last_tok += tok+"/"; + full_path.erase(0,s); + } + } + if(find(cached_res.begin(), cached_res.end(), input.substr(4,input.length()-1-4)) == cached_res.end()) + cached_res.push_back(input.substr(4,input.length()-1-4)); // Not found, adding it + + + } else if(input.substr(0,5) == "list_"){ //LISTINGS + + string name = input.substr(5,input.length()-1-4); + string list_template = name + "_listing.html"; + + if(templates.find(list_template) == templates.end()){ + cerr << "Error: swg: Listing template '" << list_template << "' does not exist." << endl; + exit(2); + } + + if(name == "menu"){ + string current_link = variables["link"]; + map<string, string>::iterator it = pages.begin(); + while (it != pages.end()){ + output += parse(it->first,templates[list_template], false); + it ++; + } + variables["link"] = current_link; + }else if(name == "post"){ + string current_date = ""; + string current_link = variables["link"]; + if(variables.find("date") != templates.end()) + current_date = variables["date"]; + map<string, string>::iterator it = posts.begin(); + while (it != posts.end()){ + string date = parse_arg("date", it->second); + if(date != "") + variables["date"] = date; + else{ + cerr << "Error: swg: Variable 'date' of post '" << it->first << "' is not defined." << endl; + exit(5); + } + output += parse(it->first,templates[list_template], true); + it ++; + } + if(current_date != "") + variables["date"] = current_date; + else + variables.erase("date"); + variables["link"] = current_link; + } + } + if(output.length() == 0){ + cerr << "Error: swg: Invalid swg text section: \"" << input << "\"." << endl; + exit(4); + } + parsed.replace(pos_first,pos_second-pos_first+1, output); + } + return parsed; +} + +string FileAssembler::parse_arg(string arg_name, string to_parse){ + if(to_parse.substr(3,6) != "$"+arg_name+"(") + return ""; + size_t end = to_parse.find(")"); + if (end == string::npos) + return ""; + string parsed = to_parse.substr(9, end-9); + return parsed; +} diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..333a841 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,108 @@ +#include "../inc/FileAssembler.h" +#include <filesystem> +#include <iostream> +#include <fstream> +#include <cstring> +#include <string> + + +using namespace std; +namespace fs = filesystem; + +void write_file(string path, string content){ + fstream f; + f.open(path, ios::out); + if (!f) { + cerr << "Error: swg: File '" << path << "' could not be created!" << endl; + exit(6); + }else{ + f << content; + f.close(); + } +} + +void recursive_directory_copy(const fs::path& src, const fs::path& dst) noexcept +{ +} + +int generateWebsite(string arg, string config){ + // cout << arg << " " << config << endl; + if(config[config.length()-1] != '/') + config += "/"; + FileAssembler *fa = new FileAssembler(config); + /* TODO + * clean or don't clean*/ + map<string, string> pages = fa->get_pages(); + map<string, string> posts = fa->get_posts(); + string target = fa->get_target(); + string index = fa->get_index(); + + if(!fs::create_directory(target)){ + cerr << "Error: swg: Directory '" << target << "' could not be created!" << endl; + exit(6); + } + if(!fs::create_directory(target+"/posts")){ + cerr << "Error: swg: Directory '" << target << "/posts' could not be created!" << endl; + exit(6); + } + map<string, string>::iterator it = pages.begin(); + while(it != pages.end()){ + if(it->first == index){ + write_file(target+"/index.html", it->second); + }else{ + write_file(target+"/"+FileAssembler::lowercase(it->first)+".html", it->second); + } + it++; + } + + it = posts.begin(); + while(it != posts.end()){ + write_file(target+"/posts/"+FileAssembler::lowercase(it->first)+".html", it->second); + it++; + } + + if (false){ // Only copying the cached resources vs all of them + /** list<string> resources = fa->get_cached_resources(); + + list<string>::iterator res = resources.begin(); + while(res != resources.end()){ + error_code ec; + fs::copy(config+"resources/"+*res, target+"/"+*res,ec); + if(ec.value() != 0){ + cerr << "Error: swg: Resource file '" << *res << "' could not be copied!" << endl; + exit(6); + } + res ++; + } + **/ + }else{ + // Recursively copies all files and folders from src to target and overwrites existing files in target. + try{ + fs::copy(config+"resources/", target, fs::copy_options::overwrite_existing | fs::copy_options::recursive); + }catch (std::exception& e){ + std::cout << e.what(); // TODO better print + } + } + + return 0; +} + +int main(int argc, char * argv[]){ + for(int i = 1; i < argc; i++){ + if(!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help") ){ + cout << "Usage: swg <options>\nOptions are:" << endl; + cout << "Option list goes here" << endl; + exit(0); + }else if(!strcmp(argv[i], "-t") || !strcmp(argv[i], "-g") || !strcmp(argv[i], "-cg")){ + }else{ //TODO - MAKE IT CORRECTLY - ACCEPT TWO PATH IF G IS SPECIFIED + if(i == argc-1){ //passes if not actual options specified because i == argc-1 + return generateWebsite(argv[i-1], argv[i]); + } + cerr << "ERROR: Invalid Command Line Option Found: \"" << argv[i] << "\"." << endl; + return 1; + } + } + + cerr << "ERROR: No Command Line Option Found. Type in --help or -h" << endl; + return 1; +} |
