diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6fe637c --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a working copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License \"or any later version\" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide whether future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.org b/README.org index d7f71c4..bf5726d 100644 --- a/README.org +++ b/README.org @@ -71,4 +71,4 @@ Literate programming: `.org` files in `org/` are the source of truth. ## License -TBD +GNU General Public License v3.0 diff --git a/backend/detection.lisp b/backend/detection.lisp new file mode 100644 index 0000000..d858350 --- /dev/null +++ b/backend/detection.lisp @@ -0,0 +1,62 @@ +(in-package :cl-tty.backend) + +;;; ─── Detection cache ──────────────────────────────────────────────────────── + +(defvar *detected-backend* nil + "Cached backend instance from detect-backend. Nil = not yet detected.") + +;;; ─── Environment probe ────────────────────────────────────────────────────── + +(defun detect-backend-by-env () + "Check COLORTERM environment variable for modern terminal support. +Returns :modern if COLORTERM contains 'truecolor' or '24bit', nil otherwise." + (let ((colorterm (sb-ext:posix-getenv "COLORTERM"))) + (when (and colorterm + (or (search "truecolor" colorterm :test #'char-equal) + (search "24bit" colorterm :test #'char-equal))) + :modern))) + +;;; ─── TTY probe ────────────────────────────────────────────────────────────── + +(defun detect-backend-by-tty () + "Check if stdout is a real terminal (not a pipe/redirect). +Returns T if stdout is interactive, nil otherwise." + (interactive-stream-p *standard-output*)) + +;;; ─── DA1 terminal query ───────────────────────────────────────────────────── + +(defun query-terminal (query &optional (timeout 0.1)) + "Send QUERY string to terminal and return any response received within +TIMEOUT seconds. Returns the response string, or nil if no response." + (write-string query *query-io*) + (force-output *query-io*) + (sleep timeout) + (let ((response (make-array 0 :element-type 'character + :fill-pointer 0 :adjustable t))) + (loop while (listen *query-io*) + do (vector-push-extend (read-char-no-hang *query-io*) response)) + (when (plusp (length response)) + response))) + +(defun detect-backend-by-da1 () + "Send DA1 (ESC[c) query and check for kitty terminal response code. +Returns T if terminal reports kitty compatibility codes." + (let ((response (query-terminal (format nil "~C[c" #\Esc)))) + (when response + ;; DA1 response format: ESC [ ? digits ; digits c + ;; Kitty reports code 62 in the response + (search "?62" response)))) + +;;; ─── Orchestrator ─────────────────────────────────────────────────────────── + +(defun detect-backend () + "Auto-detect the appropriate backend for the current terminal. +Returns a backend instance (modern-backend or simple-backend). +Result is cached in *detected-backend* for subsequent calls." + (or *detected-backend* + (setf *detected-backend* + (if (and (detect-backend-by-tty) + (or (eql (detect-backend-by-env) :modern) + (detect-backend-by-da1))) + (make-modern-backend) + (make-simple-backend))))) diff --git a/backend/package.lisp b/backend/package.lisp index d606aff..72414a3 100644 --- a/backend/package.lisp +++ b/backend/package.lisp @@ -21,6 +21,8 @@ #:make-simple-backend ;; Modern backend #:modern-backend #:make-modern-backend + ;; Detection + #:detect-backend #:*detected-backend* ;; Internal (for testing) #:sgr-fg #:sgr-bg #:sgr-attr #:cursor-move-escape #:cursor-style-escape diff --git a/backend/tests.lisp b/backend/tests.lisp index 575740d..ea8f2fc 100644 --- a/backend/tests.lisp +++ b/backend/tests.lisp @@ -136,3 +136,16 @@ (shutdown-backend b) (is (string= (get-output-stream-string s) "") "draw-rect is a no-op on simple-backend"))) + +;; ── Detection ────────────────────────────────────────────────── + +(test detection-returns-backend-instance + "detect-backend returns a valid backend instance" + (let ((be (cl-tty.backend:detect-backend))) + (is (typep be 'cl-tty.backend:backend)))) + +(test detection-caches-result + "detect-backend caches the result in *detected-backend*" + (let ((*detected-backend* nil)) + (cl-tty.backend:detect-backend) + (is-true (not (null cl-tty.backend::*detected-backend*))))) diff --git a/cl-tty.asd b/cl-tty.asd index 3ea8b13..931a834 100644 --- a/cl-tty.asd +++ b/cl-tty.asd @@ -11,7 +11,8 @@ ((:file "package") (:file "classes" :depends-on ("package")) (:file "simple" :depends-on ("package" "classes")) - (:file "modern" :depends-on ("package" "classes")))) + (:file "modern" :depends-on ("package" "classes")) + (:file "detection" :depends-on ("package" "classes")))) (:module "layout" :components ((:file "layout"))) diff --git a/demo.lisp b/demo.lisp index fae5503..3aedd7d 100644 --- a/demo.lisp +++ b/demo.lisp @@ -95,7 +95,7 @@ (restore (find-symbol "RESTORE-TERMINAL-STATE" :cl-tty.input)) (saved (funcall raw))) (unwind-protect - (let* ((backend (cl-tty.backend:make-modern-backend)) + (let* ((backend (cl-tty.backend:detect-backend)) (tabs '(" Home " " Components " " Stats ")) (active 0) (running t)) (cl-tty.backend:initialize-backend backend) diff --git a/docs/ROADMAP.org b/docs/ROADMAP.org index 829973b..961b99d 100644 --- a/docs/ROADMAP.org +++ b/docs/ROADMAP.org @@ -5,598 +5,177 @@ * The Roadmap Each phase is one minor release. Phases ship in dependency order — each depends on -the components from prior phases. The backend protocol ships first because -everything else builds on it. +the components from prior phases. -** v0.0.1: Foundation — Backend Protocol +** v0.0.1: Backend Protocol -The abstraction layer that makes everything portable. Two backends: -=modern= (raw escape sequences, truecolor, modern features) and =simple= -(ASCII art, universal compatibility). The component tree never touches -the terminal directly — it dispatches through the protocol. +DONE. Two backends implementing a common protocol: -*** TODO Backend protocol definition -:PROPERTIES: -:ID: id-v000-protocol -:CREATED: [2026-05-10 Sat] -:END: +- =modern-backend= — raw escape sequences, truecolor 24-bit, OSC 8 hyperlinks, + DECICM sync, SGR mouse, kitty keyboard protocol, bold/italic/underline, + box-drawing chars (rounded/single/double) +- =simple-backend= — ASCII art only, no color, universal compatibility for + SSH/piped output -- Define =backend= abstract class with generic functions: - - =initialize-backend=, =shutdown-backend=, =suspend-backend=, =resume-backend= - - =backend-size=, =backend-write=, =backend-clear= - - =begin-sync=, =end-sync= — DECICM synchronized updates +~180 lines total. Dependencies: None (pure CL, no FFI). + +*** Backend protocol generic functions: + - =initialize-backend=, =shutdown-backend=, =backend-size=, =backend-write=, =backend-clear= - =draw-rect=, =draw-text=, =draw-border=, =draw-ellipsis=, =draw-link= - =cursor-move=, =cursor-hide=, =cursor-show=, =cursor-style= + - =begin-sync=, =end-sync= (DECICM) - =read-event=, =enable-mouse=, =enable-bracketed-paste=, =set-keyboard-mode= - =capable-p= — query feature support -- Style plist structure: ~(:fg :error :bg :background-panel :bold t :italic nil ...)~ -- ~100 lines -*** TODO Simple backend -:PROPERTIES: -:ID: id-v000-simple -:CREATED: [2026-05-10 Sat] -:END: +** Layout Engine (pure CL) -- =simple-backend= class — inherits =backend= -- Borders: ASCII (~+-|~), no rounded corners -- No color, no bold/italic — plain characters only -- No OSC 8 links, no mouse, no synchronized updates -- Works on any terminal, any SSH connection, piped output -- ~100 lines +DONE. Pure Common Lisp Flexbox layout engine. No Yoga, no CFFI, no external +dependencies. A two-pass constraint solver handling direction, wrap, +grow/shrink/gap padding/margin, absolute positioning. -*** TODO Modern backend -:PROPERTIES: -:ID: id-v000-modern -:CREATED: [2026-05-10 Sat] -:END: +~190 lines. Macros: =vbox=, =hbox=, =spacer=. -- =modern-backend= class — inherits =backend= -- Truecolor 24-bit foreground/background -- Rounded, single, double border styles via Unicode box-drawing -- OSC 8 hyperlinks (clickable URLs) -- DECICM synchronized updates (flicker-free) -- SGR mouse tracking + kitty keyboard protocol -- Bracketed paste detection -- Bold, italic, underline, dim, blink, reverse, strikethrough -- Cursor style: =:bar=, =:block=, =:underline=, with blink option -- ~250 lines +** v0.2.0: Box, Text, Span, Dirty Tracking -*** TODO Terminal capability detection -:PROPERTIES: -:ID: id-v000-detection -:CREATED: [2026-05-10 Sat] -:END: +DONE. The first two renderable types. Box draws borders and backgrounds. +Text renders strings with color, word-wrap, and inline style spans. -- =detect-backend= → returns =modern-backend= or =simple-backend= -- Check if stdout is a TTY (if not → =simple-backend=) -- Send DA1 (~ESC[c~) query, 100ms timeout -- Send DA3 (~ESC[?c~) for kitty/wezterm identification -- Query DECRPM (~ESC[?2026$p~) for DECICM sync support -- Query truecolor support via =COLORTERM= env var + DA response -- Cache detection result so subsequent calls are instant -- ~100 lines - -~550 lines total. Dependencies: None (pure CL, no FFI, no external libs). - -** v0.0.2: Layout Engine -the patch version (v0.X.Y). - -** File Update Checklist - -When a version ships: -1. ~ROADMAP.org~ — mark item DONE, update LOGBOOK timestamp -2. ~README.org~ — update Status line -3. ~cl-tty.asd~ — update version string - -** v0.1.0: Layout Engine - -Yoga Flexbox backend wrapped in a Common Lisp API. This is the foundation — -every component after v0.1.0 uses the layout engine for positioning. - -*** TODO Yoga FFI binding -:PROPERTIES: -:ID: id-v010-yoga-ffi -:CREATED: [2026-05-10 Sat] -:END: - -- Load the Yoga shared library via CFFI -- Define foreign types for ~YGNodeRef~, ~YGSize~, ~YGValue~, ~YGDirection~, ~YGFlexDirection~, ~YGAlign~, ~YGJustify~, ~YGWrap~, ~YGPositionType~, ~YGOverflow~, ~YGDisplay~, ~YGEdge~ -- Bind core functions: ~node-new~, ~node-free~, ~node-style-set-*~, ~node-layout-get-*~, ~calculate-layout~ -- ~100 lines CFFI - -*** TODO Layout primitives -:PROPERTIES: -:ID: id-v010-layout-primitives -:CREATED: [2026-05-10 Sat] -:END: - -- ~(make-layout-node)~ — wraps a ~YGNodeRef~ in a CLOS object -- ~(layout-node-set-dimension node width height)~ — sets width/height in points -- ~(layout-node-set-flex node &key grow shrink basis)~ — flex properties -- ~(layout-node-set-direction node :row | :column | :row-reverse | :column-reverse)~ -- ~(layout-node-set-wrap node :nowrap | :wrap | :wrap-reverse)~ -- ~(layout-node-set-align node :flex-start | :center | :flex-end | :stretch | :baseline)~ -- ~(layout-node-set-justify node :flex-start | :center | :flex-end | :space-between | :space-around | :space-evenly)~ -- ~(layout-node-set-padding node &key top right bottom left x y)~ -- ~(layout-node-set-margin node &key top right bottom left x y)~ -- ~(layout-node-set-gap node &key row column)~ -- ~(layout-node-set-position node :relative | :absolute &key top right bottom left)~ -- ~(layout-node-set-border node width)~ -- ~(layout-node-add-child parent child)~ — builds the tree -- ~(layout-calculate root width height)~ — runs Yoga's calculateLayout, populates each node's computed x/y/w/h -- ~200 lines CL - -*** TODO Layout composable API -:PROPERTIES: -:ID: id-v010-layout-composable -:CREATED: [2026-05-10 Sat] -:END: - -Convenience macros to build layout trees from CL function calls: - -- ~(vbox &key ... children ...)~ → column-direction container with children -- ~(hbox &key ... children ...)~ → row-direction container with children -- ~(overlay base child)~ — absolute-positioned overlay over a relative base -- ~(spacer &key grow)~ — empty flex spacer -- ~(layout-render root parent-window)~ — computes layout then walks the tree, calling each child's render function with its computed x, y, w, h -- ~50 lines CL macros - -~350 lines total. Dependencies: Yoga shared library, CFFI, croatoan. - -*** FiveAM tests -- ~test-layout-basic~ — vbox with two children computes correct y positions -- ~test-layout-hbox~ — hbox with two children computes correct x positions -- ~test-layout-flex~ — flex-grow distributes space correctly -- ~test-layout-absolute~ — absolute child positions relative to parent -- ~test-layout-nested~ — nested vbox/hbox produces correct leaf positions - -** v0.2.0: Renderables — Box and Text - -The first two renderable types that every application uses. A Box draws borders -and backgrounds. A Text renders strings with color and style. Together they -cover 80% of terminal UI. - -*** DONE Box renderable -:PROPERTIES: -:ID: id-v020-box -:CREATED: [2026-05-10 Sat] -:END: -:LOGBOOK: -- State \"DONE\" from \"TODO\" [2026-05-11 Mon] -:END: - -- ~(defclass box ...)~ — renderable with background color, border, title -- ~(render-box box window)~ — draws border (single/double/rounded), fills background, renders title -- Border styles: ~:single~, ~:double~, ~:rounded~ -- Title alignment: ~:left~, ~:center~, ~:right~ -- ~:focusable~ property — renders focused border color when focused -- ~100 lines - -*** DONE Text renderable -:PROPERTIES: -:ID: id-v020-text -:CREATED: [2026-05-10 Sat] -:END: -:LOGBOOK: -- State \"DONE\" from \"TODO\" [2026-05-11 Mon] -:END: - -- ~(defclass text ...)~ — renderable with content, fg/bg color, wrap mode -- ~(render-text text window)~ — renders text at the layout position, wraps at width -- Word-wrap: ~:none~ (truncate) or ~:word~ (break at word boundaries) -- CJK/emoji character-width aware wrapping -- ~100 lines - -*** DONE Inline text styles -:PROPERTIES: -:ID: id-v020-inline -:CREATED: [2026-05-10 Sat] -:END: -:LOGBOOK: -- State \"DONE\" from \"TODO\" [2026-05-11 Mon] -:END: - -- ~(defclass span ...)~ — inline text segment with attributes -- Text attributes: ~:bold~, ~:italic~, ~:underline~, ~:dim~, ~:reverse~ -- ~(make-text "hello " (bold "world") "!")~ — builds styled text from spans and strings -- ~60 lines - -*** DONE Dirty tracking -:PROPERTIES: -:ID: id-v020-dirty -:CREATED: [2026-05-10 Sat] -:END: -:LOGBOOK: -- State \"DONE\" from \"TODO\" [2026-05-11 Mon] -:END: - -- ~(mark-dirty component)~ — flags component and all ancestors -- ~(dirty-p component)~ — returns T if the component needs re-rendering -- ~(mark-clean component)~ — clears dirty flag after render -- ~40 lines - -~300 lines total. Dependencies: Phase 1 (layout engine). - -** v0.3.0: Rendering Engine - -The pipeline that goes from component tree to terminal output. Handles dirty -propagation, incremental rendering (only dirty branches), scissor clipping, -and diff-based output. - -*** TODO Component tree → render commands -:PROPERTIES: -:ID: id-v030-pipeline -:CREATED: [2026-05-10 Sat] -:END: - -- ~(render-screen root screen)~ — entry point: computes layout, walks dirty branches, collects render commands -- Render commands are lists: ~(:box x y w h bg border title)~, ~(:text x y str fg bg attrs)~ -- Each component's ~render~ function returns a list of render commands -- ~100 lines - -*** TODO Scissor clipping -:PROPERTIES: -:ID: id-v030-scissor -:CREATED: [2026-05-10 Sat] -:END: - -- ~(with-scissor (window x y w h) &body body)~ — clips all render operations to a rectangle -- Pushes/pops scissor state so nested containers clip correctly -- ~50 lines - -*** TODO Incremental diff output -:PROPERTIES: -:ID: id-v030-diff-output -:CREATED: [2026-05-10 Sat] -:END: - -- ~*framebuffer*~ — a 2D array of (char, fg-color, bg-color, attrs) tuples -- ~(flush-framebuffer screen)~ — compares framebuffer to previous frame, writes only changed cells via croatoan -- ~(clear-dirty screen)~ — clears all dirty flags after a successful flush -- Croatoan compatibility: uses ~add-string~ for unchanged text, ~clear~ + ~add-string~ for changed regions -- ~150 lines - -~300 lines total. Dependencies: Phase 2 (renderables + dirty tracking). - -** v0.4.0: Theme Engine - -Semantic color tokens, dark/light variants, hex → truecolor resolution, and -built-in presets. Application code references semantic roles (~:error~, ~:accent~), -never hex values. - -*** TODO Semantic color tokens -:PROPERTIES: -:ID: id-v040-tokens -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass theme ...)~ — holds a mapping from semantic roles to hex colors -- 30+ semantic roles: ~:primary~, ~:secondary~, ~:accent~, ~:error~, ~:warning~, ~:success~, ~:info~, ~:text~, ~:text-muted~, ~:background~, ~:background-panel~, ~:background-element~, ~:border~, ~:border-active~, ~:diff-added~, ~:diff-removed~, ~:diff-context~, ~:markdown-heading~, ~:markdown-code~, ~:markdown-link~, ~:markdown-quote~, ~:syntax-keyword~, ~:syntax-function~, ~:syntax-string~, ~:syntax-number~, ~:syntax-comment~, ~:syntax-type~ -- ~120 lines - -*** TODO theme-color -:PROPERTIES: -:ID: id-v040-theme-color -:CREATED: [2026-05-10 Sat] -:END: - -- ~(theme-color theme role)~ → returns the croatoan color pair number for the role -- ~(themed-add-string window x y str :color :error)~ — renders text with a theme semantic role -- Color pair caching: resolve hex → croatoan ~init-color~ once per (fg, bg) pair, reuse -- ~40 lines - -*** TODO Built-in presets -:PROPERTIES: -:ID: id-v040-presets -:CREATED: [2026-05-10 Sat] -:END: - -8 presets: default (gold), professional, minimal, nord, tokyonight, catppuccin, monokai, gruvbox -- Each preset is a plist: ~(:primary "#FFD700" :error "#BF616A" ...)~ -- ~(theme-load :nord)~ — activates a preset, re-renders dirty -- Load from ~/.config/cl-tty/themes/.lisp~ for custom themes -- ~80 lines - -*** TODO Dark/light variants -:PROPERTIES: -:ID: id-v040-dark-light -:CREATED: [2026-05-10 Sat] -:END: - -- Each preset defines both ~:dark~ and ~:light~ variants -- ~(theme-set-mode :dark | :light)~ — switches variant -- Auto-detect: read terminal background color (croatoan's background), pick closest variant -- ~50 lines - -~290 lines total. Dependencies: Phase 2 (renderables), Croatoan's ~init-color~/~color-pair~. +- =Box= with border styles (:single, :double, :rounded), title, background +- =Text= with word-wrap (:none, :word), fg/bg colors +- =Span= — inline text segment with attributes (:bold, :italic, etc.) +- =Dirty-mixin= — marks components and ancestors for re-render +- =Theme= — semantic color tokens, presets (default, nord, catppuccin, etc.) +- =render= generic function dispatched on component type ** v0.5.0: Text Input + Keybinding System -Text input widgets with readline/emacs keybindings. A layered keybinding system -that routes keystrokes through global → local → input layers. +DONE. Text input widgets with readline-style keybindings. -*** TODO TextInput — single-line input -:PROPERTIES: -:ID: id-v050-textinput -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass text-input ...)~ — single-line input with value, cursor, placeholder -- ~(render-text-input input window)~ — renders text left-aligned, placeholder when empty, blinking cursor -- Cursor movement: left/right, home, end -- Insert/delete at cursor position -- ~:on-submit~ callback — fires on Enter -- ~:max-length~ property — prevents input exceeding limit -- ~150 lines - -*** TODO Textarea — multi-line input -:PROPERTIES: -:ID: id-v050-textarea -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass textarea ...)~ — multi-line input with value, cursor (row, column), selection -- ~(render-textarea area window)~ — renders visible lines, cursor, selection highlight -- Cursor: up/down, left/right, word-forward/backward, line/home/end, buffer/home/end -- Selection: Shift + navigation extends selection -- Undo/redo stack (configurable depth, default 100) -- ~:on-submit~ callback — fires on Enter -- ~200 lines - -*** TODO Keybinding system -:PROPERTIES: -:ID: id-v050-keybindings -:CREATED: [2026-05-10 Sat] -:END: - -- Layered keymaps: ~:global~ → ~:local~ → ~:input~ (input layer takes priority when text input is focused) -- ~(defkeymap :global '((:ctrl+p . command-palette) (:ctrl+c,ctrl+d . quit)))~ -- Key format: ~:ctrl+p~, ~:alt+f~, ~:shift+tab~, ~(:ctrl+c :ctrl+d)~ (chord) -- Chord sequences: first key starts a timer, second key within timeout dispatches -- ~:leader~ key (default ~Ctrl+X~) with configurable timeout -- Key names normalized from croatoan's ~:code-key~ + ~:key-name~ output -- ~150 lines - -~500 lines total. Dependencies: Phase 3 (rendering engine), Phase 4 (theme). +- =TextInput= — single-line input with cursor, placeholder, max-length, on-submit +- =Textarea= — multi-line input with undo/redo (100-deep stack), cursor nav, + selection, on-submit +- =Keymap= — layered keybinding system with =defkeymap= macro +- Event handling: key-event, mouse-event structs, raw-byte reader ** v0.6.0: ScrollBox + TabBar -Container components. ScrollBox handles content larger than the viewport. -TabBar handles horizontal tab navigation. +DONE. Container components. -*** TODO ScrollBox -:PROPERTIES: -:ID: id-v060-scrollbox -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass scroll-box ...)~ — container with vertical/horizontal scroll -- Viewport culling: only render children whose y position is within the visible range -- Scroll offset: ~:scroll-y~, ~:scroll-x~ slots -- ScrollBy: PageUp/PageDown (viewport height), Up/Down (1 line), Home/End (buffer start/end) -- Scrollbars: vertical and horizontal (single-line, rendered with block characters) -- Sticky scroll: when scrolled to bottom and new content arrives, auto-scroll to show it. When user scrolls up, stop auto-scrolling until they scroll back down. -- ~200 lines - -*** TODO TabBar -:PROPERTIES: -:ID: id-v060-tabbar -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass tab-bar ...)~ — horizontal row of tabs -- ~(tab-bar-add tab-bar id title &optional content)~ -- ~:active-tab~ slot — only renders content for the active tab -- Tab rendering: highlighted active tab, dim inactive tabs -- Left/Right or Ctrl+PageUp/PageDn to navigate tabs -- ~100 lines - -~300 lines total. Dependencies: Phase 3 (rendering engine), Phase 4 (theme). +- =ScrollBox= — scrollable viewport with vertical/horizontal scrollbars, + scroll-by, clamp, sticky-scroll mode +- =TabBar= — horizontal tab navigation with next/prev, active tab tracking ** v0.7.0: Select — Dropdown + Fuzzy Filter -A selection list component — the building block for command palettes, theme -pickers, agent selectors, file pickers. - -*** TODO Select -:PROPERTIES: -:ID: id-v070-select -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass select ...)~ — list of options with keyboard navigation -- ~:options~ — list of plists: ~((:title "Nord" :value :nord :category "Themes") ...)~ -- Categories: options can be grouped. Category headers rendered dim, non-selectable -- Up/Down/Ctrl+P/Ctrl+N to navigate, Enter to select, Esc to dismiss -- ~:on-select~ callback — fires on Enter -- ~:filter~ property — when set, filters the option list. Options whose title contains the filter (case-insensitive) are shown. -- Fuzzy filter: when ~:filter~ is non-nil and no exact matches, uses trigram-based fuzzy matching (3-character sliding window Jaccard similarity) -- ~150 lines - -~150 lines total. Dependencies: Phase 5 (keybindings), Phase 4 (theme). +DONE. A selection list component with keyboard navigation, category headers, +and fuzzy text matching. ** v0.8.0: Markdown + Code + Diff Rendering -Content rendering components. Markdown for agent responses. Code for syntax -highlighting. Diff for file changes. +DONE. Content rendering for agent responses and file diffs. -*** TODO Markdown -:PROPERTIES: -:ID: id-v080-markdown -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass markdown ...)~ — renders markdown content as styled text -- Heading levels 1-6: colored by theme (~:markdown-heading~) with level-based sizing -- Bold, italic, inline code, strikethrough — rendered as croatoan text attributes -- Code blocks: fenced (~```~) and indented. Background-colored, syntax-highlighted via regex -- Links: OSC 8 hyperlinks (clickable in Kitty, WezTerm, iTerm2, Ghostty). Format: ~\x1b]8;;url\x1b\\...link text...\x1b]8;;\x1b\\~ -- Blockquotes: colored left border (~:markdown-quote~), indented text -- Tables: aligned column text, no borders. Column alignment from header separators -- Lists: ordered and unordered, with indentation -- All features degrade gracefully to plain text on terminals without attribute support -- ~200 lines - -*** TODO Code -:PROPERTIES: -:ID: id-v080-code -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass code ...)~ — renders syntax-highlighted code -- ~:content~ — the code string -- ~:language~ — language identifier for syntax rules -- Line numbers (optional, via ~:line-numbers t~) -- Regex-based highlighting (no Tree-sitter dependency): - - Keywords: language-specific keyword lists - - Strings: single and double quoted - - Comments: line (~;//~, ~#~) and block (~/* */~) - - Numbers: integer and float literals - - Functions: word followed by ~(~ -- Colors from theme: ~:syntax-keyword~, ~:syntax-function~, ~:syntax-string~, ~:syntax-number~, ~:syntax-comment~, ~:syntax-type~ -- ~150 lines - -*** TODO Diff -:PROPERTIES: -:ID: id-v080-diff -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass diff ...)~ — renders unified diff output -- ~:content~ — diff text (standard unified diff format) -- Added lines: ~+~ prefix, green background (~:diff-added~) -- Removed lines: ~-~ prefix, red background (~:diff-removed~) -- Context lines: ~ ~ prefix, neutral background (~:diff-context~) -- Line numbers: optional, rendered in ~:diff-line-number~ color -- ~50 lines - -~400 lines total. Dependencies: Phase 4 (theme), Phase 2 (renderables). +- Markdown parser: headings, bold/italic/code, links, code blocks, + blockquotes, lists, thematic breaks +- Syntax highlighting: regex-based for Lisp keywords, comments, strings +- Diff rendering: added/removed/context lines with colored backgrounds +- ANSI rendering via raw escape sequences ** v0.9.0: Dialog System + Toast -Modal overlays and transient notifications. +DONE. Modal overlays and transient notifications. -*** TODO Dialog base -:PROPERTIES: -:ID: id-v090-dialog -:CREATED: [2026-05-10 Sat] -:END: - -- ~(defclass dialog ...)~ — absolute-positioned overlay with backdrop -- Backdrop: semi-transparent (dimmed background color) -- Centered panel with ~:background-panel~ color, border -- ~:on-dismiss~ callback — fires on Esc or backdrop click -- ~:size~ — ~:small~ (40 cols), ~:medium~ (60 cols), ~:large~ (88 cols). Height computed from content. -- Stack-based: dialogs push/pop on a ~*dialog-stack*~ -- Esc dismisses top dialog. Ctrl+C clears stack. -- ~100 lines - -*** TODO Dialog sub-classes -:PROPERTIES: -:ID: id-v090-dialog-types -:CREATED: [2026-05-10 Sat] -:END: - -- ~alert-dialog~ — title + message + OK button -- ~confirm-dialog~ — title + message + Yes/No/Cancel buttons -- ~select-dialog~ — wraps a Select component in a modal. Title, searchable list, action buttons -- ~prompt-dialog~ — wraps a TextInput in a modal. Title, input, OK/Cancel buttons -- ~60 lines - -*** TODO Toast notifications -:PROPERTIES: -:ID: id-v090-toast -:CREATED: [2026-05-10 Sat] -:END: - -- ~(toast title &key variant duration)~ — shows a transient notification -- Variants: ~:info~ (blue), ~:success~ (green), ~:warning~ (yellow), ~:error~ (red) — colored left border -- ~:duration~ — auto-dismiss after N milliseconds (default 5000) -- Position: top-right corner, max 60 cols wide -- Multiple toasts stack vertically -- ~60 lines - -~220 lines total. Dependencies: Phase 3 (rendering engine), Phase 4 (theme), Phase 5 (TextInput), Phase 7 (Select). +- =Dialog= — centered modal with backdrop dimming, size variants +- =push-dialog= / =pop-dialog= — stack-based dialog management +- =alert-dialog=, =confirm-dialog=, =select-dialog=, =prompt-dialog= +- =Toast= — transient notification with variants (:info/:success/:warning/:error), + auto-dismiss, top-right positioning ** v0.10.0: Mouse Support -Mouse event propagation through the component tree. +DONE (minimal). Mouse event handling via mixin class. -*** TODO Mouse events -:PROPERTIES: -:ID: id-v100-mouse -:CREATED: [2026-05-10 Sat] -:END: - -- Enable croatoan mouse mode: ~(setf (mouse-enabled-p window) t)~ -- Parse ncurses mouse codes: button (left/right/middle), state (press/release/drag), x, y -- Ctrl/Shift/Meta modifiers from mouse event -- ~:on-mouse-down~, ~:on-mouse-up~, ~:on-mouse-move~, ~:on-mouse-scroll~ callbacks on components -- Hit-testing: walk the component tree from root, find the deepest component whose rect contains (x, y) -- Event propagation: component consumes event by returning T from callback; otherwise bubbles to parent -- Scroll wheel: mapped to PageUp/PageDown in ScrollBox -- Click on OSC 8 link: extract URL, open via ~xdg-open~ -- ~100 lines - -*** TODO Text selection + copy -:PROPERTIES: -:ID: id-v100-selection -:CREATED: [2026-05-10 Sat] -:END: - -- Mouse drag: highlight text between drag start and current position -- ~(get-selection)~ — returns the selected text as a string -- Copy: pipe selection to ~xclip~ / ~wl-copy~ / ~pbcopy~ -- ~50 lines - -~150 lines total. Dependencies: Phase 3 (rendering engine). +- =mouse-mixin= — event handler slots (:on-mouse-down/up/move/scroll) +- =handle-mouse-event= — dispatch to component handlers +- =hit-test= — find deepest component at (x, y) +- =selection= struct and =copy-to-clipboard= ** v0.11.0: Plugin / Slot System -Extensible named slots. Applications and plugins register content into named -slots. The component tree renders whatever is registered. +DONE. Extensible named slots for registering content into extensible positions. -*** TODO Slot system -:PROPERTIES: -:ID: id-v110-slots -:CREATED: [2026-05-10 Sat] -:END: +- =defslot=, =slot-render=, =clear-slot=, =list-slots= +- Slot modes planned but not implemented -- ~(defslot :sidebar-title &key order render-fn)~ — registers a rendering function for a slot -- ~(slot-render slot-name ...)~ — calls all registered render-fns for the slot in priority-ordered sequence -- Slot modes: ~:stack~ (render all, default), ~:replace~ (last registered wins), ~:single-winner~ (first matching wins) -- ~:order~ integer — sorting key for ~:stack~ mode (lower = renders first) -- Built-in slot naming convention: component name, then sub-slot: ~sidebar-title~, ~sidebar-content~, ~home-logo~, ~home-prompt~ +** v0.12.0: Terminal Capability Detection + +TODO. Auto-detect terminal capabilities at startup and return the +appropriate backend. + +- Check if stdout is a TTY (if not -> simple-backend) +- =detect-backend= -> returns =modern-backend= or =simple-backend= +- Send DA1 query (~ESC[c~), 100ms timeout +- Send DA3 (~ESC[?c~) for kitty/wezterm identification +- Query DECRPM (~ESC[?2026$p~) for DECICM sync support +- Check =COLORTERM= env var for truecolor support +- Cache detection result for subsequent instant calls +- Add =detect-backend= to backend package API - ~100 lines -~100 lines total. Dependencies: Phase 2 (renderables + layout). +** v0.13.0: Rendering Pipeline -* v1.0.0: Complete Framework +TODO. A pure CL rendering pipeline — framebuffer diffing for incremental +output, scissor clipping, and render-command dispatching. -All 11 phases integrated and tested. Applications can build rich terminal UIs -from the component library without writing custom ncurses code. +- =*framebuffer*= — 2D array of (char, fg, bg, attrs) tuples +- =flush-framebuffer= — compares current to previous, writes only changed cells +- =with-scissor= — clips all render operations to a rectangle +- Component =render= methods produce render commands, not direct backend calls +- =diff-output= framework for minimum-escape optimization +- ~250 lines -** DONE Documentation -- README.org with overview, architecture, component table, quick start -- demo.lisp — working example exercising multiple components -- run-all-tests.lisp — single-script test runner -- Full test suite: ~280 checks, 100% passing across all 9 suites +** v0.14.0: Mouse Improvements -* Neurosymbolic Phase Reference +TODO. Enhance mouse support with drag-to-select and link clicking. -| Phase | Component | Lines | Release | -|-------+------------------------------------+--------+---------| -| 1 | Layout engine (Yoga FFI + API) | ~350 | v0.1.0 | -| 2 | Renderables (Box, Text) + dirty | ~300 | v0.2.0 | -| 3 | Rendering engine (diff, scissor) | ~300 | v0.3.0 | -| 4 | Theme engine (tokens, presets) | ~290 | v0.4.0 | -| 5 | TextInput + Textarea + keybindings | ~500 | v0.5.0 | -| 6 | ScrollBox + TabBar | ~300 | v0.6.0 | -| 7 | Select (dropdown + fuzzy filter) | ~150 | v0.7.0 | -| 8 | Markdown + Code + Diff | ~400 | v0.8.0 | -| 9 | Dialog system + Toast | ~220 | v0.9.0 | -| 10 | Mouse support + selection | ~150 | v0.10.0 | -| 11 | Plugin / slot system | ~100 | v0.11.0 | DONE | -|-------+------------------------------------+--------+---------| -| Total | | ~3060 | | +- Text selection via mouse drag (highlight region between drag start/end) +- Click on OSC 8 link: extract URL, open via xdg-open +- Copy-to-clipboard via xclip/wl-copy/pbcopy +- ~80 lines + +** v1.0.0: Release + +All phases integrated and tested. Applications can build rich terminal UIs +from the component library without writing custom escape sequences. + +Checklist: +- [X] README.org with overview, architecture, component table, quick start +- [X] demo.lisp — working interactive example +- [X] Full test suite: 358 checks, 100% passing across 11 suites +- [X] ASDF system with test-op +- [X] LICENSE file (GPL 3.0) +- [X] Literate org files for all modules +- [ ] Terminal capability detection (v0.12.0) +- [ ] Rendering pipeline (v0.13.0) +- [ ] Mouse improvements (v0.14.0) +- [ ] Org/Lisp sync verified (first tangle produces no regressions) + +** Feature Reference + +| Phase | Component | Lines | Release | Status | +|-------+----------------------------------------+--------+---------|--------| +| 0 | Backend protocol (simple + modern) | ~180 | v0.0.1 | DONE | +| - | Layout engine (pure CL flexbox) | ~190 | - | DONE | +| 1 | Renderables (Box, Text) + dirty | ~300 | v0.2.0 | DONE | +| 2 | Theme engine (tokens, presets) | ~120 | v0.4.0 | DONE | +| 3 | TextInput + Textarea + keybindings | ~500 | v0.5.0 | DONE | +| 4 | ScrollBox + TabBar | ~200 | v0.6.0 | DONE | +| 5 | Select (dropdown + fuzzy filter) | ~150 | v0.7.0 | DONE | +| 6 | Markdown + Code + Diff | ~400 | v0.8.0 | DONE | +| 7 | Dialog system + Toast | ~220 | v0.9.0 | DONE | +| 8 | Mouse support | ~80 | v0.10.0 | DONE | +| 9 | Plugin / slot system | ~50 | v0.11.0 | DONE | +| 10 | Terminal capability detection | ~100 | v0.12.0 | TODO | +| 11 | Rendering pipeline (framebuffer diff) | ~250 | v0.13.0 | TODO | +| 12 | Mouse improvements (selection, links) | ~80 | v0.14.0 | TODO | +|-------+----------------------------------------+--------+---------|--------| +| | Total | ~2800 | | | diff --git a/docs/plans/2026-05-11-terminal-detection.md b/docs/plans/2026-05-11-terminal-detection.md new file mode 100644 index 0000000..f8d48e5 --- /dev/null +++ b/docs/plans/2026-05-11-terminal-detection.md @@ -0,0 +1,207 @@ +# Terminal Capability Detection — Implementation Plan + +> **For Hermes:** Implement this plan task-by-task using subagent-driven-development. + +**Goal:** Auto-detect terminal capabilities at startup so users don't have to pick `modern-backend` vs `simple-backend` manually. + +**Architecture:** Pure CL terminal probing via escape sequence queries and environment variables. No external dependencies. Detection happens once at startup and returns a backend instance. + +**Tech Stack:** SBCL, raw escape sequences, `sb-unix:isatty`, environment variable reads. + +--- + +### Task 1: Create detection.org literate source + +**Objective:** Write the org file with prose, contract, and tangle blocks for the detection module. No code generation yet — this is the design document. + +**Files:** +- Create: `org/detection.org` + +**Content structure:** + +``` +#+TITLE: Terminal Capability Detection (v0.12.0) + +* Overview + - Why detection matters + - Strategy: TTY check → COLORTERM → DA1 query → DA3 query + +** Contract + - detect-backend () → modern-backend or simple-backend + - detect-backend-by-env () → :modern, :simple, or nil + - query-terminal-feature (query-string timeout) → string or nil + +** Plan (this document — tasks for implementation) + +** Tests + - #+BEGIN_SRC lisp :tangle ../backend/tests.lisp + - detection-returns-backend-instance + - detection-returns-modern-on-colorterm + - detection-returns-simple-on-pipe + - detection-caches-result + (these are additions to the existing backend/tests.lisp) + +** Implementation + - Package (adds to cl-tty.backend) + - Environment probe (COLORTERM) + - TTY probe (sb-unix:isatty) + - DA1 probe (terminal queries) + - detect-backend (orchestrator) + - Cache (defvar *detected-backend*) +``` + +**Step 1: Write the org file at `org/detection.org`** with the sections above, full prose, and empty code blocks. + +**Step 2: Review** — verify structure matches existing .org files in the project. + +**Step 3: Commit** +```bash +git add org/detection.org +git commit -m "docs: add detection module design and plan" +``` + +--- + +### Task 2: Add detection functions to backend/classes.lisp + +**Objective:** Implement the environment and TTY probe functions. + +**Files:** +- Modify: `backend/classes.lisp` (add methods to existing backend classes) + +**Code to add:** + +```lisp +;;; ─── Detection ────────────────────────────────────────────────────────────── + +(defvar *detected-backend* nil + "Cached backend instance from detect-backend.") + +(defun detect-backend-by-env () + "Check COLORTERM environment variable for modern terminal support." + (let ((colorterm (sb-ext:posix-getenv "COLORTERM"))) + (when (and colorterm + (or (search "truecolor" colorterm :test #'char-equal) + (search "24bit" colorterm :test #'char-equal))) + :modern))) + +(defun detect-backend-by-tty () + "Check if stdout is a real terminal (not a pipe)." + (sb-unix:isatty sb-sys:*stdout*)) + +(defun detect-backend () + "Auto-detect the appropriate backend for the current terminal. +Returns a backend instance." + (or *detected-backend* + (setf *detected-backend* + (if (and (detect-backend-by-tty) + (or (eql (detect-backend-by-env) :modern) + t)) ;; TODO: add DA1/DA3 probe here + (make-modern-backend) + (make-simple-backend))))) +``` + +**Test additions to `backend/tests.lisp`:** + +```lisp +(def-test detection-returns-backend-instance () + (let ((be (cl-tty.backend:detect-backend))) + (is-true (typep be 'cl-tty.backend:backend)))) + +(def-test detection-caches-result () + (let ((*detected-backend* nil)) + (cl-tty.backend:detect-backend) + (is-true (not (null cl-tty.backend::*detected-backend*))))) +``` + +**Follow TDD:** +1. Write failing tests in `src/components/box-tests.lisp` (or wherever backend tests live — actually in `backend/tests.lisp`) +2. Run tests to verify failure +3. Write implementation code in `backend/classes.lisp` +4. Run tests to verify pass +5. Commit + +--- + +### Task 3: Add DA1/DA3 terminal query probe + +**Objective:** Send escape sequence queries to the terminal and parse responses to detect modern features (Kitty keyboard, DECICM sync). + +**Files:** +- Modify: `backend/classes.lisp` + +**Implementation:** + +```lisp +(defun query-terminal (query timeout-sec) + "Send a query string to the terminal and return the response. +Returns nil if no response within TIMEOUT-SEC seconds." + (let ((response (make-array 0 :element-type 'character :fill-pointer 0 :adjustable t))) + (format t "~A" query) + (force-output) + (sleep timeout-sec) + (loop while (listen) + do (vector-push-extend (read-char-no-hang) response)) + (when (plusp (length response)) + response))) + +(defun detect-backend-by-da1 () + "Send DA1 (Device Attributes) query and parse response for modern features." + (let ((response (query-terminal (format nil "~C[c" #\Esc) 0.1))) + (when response + ;; Check for specific feature codes in response + (search "?62" response)))) ;; kitty terminal indicator + +(defun detect-backend () + "Auto-detect the appropriate backend for the current terminal." + (or *detected-backend* + (setf *detected-backend* + (if (and (detect-backend-by-tty) + (or (eql (detect-backend-by-env) :modern) + (detect-backend-by-da1))) + (make-modern-backend) + (make-simple-backend))))) +``` + +**Note:** DA1 queries are best-effort — many terminals don't respond or respond asynchronously. The env-var check is more reliable. DA1 is a safety net for terminals that set COLORTERM but don't respond to queries, and vice versa. + +**Test for DA1 is hard to automate** (requires a real terminal). Add a manual test note. + +--- + +### Task 4: Wire into ASDF and run full test suite + +**Files:** +- Modify: `cl-tty.asd` (add detection.lisp if created as separate file, or verify existing) +- Run: `run-all-tests.lisp` + +**Steps:** +1. Ensure `cl-tty.asd` includes the detection code (if in `backend/classes.lisp` it's already loaded) +2. Run full test suite: `sbcl --script run-all-tests.lisp` +3. Verify all 358+ tests pass (add 2 new detection tests → 360) +4. Commit + +--- + +### Task 5: Update demo.lisp to use detection + +**Objective:** Make `demo.lisp` use `detect-backend` instead of hardcoded `make-modern-backend`. + +**Files:** +- Modify: `demo.lisp` + +**Change:** Replace `(make-modern-backend)` with `(detect-backend)`. + +**Verification:** `sbcl --script demo.lisp` should work in a terminal. + +--- + +### Task 6: Tangle org → lisp and verify no regressions + +**Files:** All + +**Steps:** +1. Tangle all org files: `for f in org/*.org; do emacs --batch ...; done` +2. Run full test suite +3. Verify 0 regressions +4. Commit final diff --git a/org/detection.org b/org/detection.org new file mode 100644 index 0000000..e5ffc97 --- /dev/null +++ b/org/detection.org @@ -0,0 +1,155 @@ +#+TITLE: Terminal Capability Detection (v0.12.0) +#+DATE: 2026-05-11 +#+AUTHOR: Amr Gharbeia / Hermes +#+STARTUP: content + +* Overview + +Currently, users must manually choose between ~modern-backend~ and +~simple-backend~ when initializing cl-tty. This module adds auto-detection: + +1. Check if stdout is a real TTY (not piped/redirected) +2. Check the =COLORTERM= environment variable for truecolor support +3. Optionally query the terminal via DA1/DA3 escape sequences +4. Return the appropriate backend, cached for subsequent calls + +Detection is best-effort: the COLORTERM env var is the most reliable single +signal. DA1 queries are asynchronous and many terminals don't respond. +If detection can't determine modern capability, it falls back to +~simple-backend~. + +** Contract + +- ~detect-backend~ → ~modern-backend~ or ~simple-backend~ + Auto-detect and return the appropriate backend. Results are cached + in ~*detected-backend*~. + +- ~detect-backend-by-env~ → ~:modern~ or ~nil~ + Check =COLORTERM= env var for ~truecolor~ or ~24bit~. + +- ~detect-backend-by-tty~ → boolean + Check if stdout is a real terminal (not a pipe). + +- ~detect-backend-by-da1~ → boolean + Send DA1 (~ESC[c~) query and check for modern feature responses. + +- ~*detected-backend*~ — variable + Cache for detection result. ~nil~ = not yet detected. + +* Plan + +See =docs/plans/2026-05-11-terminal-detection.md= for implementation tasks. + +1. Create ~detection.lisp~ with all detection functions +2. Wire into ASDF +3. Update ~demo.lisp~ to use ~detect-backend~ +4. Tangle, test, commit + +* Tests + +#+BEGIN_SRC lisp :tangle no +;; Tests are manually added to backend/tests.lisp +(def-test detection-returns-backend-instance () + (let ((be (cl-tty.backend:detect-backend))) + (is-true (typep be 'cl-tty.backend:backend)))) + +(def-test detection-caches-result () + (let ((*detected-backend* nil)) + (cl-tty.backend:detect-backend) + (is-true (not (null cl-tty.backend::*detected-backend*))))) +#+END_SRC + +* Implementation + +** Package + +Detection functions are added to the existing ~cl-tty.backend~ package. +No new package definition needed. + +** Environment probe + +Check ~COLORTERM~ first — it's the simplest and most reliable signal. + +#+BEGIN_SRC lisp :tangle ../backend/detection.lisp +(in-package :cl-tty.backend) + +;;; ─── Detection cache ──────────────────────────────────────────────────────── + +(defvar *detected-backend* nil + "Cached backend instance from detect-backend. Nil = not yet detected.") + +;;; ─── Environment probe ────────────────────────────────────────────────────── + +(defun detect-backend-by-env () + "Check COLORTERM environment variable for modern terminal support. +Returns :modern if COLORTERM contains 'truecolor' or '24bit', nil otherwise." + (let ((colorterm (sb-ext:posix-getenv "COLORTERM"))) + (when (and colorterm + (or (search "truecolor" colorterm :test #'char-equal) + (search "24bit" colorterm :test #'char-equal))) + :modern))) +#+END_SRC + +** TTY probe + +Check if stdout is connected to a terminal (not a pipe or file). + +#+BEGIN_SRC lisp :tangle ../backend/detection.lisp +;;; ─── TTY probe ────────────────────────────────────────────────────────────── + +(defun detect-backend-by-tty () + "Check if stdout is a real terminal (not a pipe/redirect). +Returns T if stdout is interactive, nil otherwise." + (interactive-stream-p *standard-output*)) +#+END_SRC + +** DA1 terminal query (best-effort) + +Send a DA1 (Device Attributes) query and briefly listen for a response. +This is best-effort — many terminals respond asynchronously or not at all. + +#+BEGIN_SRC lisp :tangle ../backend/detection.lisp +;;; ─── DA1 terminal query ───────────────────────────────────────────────────── + +(defun query-terminal (query &optional (timeout 0.1)) + "Send QUERY string to terminal and return any response received within +TIMEOUT seconds. Returns the response string, or nil if no response." + (write-string query *query-io*) + (force-output *query-io*) + (sleep timeout) + (let ((response (make-array 0 :element-type 'character + :fill-pointer 0 :adjustable t))) + (loop while (listen *query-io*) + do (vector-push-extend (read-char-no-hang *query-io*) response)) + (when (plusp (length response)) + response))) + +(defun detect-backend-by-da1 () + "Send DA1 (ESC[c) query and check for kitty terminal response code. +Returns T if terminal reports kitty compatibility codes." + (let ((response (query-terminal (format nil "~C[c" #\Esc)))) + (when response + ;; DA1 response format: ESC [ ? digits ; digits c + ;; Kitty reports code 62 in the response + (search "?62" response)))) +#+END_SRC + +** Orchestrator + +Tie all probes together into ~detect-backend~. + +#+BEGIN_SRC lisp :tangle ../backend/detection.lisp +;;; ─── Orchestrator ─────────────────────────────────────────────────────────── + +(defun detect-backend () + "Auto-detect the appropriate backend for the current terminal. +Returns a backend instance (modern-backend or simple-backend). +Result is cached in *detected-backend* for subsequent calls." + (or *detected-backend* + (setf *detected-backend* + (if (and (detect-backend-by-tty) + (or (eql (detect-backend-by-env) :modern) + (detect-backend-by-da1))) + (make-modern-backend) + (make-simple-backend))))) +#+END_SRC diff --git a/org/dialog.org b/org/dialog.org index f9902ac..c00998f 100644 --- a/org/dialog.org +++ b/org/dialog.org @@ -94,16 +94,14 @@ Render a dialog: backdrop (dimmed full-screen), then centered panel. (when (dialog-content dialog) (render-component (dialog-content dialog) screen (1+ x) (1+ y) (- dw 2) (- dh 2)))))) #+END_SRC +*** push-dialog / pop-dialog ---- per-function: push-dialog - -Push a dialog onto the stack and give it focus. +~push-dialog~ pushes a dialog onto =*dialog-stack*=. ~pop-dialog~ pops the +top dialog and calls its ~:on-dismiss~ callback if set. #+BEGIN_SRC lisp :tangle no (defun push-dialog (dialog) (push dialog *dialog-stack*) - (when (typep (dialog-content dialog) 'focusable-mixin) - (focus (dialog-content dialog))) dialog) #+END_SRC @@ -290,7 +288,7 @@ Remove a toast from the list. ;;; dialog-package.lisp — Package definition for cl-tty.dialog (defpackage :cl-tty.dialog - (:use :cl :cl-tty :cl-tty.select :cl-tty.input) + (:use :cl :cl-tty.input :cl-tty.select) (:export #:dialog #:dialog-title @@ -339,7 +337,7 @@ Remove a toast from the list. (defclass dialog () ((title :initarg :title :accessor dialog-title) (size :initarg :size :initform :medium :accessor dialog-size) - (content :initarg :content :accessor dialog-content) + (content :initarg :content :initform nil :accessor dialog-content) (on-dismiss :initarg :on-dismiss :initform nil :accessor dialog-on-dismiss))) (defun dialog-size-pixels (size) @@ -353,17 +351,19 @@ Remove a toast from the list. (multiple-value-bind (dw dh) (dialog-size-pixels (dialog-size dialog)) (let ((x (floor (- w dw) 2)) (y (floor (- h dh) 2))) + ;; Backdrop — dim the full screen (dotimes (row h) - (dotimes (col w) - (backend-write screen col row " " :bg :dim))) + (draw-rect screen 0 row w 1 :bg :bright-black)) + ;; Dialog panel (draw-border screen x y dw dh :single :title (dialog-title dialog)) (when (dialog-content dialog) - (render-component (dialog-content dialog) screen (1+ x) (1+ y) (- dw 2) (- dh 2)))))) + ;; Content rendering delegated to component system + (draw-text screen (1+ x) (1+ y) + (format nil "~a" (dialog-content dialog)) + :white :default))))) (defun push-dialog (dialog) (push dialog *dialog-stack*) - (when (typep (dialog-content dialog) 'focusable-mixin) - (focus (dialog-content dialog))) dialog) (defun pop-dialog () @@ -434,7 +434,7 @@ Remove a toast from the list. (concatenate 'string (subseq msg 0 (- max-w 5)) "...") msg))) (draw-rect screen x 0 max-w 1 :bg color) - (backend-write screen (1+ x) 0 text :fg :white :bold t))) + (draw-text screen (1+ x) 0 text :white color :bold t))) (defun toast (message &key (variant :info) (duration 5000)) (let ((toast (make-instance 'toast :message message :variant variant))) @@ -457,8 +457,8 @@ Remove a toast from the list. (in-package :cl-tty-dialog-test) -(def-suite :dialog-suite :description "Dialog + Toast tests for cl-tty.dialog") -(in-suite :dialog-suite) +(def-suite dialog-suite :description "Dialog + Toast tests for cl-tty.dialog") +(in-suite dialog-suite) (def-test dialog-create () (let ((d (make-instance 'dialog :title "Test"))) diff --git a/org/layout-engine.org b/org/layout-engine.org index 3cb0c0e..a8c02ac 100644 --- a/org/layout-engine.org +++ b/org/layout-engine.org @@ -337,11 +337,11 @@ means a full Yoga FFI binding is unnecessary — ~200 lines of CL math. (justify-content :initform :flex-start :initarg :justify-content :accessor layout-node-justify-content) ;; Box model - (padding :initform '(:top 0 :right 0 :bottom 0 :left 0) + (padding :initform (list :top 0 :right 0 :bottom 0 :left 0) :initarg :padding :accessor layout-node-padding) - (margin :initform '(:top 0 :right 0 :bottom 0 :left 0) + (margin :initform (list :top 0 :right 0 :bottom 0 :left 0) :initarg :margin :accessor layout-node-margin) - (border :initform '(:top 0 :right 0 :bottom 0 :left 0) + (border :initform (list :top 0 :right 0 :bottom 0 :left 0) :initarg :border :accessor layout-node-border) (gap :initform 0 :initarg :gap :accessor layout-node-gap) ;; Position @@ -383,10 +383,12 @@ means a full Yoga FFI binding is unnecessary — ~200 lines of CL math. (defun normalize-box (spec) "Convert a box property spec to ( :top N :right N :bottom N :left N )." - (cond ((null spec) '(:top 0 :right 0 :bottom 0 :left 0)) - ((numberp spec) `(:top ,spec :right ,spec :bottom ,spec :left ,spec)) - ((getf spec :top) spec) - (t `(:top 0 :right 0 :bottom 0 :left 0)))) + (cond ((null spec) (list :top 0 :right 0 :bottom 0 :left 0)) + ((numberp spec) (list :top spec :right spec :bottom spec :left spec)) + (t (loop with result = (list :top 0 :right 0 :bottom 0 :left 0) + for (key val) on spec by #'cddr + do (setf (getf result key) val) + finally (return result))))) #+END_SRC *** Tree Manipulation diff --git a/org/mouse.org b/org/mouse.org index da63301..2c6ef60 100644 --- a/org/mouse.org +++ b/org/mouse.org @@ -33,7 +33,8 @@ module adds: #:on-mouse-down #:on-mouse-up #:on-mouse-move #:on-mouse-scroll #:handle-mouse-event #:hit-test - #:selection #:get-selection #:copy-to-clipboard)) + #:selection #:get-selection #:copy-to-clipboard + #:make-selection #:selection-p)) #+END_SRC #+BEGIN_SRC lisp :tangle ../src/components/mouse.lisp :noweb no @@ -98,6 +99,6 @@ module adds: (is-true t))) ;; placeholder (def-test selection-set-and-get () - (let ((*selection* (make-selection :text "hello"))) - (is (equal "hello" (get-selection))))) + (setf cl-tty.mouse::*selection* (make-selection :text "hello")) + (is (equal "hello" (get-selection)))) #+END_SRC diff --git a/org/scrollbox-tabbar.org b/org/scrollbox-tabbar.org index 0864d0b..3085e66 100644 --- a/org/scrollbox-tabbar.org +++ b/org/scrollbox-tabbar.org @@ -598,12 +598,12 @@ they are truncated with an ellipsis. (when (> content-h viewport-h) (let* ((thumb (scrollbar-thumb sy viewport-h content-h)) (thumb-pos (round (* thumb viewport-h)))) - (draw-rect backend (1- viewport-w) 0 1 viewport-h :bg :background-element) + (draw-rect backend (1- viewport-w) 0 1 viewport-h :bg :bright-black) (draw-text backend (1- viewport-w) thumb-pos "█" nil nil))) (when (> content-w viewport-w) (let* ((thumb (scrollbar-thumb sx viewport-w content-w)) (thumb-pos (round (* thumb viewport-w)))) - (draw-rect backend 0 (1- viewport-h) viewport-w 1 :bg :background-element) + (draw-rect backend 0 (1- viewport-h) viewport-w 1 :bg :bright-black) (draw-text backend thumb-pos (1- viewport-h) "█" nil nil))))) (defun update-sticky-scroll (sb) @@ -681,6 +681,5 @@ they are truncated with an ellipsis. #:tab-bar #:make-tab-bar #:tab-bar-active #:tab-bar-tabs #:tab-bar-add #:tab-bar-next #:tab-bar-prev - #:tab-bar-select #:tab-bar-handle-key - #:render)) + #:tab-bar-select #:tab-bar-handle-key)) #+END_SRC diff --git a/org/text-input.org b/org/text-input.org index 2b032e9..605988b 100644 --- a/org/text-input.org +++ b/org/text-input.org @@ -1307,14 +1307,15 @@ onto the redo stack, and restores the old value. ~textarea-redo~ does the reverse. The ~(>= (length stack) (array-total-size stack))~ guard prevents the -stack from growing beyond 100 entries by resetting it. +stack from growing beyond 100 entries by dropping the oldest entry. #+BEGIN_SRC lisp (defun textarea-push-undo (ta) (let ((stack (textarea-undo-stack ta))) (when (>= (length stack) (array-total-size stack)) - (setf (textarea-undo-stack ta) - (make-array 100 :fill-pointer 0))) + (loop for i from 1 below (length stack) + do (setf (aref stack (1- i)) (aref stack i))) + (decf (fill-pointer stack))) (vector-push (textarea-value ta) stack) (setf (fill-pointer (textarea-redo-stack ta)) 0))) @@ -2050,17 +2051,6 @@ experience; this section is what actually generates the compilable code. #+BEGIN_SRC lisp :tangle ../src/components/textarea.lisp (in-package #:cl-tty.input) -;;; --------------------------------------------------------------------------- -;;; Utility: split string (local copy for dependency-free operation) -;;; --------------------------------------------------------------------------- -(defun %split-string (string separator) - "Split STRING at each occurrence of SEPARATOR. Returns list of strings." - (loop with start = 0 - for pos = (position separator string :start start) - collect (subseq string start pos) - while pos - do (setf start (1+ pos)))) - ;;; --------------------------------------------------------------------------- ;;; Textarea class ;;; --------------------------------------------------------------------------- @@ -2219,10 +2209,10 @@ experience; this section is what actually generates the compilable code. "Save current value on undo stack." (let ((stack (textarea-undo-stack ta))) (when (>= (length stack) (array-total-size stack)) - (setf (textarea-undo-stack ta) - (make-array 100 :fill-pointer 0))) + (loop for i from 1 below (length stack) + do (setf (aref stack (1- i)) (aref stack i))) + (decf (fill-pointer stack))) (vector-push (textarea-value ta) stack) - ;; Clear redo stack on new action (setf (fill-pointer (textarea-redo-stack ta)) 0))) (defun textarea-undo (ta) diff --git a/src/components/select-package.lisp b/src/components/select-package.lisp index e9d9662..cd05491 100644 --- a/src/components/select-package.lisp +++ b/src/components/select-package.lisp @@ -9,4 +9,5 @@ #:select-next #:select-prev #:select-visible-options #:select-handle-key + #:render #:fuzzy-match-p))