commit 6e4c877164ffdfb534d41144b506ea915afbd5d3 Author: CismonX Date: Tue Nov 17 14:24:43 2020 +0800 Initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f4ba754 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +# Attributes for GitHub Linguist +*.h linguist-language=c +configure.ac linguist-detectable=false +Makefile.am linguist-detectable=false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fc00a8e --- /dev/null +++ b/.gitignore @@ -0,0 +1,47 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +# IDE & plugins +.idea/ +.vscode/ +.ccls* + +# OSX stuff +.DS_Store + +# Autotools +autoscan.log +configure.scan +*.cache/ +.deps/ +config.* +configure +Makefile.in +Makefile +depcomp +compile +libtool +ltmain.sh +install-sh +missing +stamp-h1 +.dirstamp +aclocal.m4 + +# build +*.o +*.lo +*.loT +*.la +*.lai +*.a +*.so +*.dylib +.libs/ +examples/sixdraw +tests/tcsgrep diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..26259ed --- /dev/null +++ b/.travis.yml @@ -0,0 +1,44 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +language: c + +os: + - linux + - osx + +dist: focal + +compiler: + - gcc + - clang + +addons: + apt: + update: true + packages: + - autoconf-archive + - dejagnu + homebrew: + update: true + packages: + - autoconf-archive + - dejagnu + +branches: + only: + - master + +before_script: + - test $TRAVIS_OS_NAME$CC = osxgcc && export CC=gcc-9 || true + +script: + - autoreconf --install + - ./configure CFLAGS='-O0 -g -Wall -Wextra -Wpedantic' + - make + - sudo make install diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -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 copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + 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/INSTALL.org b/INSTALL.org new file mode 100644 index 0000000..62d069e --- /dev/null +++ b/INSTALL.org @@ -0,0 +1,59 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +#+TITLE: Installation Guidelines + +** Copy Library Code to Your Project + + This is the recommended way to use this library. Just copy [[file:src/ctlseqs.h][ctlseqs.h]] and + [[file:src/ctlseqs.c][ctlseqs.c]] (and optionally the C++ wrapper [[file:src/ctlseqs.hh][ctlseqs.hh]]) to your project and + build it alongside with other code. + + No precautions need to be taken, as ctlseqs has no third-party dependencies + and does not require any fancy compiler flags or CPP macros. An ISO C99 and + POSIX.1-2008 compliant C implementation would suffice. + +** Build and Install From Source + + Alternatively, You may want a systemwide installation of the library and + link it to your project. Some scripts are provided to help you with that. + + GNU Autoconf, Automake, Libtool and Autoconf Archive is required. + + Generate and execute configure script. There are no custom configuration + options available for this library, just builtin ones. + + #+BEGIN_SRC shell + autoreconf --install + ./configure --prefix=$HOME CFLAGS='-O0 -g' + #+END_SRC + + Compile the library source code, as well as [[file:examples][examples]] and test suites. + Optionally, you can run the test suite (requires DejaGnu), install the + binary and man pages to your prefix. + + #+BEGIN_SRC shell + make && make check && make install + #+END_SRC + + Finally, link it to your project with the ~-lctlseqs~ (or similar) flag. + +** Install From a Package Manager + + We maintain unofficial repositories for a few package managers, so that the + ctlseqs library can be installed from them. + + However, there is no guarantee that any of those repositories will be + actively maintained in the future. + +*** Homebrew + + #+BEGIN_SRC shell + brew tap CismonX/repos + brew install ctlseqs + #+END_SRC diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..b74da4f --- /dev/null +++ b/Makefile.am @@ -0,0 +1,9 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +SUBDIRS = src man tests examples diff --git a/README.org b/README.org new file mode 100644 index 0000000..6551fff --- /dev/null +++ b/README.org @@ -0,0 +1,35 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +#+TITLE: README + + [[https://travis-ci.com/CismonX/ctlseqs][https://travis-ci.com/CismonX/ctlseqs.svg]] + [[file:COPYING][https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg]] + + ctlseqs - helper library for terminal control sequences + +** Description + + The ctlseqs library provides low-level C API for manipulating terminal + emulators with control sequences. + + This library 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. + +** Getting Started + + Build from source or install from a package manager. See [[file:INSTALL.org][INSTALL.org]] + for details. + + For documentation, see the [[man/ctlseqs.7][ctlseqs(7)]] man page, and also + [[https://invisible-island.net/xterm/ctlseqs/ctlseqs.html][XTerm Control Sequences]] if you're unfamiliar with them. + + Some [[file:examples][examples]] are provided to demonstrate the basic usage of this + library. diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..ae4d0f0 --- /dev/null +++ b/configure.ac @@ -0,0 +1,50 @@ +dnl +dnl Copyright (C) 2020 CismonX +dnl +dnl Copying and distribution of this file, with or without modification, are +dnl permitted in any medium without royalty, provided the copyright notice and +dnl this notice are preserved. This file is offered as-is, without any warranty. +dnl + +AC_PREREQ([2.60]) +AC_INIT([ctlseqs], [0.01], [bug-report@cismon.net]) +AC_CONFIG_SRCDIR([src/ctlseqs.c]) +AC_CONFIG_HEADERS([config.h]) +AM_INIT_AUTOMAKE([foreign]) +LT_PREREQ([2.4.0]) +LT_INIT + +# Checks for programs. +AC_PROG_CC_C99 +AC_PROG_CXX +AC_PROG_AWK +AC_PROG_CPP +AC_PROG_INSTALL +AC_PROG_LN_S +AC_PROG_MAKE_SET +AC_PROG_RANLIB + +# Checks for compiler builtins and attributes. +m4_ifdef([AX_GCC_BUILTIN], [ + AX_GCC_BUILTIN(__builtin_expect) + AX_GCC_BUILTIN(__builtin_unreachable) + AX_GCC_FUNC_ATTRIBUTE(cold) + AX_GCC_FUNC_ATTRIBUTE(hot) +]) + +# Checks for header files. +AC_CHECK_HEADERS([fcntl.h limits.h stddef.h stdlib.h string.h sys/ioctl.h termios.h unistd.h]) + +# Checks for typedefs, structures, and compiler characteristics. +AC_CHECK_HEADER_STDBOOL +AC_C_INLINE +AC_TYPE_SIZE_T +AC_TYPE_SSIZE_T + +# Checks for library functions. +AC_FUNC_MALLOC +AC_FUNC_REALLOC +AC_CHECK_FUNCS([dprintf memset strtoul]) + +AC_CONFIG_FILES([Makefile man/Makefile src/Makefile tests/Makefile examples/Makefile]) +AC_OUTPUT diff --git a/examples/Makefile.am b/examples/Makefile.am new file mode 100644 index 0000000..6134ecc --- /dev/null +++ b/examples/Makefile.am @@ -0,0 +1,12 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +AM_CPPFLAGS = -I$(top_srcdir)/src +noinst_PROGRAMS = sixdraw +sixdraw_SOURCES = sixdraw.c +sixdraw_LDADD = $(top_srcdir)/src/libctlseqs.la diff --git a/examples/sixdraw.c b/examples/sixdraw.c new file mode 100644 index 0000000..dbfb314 --- /dev/null +++ b/examples/sixdraw.c @@ -0,0 +1,283 @@ +/** + * sixdraw.c - draw lines on your terminal + * + * Requires sixel graphics and DEC locator support to run on your terminal. + * These features are not widely supported. To save yourself from trouble, + * use a latest version of XTerm or mlterm. + * + * Copyright (C) 2020 CismonX + * + * 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 . + */ + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif // HAVE_CONFIG_H + +#include +#include +#include +#include + +#include +#include +#include +#include + +#include + +#ifndef SIXDRAW_DEFAULT_TIMEOUT_MILLIS +# define SIXDRAW_DEFAULT_TIMEOUT_MILLIS 500 +#endif // !SIXDRAW_DEFAULT_TIMEOUT_MILLIS + +struct sixdraw_ctx { + struct termios termios; + union ctlseqs_value buffer[10]; + char *prog_name; + struct ctlseqs_matcher *matcher; + struct ctlseqs_reader *reader; + bool has_termios; + bool show_cursor; + int in_fd; + int out_fd; + int timeout; + int rows; + int cols; + int ch_width; + int ch_height; +}; + +static inline void +sixdraw_print_error(struct sixdraw_ctx *ctx, char const *msg) +{ + dprintf(ctx->out_fd, "%s: [error] %s.\n", ctx->prog_name, msg); +} + +static inline void +sixdraw_clear_signal(int signum) +{ + sigset_t sigset; + sigemptyset(&sigset); + sigaddset(&sigset, signum); + sigwait(&sigset, &signum); +} + +static bool +sixdraw_handle_signals(struct sixdraw_ctx *ctx) +{ + sigset_t sigset; + sigpending(&sigset); + if (!sigismember(&sigset, SIGWINCH)) { + return false; + } + sixdraw_clear_signal(SIGWINCH); + return true; +} + +static void +sixdraw_terminate(struct sixdraw_ctx *ctx) +{ + ctlseqs_matcher_free(ctx->matcher); + ctlseqs_reader_free(ctx->reader); + + // Restore original terminal modes + if (ctx->has_termios) { + tcsetattr(ctx->in_fd, TCSANOW, &ctx->termios); + } +} + +static bool +sixdraw_get_winsize(struct sixdraw_ctx *ctx) +{ + struct winsize ws = { 0 }; + if (ioctl(ctx->in_fd, TIOCGWINSZ, &ws) != 0) { + return false; + } + if (ws.ws_xpixel == 0 || ws.ws_ypixel == 0) { + return false; + } + ctx->rows = ws.ws_row; + ctx->cols = ws.ws_col; + ctx->ch_width = ws.ws_xpixel / ws.ws_col; + ctx->ch_height = ws.ws_ypixel / ws.ws_row; + dprintf(ctx->out_fd, "%d %d \n%d %d %d %d\n", ws.ws_xpixel, ws.ws_ypixel, ctx->rows, ctx->cols, ctx->ch_width, ctx->ch_height); + return true; +} + +static bool +sixdraw_init(struct sixdraw_ctx *ctx, int argc, char **argv) +{ + *ctx = (struct sixdraw_ctx) { + .prog_name = argc > 0 ? argv[0] : "sixdraw", + .in_fd = STDIN_FILENO, + .out_fd = STDOUT_FILENO, + .timeout = SIXDRAW_DEFAULT_TIMEOUT_MILLIS, + }; + + // Process command line arguments + int opt; + while (-1 != (opt = getopt(argc, argv, "t:"))) { + switch (opt) { + case 't': + ctx->timeout = atoi(optarg); + break; + case '?': + default: + return false; + } + } + + // Initialize control sequence matcher + ctx->matcher = ctlseqs_matcher_init(); + if (ctx->matcher == NULL) { + sixdraw_print_error(ctx, "failed to initialize matcher"); + return false; + } + char const *patterns[] = { + CTLSEQS_RESP_PRIMARY_DA(CTLSEQS_PH_NUMS), + CTLSEQS_RESP_DECRQM(CTLSEQS_PH_NUM, CTLSEQS_PH_NUM) + }; + struct ctlseqs_matcher_opts options = { + .patterns = patterns, + .npatterns = sizeof(patterns) / sizeof(char const *), + }; + if (ctlseqs_matcher_setopt(ctx->matcher, &options) != 0) { + sixdraw_print_error(ctx, "failed to set matcher options"); + return false; + } + + // Initialize control sequence reader + ctx->reader = ctlseqs_reader_init(); + if (ctx->reader == NULL) { + sixdraw_print_error(ctx, "failed to initialize reader"); + return false; + } + struct ctlseqs_reader_opts reader_opts = { + .buffer = ctx->buffer, + .fd = ctx->in_fd, + .maxlen = 32, + }; + if (ctlseqs_reader_setopt(ctx->reader, &reader_opts) != CTLSEQS_OK) { + sixdraw_print_error(ctx, "failed to set reader options"); + return false; + } + + // Block SIGWINCH + sigset_t sigset; + sigemptyset(&sigset); + sigaddset(&sigset, SIGWINCH); + sigprocmask(SIG_BLOCK, &sigset, NULL); + signal(SIGWINCH, SIG_DFL); + + return true; +} + +static bool +sixdraw_prepare(struct sixdraw_ctx *ctx) +{ + // Check whether we're running on a terminal + if (!isatty(ctx->in_fd) || !isatty(ctx->out_fd)) { + sixdraw_print_error(ctx, "this program can only run in a terminal"); + return false; + } + + // Set terminal to noncanonical mode + struct termios termios; + if (tcgetattr(ctx->in_fd, &ctx->termios) != 0) { + sixdraw_print_error(ctx, "failed to get terminal attributes"); + return false; + } + termios = ctx->termios; + termios.c_lflag &= ~(ICANON | ISIG | ECHO); + if (tcsetattr(ctx->in_fd, TCSANOW, &termios) != 0) { + sixdraw_print_error(ctx, "failed to get terminal attributes"); + return false; + } + ctx->has_termios = true; + + // Set STDIN flags to non-blocking + int flags = fcntl(ctx->in_fd, F_GETFL); + if (flags == -1) { + sixdraw_print_error(ctx, "failed to get file status flags"); + return false; + } + if (fcntl(ctx->in_fd, F_SETFL, flags | O_NONBLOCK) == -1) { + sixdraw_print_error(ctx, "failed to set file status flags"); + return false; + } + + // Get initial terminal window size + if (!sixdraw_get_winsize(ctx)) { + sixdraw_print_error(ctx, "failed to get terminal window size"); + return false; + } + return true; + + // Check terminal support for sixel graphics and DEC locator + dprintf(ctx->out_fd, CTLSEQS_PRIMARY_DA()); + ssize_t result = ctlseqs_read(ctx->reader, ctx->matcher, 500); + if (result != 0) { + sixdraw_print_error(ctx, "failed to get terminal attributes"); + return false; + } + bool has_sixel = false; + bool has_dec_locator = false; + union ctlseqs_value *buffer = ctx->buffer; + for (size_t i = 1; i <= buffer[0].num; ++i) { + if (buffer[i].num == 4) { + has_sixel = true; + } else if (buffer[i].num == 29) { + has_dec_locator = true; + } + } + if (!has_sixel) { + sixdraw_print_error(ctx, "terminal does not support sixel graphics"); + return false; + } + if (!has_dec_locator) { + sixdraw_print_error(ctx, "terminal does not support DEC locator mode"); + return false; + } + + // Get current cursor status + dprintf(ctx->out_fd, CTLSEQS_DECRQM("25")); + result = ctlseqs_read(ctx->reader, ctx->matcher, ctx->timeout); + if (result != 1) { + sixdraw_print_error(ctx, "failed to get cursor status"); + return false; + } + if (buffer[0].num != 25 || (buffer[1].num != 1 && buffer[1].num != 2)) { + sixdraw_print_error(ctx, "cursor status not recognizable"); + return false; + } + ctx->show_cursor = buffer[1].num == 1; + + return true; +} + +int +main(int argc, char **argv) +{ + int status = 0; + + struct sixdraw_ctx ctx; + if (!sixdraw_init(&ctx, argc, argv) || !sixdraw_prepare(&ctx)) { + status = -1; + goto terminate; + } + + terminate: + sixdraw_terminate(&ctx); + return status; +} diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..d9382d7 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,12 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +dist_man3_MANS = ctlseqs_matcher_init.3 ctlseqs_matcher_setopt.3 ctlseqs_matcher_free.3 \ + ctlseqs_reader_init.3 ctlseqs_reader_setopt.3 ctlseqs_read.3 ctlseqs_reader_free.3 + +dist_man7_MANS = ctlseqs.7 diff --git a/man/ctlseqs.7 b/man/ctlseqs.7 new file mode 100644 index 0000000..bb761d2 --- /dev/null +++ b/man/ctlseqs.7 @@ -0,0 +1,66 @@ +.TH CTLSEQS 7 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs - helper library for terminal control sequences +. +.SH SYNOPSIS +.nf +.B #include +.PP +.B #define __cplusplus 201103L +.BR "#include " " /* C++ Wrapper */" +.fi +. +.SH DESCRIPTION +The ctlseqs library provides low-level API for manipulating terminal emulators with control sequences. +.SS Terminal escape sequences +Terminals and hosts exchange control information regarding colors, font styles, cursor position, etc., using escape sequences embedded in normal text. +.PP +In distant past, when there are no standard protocols to apply, those escape sequences are largely vendor-specific. +We can assume that most, if not all modern terminal emulators recognize ANSI-compliant escape sequences, as well as supporting popular control functions like the ones shipped with DEC VT100 series. +However, this is not guaranteed, and using raw escape sequences is prone to broken compatibility. +.PP +While most text-based applications should stick to terminfo/ncurses, there are occasions when dealing with raw escape sequences is inevitable. +For example, when trying to make use of proprietary features provided by a specific terminal emulator. +Or perhaps, when implementing one's own terminal emulator. +.PP +Writing escape sequences is pretty straightforward, but reading and processing them could be tricky, and not trivial to implement. +.SS The ctlseqs library +The ctlseqs library tries to make your life easier when dealing with raw escape sequences. +There are three major concepts in the library, the reader, the matcher, and the helper macros. +.PP +The reader is responsible to read arbitrary data from a file descriptor, buffer it, and check whether it (or part of it) is a valid terminal control sequence. +.PP +The matcher is configured with patterns describing a terminal control sequence. +After a sequence is successfully read, it can be matched against the patterns, and according to which, values can be extracted. +.PP +The helper macros include C0 (7-bit) control characters, commonly used control sequences (mostly CSI sequences) from DEC VTxxx series and XTerm, and placeholders. +Helper macros always expand to string literals. +.PP +For reader/matcher details, see the corresponding man page in section 3. +For helper macro details, see the source code of the +.I ctlseqs.h +header. +. +.SH BUGS +C1 (8-bit) control characters are not supported. +. +.SH SEE ALSO +.BR terminfo (5), +.BR ncurses (3X) +.PP +.BR ctlseqs_matcher_init (3), +.BR ctlseqs_matcher_setopt (3), +.BR ctlseqs_matcher_free (3) +.PP +.BR ctlseqs_reader_init (3), +.BR ctlseqs_reader_setopt (3), +.BR ctlseqs_reader_free (3) +.PP +.BR ctlseqs_read (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/ctlseqs_matcher_free.3 b/man/ctlseqs_matcher_free.3 new file mode 100644 index 0000000..3b4273c --- /dev/null +++ b/man/ctlseqs_matcher_free.3 @@ -0,0 +1,34 @@ +.TH CTLSEQS_MATCHER_FREE 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_matcher_free - free control sequence matcher +. +.SH SYNOPSYS +.nf +.B #include +.PP +.BI "void ctlseqs_matcher_free(struct ctlseqs_matcher *" matcher ");" +.fi +. +.SH DESCRIPTION +Destroys a +.I matcher +instance created by +.BR ctlseqs_matcher_init () +and release its holding memory. +.PP +If +.I matcher +is NULL, this function has no effect. +. +.SH RETURN VALUE +This function has no return values. +. +.SH SEE ALSO +.BR ctlseqs_matcher_init (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/ctlseqs_matcher_init.3 b/man/ctlseqs_matcher_init.3 new file mode 100644 index 0000000..c779507 --- /dev/null +++ b/man/ctlseqs_matcher_init.3 @@ -0,0 +1,35 @@ +.TH CTLSEQS_MATCHER_INIT 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_matcher_init - initialize control sequence matcher +. +.SH SYNOPSYS +.nf +.B #include +.PP +.B struct ctlseqs_matcher *ctlseqs_matcher_init(void); +.fi +. +.SH DESCRIPTION +Creates a control sequence matcher, which can be configured with +.BR ctlseqs_matcher_setopt (). +.PP +Instance of a control sequence matcher should be freed with +.BR ctlseqs_matcher_free (). +. +.SH RETURN VALUE +Returns a pointer to opaque type +.B struct ctlseqs_matcher +holding the matcher instance. +.PP +If the function fails to allocate sufficient memory, returns NULL. +. +.SH SEE ALSO +.BR ctlseqs_matcher_setopt (3), +.BR ctlseqs_matcher_free (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/ctlseqs_matcher_setopt.3 b/man/ctlseqs_matcher_setopt.3 new file mode 100644 index 0000000..989dfc1 --- /dev/null +++ b/man/ctlseqs_matcher_setopt.3 @@ -0,0 +1,63 @@ +.TH CTLSEQS_MATCHER_SETOPT 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_matcher_setopt - set control sequence matcher options +. +.SH SYNOPSYS +.nf +.B #include +.PP +.BI "int ctlseqs_matcher_setopt(struct ctlseqs_matcher *" matcher , +.BI " struct ctlseqs_matcher_opts const *" options ); +.fi +. +.SH DESCRIPTION +Changes the properties of the given +.IR matcher . +.PP +The +.I options +argument is a pointer to a +.BR "struct ctlseqs_matcher_opts" , +whose definition is shown below: +.PP +.nf +.in +4n +.EX +struct ctlseqs_matcher_opts { + char const *const *patterns; + size_t npatterns; +}; +.EE +.in +.fi +.PP +Field +.I patterns +is an array of pointers to NUL-terminated strings, each of which represents a pattern of control sequences. +.PP +Field +.I npatterns +is the number of strings provided in +.IR patterns . +.PP +Multiple calls on the same +.I matcher +will discard all data from previous calls. +. +.SH RETURN VALUE +.TP +.B CTLSEQS_OK +Success. +.TP +.B CTLSEQS_NOMEM +Fails to allocate sufficient memory. +. +.SH SEE ALSO +.BR ctlseqs (7) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/ctlseqs_read.3 b/man/ctlseqs_read.3 new file mode 100644 index 0000000..59b49e6 --- /dev/null +++ b/man/ctlseqs_read.3 @@ -0,0 +1,99 @@ +.TH CTLSEQS_READ 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_read - read control sequence +. +.SH SYNOPSYS +.nf +.B #include +.PP +.BI "ssize_t ctlseqs_read(struct ctlseqs_reader *" reader , +.BI " struct ctlseqs_matcher const *" matcher ", int " timeout ); +.fi +. +.SH DESCRIPTION +Attempts to read a terminal control sequence, and extract values according to given patterns. +.PP +The +.I reader +argument specifies the behaviour of the read operation, which can be configured with +.BR ctlseqs_reader_setopt (). +.PP +The +.I matcher +argument specifies the expected patterns of control sequences to be matched upon after a successful read, which can be configured with +.BR ctlseqs_matcher_setopt (). +A NULL +.I matcher +is allowed, acting as if +.I npatterns +is 0. +.PP +Argument +.I timeout +is the maximum duration of time (in milliseconds) to wait until any data can be read. +If +.I timeout +is -1, the function blocks indefinitely. If option +.B CTLSEQS_READER_NO_POLL +is enabled, this argument has no effect. +. +.SH RETURN VALUE +If a control sequence is successfully read, and matches at least one pattern in +.IR matcher , +returns a non-negative integer representing the offset of one of the matching patterns. +.PP +Otherwise, returns a negative value: +.TP +.B CTLSEQS_NOMATCH +A control sequence is successfully read, but fails to match any pattern in +.IR matcher . +.TP +.B CTLSEQS_PARTIAL +Data is read successfully and can be recognized as part of a control sequence, but is not yet terminated. +.TP +.B CTLSEQS_NOSEQ +Data is read successfully, but cannot be recognized as a valid control sequence. +.TP +.B CTLSEQS_TIMEOUT +The specified +.I timeout +has expired, and no data is read. +.TP +.B CTLSEQS_EOF +End-of-file is encountered, and no data is read. +.TP +.B CTLSEQS_ERROR +An unexpected error occurs during a system call within the function. +.TP +.B CTLSEQS_INTR +A system call within the function is interrupted by a signal, and no data is read. +. +.SH NOTES +Any pattern in +.I matcher +must be a ECMA-35/ECMA-48 conformant escape sequence, and should also be recognizable by the matcher. +Otherwise, function behaviour is undefined. +.PP +Currently supported escape sequences: +.TP +.B CSI [param...] [intmd...] final +Parameter bytes are of range 0x30\(ti0x3f, intermediate bytes 0x20\(ti0x2f, and final byte 0x40\(ti0x7e. +.TP +.B (APC|DCS|OSC|PM) [cmdstr] ST +Command string consists of bytes of printable characters and characters of range 0x08\(ti0x0d. +.TP +.B (SS2|SS3) ch +The byte following a single-shift should be a printable character. +.TP +.B SOS [chrstr] ST +Character string can be any bit combination which does not represent SOS or ST. +.SH SEE ALSO +.BR ctlseqs_matcher_setopt (3), +.BR ctlseqs_reader_setopt (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/ctlseqs_reader_free.3 b/man/ctlseqs_reader_free.3 new file mode 100644 index 0000000..2bd097a --- /dev/null +++ b/man/ctlseqs_reader_free.3 @@ -0,0 +1,34 @@ +.TH CTLSEQS_MATCHER_FREE 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_reader_free - free control sequence reader +. +.SH SYNOPSYS +.nf +.B #include +.PP +.BI "void ctlseqs_reader_free(struct ctlseqs_reader *" reader ");" +.fi +. +.SH DESCRIPTION +Destroys a +.I reader +instance created by +.BR ctlseqs_reader_init () +and release its holding memory. +.PP +If +.I reader +is NULL, this function has no effect. +. +.SH RETURN VALUE +This function has no return values. +. +.SH SEE ALSO +.BR ctlseqs_reader_init (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/ctlseqs_reader_init.3 b/man/ctlseqs_reader_init.3 new file mode 100644 index 0000000..22bf0b5 --- /dev/null +++ b/man/ctlseqs_reader_init.3 @@ -0,0 +1,35 @@ +.TH CTLSEQS_READER_INIT 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_reader_init - initialize control sequence reader +. +.SH SYNOPSYS +.nf +.B #include +.PP +.B struct ctlseqs_reader *ctlseqs_reader_init(void); +.fi +. +.SH DESCRIPTION +Creates a control sequence reader, which can be configured with +.BR ctlseqs_reader_setopt (). +.PP +Instance of a control sequence reader should be freed with +.BR ctlseqs_reader_free (). +. +.SH RETURN VALUE +Returns a pointer to opaque type +.B struct ctlseqs_reader +holding the reader instance. +.PP +If the function fails to allocate sufficient memory, returns NULL. +. +.SH SEE ALSO +.BR ctlseqs_reader_setopt (3), +.BR ctlseqs_reader_free (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty.. diff --git a/man/ctlseqs_reader_setopt.3 b/man/ctlseqs_reader_setopt.3 new file mode 100644 index 0000000..92b1709 --- /dev/null +++ b/man/ctlseqs_reader_setopt.3 @@ -0,0 +1,154 @@ +.TH CTLSEQS_READER_SETOPT 3 "Sep 01, 2020" 0.1.0 "Ctlseqs Library Manual" +. +.SH NAME +ctlseqs_reader_setopt - set control sequence reader options +. +.SH SYNOPSYS +.nf +.B #include +.PP +.BI "int ctlseqs_reader_setopt(struct ctlseqs_reader *" reader , +.BI " struct ctlseqs_reader_opts const *" options ); +.fi +. +.SH DESCRIPTION +Function +.BR ctlseqs_reader_setopt () +changes the properties of the given +.IR reader . +.PP +The +.I options +argument is a pointer to a +.BR "struct ctlseqs_reader_opts" , +as shown below: +.PP +.nf +.in +4n +.EX +struct ctlseqs_reader_opts { + union ctlseqs_value *buffer; + size_t maxlen; + int fd; + unsigned flags; +}; +.EE +.in +.fi +.PP +Field +.I buffer +is the pointer to the buffer where the values extracted from the matching sequence of +.BR ctlseqs_read () +will be stored. +.PP +Field +.I maxlen +specifies the maximum possible length (in bytes) of control sequence to be read. +.PP +Field +.I fd +is the file descriptor to read from. +.PP +Field +.I flags +is the bit mask of multiple boolean options. +.SS Buffer Values +A +.I buffer +is an array of +.BR "union ctlseqs_value" , +as shown below: +.PP +.nf +.in +4n +.EX +union ctlseqs_value { + char const *str; + unsigned long num; +}; +.EE +.in +.fi +.PP +The value can be either a string (not guaranteed to be NUL-terminated), or an unsigned integer. +Once a sequence is successfully matched, a group of values is extracted from the sequence for each placeholder, and stored into the buffer sequentially. +.PP +A group can contain one or multiple values, depending on different placeholders: +.TP +.B CTLSEQS_PH_NUM +A single unsigned integer. +.TP +.B CTLSEQS_PH_NUMS +An unsigned integer indicating the number of extracted values, followed by unsigned integers of that many. +.TP +.B CTLSEQS_PH_STR +An unsigned integer indicating the number of characters of the extracted string, followed by a string of printable characters. +.TP +.B CTLSEQS_PH_CMDSTR +An unsigned integer indicating the number of characters of the extracted string, followed by a string containing only printable characters and characters of range 0x08\(ti0x0d. +.TP +.B CTLSEQS_PH_CSI_PARAM +An unsigned integer indicating the number of characters of the extracted string, followed by a string of CSI parameter bytes (range 0x30\(ti0x3f). +.TP +.B CTLSEQS_PH_CSI_INTMD +An unsigned integer indicating the number of characters of the extracted string, followed by a string of CSI intermediate bytes (range 0x20\(ti0x2f). +.TP +.B CTLSEQS_PH_HEXNUM +A single unsigned integer, which is the integer value of extracted hexadecimal string. +.TP +.B CTLSEQS_PH_CHRSTR +An unsigned integer indicating the number of characters of the extracted string, followed by a string of any bit combination which does not represent SOS or ST. +.PP +If the +.BR ctlseqs_read () +call returns +.BR CTLSEQS_NOSEQ , +.B CTLSEQS_NOMATCH +or +.BR CTLSEQS_PARTIAL , +the length of the entire string followed by the string itself will be stored into the buffer. +.SS Flags +.TP +.B CTLSEQS_READER_NO_POLL +In a +.BR ctlseqs_read () +call, do not +.BR poll () +before +.BR read (). +You may want this option enabled if +.I fd +is maintained in an event loop. +.TP +.B CTLSEQS_READER_RETAIN_PARTIAL +When +.BR ctlseqs_read () +returns +.BR CTLSEQS_PARTIAL , +preserve the partially matched sequence in the internal buffer for future calls. +. +.SH RETURN VALUE +.TP +.B CTLSEQS_OK +Success. +.TP +.B CTLSEQS_NOMEM +Fails to allocate sufficient memory. +.SH BUGS +After a successful +.BR ctlseqs_read () +call, changing +.I maxlen +to a smaller value on the same +.I reader +may result in data loss due to truncation of the internal read buffer. +. +.SH SEE ALSO +.BR ctlseqs_read (3) +. +.SH COPYRIGHT +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..7c3e18d --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,21 @@ +## +## Copyright (C) 2020 CismonX +## +## This file 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 file 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 file. If not, see . +## + +lib_LTLIBRARIES = libctlseqs.la +libctlseqs_la_SOURCES = ctlseqs.c + +include_HEADERS = ctlseqs.h ctlseqs.hh diff --git a/src/ctlseqs.c b/src/ctlseqs.c new file mode 100644 index 0000000..36946a0 --- /dev/null +++ b/src/ctlseqs.c @@ -0,0 +1,502 @@ +/** + * ctlseqs.c - helper library for terminal control sequences + * + * Copyright (C) 2020 CismonX + * + * This file is part of the ctlseqs library. + * + * This library 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 library 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 library. If not, see . + */ + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif // HAVE_CONFIG_H + +#include "ctlseqs.h" + +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#ifdef HAVE___BUILTIN_EXPECT +# define CTLSEQS_LIKELY(expr) __builtin_expect(!!(expr), 1) +# define CTLSEQS_UNLIKELY(expr) __builtin_expect(!!(expr), 0) +#else +# define CTLSEQS_LIKELY(expr) (expr) +# define CTLSEQS_UNLIKELY(expr) (expr) +#endif // HAVE___BUILTIN_EXPECT +#ifdef HAVE___BUILTIN_UNREACHABLE +# define CTLSEQS_UNREACHABLE() __builtin_unreachable() +#else +# define CTLSEQS_UNREACHABLE() +#endif // HAVE___BUILTIN_UNREACHABLE + +#ifdef HAVE_FUNC_ATTRIBUTE_COLD +# define CTLSEQS_COLD __attribute__((cold)) +#else +# define CTLSEQS_COLD +#endif // HAVE_FUNC_ATTRIBUTE_COLD +#ifdef HAVE_FUNC_ATTRIBUTE_HOT +# define CTLSEQS_HOT __attribute__((hot)) +#else +# define CTLSEQS_HOT +#endif // HAVE_FUNC_ATTRIBUTE_HOT + +#ifndef CTLSEQS_TRIE_INIT_SIZE +# define CTLSEQS_TRIE_INIT_SIZE 16 +#endif // !CTLSEQS_TRIE_INIT_SIZE + +#define CTLSEQS_VALUE_STR(stop_cond) \ + for (cnt = 0; ; ++cnt) { \ + num = seq_val[cnt]; \ + if (stop_cond) { \ + break; \ + } \ + } \ + buf[0].num = cnt; \ + buf[1].str = seq_val; \ + *seq = seq_val + cnt; \ + *buf_offset += 2; \ + return true +#define CTLSEQS_VALUE_NUM(base) \ + errno = 0; \ + num = strtoul(seq_val, seq, base); \ + if (errno != 0 || seq_val == *seq) { \ + return false; \ + } \ + buf[0].num = num; \ + *buf_offset += 1; \ + return true + +enum ctlseqs_placeholder { + ctlseqs_ph_begin = 0x0e, + ctlseqs_ph_num = ctlseqs_ph_begin, + ctlseqs_ph_nums, + ctlseqs_ph_str, + ctlseqs_ph_cmdstr, + ctlseqs_ph_csi_param, + ctlseqs_ph_csi_intmd, + ctlseqs_ph_hexnum, + ctlseqs_ph_chrstr, + ctlseqs_ph_end, +}; + +enum ctlseqs_state { + ctlseqs_state_none, + ctlseqs_state_esc, + ctlseqs_state_csi, + ctlseqs_state_csi_intmd, + ctlseqs_state_cmdstr, + ctlseqs_state_ss, + ctlseqs_state_ctlstr, + ctlseqs_state_str_end, + ctlseqs_state_done, + ctlseqs_state_err, +}; + +struct ctlseqs_trie_node { + ssize_t value; + int placeholder; + struct ctlseqs_trie_node *next; + struct ctlseqs_trie_node *children[128]; +}; + +struct ctlseqs_match_ctx { + ssize_t value; + struct ctlseqs_trie_node const *node; + char *buf; +}; + +struct ctlseqs_matcher { + struct ctlseqs_trie_node root; + struct ctlseqs_trie_node *node_pool; + size_t node_pool_size; + struct ctlseqs_match_ctx *match_stack; +}; + +struct ctlseqs_reader { + union ctlseqs_value *buffer; + size_t readlen; + struct pollfd pollfd; + bool no_poll; + bool retain_partial; + char *rbuf; + size_t buf_start; + size_t buf_end; + enum ctlseqs_state state; +}; + +CTLSEQS_HOT static int +ctlseqs_poll(struct pollfd *pollfd, int timeout) +{ + int nevents = poll(pollfd, 1, timeout); + if (nevents == -1) { + return errno == EINTR ? CTLSEQS_INTR : CTLSEQS_ERROR; + } + if (nevents == 0) { + return CTLSEQS_TIMEOUT; + } + if (CTLSEQS_LIKELY(pollfd->revents & POLLIN)) { + return CTLSEQS_OK; + } + return pollfd->revents & POLLHUP ? CTLSEQS_EOF : CTLSEQS_ERROR; +} + +CTLSEQS_HOT static int +ctlseqs_do_read(struct ctlseqs_reader *reader) +{ + ssize_t nbytes = read(reader->pollfd.fd, reader->rbuf + reader->buf_start, reader->readlen - reader->buf_start); + if (CTLSEQS_UNLIKELY(nbytes == -1)) { + if (errno == EAGAIN || errno == EWOULDBLOCK) { + return CTLSEQS_TIMEOUT; + } + return errno == EINTR ? CTLSEQS_INTR : CTLSEQS_ERROR; + } + if (CTLSEQS_UNLIKELY(nbytes == 0)) { + return CTLSEQS_EOF; + } + reader->buf_end += nbytes; + return CTLSEQS_OK; +} + +CTLSEQS_HOT static enum ctlseqs_state +ctlseqs_state_transit(enum ctlseqs_state state, char ch) +{ + switch (state) { + case ctlseqs_state_none: + return ch == 0x1b ? ctlseqs_state_esc : ctlseqs_state_err; + case ctlseqs_state_esc: + switch (ch) { + case '[': + return ctlseqs_state_csi; + case 'N': + case 'O': + return ctlseqs_state_ss; + case 'P': + case ']': + case '_': + case '^': + return ctlseqs_state_cmdstr; + case 'X': + return ctlseqs_state_ctlstr; + default: + return (ch >= ' ' && ch <= '~') ? ctlseqs_state_done : ctlseqs_state_err; + } + case ctlseqs_state_csi: + if (ch >= '0' && ch <= '?') { + return state; + } + return (ch >= ' ' && ch <= '/') ? ctlseqs_state_csi_intmd : ctlseqs_state_err; + case ctlseqs_state_csi_intmd: + if (ch >= ' ' && ch <= '/') { + return state; + } + return (ch >= '@' && ch <= '~') ? ctlseqs_state_done : ctlseqs_state_err; + case ctlseqs_state_cmdstr: + if (ch == 0x1b) { + return ctlseqs_state_str_end; + } else if (ch < 0x08 || ch > '~' || (ch > 0x0d && ch < ' ')) { + return ctlseqs_state_err; + } else { + return state; + } + case ctlseqs_state_ss: + return (ch >= ' ' && ch <= '~') ? ctlseqs_state_done : ctlseqs_state_err; + case ctlseqs_state_ctlstr: + return ch == 0x1b ? ctlseqs_state_str_end : state; + case ctlseqs_state_str_end: + return ch == '\\' ? ctlseqs_state_done : ctlseqs_state_err; + default: + CTLSEQS_UNREACHABLE(); + return state; + } +} + +CTLSEQS_HOT bool +ctlseqs_fetch(char **seq, int type, union ctlseqs_value *buf, size_t *buf_offset) +{ + unsigned long cnt, num; + char *seq_val = *seq; + buf += *buf_offset; + switch (type) { + case ctlseqs_ph_num: + CTLSEQS_VALUE_NUM(10); + case ctlseqs_ph_nums: + for (cnt = 1; ; ++cnt) { + num = strtoul(seq_val, seq, 10); + if (errno != 0 || seq_val == *seq) { + return false; + } + buf[cnt].num = num; + if (seq_val[0] == ';') { + ++seq_val; + } else { + break; + } + } + buf[0].num = cnt; + *buf_offset += 1; + return true; + case ctlseqs_ph_str: + CTLSEQS_VALUE_STR(num < ' ' || num > '~'); + case ctlseqs_ph_cmdstr: + CTLSEQS_VALUE_STR(num < 0x08 || num > '~' || (num > 0x0d && num < ' ')); + case ctlseqs_ph_csi_param: + CTLSEQS_VALUE_STR(num < '0' || num > '?'); + case ctlseqs_ph_csi_intmd: + CTLSEQS_VALUE_STR(num < ' ' || num > '/'); + case ctlseqs_ph_hexnum: + CTLSEQS_VALUE_NUM(16); + case ctlseqs_ph_chrstr: + CTLSEQS_VALUE_STR(num > 0x7f); + default: + CTLSEQS_UNREACHABLE(); + return false; + } +} + +CTLSEQS_HOT static ssize_t +ctlseqs_match_pattern(struct ctlseqs_reader *reader, struct ctlseqs_matcher const *matcher) +{ + static struct ctlseqs_trie_node const *old_node, empty_node = { 0 }; + struct ctlseqs_match_ctx match_ctx = { + .node = matcher == NULL ? &empty_node : &matcher->root, + .buf = reader->rbuf + reader->buf_start + 1, + }; + ssize_t match_stack_top = -1; + size_t buffer_offset = 0; + while (true) { + match_ctx.value = match_ctx.node->value; + if (match_ctx.value == -1) { + // Match character as-is. + match_ctx.node = match_ctx.node->children[(unsigned)match_ctx.buf++[0]]; + if (match_ctx.node == NULL) { + break; + } + } else if (match_ctx.value < -1) { + // Match placeholder. + start_match: + old_node = match_ctx.node; + match_ctx.node = match_ctx.node->children[-match_ctx.value]; + // If other placeholders exist on the same level, save them + // to the stack for future retry. + if (match_ctx.node->next != NULL) { + matcher->match_stack[++match_stack_top] = (struct ctlseqs_match_ctx) { + .value = match_ctx.node->next->placeholder, + .node = old_node, + .buf = match_ctx.buf, + }; + } + if (!ctlseqs_fetch(&match_ctx.buf, -match_ctx.value, reader->buffer, &buffer_offset)) { + break; + } + } else { + // Successfully matched. + return match_ctx.value; + } + } + if (match_stack_top >= 0) { + match_ctx = matcher->match_stack[match_stack_top--]; + goto start_match; + } + return CTLSEQS_NOMATCH; +} + +CTLSEQS_HOT static ssize_t +ctlseqs_match(struct ctlseqs_reader *reader, struct ctlseqs_matcher const *matcher) +{ + ssize_t retval = CTLSEQS_PARTIAL; + char const *buf = reader->rbuf + reader->buf_start; + size_t idx, len = reader->buf_end - reader->buf_start; + enum ctlseqs_state state = reader->state; + for (idx = 0; idx < len; ++idx) { + state = ctlseqs_state_transit(state, buf[idx]); + if (state == ctlseqs_state_err) { + retval = CTLSEQS_NOSEQ; + for (; idx < len; ++idx) { + if (buf[idx] == 0x1b) { + break; + } + } + reader->buffer[0].num = idx; + reader->buffer[1].str = buf; + break; + } + if (state == ctlseqs_state_done) { + retval = ctlseqs_match_pattern(reader, matcher); + break; + } + } + reader->state = state; + reader->buf_start += idx; + if (reader->buf_start == reader->buf_end) { + reader->buf_start = 0; + reader->buf_end = 0; + } + return retval; +} + +struct ctlseqs_matcher * +ctlseqs_matcher_init() +{ + struct ctlseqs_matcher *matcher = malloc(sizeof(struct ctlseqs_matcher)); + if (CTLSEQS_LIKELY(matcher != NULL)) { + *matcher = (struct ctlseqs_matcher) { .node_pool_size = 0 }; + } + return matcher; +} + +int +ctlseqs_matcher_setopt(struct ctlseqs_matcher *matcher, struct ctlseqs_matcher_opts const *options) +{ + size_t node_pool_idx = 0, max_format_size = 0; + if (matcher->node_pool == NULL) { + matcher->node_pool_size = sizeof(struct ctlseqs_trie_node) * CTLSEQS_TRIE_INIT_SIZE; + matcher->node_pool = malloc(matcher->node_pool_size); + if (CTLSEQS_UNLIKELY(matcher->node_pool == NULL)) { + return CTLSEQS_NOMEM; + } + } + matcher->root = (struct ctlseqs_trie_node) { .value = -1 }; + for (size_t i = 0; i < options->npatterns; ++i) { + char const *pattern = options->patterns[i]; + struct ctlseqs_trie_node *node = &matcher->root; + for (size_t j = 1; ; ++j) { + int ch = pattern[j]; + if (ch == '\0') { + node->value = i; + if (j > max_format_size) { + max_format_size = j; + } + break; + } + struct ctlseqs_trie_node *old_node = node; + node = node->children[ch]; + if (node != NULL) { + continue; + } + if (CTLSEQS_UNLIKELY(++node_pool_idx >= matcher->node_pool_size)) { + struct ctlseqs_trie_node *new_pool = realloc(matcher->node_pool, matcher->node_pool_size * 2); + if (CTLSEQS_UNLIKELY(new_pool == NULL)) { + return CTLSEQS_NOMEM; + } + matcher->node_pool = new_pool; + matcher->node_pool_size *= 2; + } + old_node->children[ch] = node = &matcher->node_pool[node_pool_idx]; + *node = (struct ctlseqs_trie_node) { .value = -1 }; + if (ch < ctlseqs_ph_begin || ch >= ctlseqs_ph_end) { + continue; + } + // Node with multiple placeholders contains negated offset of child + // which is the head of the linked list. + if (old_node->value < -1) { + node->next = old_node->children[-old_node->value]; + node->next->value = old_node->value; + } + old_node->value = -ch; + } + } + size_t stack_size = sizeof(struct ctlseqs_match_ctx) * max_format_size; + struct ctlseqs_match_ctx *new_stack = realloc(matcher->match_stack, stack_size); + if (CTLSEQS_UNLIKELY(new_stack == NULL)) { + return CTLSEQS_NOMEM; + } + matcher->match_stack = new_stack; + return CTLSEQS_OK; +} + +CTLSEQS_COLD void +ctlseqs_matcher_free(struct ctlseqs_matcher *matcher) +{ + if (matcher != NULL) { + free(matcher->node_pool); + free(matcher); + } +} + +struct ctlseqs_reader * +ctlseqs_reader_init() +{ + struct ctlseqs_reader *reader = malloc(sizeof(struct ctlseqs_reader)); + if (CTLSEQS_LIKELY(reader != NULL)) { + *reader = (struct ctlseqs_reader) { 0 }; + } + return reader; +} + +int +ctlseqs_reader_setopt(struct ctlseqs_reader *reader, struct ctlseqs_reader_opts const *options) +{ + reader->buffer = options->buffer; + size_t readlen = options->maxlen; + if (reader->readlen != readlen) { + char *rbuf; + if (reader->rbuf == NULL) { + rbuf = malloc(readlen); + } else { + rbuf = realloc(reader->rbuf, readlen); + } + if (rbuf == NULL) { + return CTLSEQS_NOMEM; + } + reader->readlen = readlen; + reader->rbuf = rbuf; + if (reader->buf_end > reader->readlen) { + reader->buf_end = reader->readlen; + } + } + reader->pollfd = (struct pollfd) { .fd = options->fd, .events = POLLIN }; + reader->no_poll = options->flags & CTLSEQS_READER_NO_POLL; + reader->retain_partial = options->flags & CTLSEQS_READER_RETAIN_PARTIAL; + return CTLSEQS_OK; +} + +CTLSEQS_HOT ssize_t +ctlseqs_read(struct ctlseqs_reader *reader, struct ctlseqs_matcher const *matcher, int timeout) +{ + if (reader->buf_start != 0) { + ssize_t match_result = ctlseqs_match(reader, matcher); + if (match_result >= 0) { + return match_result; + } + } + if (!reader->no_poll) { + int poll_result = ctlseqs_poll(&reader->pollfd, timeout); + if (poll_result < 0) { + return poll_result; + } + } + int read_result = ctlseqs_do_read(reader); + if (CTLSEQS_UNLIKELY(read_result < 0)) { + return read_result; + } + return ctlseqs_match(reader, matcher); +} + +CTLSEQS_COLD void +ctlseqs_reader_free(struct ctlseqs_reader *reader) +{ + if (reader != NULL) { + free(reader->rbuf); + free(reader); + } +} diff --git a/src/ctlseqs.h b/src/ctlseqs.h new file mode 100644 index 0000000..8a7f8e8 --- /dev/null +++ b/src/ctlseqs.h @@ -0,0 +1,419 @@ +/** + * ctlseqs.h - helper library for terminal control sequences + * + * Copyright (C) 2020 CismonX + * + * This file is part of the ctlseqs library. + * + * This library 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 library 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 library. If not, see . + */ + +#ifndef CTLSEQS_H_ +#define CTLSEQS_H_ + +#define CTLSEQS_ESC "\x1b" // Escape + +/* C0(7-bit) Control Characters */ + +#define CTLSEQS_IND CTLSEQS_ESC "D" // Index +#define CTLSEQS_NEL CTLSEQS_ESC "E" // Next Line +#define CTLSEQS_HTS CTLSEQS_ESC "H" // Tab Set +#define CTLSEQS_RI CTLSEQS_ESC "M" // Reverse Index +#define CTLSEQS_SS2 CTLSEQS_ESC "N" // Single Shift Select of G2 Character Set +#define CTLSEQS_SS3 CTLSEQS_ESC "O" // Single Shift Select of G3 Character Set +#define CTLSEQS_DCS CTLSEQS_ESC "P" // Device Control String +#define CTLSEQS_SPA CTLSEQS_ESC "V" // Start of Guarded Area +#define CTLSEQS_EPA CTLSEQS_ESC "W" // End of Guarded Area +#define CTLSEQS_SOS CTLSEQS_ESC "X" // Start of String +#define CTLSEQS_CSI CTLSEQS_ESC "[" // Control Sequence Introducer +#define CTLSEQS_ST CTLSEQS_ESC "\\" // String Terminator +#define CTLSEQS_OSC CTLSEQS_ESC "]" // Operating System Command +#define CTLSEQS_PM CTLSEQS_ESC "^" // Privacy Message +#define CTLSEQS_APC CTLSEQS_ESC "_" // Application Program Command + +/* Single Character Functions */ + +#define CTLSEQS_ENQ() "\x05" // Return Terminal Status +#define CTLSEQS_BEL() "\x07" // Bell +#define CTLSEQS_BS() "\x08" // Backspace +#define CTLSEQS_TAB() "\x09" // Horizontal Tab +#define CTLSEQS_LF() "\x0a" // Line Feed or New Line +#define CTLSEQS_VT() "\x0b" // Vertical Tab +#define CTLSEQS_FF() "\x0c" // Form Feed or New Page +#define CTLSEQS_CR() "\x0d" // Carriage Return +#define CTLSEQS_SO() "\x0e" // Switch to Alternate Character Set +#define CTLSEQS_SI() "\x0f" // Switch to Standard Character Set +#define CTLSEQS_SP() "\x20" // Space + +/* Controls beginning with ESC */ + +#define CTLSEQS_S7C1T() CTLSEQS_ESC " F" // 7-bit controls +#define CTLSEQS_S8C1T() CTLSEQS_ESC " G" // 8-bit controls +#define CTLSEQS_DECDHL_TOP() CTLSEQS_ESC "#3" // DEC double-height line, top half +#define CTLSEQS_DECDHL_BOTOM() CTLSEQS_ESC "#4" // DEC double-height line, bottom half +#define CTLSEQS_DECSWL() CTLSEQS_ESC "#5" // DEC single-width line +#define CTLSEQS_DECDWL() CTLSEQS_ESC "#6" // DEC double-width line +#define CTLSEQS_DECALN() CTLSEQS_ESC "#8" // DEC Screen Alignment Test +#define CTLSEQS_DECBI() CTLSEQS_ESC "6" // Back Index +#define CTLSEQS_DECSC() CTLSEQS_ESC "7" // Save Cursor +#define CTLSEQS_DECRC() CTLSEQS_ESC "8" // Restore Cursor +#define CTLSEQS_DECFI() CTLSEQS_ESC "9" // Forward Index +#define CTLSEQS_DECKPAM() CTLSEQS_ESC "=" // Application Keypad +#define CTLSEQS_DECKPNM() CTLSEQS_ESC ">" // Normal Keypad +#define CTLSEQS_RIS() CTLSEQS_ESC "c" // Full Reset + +/* Device-Control functions */ + +// User-Defined Keys +#define CTLSEQS_DECUDK(i1, i2, s) CTLSEQS_DCS i1 ";" i2 "|" s CTLSEQS_ST +// Request Status String +#define CTLSEQS_DECRQSS(s) CTLSEQS_DCS "$q" s CTLSEQS_ST +// Restore presentation status +#define CTLSEQS_DECRSPS(i, s) CTLSEQS_DCS i "$t" s CTLSEQS_ST +// Request resource values +#define CTLSEQS_XTGETXRES(s) CTLSEQS_DCS "+Q" s CTLSEQS_ST +// Set Termcap/Terminfo Data +#define CTLSEQS_XTSETTCAP(s) CTLSEQS_DCS "+p" s CTLSEQS_ST +// Request Termcap/Terminfo String +#define CTLSEQS_XTGETTCAP(s) CTLSEQS_DCS "+q" s CTLSEQS_ST + +/* Functions using CSI */ + +// Insert $n (Blank) Character(s) +#define CTLSEQS_ICH(n) CTLSEQS_CSI n "@" +// Shift left $n columns(s) +#define CTLSEQS_SL(n) CTLSEQS_CSI n " @" +// Cursor Up $n Times +#define CTLSEQS_CUU(n) CTLSEQS_CSI n "A" +// Shift right $n columns(s) +#define CTLSEQS_SR(n) CTLSEQS_CSI n " A" +// Cursor Down $n Times +#define CTLSEQS_CUD(n) CTLSEQS_CSI n "B" +// Cursor Forward $n Times +#define CTLSEQS_CUF(n) CTLSEQS_CSI n "C" +// Cursor Backward $n Times +#define CTLSEQS_CUB(n) CTLSEQS_CSI n "D" +// Cursor Next Line $n Times +#define CTLSEQS_CNL(n) CTLSEQS_CSI n "E" +// Cursor Preceding Line $n Times +#define CTLSEQS_CPL(n) CTLSEQS_CSI n "F" +// Cursor Character Absolute +#define CTLSEQS_CHA(row) CTLSEQS_CSI row "G" +// Cursor Position +#define CTLSEQS_CUP(row, col) CTLSEQS_CSI row ";" col "H" +// Cursor Forward Tabulation $n tab stops +#define CTLSEQS_CHT(n) CTLSEQS_CSI n "I" +// Erase in Display +#define CTLSEQS_ED(i) CTLSEQS_CSI i "J" +// Erase in Display +#define CTLSEQS_DECSED(i) CTLSEQS_CSI "?" i "J" +// Erase in Line +#define CTLSEQS_EL(i) CTLSEQS_CSI i "K" +// Erase in Line +#define CTLSEQS_DECSEL(i) CTLSEQS_CSI "?" i "K" +// Insert $n Line(s) +#define CTLSEQS_IL(n) CTLSEQS_CSI n "L" +// Delete $n Line(s) +#define CTLSEQS_DL(n) CTLSEQS_CSI n "M" +// Delete $n Character(s) +#define CTLSEQS_DCH(n) CTLSEQS_CSI n "P" +// Scroll up $n Lines +#define CTLSEQS_SU(n) CTLSEQS_CSI n "S" +// Set or request graphics attribute +#define CTLSEQS_XTSMGRAPHICS(i1, i2, is) CTLSEQS_CSI "?" i1 ";" i2 ";" is "S" +// Scroll Down $n Line(s) +#define CTLSEQS_SD(n) CTLSEQS_CSI n "T" +// Initiate highlight mouse tracking +#define CTLSEQS_XTHIMOUSE(f, x, y, fr, lr) CTLSEQS_CSI f ";" x ";" y ";" fr ";" lr "T" +// Reset title mode features to default value +#define CTLSEQS_XTRMTITLE(is) CTLSEQS_CSI ">" is "T" +// Erase $n Character(s) +#define CTLSEQS_ECH(n) CTLSEQS_CSI n "X" +// Cursor Backward Tabulation $n tab stops +#define CTLSEQS_CBT(n) CTLSEQS_CSI n "Z" +// Character Position Absolute +#define CTLSEQS_HPA(n) CTLSEQS_CSI n "`" +// Character Position Relative +#define CTLSEQS_HPR(n) CTLSEQS_CSI n "a" +// Repeat the preceding graphic character $n times +#define CTLSEQS_REP(n) CTLSEQS_CSI n "b" +// Send Device Attributes +#define CTLSEQS_PRIMARY_DA() CTLSEQS_CSI "c" +// Send Device Attributes +#define CTLSEQS_TERTIARY_DA() CTLSEQS_CSI "=0c" +// Send Device Attributes +#define CTLSEQS_SECONDARY_DA() CTLSEQS_CSI ">c" +// Line Position Absolute +#define CTLSEQS_VPA(row) CTLSEQS_CSI row "d" +// Line Position Relative +#define CTLSEQS_VPR(rows) CTLSEQS_CSI rows "e" +// Horizontal and Vertical Position +#define CTLSEQS_HVP(row, col) CTLSEQS_CSI row ";" col "f" +// Tab Clear +#define CTLSEQS_TBC(i) CTLSEQS_CSI i "g" +// Set Mode +#define CTLSEQS_SM(i) CTLSEQS_CSI i "h" +// DEC Private Mode Set +#define CTLSEQS_DECSET(i) CTLSEQS_CSI "?" i "h" +// Media Copy +#define CTLSEQS_MC(i) CTLSEQS_CSI i "i" +// Media Copy, DEC-specific +#define CTLSEQS_MC_DEC(i) CTLSEQS_CSI "?" i "i" +// Reset Mode +#define CTLSEQS_RM(i) CTLSEQS_CSI i "l" +// DEC Private Mode Reset +#define CTLSEQS_DECRST(i) CTLSEQS_CSI "?" i "l" +// Character Attributes +#define CTLSEQS_SGR(i) CTLSEQS_CSI i "m" +// Set/reset key modifier options +#define CTLSEQS_XTMODKEYS(is) CTLSEQS_CSI ">" is "m" +// Device Status Report +#define CTLSEQS_DSR(i) CTLSEQS_CSI i "n" +// Disable key modifier options +#define CTLSEQS_XTMODKEYS_DISABLE(i) CTLSEQS_CSI ">" i "n" +// Device Status Report +#define CTLSEQS_DSR_DEC(i) CTLSEQS_CSI "?" i "n" +// Set resource value pointerMode +#define CTLSEQS_XTSMPOINTER(i) CTLSEQS_CSI ">" i "p" +// Soft terminal reset +#define CTLSEQS_DECSTR() CTLSEQS_CSI "!p" +// Set conformance level +#define CTLSEQS_DECSCL(i1, i2) CTLSEQS_CSI i1 ";" i2 "\"p" +// Request ANSI mode +#define CTLSEQS_DECRQM_ANSI(i) CTLSEQS_CSI i "$p" +// Request DEC private mode +#define CTLSEQS_DECRQM(i) CTLSEQS_CSI "?" i "$p" +// Report xterm name and version +#define CTLSEQS_XTVERSION() CTLSEQS_CSI ">0q" +// Load LEDs +#define CTLSEQS_DECLL(i) CTLSEQS_CSI i "q" +// Set cursor style +#define CTLSEQS_DECSCUSR(i) CTLSEQS_CSI i " q" +// Select character protection attribute +#define CTLSEQS_DECSCA(i) CTLSEQS_CSI i "\"q" +// Set Scrolling Region +#define CTLSEQS_DECSTBM(top, btm) CTLSEQS_CSI top ";" btm "r" +// Restore DEC Private Mode Values +#define CTLSEQS_XTRESTORE(is) CTLSEQS_CSI "?" is "r" +// Change Attributes in Rectangular Area +#define CTLSEQS_DECCARA(t, l, b, r, i) CTLSEQS_CSI t ";" l ";" b ";" r ";" i "$r" +// Save cursor +#define CTLSEQS_SCOSC() CTLSEQS_CSI "s" +// Set left and right margins +#define CTLSEQS_DECSLRM(l, r) CTLSEQS_CSI l ";" r "s" +// Save DEC Private Mode Values +#define CTLSEQS_XTSAVE(is) CTLSEQS_CSI "?" is "s" +// Window manipulation +#define CTLSEQS_XTWINOPS(is) CTLSEQS_CSI is "t" +// Set one or more features of the title modes +#define CTLSEQS_XTSMTITLE(is) CTLSEQS_CSI ">" is "t" +// Set warning-bell volume +#define CTLSEQS_DECSWBV(i) CTLSEQS_CSI i " t" +// Reverse Attributes in Rectangular Area +#define CTLSEQS_DECRARA(t, l, b, r, i) CTLSEQS_CSI t ";" l ";" b ";" r ";" i "$t" +// Restore cursor +#define CTLSEQS_SCORC() CTLSEQS_CSI "u" +// Set margin-bell volume +#define CTLSEQS_DECSMBV(i) CTLSEQS_CSI i " u" +// Copy Rectangular Area +#define CTLSEQS_DECCRA(t, l, b, r, sp, dt, dl, dp) CTLSEQS_CSI t ";" l ";" b ";" r ";" sp ";" dt ";" dl ";" dp "$v" +// Request presentation state report +#define CTLSEQS_DECRQPSR(i) CTLSEQS_CSI i "$w" +// Enable Filter Rectangle +#define CTLSEQS_DECEFR(t, l, b, r) CTLSEQS_CSI t ";" l ";" b ";" r "'w" +// Request Terminal Parameters +#define CTLSEQS_DECREQTPARM(i) CTLSEQS_CSI i "x" +// Select Attribute Change Extent +#define CTLSEQS_DECSACE(i) CTLSEQS_CSI i "*x" +// Fill Rectangular Area +#define CTLSEQS_DECFRA(c, t, l, b, r) CTLSEQS_CSI c ";" t ";" l ";" b ";" r "$x" +// Select checksum extension +#define CTLSEQS_XTCHECKSUM(i) CTLSEQS_CSI i "#y" +// Request Checksum of Rectangular Area +#define CTLSEQS_DECRQCRA(id, p, t, l, b, r) CTLSEQS_CSI id ";" p ";" t ";" l ";" b ";" r "*y" +// Enable Locator Reporting +#define CTLSEQS_DECELR(i1, i2) CTLSEQS_CSI i1 ";" i2 "'z" +// Erase Rectangular Area +#define CTLSEQS_DECERA(t, l, b, r) CTLSEQS_CSI t ";" l ";" b ";" r "$z" +// Select Locator Events +#define CTLSEQS_DECSLE(is) CTLSEQS_CSI is "'{" +// Push video attributes onto stack +#define CTLSEQS_XTPUSHSGR(is) CTLSEQS_CSI is "#{" +// Selective Erase Rectangular Area +#define CTLSEQS_DECSERA(t, l, b, r) CTLSEQS_CSI t ";" l ";" b ";" r "${" +// Report selected graphic rendition +#define CTLSEQS_XTREPORTSGR(t, l, b, r) CTLSEQS_CSI t ";" l ";" b ";" r "$|" +// Select columns per page +#define CTLSEQS_DECSCPP(i) CTLSEQS_CSI i "$|" +// Request Locator Position +#define CTLSEQS_DECRQLP() CTLSEQS_CSI "'|" +// Select $n number of lines per screen +#define CTLSEQS_DECSNLS(n) CTLSEQS_CSI n "*|" +// Pop video attributes from stack +#define CTLSEQS_XTPOPSGR() CTLSEQS_CSI "#}" +// Insert $n Column(s) +#define CTLSEQS_DECIC(n) CTLSEQS_CSI n "'}" +// Delete $n Column(s) +#define CTLSEQS_DECDC(n) CTLSEQS_CSI n "'~" + +/* Operating System Commands */ + +// Set Text Parameters +#define CTLSEQS_OSC_SEQ(i, s) CTLSEQS_OSC i ";" s CTLSEQS_ST + +/* Response messages */ + +// DECRQSS response message +#define CTLSEQS_RESP_DECRQSS(n, s) CTLSEQS_DCS n "$r" s CTLSEQS_ST +// XTGETXRES response message +#define CTLSEQS_RESP_XTGETXRES(n, s) CTLSEQS_DCS n "+R" s CTLSEQS_ST +// XTGETTCAP response message +#define CTLSEQS_RESP_XTGETTCAP(n, s) CTLSEQS_DCS n "+r" s CTLSEQS_ST +// Primary DA response message +#define CTLSEQS_RESP_PRIMARY_DA(ns) CTLSEQS_CSI ns "c" +// Secondary DA response message +#define CTLSEQS_RESP_SECONDARY_DA(n1, n2, n3) CTLSEQS_CSI ">" n1 ";" n2 ";" n3 "c" +// DECLRP response message +#define CTLSEQS_RESP_DECXCPR(n1, n2) CTLSEQS_CSI "?" n1 ";" n2 "R" +// DSR response message +#define CTLSEQS_RESP_DSR(ns) CTLSEQS_CSI "?" ns "n" +// DECRQM response message (ANSI mode) +#define CTLSEQS_RESP_DECRQM_ANSI(n1, n2) CTLSEQS_CSI n1 ";" n2 "$y" +// DECRQM response message (DEC private mode) +#define CTLSEQS_RESP_DECRQM(n1, n2) CTLSEQS_CSI "?" n1 ";" n2 "$y" +// XTVERSION response message +#define CTLSEQS_RESP_XTVERSION(s) CTLSEQS_DCS ">|" s CTLSEQS_ST +// DECCIR response message +#define CTLSEQS_RESP_DECCIR(s) CTLSEQS_DCS "1$u" s CTLSEQS_ST +// DECTABSR response message +#define CTLSEQS_RESP_DECTABSR(s) CTLSEQS_DCS "2$u" s CTLSEQS_ST +// DECRQCRA response message +#define CTLSEQS_RESP_DECRQCRA(n, s) CTLSEQS_DCS n "!~" s CTLSEQS_ST +// DECRQLP response message +#define CTLSEQS_RESP_DECRQLP(e, b, row, col, p) CTLSEQS_CSI e ";" b ";" row ";" col ";" p "&w" + +/// PC-Style Function Keys + +#define CTLSEQS_KEY_UP() CTLSEQS_CSI "A" // Up arrow key +#define CTLSEQS_KEY_DOWN() CTLSEQS_CSI "B" // Down arrow key +#define CTLSEQS_KEY_RIGHT() CTLSEQS_CSI "C" // Right arrow key +#define CTLSEQS_KEY_LEFT() CTLSEQS_CSI "D" // Left arrow key +#define CTLSEQS_KEY_HOME() CTLSEQS_CSI "H" // Home key +#define CTLSEQS_KEY_END() CTLSEQS_CSI "F" // End key +#define CTLSEQS_KEY_INSERT() CTLSEQS_CSI "2~" // Insert key +#define CTLSEQS_KEY_DELETE() CTLSEQS_CSI "3~" // Delete key +#define CTLSEQS_KEY_PGUP() CTLSEQS_CSI "5~" // Page Up key +#define CTLSEQS_KEY_PGDN() CTLSEQS_CSI "6~" // Page Down key +#define CTLSEQS_KEY_F1() CTLSEQS_SS3 "P" // F1 key +#define CTLSEQS_KEY_F2() CTLSEQS_SS3 "Q" // F2 key +#define CTLSEQS_KEY_F3() CTLSEQS_SS3 "R" // F3 key +#define CTLSEQS_KEY_F4() CTLSEQS_SS3 "S" // F4 key +#define CTLSEQS_KEY_F5() CTLSEQS_CSI "15~" // F5 key +#define CTLSEQS_KEY_F6() CTLSEQS_CSI "17~" // F6 key +#define CTLSEQS_KEY_F7() CTLSEQS_CSI "18~" // F7 key +#define CTLSEQS_KEY_F8() CTLSEQS_CSI "19~" // F8 key +#define CTLSEQS_KEY_F9() CTLSEQS_CSI "20~" // F9 key +#define CTLSEQS_KEY_F10() CTLSEQS_CSI "21~" // F10 key +#define CTLSEQS_KEY_F11() CTLSEQS_CSI "23~" // F11 key +#define CTLSEQS_KEY_F12() CTLSEQS_CSI "24~" // F12 key + +#ifdef __cplusplus +# include +#else +# include +#endif // __cplusplus + +#include + +/* Placeholders */ + +#define CTLSEQS_PH_NUM "\x0e" // CSI Parameter Bytes, numbers only +#define CTLSEQS_PH_NUMS "\x0f" // CSI Parameter Bytes, multiple numbers separated by semicolon +#define CTLSEQS_PH_STR "\x10" // String, printable characters only +#define CTLSEQS_PH_CMDSTR "\x11" // Command String +#define CTLSEQS_PH_CSI_PARAM "\x12" // CSI Parameter Bytes +#define CTLSEQS_PH_CSI_INTMD "\x13" // CSI Intermediate Bytes +#define CTLSEQS_PH_HEXNUM "\x14" // Printable characters representing a hexadecimal number +#define CTLSEQS_PH_CHRSTR "\x15" // Character String + +/* Reader option flags */ + +#define CTLSEQS_READER_NO_POLL (1 << 0) // Do not poll() before read() +#define CTLSEQS_READER_RETAIN_PARTIAL (1 << 1) // Retain data after a partial match + +/* Function return status codes */ + +#define CTLSEQS_OK 0 +#define CTLSEQS_NOMEM -1 +#define CTLSEQS_ERROR -2 +#define CTLSEQS_EOF -3 +#define CTLSEQS_TIMEOUT -4 +#define CTLSEQS_NOMATCH -5 // Not matching given patterns +#define CTLSEQS_PARTIAL -6 // Parially a control sequence +#define CTLSEQS_NOSEQ -7 // Not a control sequence +#define CTLSEQS_INTR -8 // Interrupted by signal + +struct ctlseqs_matcher; + +struct ctlseqs_reader; + +struct ctlseqs_matcher_opts { + char const *const *patterns; + size_t npatterns; +}; + +struct ctlseqs_reader_opts { + union ctlseqs_value *buffer; + size_t maxlen; + int fd; + unsigned flags; +}; + +union ctlseqs_value { + char const *str; + unsigned long num; +}; + +#ifdef __cplusplus +extern "C" { + +using std::size_t; +#endif // __cplusplus + +struct ctlseqs_matcher * +ctlseqs_matcher_init(); + +int +ctlseqs_matcher_setopt(struct ctlseqs_matcher *matcher, struct ctlseqs_matcher_opts const *options); + +void +ctlseqs_matcher_free(struct ctlseqs_matcher *matcher); + +struct ctlseqs_reader * +ctlseqs_reader_init(); + +int +ctlseqs_reader_setopt(struct ctlseqs_reader *reader, struct ctlseqs_reader_opts const *options); + +ssize_t +ctlseqs_read(struct ctlseqs_reader *reader, struct ctlseqs_matcher const *matcher, int timeout); + +void +ctlseqs_reader_free(struct ctlseqs_reader *reader); + +#ifdef __cplusplus +} +#endif // __cplusplus + +#endif // !CTLSEQS_H_ diff --git a/src/ctlseqs.hh b/src/ctlseqs.hh new file mode 100644 index 0000000..80b15d4 --- /dev/null +++ b/src/ctlseqs.hh @@ -0,0 +1,172 @@ +/** + * ctlseqs.hh - C++ wrapper for the ctlseqs library + * + * Copyright (C) 2020 CismonX + * + * This file is part of the ctlseqs library. + * + * This library 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 library 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 library. If not, see . + */ + +#ifndef CTLSEQS_HH_ +#define CTLSEQS_HH_ + +#include "ctlseqs.h" + +#include +#include +#include +#include + +namespace ctlseqs { + + // Control sequence matcher + class matcher final { + + ctlseqs_matcher *const matcher_; + + friend class reader; + + public: + + matcher(matcher const &matcher) = delete; + + matcher() : matcher_(ctlseqs_matcher_init()) { + if (matcher_ == nullptr) { + throw std::bad_alloc(); + } + } + + void patterns(std::vector const &patterns) { + ctlseqs_matcher_opts opts { patterns.data(), patterns.size() }; + switch (ctlseqs_matcher_setopt(matcher_, &opts)) { + case CTLSEQS_NOMEM: + throw std::bad_alloc(); + } + } + + ~matcher() { + ctlseqs_matcher_free(matcher_); + } + }; + + // Buffer for parsed sequence + template + class buffer final { + + ctlseqs_value buffer_[N]; + + public: + + // Get string value + char const *str(std::size_t idx) const { + return buffer_[idx].str; + } + + // Get integer value by index + unsigned long num(std::size_t idx) const { + return buffer_[idx].num; + } + }; + + // Control sequence reader + class reader final { + + ctlseqs_reader *const reader_; + + ctlseqs_value *buffer_; + size_t maxlen_; + int fd_; + bool no_poll_; + bool retain_partial_; + bool options_modified_; + + ssize_t setopt_and_read(matcher const &matcher, int timeout) { + if (options_modified_) { + unsigned flags = retain_partial_ * CTLSEQS_READER_RETAIN_PARTIAL | no_poll_ * CTLSEQS_READER_NO_POLL; + ctlseqs_reader_opts opts { buffer_, maxlen_, fd_, flags }; + switch (ctlseqs_reader_setopt(reader_, &opts)) { + case CTLSEQS_NOMEM: + throw std::bad_alloc(); + } + options_modified_ = false; + } + ssize_t retval = ctlseqs_read(reader_, matcher.matcher_, timeout); + switch (retval) { + case CTLSEQS_ERROR: + throw std::runtime_error("read failed"); + } + return retval; + } + + public: + + reader(reader const &reader) = delete; + + reader() : reader_(ctlseqs_reader_init()) { + if (reader_ == nullptr) { + throw std::bad_alloc(); + } + } + + // Set buffer for parsed message + template + void buffer(buffer const &buffer) { + buffer_ = reinterpret_cast(&buffer); + options_modified_ = true; + } + + // Set file descriptor to read from + void fd(int fd) { + fd_ = fd; + options_modified_ = true; + } + + // Set maximum read size + void maxlen(std::size_t maxlen) { + maxlen_ = maxlen; + options_modified_ = true; + } + + // Do not poll() before read() + void no_poll(bool enabled = true) { + no_poll_ = enabled; + options_modified_ = true; + } + + // Retain data after a partial match + void retain_partial(bool enabled = true) { + retain_partial_ = enabled; + options_modified_ = true; + } + + // Read without timemout + ssize_t read(matcher const &matcher) { + return setopt_and_read(matcher, -1); + } + + // Read with timeout + template + ssize_t read(matcher const &matcher, std::chrono::duration timeout) { + int timeout_millis = std::chrono::duration_cast(timeout).count(); + return setopt_and_read(matcher.matcher_, timeout_millis); + } + + ~reader() { + ctlseqs_reader_free(reader_); + } + }; +} + +#endif // !CTLSEQS_HH_ diff --git a/tests/Makefile.am b/tests/Makefile.am new file mode 100644 index 0000000..4b4acc8 --- /dev/null +++ b/tests/Makefile.am @@ -0,0 +1,12 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +AM_CPPFLAGS = -I$(top_srcdir)/src +noinst_PROGRAMS = tcsgrep +tcsgrep_SOURCES = tcsgrep.c +tcsgrep_LDADD = $(top_srcdir)/src/libctlseqs.la diff --git a/tests/tcsgrep.c b/tests/tcsgrep.c new file mode 100644 index 0000000..ee9099a --- /dev/null +++ b/tests/tcsgrep.c @@ -0,0 +1,103 @@ +/** + * tcsgrep.c - match input against terminal control sequence patterns + * + * Copyright (C) 2020 CismonX + * + * 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 . + */ + +#include "ctlseqs.h" + +#define TCSGREP_NINTH_ARG_(a1, a2, a3, a4, a5, a6, a7, a8, a9, ...) a9 +#define TCSGREP_COUNT_ARGS_(...) TCSGREP_NINTH_ARG_(__VA_ARGS__, 8, 7, 6, 5, 4, 3, 2, 1, 0) + +#define TCSGREP_CONCAT_1_(a1) a1 +#define TCSGREP_CONCAT_2_(a1, a2) a1 a2 +#define TCSGREP_CONCAT_3_(a1, a2, a3) a1 a2 a3 +#define TCSGREP_CONCAT_4_(a1, a2, a3, a4) a1 a2 a3 a4 +#define TCSGREP_CONCAT_5_(a1, a2, a3, a4, a5) a1 a2 a3 a4 a5 +#define TCSGREP_CONCAT_6_(a1, a2, a3, a4, a5, a6) a1 a2 a3 a4 a5 a6 +#define TCSGREP_CONCAT_7_(a1, a2, a3, a4, a5, a6, a7) a1 a2 a3 a4 a5 a6 a7 +#define TCSGREP_CONCAT_8_(a1, a2, a3, a4, a5, a6, a7, a8) a1 a2 a3 a4 a5 a6 a7 a8 + +#define TCSGREP_CONCAT_(nargs) TCSGREP_CONCAT_##nargs##_ +#define TCSGREP_DEFARGS_(nargs, ...) TCSGREP_CONCAT_(nargs)(__VA_ARGS__) + +#define TCSGREP_DEFSEQ_NOARGS(name) { #name, CTLSEQS_##name(), "" } +#define TCSGREP_DEFSEQ(name, ...) \ + { #name, CTLSEQS_##name(__VA_ARGS__), TCSGREP_DEFARGS_(TCSGREP_COUNT_ARGS_(__VA_ARGS__), __VA_ARGS__) } + +struct tcsgrep_sequence { + char const *name; + char const *pattern; + char const args[8]; +}; + +int +main(int argc, char **argv) +{ + static struct tcsgrep_sequence seqs[] = { + TCSGREP_DEFSEQ_NOARGS(S7C1T), + TCSGREP_DEFSEQ_NOARGS(S8C1T), + TCSGREP_DEFSEQ_NOARGS(DECDHL_TOP), + TCSGREP_DEFSEQ_NOARGS(DECDHL_BOTOM), + TCSGREP_DEFSEQ_NOARGS(DECSWL), + TCSGREP_DEFSEQ_NOARGS(DECDWL), + TCSGREP_DEFSEQ_NOARGS(DECALN), + TCSGREP_DEFSEQ_NOARGS(DECBI), + TCSGREP_DEFSEQ_NOARGS(DECSC), + TCSGREP_DEFSEQ_NOARGS(DECRC), + TCSGREP_DEFSEQ_NOARGS(DECFI), + TCSGREP_DEFSEQ_NOARGS(DECKPAM), + TCSGREP_DEFSEQ_NOARGS(DECKPNM), + TCSGREP_DEFSEQ_NOARGS(RIS), + TCSGREP_DEFSEQ(DECUDK, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM, CTLSEQS_PH_NUMS), + TCSGREP_DEFSEQ(DECRQSS, CTLSEQS_PH_STR), + TCSGREP_DEFSEQ(DECRSPS, CTLSEQS_PH_NUM, CTLSEQS_PH_STR), + TCSGREP_DEFSEQ(XTGETXRES, CTLSEQS_PH_STR), + TCSGREP_DEFSEQ(XTSETTCAP, CTLSEQS_PH_STR), + TCSGREP_DEFSEQ(XTGETTCAP, CTLSEQS_PH_STR), + TCSGREP_DEFSEQ(ICH, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(SL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CUU, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CUD, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CUF, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CUB, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CNL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CPL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CHA, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CUP, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CHT, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(ED, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(DECSED, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(EL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(DECSEL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(IL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(DL, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(DCH, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(SU, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(XTSMGRAPHICS, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM, CTLSEQS_PH_NUMS), + TCSGREP_DEFSEQ(SD, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(XTHIMOUSE, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(XTRMTITLE, CTLSEQS_PH_STR), + TCSGREP_DEFSEQ(ECH, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(CBT, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(HPA, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(HPR, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ(REP, CTLSEQS_PH_NUM), + TCSGREP_DEFSEQ_NOARGS(PRIMARY_DA), + TCSGREP_DEFSEQ_NOARGS(TERTIARY_DA), + TCSGREP_DEFSEQ_NOARGS(SECONDARY_DA), + }; +}