From: Lady Date: Thu, 5 Mar 2026 02:38:56 +0000 (-0500) Subject: Initial commit X-Git-Url: https://git.ladys.computer/Codemark/commitdiff_plain/refs/heads/%F0%9F%86%95?ds=inline Initial commit At present, this is enough for the code to be able to generate (minimal) documentation for itself. This code was derived from past work on documentation generation for C code, originally written 2025. In fact, the X·S·L·T transform and documentation makefile contain the only actual code derived from this previous effort; the shell script itself descends only in spirit. --- 3b28f452f832724610d843c16a475d0c7a388c29cd52dfe4cf7c762afddba57c diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a361b7e --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Lady +# SPDX-License-Identifier: CC0-1.0 + +/@*.tmp +!/@modules.tmp +*%* diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..7995eae --- /dev/null +++ b/.gitmodules @@ -0,0 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Lady +# SPDX-License-Identifier: CC0-1.0 + +[submodule "LesM·L"] + path = @modules.tmp/💄📝 + url = https://git.ladys.computer/LesML.git diff --git "a/@modules.tmp/\360\237\222\204\360\237\223\235" "b/@modules.tmp/\360\237\222\204\360\237\223\235" new file mode 160000 index 0000000..edd3e26 --- /dev/null +++ "b/@modules.tmp/\360\237\222\204\360\237\223\235" @@ -0,0 +1 @@ +Subproject commit edd3e261cf6e99a747137211256f94fbaefd6e0f000000000000000000000000 diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt new file mode 100644 index 0000000..c2d53c0 --- /dev/null +++ b/LICENSES/CC-BY-SA-4.0.txt @@ -0,0 +1,170 @@ +Creative Commons Attribution-ShareAlike 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. + +Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution-ShareAlike 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. + + C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. + + 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..89c734d --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/MPL-2.0.txt b/LICENSES/MPL-2.0.txt new file mode 100644 index 0000000..4224033 --- /dev/null +++ b/LICENSES/MPL-2.0.txt @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/PROFILE.lesml b/PROFILE.lesml new file mode 100644 index 0000000..57b6d84 --- /dev/null +++ b/PROFILE.lesml @@ -0,0 +1,46 @@ +#!lesml@en$ +## SPDX-FileCopyrightText: 2026 Lady +## SPDX-License-Identifier: CC-BY-SA-4.0 + +⁌ 🧮🖍 Codemark Les·M·L Output + +This document describes the expected Les·ML output of the + `./sh/codemark.sh´ script, which is identified via the profile + `urn:fdc:ladys.computer:20260226:codemark:prf:out´. + +§ Lines Of Code + +Lines of code which represent the literal text of the program are + recorded as plain (toplevel) preformatted lines. +The first line will begin with a comment of the form `syntax:XXX´, + where `XXX´ is the syntax identifier. + +It is important that code does not accidentally contain Les·M·L + formatting, as no escaping is done. +In most cases, only the acute quote is problematic, as it pairs with + the grave quote common in source code. + +§ Code Formatting + +The following conventions are used :⁠— + +• Variable names are underlined (`⸤´ and `⸥´). + +• Comments are marked as inline notes (`⟦´ and `⟧´). + +• Labels are marked as titles (`⟪´ and `⟫´). + +• Strings, numbers, and other values are made offset (`⟨´ and `⟩´). + They are given a class indicating the type of value; one of :⁠— + +◦ ☞︎`string´:☜︎ Characters, codepoints, or sequences there·of. + +◦ ☞︎`numeric´:☜︎ Numeric values of various types. + +◦ ☞︎`boolean´:☜︎ True or false. + +◦ ☞︎`enum´:☜︎ An enumerated value of some sort. + +◦ ☞︎`nullish´:☜︎ Null, undefined, or similar language values. + +• Keywords and commands are made bold (`⦃´ and `⦄´). diff --git a/README.lesml b/README.lesml new file mode 100644 index 0000000..e2dce32 --- /dev/null +++ b/README.lesml @@ -0,0 +1,47 @@ +#!lesml@en$ +## SPDX-FileCopyrightText: 2026 Lady +## SPDX-License-Identifier: CC-BY-SA-4.0 + +⁌ 🧮🖍 Codemark + +☞︎A documentation generator.☜︎ + +The goal of 🧮🖍 Codemark is to make it easy to convert source files + in various programming languages into {🔗LesM·L + files} which document them. +This is done “simply”; i·e with shell scripting and the programs + already installed on your (Posix‐compliant) computer. +The broader intention is that this can serve as a component in a + Make‐based documentation generation program for a repository of + various files. + +§ Usage + +»|sh$ sh ./sh/codemark.sh [--] [source_file] [syntax] + +• If `source_file´ is not provided, it is taken to be `-´ (standard + input). + +• If `syntax´ is not provided, it is taken from the file extension of + `source_file´. + +The makefile in `make/documentation.make´ provides an example (minimal) + build system which makes use of the 🧮🖍 Codemark script. + +§ Description + +The vast majority of markup capabilities are provided by Sed programs, + which are run on source files and whose output is the result. +Each source format supports a syntax for “documentation comments”, + which are essentially unwrapped and treated as the main Les·M·L text + of the file. +The remaining lines are formatted as preformatted text according to the + conventions described in `PROFILE.lesml´. + +With·in a documentation comment, source text in any supported syntax + `SYNTAX´ may be quoted using the line leader `»|SYNTAX$ ´. + +Supported syntaxes are exactly those which have corresponding files in + the `sed/SYNTAXES´ directory in this repository, plus the special + format `lesml´. + diff --git a/make/documentation.make b/make/documentation.make new file mode 100755 index 0000000..878293a --- /dev/null +++ b/make/documentation.make @@ -0,0 +1,145 @@ +#!/usr/bin/make -f +# SPDX-FileCopyrightText: 2024, 2025, 2026 Lady +# SPDX-License-Identifier: MPL-2.0 + +## ⋯ 🧮🖍 Codemark ∷ make ∷ documentation.make +## +## ⁌ Documentation makefile +## +## ] Copyright © 2024–2026 Lady [@ Ladys Computer]. +## ] +## ] This Source Code Form is subject to the terms of the Mozilla +## ] Public License, version 2.0. +## ] If a copy of the M·P·L was not distributed with this file, You can +## ] obtain one at {🔗}. + +SHELL = /bin/sh + +## This makefile is used to generate documentation from source files. +## It is an example usage of 🧮🖍 Codemark you may want to use or +## extend for your own projects. + +# This makefile should be run from the root of the source directory. + +AWK := awk +BASENAME := basename +CAT := cat +CKSUM := cksum +CP := cp +DATE := date +DIRNAME := dirname +FIND := find +GIT := git +MKDIR := mkdir +MV := mv +OD := od +PRINTF := printf +REALPATH := realpath +RM := rm +SED := sed +SORT := sort +TEST := test +TR := tr +XARGS := xargs +XSLTPROC := xsltproc + +CODEMARK := $(or $(patsubst %/make/,%,$(filter %/make/,$(dir $(realpath $(lastword $(MAKEFILE_LIST)))))),.) +LESML := @modules.tmp/💄📝 + +DEFAULTLANG := en +DEFAULTPROFILE := urn:fdc:ladys.computer:20260226:codemark:pf:out + +PROJECTNAME := 🧮🖍 Codemark + +BUILDDIR := @build.tmp +DOCDIR := @documentation.tmp + +FINDRULES := '!' '(' -name '.*' -o -name '*.test.*' ')' + +export LANG := C +export LC_ALL := C + +export cmd_BASENAME := $(BASENAME) +export cmd_CAT := $(CAT) +export cmd_CKSUM := $(CKSUM) +export cmd_CP := $(CP) +export cmd_DATE := $(DATE) +export cmd_DIRNAME := $(DIRNAME) +export cmd_MKDIR := $(MKDIR) +export cmd_MV := $(MV) +export cmd_PRINTF := $(PRINTF) +export cmd_REALPATH := $(REALPATH) +export cmd_RM := $(RM) +export cmd_SED := $(SED) +export cmd_SORT := $(SORT) +export cmd_TEST := $(TEST) +export cmd_TR := $(TR) +export cmd_XARGS := $(XARGS) + +export path_BUILDDIR := $(abspath $(BUILDDIR)) +export path_CODEMARK := $(abspath $(CODEMARK)) + +export lesml_LANG := $(DEFAULTLANG) +export lesml_PROFILE := $(DEFAULTPROFILE) + +SOURCES := $(shell $(FIND) . '(' -type f -a '!' -name '*.license' -o -type d -a '!' '(' '(' -name "@*" -o -name LICENSES ')' -a -prune ')' -o -type d ')'$(if $(FIND_RULES), -a '(' $(FINDRULES) ')',)) + +override syntaxprograms := $(wildcard $(CODEMARK)/sed/SYNTAXES/*.sed) + +override sedprograms := $(syntaxprograms) $(CODEMARK)/sed/syntax-comment.sed + +override syntaxes := lesml $(basename $(notdir $(syntaxprograms))) + +override docforsource = $(patsubst %,$(DOCDIR)/%.xhtml,$(basename $1)) + +override sources := $(patsubst ./%,%,$(foreach syntax,$(syntaxes),$(filter %.$(syntax),$(SOURCES)))) + +override sourcedocs := $(foreach source,$(sources),$(source):$(call docforsource,$(source))) + +override duplicates := $(strip $(foreach source,$(sources),$(filter-out $(source):%,$(filter %:$(call docforsource,$(source)),$(sourcedocs))))) +$(if $(duplicates),$(error Multiple source files map to destination: {$(duplicates)}),) + +override docs := $(foreach source,$(sources),$(call docforsource,$(source))) + +override doclesmls := $(patsubst $(DOCDIR)/%.xhtml,$(BUILDDIR)/documentation/%.lesml,$(docs)) + +override sourcefordoc = $(patsubst %:$1,%,$(filter %:$1,$(sourcedocs))) + +override define newline + + +endef +override empty := +override space := $(empty) $(empty) + +override quote = '$(subst ','"'"',$1)' + +override perdeccmd := $(SED) 's/|/%7C/g;s/[\]/%5C/g;s/%[0123456789ABCDEFabcdef]\{2\}/|&|/g' | $(TR) '|' '\n' | $(SED) '/^%[0123456789ABCDEFabcdef]\{2\}$$/!s/%/|%25|/' | $(TR) '|' '\n' | $(AWK) '$$0!~/%/{printf "%s",$$0}/%/{d="0123456789ABCDEF";v=substr(toupper($$0),2,2);printf "\\%04o",(index(d,substr(v,1,1))-1)*16+index(d,substr(v,2,1))-1}' | $(SED) $(call quote,s/'/'"'"'/g;s/^/'/;s/$$/'/;$$!s/$$/\\/) | $(XARGS) -E '' $(PRINTF) '%b' +override perenc = $(shell $(PRINTF) '%s\n' $(foreach unencoded,$1,$(call quote,$(unencoded))) | $(OD) -t x1 | $(SED) 's/^[0123456789]*//;s/0[Aa]/%&/g;s/2[146789ABCDEabcde]/%&/g;s/3[0123456789AaBbDd]/%&/g;s/40/%&/g;s/[46][123456789ABCDEFabcdef]/%&/g;s/[57][0123456789Aa]/%&/g;s/5[Ff]/%&/g;s/7[Ee]/%&/g;s/[ ][0123456789ABCDEFabcdef]\{2\}/%25&/g' | $(TR) -d ' \n' | $(TR) 'abcdef' 'ABCDEF' | $(perdeccmd)) +override pathenc = $(subst %2F,/,$(call perenc,$1)) + +documentation : $(DOCDIR)/index.xhtml $(docs) ; + +.SECONDEXPANSION: ; + +processlesml = { $(PRINTF) '%s\n%s' '' ''; } | $(XSLTPROC) --stringparam PROJECT_NAME $(call quote,$(PROJECTNAME)) --stringparam DOCDIR $(call quote,$(call pathenc,$(realpath $(DOCDIR)))) $(CODEMARK)/xslt/documentation.xslt - + +$(doclesmls) : $(BUILDDIR)/documentation/%.lesml : $$(call sourcefordoc,$(DOCDIR)/$$*.xhtml) $(sedprograms) $(CODEMARK)/sh/codemark.sh + @if $(TEST) '!' -d $(call quote,$(dir $@)); then $(MKDIR) -p $(call quote,$(dir $@)); fi + @$(PRINTF) '%s\n' $(call quote,Generating documentation for <$<>…) >&2 + @$(CODEMARK)/sh/codemark.sh -- $(call quote,$<) >|$(call quote,$@) + +$(BUILDDIR)/documentation/index.lesml : $(docs) $(sedprograms) $(CODEMARK)/sh/codemark.sh + @if $(TEST) '!' -d $(call quote,$(dir $@)); then $(MKDIR) -p $(call quote,$(dir $@)); fi + @$(PRINTF) '%s\n' 'Generating documentation index…' >&2 + @$(PRINTF) '%s\n\n' '#!lesml@en$$ profile=urn:fdc:ladys.computer:20260226:Codemark:pf:index' $(call quote,⁌ $(PROJECT_NAME) Documentation) $(foreach doc,$(docs), $(call quote,• {🔗./$(patsubst $(DOCDIR)/%,%,$(doc))<$(call pathenc,./$(patsubst $(DOCDIR)/%,%,$(doc)))>})) | $(CODEMARK)/sh/codemark.sh - >|$(call quote,$@) + +$(docs) $(DOCDIR)/index.xhtml : $(DOCDIR)/%.xhtml : $(BUILDDIR)/documentation/%.lesml $(LESML)/parser.xslt $(CODEMARK)/xslt/documentation.xslt + @if $(TEST) '!' -d $(call quote,$(dir $@)); then $(MKDIR) -p $(call quote,$(dir $@)); fi + @$(call processlesml,$<) >|$(call quote,$@) + +$(LESML)/parser.xslt : %/parser.xslt : FORCE + $(GIT) submodule update --init $(call quote,$*) + +FORCE : ; +.PHONY : FORCE documentation diff --git a/sed/SYNTAXES/sh.sed b/sed/SYNTAXES/sh.sed new file mode 100755 index 0000000..3364a26 --- /dev/null +++ b/sed/SYNTAXES/sh.sed @@ -0,0 +1,180 @@ +#!/usr/bin/sed -f +# SPDX-FileCopyrightText: 2025, 2026 Lady +# SPDX-License-Identifier: MPL-2.0 + +## ⋯ 🧮🖍 Codemark ∷ sed ∷ SYNTAXES ∷ sh.sed +## +## ⁌ Shell script syntax +## +## ] Copyright © 2026 Lady [@ Ladys Computer]. +## ] +## ] This Source Code Form is subject to the terms of the Mozilla +## ] Public License, version 2.0. +## ] If a copy of the M·P·L was not distributed with this file, You +## ] can obtain one at {🔗}. + +## § Implementation +## +## S·P·D·X copyright comments are made empty with·out replacement. +## Rather, any copyright information should be expressed in prose. + +/^# SPDX-.*/{ + s/.*// + b +} + +## Documentation comments begin with two hashes. +## The hashes are removed and the next cycle is begun. + +/^##/{ + :indoc + s/^## *// + n + /^##/b indoc + /^$/b +} + +## The behaviour of blank lines (not handled by the above rules) varies +## depending on the line which follows. +## If it is not a documentation comment, a pipe is prepended. + +/^$/{ + N + /\n##/!s/^/|/ + P + D +} + +## We can now assume that the current line did not begin with two +## hashes; it should be treated as code. +## +## Lines which begin with (single) hashes are comments and not +## processed further. +/^ *#/{ + s/^\( *\)\(#.*\)/|\1⟦\2⟧/ + b +} + +## An initial and final space is added to make processing easier. +## These will be removed at the end. + +s/^/ / +s/$/ / + +## Variable defaults must follow a colon `:´ command and be specified +## either as a string or as a reference to another variable. + +/^ *: "[$]{[^:}]*:=/{ + s/"[$]{\([^:]*\):=\([^$"}]*\)}"/⟨"${⸤\1⸥:=\2}"⟩{@class="string"}/ + s/"[$]{\([^:]*\):=\([$]{[^}]*}\)}"/⟨"${⸤\1⸥:=\2}"⟩{@class="string"}/ +} + +## Control flow keywords such as `if´ or `for´ must begin their line. +## They are handled upfront as they are easily recognized. +## +## For `then´, `else´, and `do´, following them with the no·op command +## `:´ is recommended as a matter of style, but not required. + +/^ *if [^ ]/s/if \([^ ]*\)/⦃︎if⦄︎ ⦃︎\1⦄︎/ +/^ *then [^ ]/s/then \([^ ]*\)/⦃then⦄︎ ⦃︎\1⦄︎/ +/^ *else [^ ]/s/else \([^ ]*\)/⦃else⦄︎ ⦃︎\1⦄︎/ +/^ *fi /s/fi/⦃︎fi⦄︎/ +/^ *for [^ ][^ ]* in /s/for \([^ ]*\) in/⦃︎for⦄︎ ⸤†1⸥ ⦃︎in⦄︎/ +/^ *do [^ ]/s/do \([^ ]*\)/⦃do⦄︎ ⦃︎\1⦄︎/ +/^ *done /s/done/⦃done⦄︎/ + +## It is not permitted to pipe into a control flow keyword. +## So, after pipes, the script will jump here to begin processing. + +:postpipe + +## When a line begins with the sequence `)"´, it is assumed to be +## closing a subshell. +## In this case, the script skips ahead to avoid recognizing this +## sequence as a command. + +/^ *)"/b postback + +## The first word which is not a variable assignment is assumed to be +## the name of a command, unless this line already contains markup +## from control flow processing. + +/⦃︎/!s/ \([^ =][^ =]*\) / ⦃︎\1⦄︎ / + +## Variables must be processed in a loop because there can be multiple +## on a line. +## However, they are only processed up to the first instance of `⦃︎´ +## markup (presumably inserted by the above rules). + +:variable +/^\([^=]*\([^A-Za-z][^0-9A-Za-z_]*=\)*\)*⦃︎/!{ + s/ \([A-Za-z][0-9A-Za-z_]*\)=/ ⸤\1⸥=/ + / [A-Za-z][0-9A-Za-z_]*=/b variable +} + +## After backslashes (line continuations) or subshells, it is assumed +## that the line is in the middle of a command. +## By jumping here, the program skips variable and command name +## processing. + +:postback + +## After `&&´, `||´, and `|´, the following word is a command. + +s/ \(&&\) \([^ ]*\) / \1 ⦃\2⦄︎ / +s/ || \([^ ]*\) / || ⦃\1⦄︎ / +s/ | \([^ ]*\) / | ⦃\1⦄︎ / + +## Some rules are enforced for strings :⁠— +## +## • When a string wraps a variable reference, it must have the form +## `"${VARIABLE_NAME}"´ (the variable must be the only thing in the +## string). +## +## • When a string wraps a subshell, the text of the subshell +## invocation must be on its own line. +## The string must not contain anything aside from the subshell; it +## must begin `"$(´ and end `)"´. +## +## • Strings consisting of only a straight single quote must be +## double‐quoted. +## +## • Otherwise, strings must be single‐quoted. +## +## The shell syntax allows strings to be concatenated by placing them +## directly adjacent to each other, so a variable reference and a +## literal value may be joined together in this manner. + +s/"'"/⟨"'"⟩{@class="string"}/g +s/"${\([^}]*\)}"/⟨"${\1}"⟩{@class="string"}/g +/^ *)"/s/)"/⟨)"⟩{@class="string"}/g +s/"$(/⟨"$(⟩{@class="string"}/g +s/\('[^']*'\)/⟨\1⟩{@class="string"}/g + +## The initial and final spaces added above can now be removed. + +s/^ // +s/ $// + +## Finally, a `|´ can be prepended to mark the line as preformatted. + +s/^/|/ + +## If the current line of code ends in a backslash or a pipe, the +## following line is a continuation of it. +## The `n´ command manually advances to the next line with·out starting +## a new cycle, and the program then jumps to the correct place for +## what might follow. + +/[\]$/{ + n + s/^/ / + s/$/ / + b postback +} +/|$/{ + n + s/^/ / + s/$/ / + b postpipe +} diff --git a/sed/syntax-comment.sed b/sed/syntax-comment.sed new file mode 100755 index 0000000..76a8e8e --- /dev/null +++ b/sed/syntax-comment.sed @@ -0,0 +1,39 @@ +#!/usr/bin/sed -f +# SPDX-FileCopyrightText: 2026 Lady +# SPDX-License-Identifier: MPL-2.0 + +## ⋯ 🧮🖍 Codemark ∷ sed ∷ syntax-comment.sed +## +## ⁌ The “syntax comment” Sed program +## +## ] Copyright © 2026 Lady [@ Ladys Computer]. +## ] +## ] This Source Code Form is subject to the terms of the Mozilla +## ] Public License, version 2.0. +## ] If a copy of the M·P·L was not distributed with this file, You +## ] can obtain one at {🔗}. + +## The program begins in the “outside” state. +## When a line starting with `|´ is encountered, it prints a syntax +## comment and switches to the “inside” state. + +:outside +/^|/{ + s/^|/|⌦syntax:⌫/ + b inside +} + +## If the line did not begin with `|´, the program advances and stays +## “outside”. + +n +b outside + +## Once “inside”, the program advances and switches to “outside” as +## soon as it encounters a line which does not begin with a `|´. +## Otherwise, it stays “inside”. + +:inside +n +/^|/!b outside +b inside diff --git a/sh/codemark.sh b/sh/codemark.sh new file mode 100755 index 0000000..62e7766 --- /dev/null +++ b/sh/codemark.sh @@ -0,0 +1,235 @@ +#!/usr/bin/env sh +# SPDX-FileCopyrightText: 2026 Lady +# SPDX-License-Identifier: MPL-2.0 + +## ⋯ 🧮🖍 Codemark ∷ sh ∷ codemark.sh +## +## ⁌ The 🧮🖍 Codemark shell script +## +## ] Copyright © 2026 Lady [@ Ladys Computer]. +## ] +## ] This Source Code Form is subject to the terms of the Mozilla +## ] Public License, version 2.0. +## ] If a copy of the M·P·L was not distributed with this file, You can +## ] obtain one at {🔗}. + +## Usage :⁠— +## +## »|sh$ sh ./sh/codemark.sh [--] [filename] [syntax] + +set -o 'errexit' + +## `set -o 'pipefail'´ is disabled because the (now quite old) version +## of Dash bundled with Mac·O·S does not support it. +## If it is ever upgraded to Posix 2024 compliance, then the option can +## (and should) be enabled. +## See the `sh´ directory at +## {🔗} for +## the current source code for Mac·O·S Dash. + +# set -o 'pipefail' + +## `LANG´ and `LC_ALL´ are set to `C´ because these scripts assume +## working with U·T·F‐8 strings as opaque series of bytes. + +LANG='C' +LC_ALL='C' + +## § Variable defaults +## +## All of the commands used by this script are overridable with your +## own implementations by setting the corresponding `cmd_COMMAND´ +## variable. +## The hope is that this provides a somewhat easier overriding +## mechanism than those built into the shell (e·g defining a function +## of the same name or overriding the `PATH´). + +: "${cmd_AWK:=awk}" +: "${cmd_BASENAME:=basename}" +: "${cmd_CAT:=cat}" +: "${cmd_CKSUM:=cksum}" +: "${cmd_CP:=cksum}" +: "${cmd_DATE:=date}" +: "${cmd_DIRNAME:=dirname}" +: "${cmd_MKDIR:=mkdir}" +: "${cmd_MV:=cksum}" +: "${cmd_PRINTF:=printf}" +: "${cmd_REALPATH:=realpath}" +: "${cmd_RM:=cksum}" +: "${cmd_SED:=sed}" +: "${cmd_SORT:=sort}" +: "${cmd_TEST:=test}" +: "${cmd_TR:=tr}" +: "${cmd_XARGS:=xargs}" + +## Similarly, there are a few special paths that this program needs to +## run. +## Their default values are calculated below. + +thisfile="$( + "${cmd_REALPATH}" -- "${0}" +)" +thisdir="$( + "${cmd_DIRNAME}" -- "${thisfile}" +)" +defaultbuilddir='@build.tmp/🧮🖍' +defaultcodemark="$( + "${cmd_REALPATH}" -- "${thisdir}"'/..' +)" +defaultsyntaxdir="${path_CODEMARK}"'/sed/SYNTAXES' + +: "${path_BUILDDIR:=${defaultbuilddir}}" +: "${path_CODEMARK:=${defaultcodemark}}" +: "${path_SYNTAXDIR:=${defaultsyntaxdir}}" + +## § Parameter processing +## +## A leading `--´ is allowed (and ignored). +## Otherwise, the first parameter is the source filename, and the +## second the syntax id. + +if "${cmd_TEST}" "${1}" = '--' +then : + shift +fi + +## If no input file is provided, it defaults to `-´ (standard input). + +if "${cmd_TEST}" -n "${1}" && "${cmd_TEST}" "${1}" != '-' +then : + inputfile="$( + "${cmd_REALPATH}" -- "${1}" + )" +else : + inputfile='-' +fi + +## If no syntax is provided, it is taken from the extension of the +## input file (the characters following the final `.´). +## If the input file does not have an extension, the syntax defaults to +## `lesml´. + +mainsyntax="${2}" +if "${cmd_TEST}" -z "${mainsyntax}" +then : + mainsyntax="$( + "${cmd_PRINTF}" '%s\n' "${inputfile}" | + "${cmd_SED}" '/[.][^/][^/]*$/!s/$/.lesml/;s/.*[.]\([^/]*\)$/\1/' + )" +fi + +## The `sedprog´ variable gives the filename of the Sed program which +## describes the current syntax. + +if "${cmd_TEST}" "${mainsyntax}" = 'lesml' +then : + sedprog= +else : + sedprog="${path_SYNTAXDIR}"'/'"${mainsyntax}"'.sed' +fi + +## It is an error if the main syntax is not `lesml´ and has no syntax +## definition. + +if "${cmd_TEST}" -n "${sedprog}" && "${cmd_TEST}" ! -f "${sedprog}" +then : + "${cmd_PRINTF}" '%s\n' 'Unrecognized syntax: '"${mainsyntax}"'.' >&2 + exit 1 +fi + +## § Processing the file +## +## The input file is processed and saved to a temporary file whose +## filename is generated from the current time and a hash of the +## input filename. +## The hope is that this is enough to prevent collisions (assuming two +## versions of this script do not attempt to process the same file at +## the same second). + +temphash="$( + "${cmd_PRINTF}" '%s\n' "${inputfile}" | "${cmd_CKSUM}" +)" +temptime="$( + "${cmd_DATE}" -u '+%Y%m%d%H%M%S' +)" +tempfile="${path_BUILDDIR}"'/'"${temphash}"'@'"${temptime}"'.lesml' + +## Assuming the syntax is not `lesml´, the input file is processed to +## produce Les·M·L output. +## This is then saved to the tempfile. +## If the syntax ⹐is⹑ `lesml´, the input file is simply copied. + +if "${cmd_TEST}" "${mainsyntax}" = 'lesml' +then : + if "${cmd_TEST}" "${inputfile}" = '-' + then : + "${cmd_CAT}" >|"${tempfile}" + else : + "${cmd_CP}" -- "${inputfile}" "${tempfile}" + fi +else : + if "${cmd_TEST}" "${inputfile}" = '-' + then : + "${cmd_SED}" -f "${sedprog}" | + "${cmd_SED}" -f "${path_CODEMARK}"'/sed/syntax-comment.sed' | + "${cmd_SED}" 's//'"${mainsyntax}"'/g' >|"${tempfile}" + else : + "${cmd_SED}" -f "${sedprog}" <"${inputfile}" | + "${cmd_SED}" -f "${path_CODEMARK}"'/sed/syntax-comment.sed' | + "${cmd_SED}" 's//'"${mainsyntax}"'/g' >|"${tempfile}" + fi +fi + +## Next, tagged code blocks in the Les·M·L need to be processed. +## First, a list of syntaxes must be collected. + +syntaxes=$( + "${cmd_SED}" '/^»|[^ $]*$ /!d;s/»|\([^ $]*\).*/\1/' <"${tempfile}" | + "${cmd_SORT}" -u | + "${cmd_TR}" -s '\n' ' ' +) + +## Each syntax can then be processed. +## Processing blanks out all lines not in the syntax, removes the +## syntax prefix, processes the resulting file, and then restores the +## blanked out lines. +## Unlike with the main syntax, missing syntaxes at this stage are +## simply ignored. + +for s in ${syntaxes} +do : + syntaxprog="${path_SYNTAXDIR}/${s}.sed" + if "${cmd_TEST}" -f "${syntaxprog}" + then : + "${cmd_MV}" -- "${tempfile}" "${tempfile}"'~' + "${cmd_SED}" \ + -e '/^»|'${s}'$ /!s/.*//;s/^»|'${s}'$ //' \ + -f "${syntaxprog}" \ + -e '//s/.*//' \ + <"${tempfile}"'~' | + "${cmd_SED}" -f "${path_CODEMARK}"'/sed/syntax-comment.sed' | + "${cmd_SED}" 's//'${s}'/g;/./s/^/»/' | + "${cmd_AWK}" \ + -F '\037' \ + 'FNR==NR{a[NR]=$0;next};{r=/^»\|'${s}'\$ /};r{print a[FNR]};!r' \ + - "${tempfile}"'~' \ + >|"${tempfile}" + "${cmd_RM}" -- "${tempfile}"'~' + fi +done + +## Finally, the resulting file is written to standard output and +## deleted. + +if "${cmd_TEST}" -z "$( + "${cmd_SED}" -n '/#!lesml/p;q' <"${tempfile}" +)" +then : + defaultheader='#!lesml@'"${lesml_LANG}"'$ profile='"${lesml_PROFILE}" + : "${lesml_LANG:=en}" + : "${lesml_PROFILE:=urn:fdc:ladys.computer:20260226:codemark:pf:out}" + : "${lesml_HEADER:=${defaultheader}}" + "${cmd_PRINTF}" '%s\n' "${lesml_HEADER}" +fi +"${cmd_CAT}" -- "${tempfile}" +"${cmd_RM}" -- "${tempfile}" diff --git a/xslt/documentation.xslt b/xslt/documentation.xslt new file mode 100644 index 0000000..fec5467 --- /dev/null +++ b/xslt/documentation.xslt @@ -0,0 +1,176 @@ + + + +⋯ 🧮🖍 Codemark ∷ xslt ∷ documentation.xslt + +⁌ Documentation transform + +] © 2025–2026 Lady [@ Ladys Computer]. +] +] This Source Code Form is subject to the terms of the Mozilla Public +] License, version 2.0. +] If a copy of the M·P·L was not distributed with this file, You can +] obtain one at {🔗}. +<--> + +]> + + + + + + + + + +