diff options
| author | Ruben Beltran del Rio <jj@r.bdr.sh> | 2026-06-15 14:35:36 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <jj@r.bdr.sh> | 2026-06-16 14:47:30 +0200 |
| commit | 657aa83a5ca24dc35572c040df64a0abb85e8612 (patch) | |
| tree | fe0b6fd425d8cad9dc6a28ada4ad8600e42b367e | |
Initial extraction from Norganize
33 files changed, 1947 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d2c5c89 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.DS_Store +/.build +/Packages +xcuserdata/ +DerivedData/ +.swiftpm/configuration/registries.json +.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata +.netrc +*.profraw diff --git a/.swiftlint.yml b/.swiftlint.yml new file mode 100644 index 0000000..51b479a --- /dev/null +++ b/.swiftlint.yml @@ -0,0 +1,36 @@ +# SwiftLint configuration for NorgKit. +# Tuned to the existing style rather than forcing churn: the parsers use short, +# conventional cursor names (i, j, lo, hi, c, s, m) and the recogniser functions +# are intentionally long, flat state machines. + +included: + - Sources + - Tests + - Benchmarks + +identifier_name: + # Allow short loop/cursor names that read clearly in tight parsing loops. + min_length: + warning: 1 + error: 1 + +line_length: + warning: 120 + error: 160 + ignores_comments: true + ignores_urls: true + +function_body_length: + warning: 80 + error: 120 + +cyclomatic_complexity: + warning: 15 + error: 25 + +disabled_rules: + # "TODO" appears in doc comments describing Norg's TODO-status syntax. + - todo + # Trailing commas are used selectively (e.g. the modifier tables); leave the + # choice to the author rather than enforcing one way. + - trailing_comma diff --git a/Justfile b/Justfile new file mode 100644 index 0000000..c6ac58d --- /dev/null +++ b/Justfile @@ -0,0 +1,24 @@ +profile := "debug" + +default: build + +build: + swift build -c {{profile}} + +test: + swift test + +coverage: + swift test --enable-code-coverage + xcrun llvm-cov report \ + .build/debug/NorgUITests.xctest/Contents/MacOS/NorgUITests \ + -instr-profile=.build/debug/codecov/default.profdata + +format: + swift-format --in-place --recursive Sources Tests + swiftlint --fix Sources Tests + +lint: + swiftlint Sources Tests + +ci: lint test @@ -0,0 +1,661 @@ +GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + NorgUI, SwiftUI components to render parsed Norg Files + Copyright (C) 2026 Ruben Beltran del Rio + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<https://www.gnu.org/licenses/>. diff --git a/Package.swift b/Package.swift new file mode 100644 index 0000000..c9a9448 --- /dev/null +++ b/Package.swift @@ -0,0 +1,51 @@ +// swift-tools-version: 6.4 +// The swift-tools-version declares the minimum version of Swift required to build this package. + +import PackageDescription + +let package = Package( + name: "NorgUI", + defaultLocalization: "en", + platforms: [ + .iOS(.v18), + .macOS(.v15), + .visionOS(.v2), + ], + products: [ + // Products define the executables and libraries a package produces, making them visible to other packages. + .library( + name: "NorgUI", + targets: ["NorgUI"] + ), + ], + dependencies: [ + // NorgKit provides the parser and model value types. Uses a local path + // while the packages are developed side by side; switch to a tagged + // git dependency once NorgKit is published. + .package(path: "../norgkit"), + ], + targets: [ + // Targets are the basic building blocks of a package, defining a module or a test suite. + // Targets can depend on other targets in this package and products from dependencies. + .target( + name: "NorgUI", + dependencies: [ + .product(name: "NorgKit", package: "norgkit"), + ], + resources: [ + .process("Resources"), + ], + swiftSettings: [ + .enableUpcomingFeature("ApproachableConcurrency"), + ], + ), + .testTarget( + name: "NorgUITests", + dependencies: ["NorgUI"], + swiftSettings: [ + .enableUpcomingFeature("ApproachableConcurrency"), + ], + ), + ], + swiftLanguageModes: [.v6] +) diff --git a/README.md b/README.md new file mode 100644 index 0000000..6d4f6e2 --- /dev/null +++ b/README.md @@ -0,0 +1,142 @@ +# NorgUI + +NorgUI provides themable SwiftUI views to render `.norg` / [Neorg](https://github.com/nvim-neorg/neorg) documents +parsed with [NorgKit](https://git.sr.ht/~rbdr/norgkit). + +`NorgUI` doesn't provide editing capabilities. + +## Installation + +Add the package with Xcode package manager: `https://git.r.bdr.sh/norgui`, and +depend on `NorgUI` from your target. + +## Usage + +Parse a document with `NorgKit` and render it with `NorgView`: + +import SwiftUI +import NorgKit +import NorgUI + +```swift +struct NoteView: View { + let source: String + + var body: some View { + ScrollView { + NorgView(document: NorgParser.parse(source)) { line, status in + // Persist the new status back to your file at `line`. + } + .padding() + } + } +} +``` + +The `onSetStatus` callback is optional (defaults to a no-op) and fires when the +user taps or long-presses a task's status symbol, reporting the source `line` +and the chosen `TaskStatus`. + +### Links + +Links are handled via an `onOpenLink` optional callback which will give you the +`InlineLink`. If you don't provide one, external links will be handled by the +system, while internal links and anchors will be inert. + +```swift +NorgView(document: document) { link in + switch link.target { + case let target? where target.hasPrefix("http"): openURL(URL(string: target)!) + default: scrollTo(target: link.target) // a heading/anchor in this document + } +} +``` + +### Collapsible View + +Pass `collapsible: true` to render the document as a tree of `DisclosureGroup`s. +Headings collapse their content, nested lists and quotes collapse their +children, and definitions/footnotes/table cells collapse their body. Each +section manages its own expand/collapse state and starts expanded. + +```swift +NorgView(document: NorgParser.parse(source), collapsible: true) +``` + +### Tasks + +You can render tasks independently (eg. if you got them via `TaskScanner`) with +`NorgTaskView`. + +```swift +NorgTaskView( + status: task.status, + text: AttributedString(task.text), + onToggle: { setStatus(task, .done) }, + onSetStatus: { setStatus(task, $0) } +) +``` + +## Theming + +Fonts and colors can be changed by creating a `NorgTheme` and using the +`.norgTheme` modifier. + +```swift +var theme = NorgTheme.default +theme.linkColor = .purple +theme.heading = { level in level == 1 ? .largeTitle.bold() : .title2 } +theme.statusSymbol = { $0 == .done ? "checkmark.square.fill" : "square" } + +NorgView(document: document) + .norgTheme(theme) +``` + +Note: `AttributedString(norg:)` can't read the environment, so you need to pass +the theme explicitly if you build text outside the views. + +```swift +let styled = AttributedString(norg: spans, theme: theme) +``` + +### NorgTheme API + +| Property | Type | Default | Styles | +| --- | --- | --- | --- | +| `heading` | `(Int) -> Font` | `.title.bold()` (lvl 1) down to `.subheadline` | Heading text, per level | +| `body` | `Font` | `.body` | Paragraphs, list items, quotes | +| `termFont` | `Font` | `.body.bold()` | Definition / footnote / table-cell titles | +| `verbatimColor` | `Color` | `.pink` | `verbatim` inline spans | +| `spoilerForeground` | `Color` | `.secondary` | `spoiler` inline text | +| `spoilerBackground` | `Color` | `.secondary.opacity(0.25)` | `spoiler` inline background | +| `linkColor` | `Color` | `.accentColor` | Links and anchors | +| `superscriptOffset` | `CGFloat` | `5` | `superscript` baseline offset | +| `subscriptOffset` | `CGFloat` | `-3` | `subscript` baseline offset | +| `quoteColor` | `Color` | `.secondary` | Quote text | +| `quoteBarColor` | `Color` | `.secondary` | Quote's vertical bar | +| `codeBackground` | `AnyShapeStyle` | `.quaternary` | Code blocks and ranged tags | +| `codeFont` | `Font` | `.system(.callout, design: .monospaced)` | Code blocks and ranged tags | +| `indentWidth` | `CGFloat` | `18` | Indentation per nesting level | +| `statusTint` | `(TaskStatus) -> Color` | `.green` / `.red` / `.blue` / `.secondary` | Task status symbol colour | +| `statusSymbol` | `(TaskStatus) -> String` | SF Symbols (`circle`, `checkmark.circle.fill`, …) | Task status symbol | +| `statusLabel` | `(TaskStatus) -> LocalizedStringResource` | `TaskStatus.displayName` | Task status menu label & accessibility | + +## Localization + +NorgUI provides labels for the long-press menu in tasks. These can be localized +either through the package's own string catalog, but can be overridden in +the theme. + +```swift +var theme = NorgTheme.default +theme.statusLabel = { status in + LocalizedStringResource(String.LocalizationValue(status.rawValue), table: "Tasks") +} +``` + +`statusLabel` defaults to `TaskStatus.displayName`. + +## Requirements + +- Swift 6 tools +- iOS 18 / macOS 15 / visionOS 2 diff --git a/Sources/NorgUI/Extensions/AttributedString+Norg.swift b/Sources/NorgUI/Extensions/AttributedString+Norg.swift new file mode 100644 index 0000000..286e0c8 --- /dev/null +++ b/Sources/NorgUI/Extensions/AttributedString+Norg.swift @@ -0,0 +1,74 @@ +import NorgKit +import SwiftUI + +/// Extensions to AttributedString to generate from NorgKit models. +extension AttributedString { + + /// Builds a styled attributed string from parsed Norg inline spans. + public init(norg spans: [InlineSpan], baseFont: Font = .body, theme: NorgTheme = .default) { + var result = AttributedString() + for span in spans { + result.append(Self.render(span, baseFont: baseFont, theme: theme)) + } + self = result + } + + private static func render(_ span: InlineSpan, baseFont: Font, theme: NorgTheme) + -> AttributedString { + var run = AttributedString(span.text) + run.font = font(for: span.styles, baseFont: baseFont) + applyDecorations(to: &run, styles: span.styles, theme: theme) + if let link = span.link { + applyLink(link, to: &run, theme: theme) + } + return run + } + + private static func font(for styles: InlineStyle, baseFont: Font) -> Font { + var font = baseFont + if styles.contains(.verbatim) || styles.contains(.math) { font = font.monospaced() } + if styles.contains(.bold) { font = font.bold() } + if styles.contains(.italic) { font = font.italic() } + return font + } + + private static func applyDecorations( + to run: inout AttributedString, styles: InlineStyle, theme: NorgTheme + ) { + if styles.contains(.underline) { run.underlineStyle = .single } + if styles.contains(.strikethrough) { run.strikethroughStyle = .single } + if styles.contains(.superscript) { run.baselineOffset = theme.superscriptOffset } + if styles.contains(.subscript) { run.baselineOffset = theme.subscriptOffset } + if styles.contains(.spoiler) { + run.foregroundColor = theme.spoilerForeground + run.backgroundColor = theme.spoilerBackground + } + if styles.contains(.verbatim) { + run.foregroundColor = theme.verbatimColor + } + } + + private static func applyLink( + _ link: InlineLink, to run: inout AttributedString, theme: NorgTheme + ) { + run.foregroundColor = theme.linkColor + run.underlineStyle = .single + run.link = url(for: link) + } + + private static func url(for link: InlineLink) -> URL? { + if link.kind == .link, let target = link.target, let external = externalURL(for: target) { + return external + } + return NorgLinkURL.encode(link) + } + + private static func externalURL(for target: String) -> URL? { + let lower = target.lowercased() + guard lower.hasPrefix("http://") || lower.hasPrefix("https://") || lower.hasPrefix("file://") + else { + return nil + } + return URL(string: target) + } +} diff --git a/Sources/NorgUI/Extensions/TaskStatus+UI.swift b/Sources/NorgUI/Extensions/TaskStatus+UI.swift new file mode 100644 index 0000000..e54e511 --- /dev/null +++ b/Sources/NorgUI/Extensions/TaskStatus+UI.swift @@ -0,0 +1,24 @@ +import Foundation +import NorgKit + +/// Adds UI rendering labels for TaskStatus. +extension TaskStatus { + + /// A localized, human-readable name for the status. + public var displayName: LocalizedStringResource { + switch self { + case .undone: return Self.label("Undone") + case .done: return Self.label("Done") + case .needsInput: return Self.label("Needs input") + case .urgent: return Self.label("Urgent") + case .recurring: return Self.label("Recurring") + case .pending: return Self.label("Pending") + case .onHold: return Self.label("On hold") + case .cancelled: return Self.label("Cancelled") + } + } + + private static func label(_ value: String.LocalizationValue) -> LocalizedStringResource { + LocalizedStringResource(value, bundle: .atURL(Bundle.module.bundleURL)) + } +} diff --git a/Sources/NorgUI/Helpers/NorgLinkURL.swift b/Sources/NorgUI/Helpers/NorgLinkURL.swift new file mode 100644 index 0000000..9b73fe3 --- /dev/null +++ b/Sources/NorgUI/Helpers/NorgLinkURL.swift @@ -0,0 +1,25 @@ +import Foundation +import NorgKit + +public enum NorgLinkURL { + public static let scheme = "norgui-link" + + public static func encode(_ link: InlineLink) -> URL? { + var components = URLComponents() + components.scheme = scheme + components.host = link.kind == .anchor ? "anchor" : "link" + if let target = link.target { + components.queryItems = [URLQueryItem(name: "target", value: target)] + } + return components.url + } + + public static func decode(_ url: URL) -> InlineLink? { + guard url.scheme == scheme else { return nil } + let kind: InlineLink.Kind = url.host == "anchor" ? .anchor : .link + let target = + URLComponents(url: url, resolvingAgainstBaseURL: false)? + .queryItems?.first { $0.name == "target" }?.value + return InlineLink(kind: kind, target: target) + } +} diff --git a/Sources/NorgUI/Helpers/Ordinals.swift b/Sources/NorgUI/Helpers/Ordinals.swift new file mode 100644 index 0000000..649c3e0 --- /dev/null +++ b/Sources/NorgUI/Helpers/Ordinals.swift @@ -0,0 +1,32 @@ +import NorgKit + +/// Assigns sequential numbers to ordered list items. +func orderedOrdinals(_ blocks: [NorgBlock]) -> [Int?] { + var counters: [Int: Int] = [:] + return blocks.map { block in + switch block { + case .orderedListItem(let level, _, _, _): + counters = counters.filter { $0.key <= level } + counters[level, default: 0] += 1 + return counters[level] + case .unorderedListItem(let level, _, _, _): + counters = counters.filter { $0.key < level } + return nil + default: + counters.removeAll() + return nil + } + } +} + +/// Numbers the ordered list items within a single tree branch. +func ordinals(forSiblings nodes: [NorgNode]) -> [Int?] { + var counter = 0 + return nodes.map { node in + if case .orderedListItem = node.block { + counter += 1 + return counter + } + return nil + } +} diff --git a/Sources/NorgUI/Resources/Localizable.xcstrings b/Sources/NorgUI/Resources/Localizable.xcstrings new file mode 100644 index 0000000..8783245 --- /dev/null +++ b/Sources/NorgUI/Resources/Localizable.xcstrings @@ -0,0 +1,33 @@ +{ + "sourceLanguage" : "en", + "strings" : { + "Cancelled" : { + "comment" : "Task status: put down / cancelled" + }, + "Done" : { + "comment" : "Task status: completed" + }, + "Needs input" : { + "comment" : "Task status: needs further input or clarification" + }, + "On hold" : { + "comment" : "Task status: paused" + }, + "Pending" : { + "comment" : "Task status: in progress" + }, + "Recurring" : { + "comment" : "Task status: repeats" + }, + "Task status: %@" : { + "comment" : "Accessibility label for a task's status control; %@ is the status name" + }, + "Undone" : { + "comment" : "Task status: not started" + }, + "Urgent" : { + "comment" : "Task status: urgent" + } + }, + "version" : "1.0" +} diff --git a/Sources/NorgUI/Theme/EnvironmentValues+NorgTheme.swift b/Sources/NorgUI/Theme/EnvironmentValues+NorgTheme.swift new file mode 100644 index 0000000..58c2c00 --- /dev/null +++ b/Sources/NorgUI/Theme/EnvironmentValues+NorgTheme.swift @@ -0,0 +1,19 @@ +import SwiftUI + +private struct NorgThemeKey: EnvironmentKey { + static let defaultValue = NorgTheme.default +} + +/// Makes NorgTheme values accessible via the environment. +extension EnvironmentValues { + public var norgTheme: NorgTheme { + get { self[NorgThemeKey.self] } + set { self[NorgThemeKey.self] = newValue } + } +} + +extension View { + public func norgTheme(_ theme: NorgTheme) -> some View { + environment(\.norgTheme, theme) + } +} diff --git a/Sources/NorgUI/Theme/NorgTheme.swift b/Sources/NorgUI/Theme/NorgTheme.swift new file mode 100644 index 0000000..47dd161 --- /dev/null +++ b/Sources/NorgUI/Theme/NorgTheme.swift @@ -0,0 +1,128 @@ +import NorgKit +import SwiftUI + +/// Typography and colours used when rendering a Norg document. +public struct NorgTheme: Sendable { + + /// Font for a heading at the given (1-based) level. + public var heading: @Sendable (Int) -> Font + /// Base font for body text, list items and paragraphs. + public var body: Font + /// Font for the title of a definition, footnote or table cell. + public var termFont: Font + /// Foreground colour for `verbatim` inline spans. + public var verbatimColor: Color + /// Foreground colour for `spoiler` inline spans. + public var spoilerForeground: Color + /// Background colour for `spoiler` inline spans. + public var spoilerBackground: Color + /// Foreground colour applied to link spans. + public var linkColor: Color + /// Baseline offset applied to `superscript` spans. + public var superscriptOffset: CGFloat + /// Baseline offset applied to `subscript` spans. + public var subscriptOffset: CGFloat + /// Foreground colour for block quotes. + public var quoteColor: Color + /// Fill colour for the vertical bar drawn alongside a quote. + public var quoteBarColor: Color + /// Background fill for fenced code blocks and ranged tags. + public var codeBackground: AnyShapeStyle + /// Font for code block and ranged-tag contents. + public var codeFont: Font + /// Horizontal indentation applied per nesting level. + public var indentWidth: CGFloat + /// Tint for a task's status symbol. + public var statusTint: @Sendable (TaskStatus) -> Color + /// SF Symbol name for a task's status symbol. + public var statusSymbol: @Sendable (TaskStatus) -> String + /// Localized label for a task status, shown in the status menu and used + /// for accessibility. Defaults to ``TaskStatus/displayName``; override to + /// supply wording from your own string catalog. + public var statusLabel: @Sendable (TaskStatus) -> LocalizedStringResource + + public init( + heading: @escaping @Sendable (Int) -> Font, + body: Font, + termFont: Font, + verbatimColor: Color, + spoilerForeground: Color, + spoilerBackground: Color, + linkColor: Color, + superscriptOffset: CGFloat, + subscriptOffset: CGFloat, + quoteColor: Color, + quoteBarColor: Color, + codeBackground: AnyShapeStyle, + codeFont: Font, + indentWidth: CGFloat, + statusTint: @escaping @Sendable (TaskStatus) -> Color, + statusSymbol: @escaping @Sendable (TaskStatus) -> String, + statusLabel: @escaping @Sendable (TaskStatus) -> LocalizedStringResource = { $0.displayName } + ) { + self.heading = heading + self.body = body + self.termFont = termFont + self.verbatimColor = verbatimColor + self.spoilerForeground = spoilerForeground + self.spoilerBackground = spoilerBackground + self.linkColor = linkColor + self.superscriptOffset = superscriptOffset + self.subscriptOffset = subscriptOffset + self.quoteColor = quoteColor + self.quoteBarColor = quoteBarColor + self.codeBackground = codeBackground + self.codeFont = codeFont + self.indentWidth = indentWidth + self.statusTint = statusTint + self.statusSymbol = statusSymbol + self.statusLabel = statusLabel + } + + /// The default theme. + public static let `default` = NorgTheme( + heading: { level in + switch level { + case 1: return .title.bold() + case 2: return .title2.bold() + case 3: return .title3.bold() + case 4: return .headline + case 5: return .subheadline.bold() + default: return .subheadline + } + }, + body: .body, + termFont: .body.bold(), + verbatimColor: .pink, + spoilerForeground: .secondary, + spoilerBackground: .secondary.opacity(0.25), + linkColor: .accentColor, + superscriptOffset: 5, + subscriptOffset: -3, + quoteColor: .secondary, + quoteBarColor: .secondary, + codeBackground: AnyShapeStyle(.quaternary), + codeFont: .system(.callout, design: .monospaced), + indentWidth: 18, + statusTint: { status in + switch status { + case .done: return .green + case .urgent: return .red + case .pending: return .blue + default: return .secondary + } + }, + statusSymbol: { status in + switch status { + case .undone: return "circle" + case .done: return "checkmark.circle.fill" + case .needsInput: return "questionmark.circle" + case .urgent: return "exclamationmark.circle" + case .recurring: return "repeat.circle" + case .pending: return "ellipsis.circle" + case .onHold: return "pause.circle" + case .cancelled: return "xmark.circle" + } + } + ) +} diff --git a/Sources/NorgUI/Views/Blocks/BlockTaskRow.swift b/Sources/NorgUI/Views/Blocks/BlockTaskRow.swift new file mode 100644 index 0000000..45255cd --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/BlockTaskRow.swift @@ -0,0 +1,23 @@ +import NorgKit +import SwiftUI + +/// Adapts any block with status to a NorgTaskView +struct BlockTaskRow: View { + @Environment(\.norgTheme) private var theme + + let status: TaskStatus + let content: [InlineSpan] + let font: Font + let line: Int + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + NorgTaskView( + status: status, + text: AttributedString(norg: content, baseFont: font, theme: theme), + font: font, + onToggle: { onSetStatus(line, status == .done ? .undone : .done) }, + onSetStatus: { onSetStatus(line, $0) } + ) + } +} diff --git a/Sources/NorgUI/Views/Blocks/BlockView.swift b/Sources/NorgUI/Views/Blocks/BlockView.swift new file mode 100644 index 0000000..59fcb78 --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/BlockView.swift @@ -0,0 +1,49 @@ +import NorgKit +import SwiftUI + +// General block renderer. +struct BlockView: View { + let block: NorgBlock + let ordinal: Int? + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + switch block { + case .heading(let level, let status, let content, let line): + HeadingView( + level: level, status: status, content: content, line: line, onSetStatus: onSetStatus) + + case .paragraph(let content, _): + ParagraphView(content: content) + + case .unorderedListItem(_, let status, let content, let line): + ListItemView( + marker: "•", status: status, content: content, line: line, onSetStatus: onSetStatus) + + case .orderedListItem(_, let status, let content, let line): + ListItemView( + marker: "\(ordinal ?? 1).", status: status, content: content, + line: line, onSetStatus: onSetStatus) + + case .quote(_, let status, let content, let line): + QuoteView(status: status, content: content, line: line, onSetStatus: onSetStatus) + + case .codeBlock(let language, let code, _): + CodeBlockView(language: language, code: code) + + case .definition(let title, let status, _, let line), + .footnote(let title, let status, _, let line), + .tableCell(let title, let status, _, let line): + RangeableBlockView(title: title, status: status, line: line, onSetStatus: onSetStatus) + + case .rangedTag(let name, _, let content, _): + RangedTagView(name: name, content: content) + + case .horizontalRule: + Divider() + + case .weakDelimiter, .strongDelimiter: + EmptyView() + } + } +} diff --git a/Sources/NorgUI/Views/Blocks/CodeBlockView.swift b/Sources/NorgUI/Views/Blocks/CodeBlockView.swift new file mode 100644 index 0000000..2f1ebfb --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/CodeBlockView.swift @@ -0,0 +1,10 @@ +import SwiftUI + +struct CodeBlockView: View { + let language: String? + let code: String + + var body: some View { + VerbatimBlock(label: language, content: code) + } +} diff --git a/Sources/NorgUI/Views/Blocks/HeadingView.swift b/Sources/NorgUI/Views/Blocks/HeadingView.swift new file mode 100644 index 0000000..3b65134 --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/HeadingView.swift @@ -0,0 +1,26 @@ +import NorgKit +import SwiftUI + +struct HeadingView: View { + @Environment(\.norgTheme) private var theme + + let level: Int + let status: TaskStatus? + let content: [InlineSpan] + let line: Int + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + let font = theme.heading(level) + Group { + if let status { + BlockTaskRow( + status: status, content: content, font: font, line: line, onSetStatus: onSetStatus) + } else { + Text(AttributedString(norg: content, baseFont: font, theme: theme)) + .font(font) + } + } + .padding(.top, 4) + } +} diff --git a/Sources/NorgUI/Views/Blocks/ListItemView.swift b/Sources/NorgUI/Views/Blocks/ListItemView.swift new file mode 100644 index 0000000..581974b --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/ListItemView.swift @@ -0,0 +1,27 @@ +import NorgKit +import SwiftUI + +struct ListItemView: View { + @Environment(\.norgTheme) private var theme + + let marker: String + let status: TaskStatus? + let content: [InlineSpan] + let line: Int + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + HStack(alignment: .firstTextBaseline, spacing: 8) { + if let status { + BlockTaskRow( + status: status, content: content, font: theme.body, line: line, onSetStatus: onSetStatus + ) + } else { + Text(marker) + .foregroundStyle(.secondary) + .monospacedDigit() + Text(AttributedString(norg: content, theme: theme)) + } + } + } +} diff --git a/Sources/NorgUI/Views/Blocks/ParagraphView.swift b/Sources/NorgUI/Views/Blocks/ParagraphView.swift new file mode 100644 index 0000000..2ad0dd5 --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/ParagraphView.swift @@ -0,0 +1,12 @@ +import NorgKit +import SwiftUI + +struct ParagraphView: View { + @Environment(\.norgTheme) private var theme + + let content: [InlineSpan] + + var body: some View { + Text(AttributedString(norg: content, theme: theme)) + } +} diff --git a/Sources/NorgUI/Views/Blocks/QuoteView.swift b/Sources/NorgUI/Views/Blocks/QuoteView.swift new file mode 100644 index 0000000..0347d78 --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/QuoteView.swift @@ -0,0 +1,29 @@ +import NorgKit +import SwiftUI + +struct QuoteView: View { + @Environment(\.norgTheme) private var theme + + let status: TaskStatus? + let content: [InlineSpan] + let line: Int + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + HStack(alignment: .top, spacing: 8) { + RoundedRectangle(cornerRadius: 1.5) + .fill(theme.quoteBarColor) + .frame(width: 3) + if let status { + BlockTaskRow( + status: status, content: content, font: theme.body, line: line, onSetStatus: onSetStatus + ) + } else { + Text(AttributedString(norg: content, theme: theme)) + .foregroundStyle(theme.quoteColor) + .italic() + } + } + .fixedSize(horizontal: false, vertical: true) + } +} diff --git a/Sources/NorgUI/Views/Blocks/RangeableBlockView.swift b/Sources/NorgUI/Views/Blocks/RangeableBlockView.swift new file mode 100644 index 0000000..433d89e --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/RangeableBlockView.swift @@ -0,0 +1,22 @@ +import NorgKit +import SwiftUI + +struct RangeableBlockView: View { + @Environment(\.norgTheme) private var theme + + let title: [InlineSpan] + let status: TaskStatus? + let line: Int + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + if let status { + BlockTaskRow( + status: status, content: title, font: theme.termFont, line: line, onSetStatus: onSetStatus + ) + } else { + Text(AttributedString(norg: title, baseFont: theme.termFont, theme: theme)) + .font(theme.termFont) + } + } +} diff --git a/Sources/NorgUI/Views/Blocks/RangedTagView.swift b/Sources/NorgUI/Views/Blocks/RangedTagView.swift new file mode 100644 index 0000000..1cdf1d9 --- /dev/null +++ b/Sources/NorgUI/Views/Blocks/RangedTagView.swift @@ -0,0 +1,10 @@ +import SwiftUI + +struct RangedTagView: View { + let name: [String] + let content: String + + var body: some View { + VerbatimBlock(label: name.joined(separator: "."), content: content) + } +} diff --git a/Sources/NorgUI/Views/FlatBlocksView.swift b/Sources/NorgUI/Views/FlatBlocksView.swift new file mode 100644 index 0000000..185d08b --- /dev/null +++ b/Sources/NorgUI/Views/FlatBlocksView.swift @@ -0,0 +1,42 @@ +import NorgKit +import SwiftUI + +struct FlatBlocksView: View { + let blocks: [NorgBlock] + let onSetStatus: (Int, TaskStatus) -> Void + var indent: CGFloat = 0 + + @Environment(\.norgTheme) private var theme + + var body: some View { + let ordinals = orderedOrdinals(blocks) + VStack(alignment: .leading, spacing: 10) { + ForEach(Array(blocks.enumerated()), id: \.offset) { index, block in + row(block, ordinal: ordinals[index]) + } + } + } + + @ViewBuilder + private func row(_ block: NorgBlock, ordinal: Int?) -> some View { + BlockView(block: block, ordinal: ordinal, onSetStatus: onSetStatus) + .padding(.leading, indent + levelIndent(block)) + .id(block.line) + .frame(maxWidth: .infinity, alignment: .leading) + + if let body = block.body, !body.isEmpty { + FlatBlocksView(blocks: body, onSetStatus: onSetStatus, indent: indent + theme.indentWidth) + } + } + + private func levelIndent(_ block: NorgBlock) -> CGFloat { + switch block { + case .unorderedListItem(let level, _, _, _), + .orderedListItem(let level, _, _, _), + .quote(let level, _, _, _): + return CGFloat(max(0, level - 1)) * theme.indentWidth + default: + return 0 + } + } +} diff --git a/Sources/NorgUI/Views/NorgTaskView.swift b/Sources/NorgUI/Views/NorgTaskView.swift new file mode 100644 index 0000000..cfe48c0 --- /dev/null +++ b/Sources/NorgUI/Views/NorgTaskView.swift @@ -0,0 +1,63 @@ +import NorgKit +import SwiftUI + +public struct NorgTaskView: View { + @Environment(\.norgTheme) private var theme + + let status: TaskStatus + let text: AttributedString + var font: Font + let onToggle: () -> Void + let onSetStatus: (TaskStatus) -> Void + + public init( + status: TaskStatus, + text: AttributedString, + font: Font = .body, + onToggle: @escaping () -> Void, + onSetStatus: @escaping (TaskStatus) -> Void + ) { + self.status = status + self.text = text + self.font = font + self.onToggle = onToggle + self.onSetStatus = onSetStatus + } + + public var body: some View { + HStack(alignment: .firstTextBaseline, spacing: 8) { + statusButton + Text(text) + .font(font) + .strikethrough(isResolved, color: .secondary) + .foregroundStyle(isResolved ? .secondary : .primary) + } + } + + private var statusButton: some View { + Button(action: onToggle) { + Image(systemName: theme.statusSymbol(status)) + .font(font) + .foregroundStyle(theme.statusTint(status)) + } + .buttonStyle(.plain) + .contextMenu { + ForEach(TaskStatus.allCases) { option in + Button { + onSetStatus(option) + } label: { + Label { + Text(theme.statusLabel(option)) + } icon: { + Image(systemName: theme.statusSymbol(option)) + } + } + } + } + .accessibilityLabel(Text("Task status: \(Text(theme.statusLabel(status)))", bundle: .module)) + } + + private var isResolved: Bool { + status == .done || status == .cancelled + } +} diff --git a/Sources/NorgUI/Views/NorgView.swift b/Sources/NorgUI/Views/NorgView.swift new file mode 100644 index 0000000..6f3deac --- /dev/null +++ b/Sources/NorgUI/Views/NorgView.swift @@ -0,0 +1,43 @@ +import NorgKit +import SwiftUI + +public struct NorgView: View { + let document: NorgDocument + let collapsible: Bool + let onSetStatus: (Int, TaskStatus) -> Void + let onOpenLink: ((InlineLink) -> Void)? + + public init( + document: NorgDocument, + collapsible: Bool = false, + onSetStatus: @escaping (Int, TaskStatus) -> Void = { _, _ in }, + onOpenLink: ((InlineLink) -> Void)? = nil + ) { + self.document = document + self.collapsible = collapsible + self.onSetStatus = onSetStatus + self.onOpenLink = onOpenLink + } + + public var body: some View { + content + .environment(\.openURL, OpenURLAction(handler: handleURL)) + } + + @ViewBuilder private var content: some View { + if collapsible { + TreeNodesView(nodes: document.tree(), onSetStatus: onSetStatus) + } else { + FlatBlocksView(blocks: document.blocks, onSetStatus: onSetStatus) + } + } + + private func handleURL(_ url: URL) -> OpenURLAction.Result { + if let onOpenLink { + let link = NorgLinkURL.decode(url) ?? InlineLink(kind: .link, target: url.absoluteString) + onOpenLink(link) + return .handled + } + return NorgLinkURL.decode(url) == nil ? .systemAction : .discarded + } +} diff --git a/Sources/NorgUI/Views/TreeNodesView.swift b/Sources/NorgUI/Views/TreeNodesView.swift new file mode 100644 index 0000000..a509138 --- /dev/null +++ b/Sources/NorgUI/Views/TreeNodesView.swift @@ -0,0 +1,48 @@ +import NorgKit +import SwiftUI + +struct TreeNodesView: View { + let nodes: [NorgNode] + let onSetStatus: (Int, TaskStatus) -> Void + + var body: some View { + let siblingOrdinals = ordinals(forSiblings: nodes) + VStack(alignment: .leading, spacing: 10) { + ForEach(Array(nodes.enumerated()), id: \.offset) { index, node in + NodeView(node: node, ordinal: siblingOrdinals[index], onSetStatus: onSetStatus) + .id(node.block.line) + .frame(maxWidth: .infinity, alignment: .leading) + } + } + } +} + +private struct NodeView: View { + let node: NorgNode + let ordinal: Int? + let onSetStatus: (Int, TaskStatus) -> Void + + @State private var expanded = true + + var body: some View { + if !node.children.isEmpty { + DisclosureGroup(isExpanded: $expanded) { + TreeNodesView(nodes: node.children, onSetStatus: onSetStatus) + } label: { + label + } + } else if let body = node.block.body, !body.isEmpty { + DisclosureGroup(isExpanded: $expanded) { + FlatBlocksView(blocks: body, onSetStatus: onSetStatus) + } label: { + label + } + } else { + label + } + } + + private var label: some View { + BlockView(block: node.block, ordinal: ordinal, onSetStatus: onSetStatus) + } +} diff --git a/Sources/NorgUI/Views/VerbatimBlock.swift b/Sources/NorgUI/Views/VerbatimBlock.swift new file mode 100644 index 0000000..722c3f3 --- /dev/null +++ b/Sources/NorgUI/Views/VerbatimBlock.swift @@ -0,0 +1,23 @@ +import SwiftUI + +struct VerbatimBlock: View { + @Environment(\.norgTheme) private var theme + + let label: String? + let content: String + + var body: some View { + VStack(alignment: .leading, spacing: 4) { + if let label, !label.isEmpty { + Text(label) + .font(.caption2) + .foregroundStyle(.secondary) + } + Text(content) + .font(theme.codeFont) + .frame(maxWidth: .infinity, alignment: .leading) + } + .padding(10) + .background(theme.codeBackground, in: RoundedRectangle(cornerRadius: 8)) + } +} diff --git a/Tests/NorgUITests/InlineTextTests.swift b/Tests/NorgUITests/InlineTextTests.swift new file mode 100644 index 0000000..c2c6537 --- /dev/null +++ b/Tests/NorgUITests/InlineTextTests.swift @@ -0,0 +1,79 @@ +import NorgKit +import SwiftUI +import Testing + +@testable import NorgUI + +@Suite struct InlineTextTests { + @Test func plainSpanCarriesText() { + let attributed = AttributedString(norg: [InlineSpan(text: "hello")]) + #expect(String(attributed.characters) == "hello") + } + + @Test func multipleSpansConcatenate() { + let attributed = AttributedString(norg: [ + InlineSpan(text: "foo"), + InlineSpan(text: "bar"), + ]) + #expect(String(attributed.characters) == "foobar") + } + + @Test func verbatimUsesThemeColor() { + let attributed = AttributedString(norg: [InlineSpan(text: "x", styles: .verbatim)]) + let run = attributed.runs.first + #expect(run?.foregroundColor == NorgTheme.default.verbatimColor) + } + + @Test func spoilerAppliesForegroundAndBackground() { + let attributed = AttributedString(norg: [InlineSpan(text: "x", styles: .spoiler)]) + let run = attributed.runs.first + #expect(run?.foregroundColor == NorgTheme.default.spoilerForeground) + #expect(run?.backgroundColor == NorgTheme.default.spoilerBackground) + } + + @Test func superscriptUsesThemeOffset() { + let attributed = AttributedString(norg: [InlineSpan(text: "x", styles: .superscript)]) + #expect(attributed.runs.first?.baselineOffset == NorgTheme.default.superscriptOffset) + } + + @Test func subscriptUsesThemeOffset() { + let attributed = AttributedString(norg: [InlineSpan(text: "x", styles: .subscript)]) + #expect(attributed.runs.first?.baselineOffset == NorgTheme.default.subscriptOffset) + } + + @Test func externalLinkBecomesTappable() { + let attributed = AttributedString(norg: [ + InlineSpan(text: "site", link: InlineLink(kind: .link, target: "https://example.com")) + ]) + let run = attributed.runs.first + #expect(run?.link == URL(string: "https://example.com")) + #expect(run?.foregroundColor == NorgTheme.default.linkColor) + } + + @Test func internalLinkIsEncodedForRouting() { + let attributed = AttributedString(norg: [ + InlineSpan(text: "note", link: InlineLink(kind: .link, target: "* Some heading")) + ]) + let run = attributed.runs.first + let decoded = run?.link.flatMap(NorgLinkURL.decode) + #expect(decoded == InlineLink(kind: .link, target: "* Some heading")) + #expect(run?.foregroundColor == NorgTheme.default.linkColor) + } + + @Test func anchorIsEncodedForRouting() { + let attributed = AttributedString(norg: [ + InlineSpan(text: "ref", link: InlineLink(kind: .anchor, target: "footnote")) + ]) + let run = attributed.runs.first + let decoded = run?.link.flatMap(NorgLinkURL.decode) + #expect(decoded == InlineLink(kind: .anchor, target: "footnote")) + } + + @Test func customThemeOverridesColors() { + var theme = NorgTheme.default + theme.verbatimColor = .orange + let attributed = AttributedString( + norg: [InlineSpan(text: "x", styles: .verbatim)], theme: theme) + #expect(attributed.runs.first?.foregroundColor == .orange) + } +} diff --git a/Tests/NorgUITests/NorgLinkURLTests.swift b/Tests/NorgUITests/NorgLinkURLTests.swift new file mode 100644 index 0000000..dcd5446 --- /dev/null +++ b/Tests/NorgUITests/NorgLinkURLTests.swift @@ -0,0 +1,30 @@ +import Foundation +import NorgKit +import Testing + +@testable import NorgUI + +@Suite struct NorgLinkURLTests { + @Test func roundTripsLink() throws { + let link = InlineLink(kind: .link, target: "* My Heading") + let url = try #require(NorgLinkURL.encode(link)) + #expect(NorgLinkURL.decode(url) == link) + } + + @Test func roundTripsAnchor() throws { + let link = InlineLink(kind: .anchor, target: "some anchor") + let url = try #require(NorgLinkURL.encode(link)) + #expect(NorgLinkURL.decode(url) == link) + } + + @Test func roundTripsMissingTarget() throws { + let link = InlineLink(kind: .link, target: nil) + let url = try #require(NorgLinkURL.encode(link)) + #expect(NorgLinkURL.decode(url) == link) + } + + @Test func ignoresForeignURLs() throws { + let url = try #require(URL(string: "https://example.com")) + #expect(NorgLinkURL.decode(url) == nil) + } +} diff --git a/Tests/NorgUITests/NorgThemeTests.swift b/Tests/NorgUITests/NorgThemeTests.swift new file mode 100644 index 0000000..a621d90 --- /dev/null +++ b/Tests/NorgUITests/NorgThemeTests.swift @@ -0,0 +1,35 @@ +import NorgKit +import SwiftUI +import Testing + +@testable import NorgUI + +@Suite struct NorgThemeTests { + @Test func defaultStatusTints() { + let theme = NorgTheme.default + #expect(theme.statusTint(.done) == .green) + #expect(theme.statusTint(.urgent) == .red) + #expect(theme.statusTint(.pending) == .blue) + #expect(theme.statusTint(.undone) == .secondary) + #expect(theme.statusTint(.cancelled) == .secondary) + #expect(theme.statusTint(.onHold) == .secondary) + } + + @Test func defaultScalarValues() { + let theme = NorgTheme.default + #expect(theme.superscriptOffset == 5) + #expect(theme.subscriptOffset == -3) + #expect(theme.indentWidth == 18) + #expect(theme.linkColor == .accentColor) + #expect(theme.verbatimColor == .pink) + } + + @Test func defaultStatusSymbols() { + let theme = NorgTheme.default + #expect(theme.statusSymbol(.undone) == "circle") + #expect(theme.statusSymbol(.done) == "checkmark.circle.fill") + for status in TaskStatus.allCases { + #expect(!theme.statusSymbol(status).isEmpty) + } + } +} diff --git a/Tests/NorgUITests/OrdinalTests.swift b/Tests/NorgUITests/OrdinalTests.swift new file mode 100644 index 0000000..954477c --- /dev/null +++ b/Tests/NorgUITests/OrdinalTests.swift @@ -0,0 +1,38 @@ +import NorgKit +import Testing + +@testable import NorgUI + +@Suite struct OrdinalTests { + private func ordered(_ level: Int) -> NorgBlock { + .orderedListItem(level: level, status: nil, content: [], line: 0) + } + private func unordered(_ level: Int) -> NorgBlock { + .unorderedListItem(level: level, status: nil, content: [], line: 0) + } + private var paragraph: NorgBlock { .paragraph(content: [], line: 0) } + + @Test func numbersConsecutiveItems() { + #expect(orderedOrdinals([ordered(1), ordered(1), ordered(1)]) == [1, 2, 3]) + } + + @Test func countsEachLevelIndependently() { + let blocks = [ordered(1), ordered(2), ordered(2), ordered(1)] + #expect(orderedOrdinals(blocks) == [1, 1, 2, 2]) + } + + @Test func paragraphResetsNumbering() { + let blocks = [ordered(1), paragraph, ordered(1)] + #expect(orderedOrdinals(blocks) == [1, nil, 1]) + } + + @Test func unorderedItemInterruptsNumbering() { + let blocks = [ordered(1), unordered(1), ordered(1)] + #expect(orderedOrdinals(blocks) == [1, nil, 1]) + } + + @Test func siblingOrdinalsNumberOrderedNodesOnly() { + let nodes = [ordered(1), unordered(1), ordered(1), paragraph].map { NorgNode(block: $0) } + #expect(ordinals(forSiblings: nodes) == [1, nil, 2, nil]) + } +} diff --git a/Tests/NorgUITests/RenderingSmokeTests.swift b/Tests/NorgUITests/RenderingSmokeTests.swift new file mode 100644 index 0000000..39c9eb5 --- /dev/null +++ b/Tests/NorgUITests/RenderingSmokeTests.swift @@ -0,0 +1,51 @@ +import NorgKit +import Testing + +@testable import NorgUI + +@Suite struct RenderingSmokeTests { + @Test func rangeableBlockExposesBodyForRecursion() { + let doc = NorgParser.parse("$ Norg\nA structured note format.") + guard case .definition(_, _, let body, _) = doc.blocks.first else { + Issue.record("Expected a definition") + return + } + #expect(!body.isEmpty) + } + + @Test func headingNestsContentAsTreeChildren() { + let nodes = NorgParser.parse("* Title\nbody text below").tree() + guard let heading = nodes.first, case .heading = heading.block else { + Issue.record("Expected a heading root") + return + } + #expect(!heading.children.isEmpty) + } + + @Test func nestedListNestsAsTreeChildren() { + let nodes = NorgParser.parse("- one\n-- nested").tree() + guard let item = nodes.first else { + Issue.record("Expected a list item") + return + } + #expect(item.children.count == 1) + } + + @Test func nonCodeRangedTagIsRouted() { + let doc = NorgParser.parse("@math\nx^2 + y^2 = z^2\n@end") + guard case .rangedTag(let name, _, _, _) = doc.blocks.first else { + Issue.record("Expected a ranged tag") + return + } + #expect(name == ["math"]) + } + + @Test func codeFenceBecomesCodeBlock() { + let doc = NorgParser.parse("@code swift\nlet x = 1\n@end") + guard case .codeBlock(let language, _, _) = doc.blocks.first else { + Issue.record("Expected a code block") + return + } + #expect(language == "swift") + } +} diff --git a/Tests/NorgUITests/TaskStatusUITests.swift b/Tests/NorgUITests/TaskStatusUITests.swift new file mode 100644 index 0000000..0b5dd53 --- /dev/null +++ b/Tests/NorgUITests/TaskStatusUITests.swift @@ -0,0 +1,29 @@ +import Foundation +import NorgKit +import Testing + +@testable import NorgUI + +@Suite struct TaskStatusUITests { + private func resolved(_ status: TaskStatus) -> String { + String(localized: status.displayName) + } + + @Test func everyStatusHasADisplayName() { + for status in TaskStatus.allCases { + #expect(!resolved(status).isEmpty) + } + } + + @Test func displayNamesAreDistinct() { + let names = Set(TaskStatus.allCases.map(resolved)) + #expect(names.count == TaskStatus.allCases.count) + } + + @Test func themeStatusLabelDefaultsToDisplayName() { + let theme = NorgTheme.default + for status in TaskStatus.allCases { + #expect(String(localized: theme.statusLabel(status)) == resolved(status)) + } + } +} |