diff --git a/programs/other/tte/LICENSE b/programs/other/tte/LICENSE new file mode 100644 index 0000000000..9cecc1d466 --- /dev/null +++ b/programs/other/tte/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a 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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/programs/other/tte/Makefile b/programs/other/tte/Makefile new file mode 100644 index 0000000000..a9d5122e2f --- /dev/null +++ b/programs/other/tte/Makefile @@ -0,0 +1,6 @@ +tte: tte.c + $(CC) tte.c -o tte -Wall -Wextra -pedantic -std=c99 + +install: tte + sudo cp tte /usr/local/bin/ + sudo chmod +x /usr/local/bin/ diff --git a/programs/other/tte/README.md b/programs/other/tte/README.md new file mode 100644 index 0000000000..7f9677766e --- /dev/null +++ b/programs/other/tte/README.md @@ -0,0 +1,60 @@ +# tte + +tte (tiny text editor) is a terminal based text editor written in C from scratch, trying to be very minimalistic and dependency independent (it's not even using **curses**). + +This project was mainly created for educational purposes, so is very commented! + +Thanks to [antirez](http://antirez.com) for inspiring me with his project `kilo` and [Jeremy Ruten](https://twitter.com/yjerem) for his tutorials. + +## Installation + +### Compiling +``` +git clone https://github.com/GrenderG/tte.git +cd tte/ +make install +``` +### Downloading executable +Download it from [here](https://github.com/GrenderG/tte/releases/latest), then +``` +sudo mv tte /usr/local/bin/ +sudo chmod +x /usr/local/bin/tte +``` + +## Usage +``` +tte [file_name] +tte -h | --help +tte -v | --version +``` +If you are planning to use special characters like (á, é, í, ó, ú, ¡, ¿, ...) you must use `ISO 8859-1` encoding in your terminal. See [this issue](https://github.com/GrenderG/tte/issues/2) for more info. + +## Keybindings +The key combinations chosen here are the ones that fit the best for me. +``` +Ctrl-Q : Exit +Ctrl-F : Search text (ESC, arrows and enter to interact once searching) +Ctrl-S : Save +Ctrl-E : Flip line upwards +Ctrl-D : Flip line downwards +Ctrl-C : Copy line +Ctrl-X : Cut line +Ctrl-V : Paste line +Ctrl-P : Pause tte (type "fg" to resume) +``` + +## Current supported languages +* C (`*.c`, `*.h`) +* C++ (`*.cpp`, `*.hpp`, `*.cc`) +* Java (`*.java`) +* Bash (`*.sh`) +* Python (`*.py`) +* PHP (`*.php`) +* JavaScript (`*.js`, `*.jsx`) +* JSON (`*.json`, `*.jsonp`) +* XML (partially) (`*.xml`) +* SQL (`*.sql`) +* Ruby (`*.rb`) + +## Images +![First screenshot](https://raw.githubusercontent.com/GrenderG/tte/master/images/scr_1.png) diff --git a/programs/other/tte/images/scr_1.png b/programs/other/tte/images/scr_1.png new file mode 100644 index 0000000000..20640c0725 Binary files /dev/null and b/programs/other/tte/images/scr_1.png differ diff --git a/programs/other/tte/tte.c b/programs/other/tte/tte.c new file mode 100644 index 0000000000..1875960d42 --- /dev/null +++ b/programs/other/tte/tte.c @@ -0,0 +1,1713 @@ +/* +* Copyright (C) 2017 Daniel Morales +* +* 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 +* 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 section ***/ + +// We add them above our includes, because the header +// files we are including use the macros to decide what +// features to expose. These macros remove some compilation +// warnings. See +// https://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html +// for more info. +#define _DEFAULT_SOURCE +#define _BSD_SOURCE +#define _GNU_SOURCE + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/*** Define section ***/ + +// This mimics the Ctrl + whatever behavior, setting the +// 3 upper bits of the character pressed to 0. +#define CTRL_KEY(k) ((k) & 0x1f) +// Empty buffer +#define ABUF_INIT {NULL, 0} +// Version code +#define TTE_VERSION "0.0.5" +// Length of a tab stop +#define TTE_TAB_STOP 4 +// Times to press Ctrl-Q before exiting +#define TTE_QUIT_TIMES 2 +// Highlight flags +#define HL_HIGHLIGHT_NUMBERS (1 << 0) +#define HL_HIGHLIGHT_STRINGS (1 << 1) + +/*** Data section ***/ + +typedef struct editor_row { + int idx; // Row own index within the file. + int size; // Size of the content (excluding NULL term) + int render_size; // Size of the rendered content + char* chars; // Row content + char* render; // Row content "rendered" for screen (for TABs). + unsigned char* highlight; // This will tell you if a character is part of a string, comment, number... + int hl_open_comment; // True if the line is part of a ML comment. +} editor_row; + +struct editor_syntax { + // file_type field is the name of the filetype that will be displayed + // to the user in the status bar. + char* file_type; + // file_match is an array of strings, where each string contains a + // pattern to match a filename against. If the filename matches, + // then the file will be recognized as having that filetype. + char** file_match; + // This will be a NULL-terminated array of strings, each string containing + // a keyword. To differentiate between the two types of keywords, + // we’ll terminate the second type of keywords with a pipe (|) + // character (also known as a vertical bar). + char** keywords; + // We let each language specify its own single-line comment pattern. + char* singleline_comment_start; + // flags is a bit field that will contain flags for whether to + // highlight numbers and whether to highlight strings for that + // filetype. + char* multiline_comment_start; + char* multiline_comment_end; + int flags; +}; + +struct editor_config { + int cursor_x; + int cursor_y; + int render_x; + int row_offset; // Offset of row displayed. + int col_offset; // Offset of col displayed. + int screen_rows; // Number of rows that we can show + int screen_cols; // Number of cols that we can show + int num_rows; // Number of rows + editor_row* row; + int dirty; // To know if a file has been modified since opening. + char* file_name; + char status_msg[80]; + time_t status_msg_time; + char* copied_char_buffer; + struct editor_syntax* syntax; + struct termios orig_termios; +} ec; + +// Having a dynamic buffer will allow us to write only one +// time once the screen is refreshing, instead of doing +// a lot of write's. +struct a_buf { + char* buf; + int len; +}; + +enum editor_key { + BACKSPACE = 0x7f, // 127 + ARROW_LEFT = 0x3e8, // 1000, large value out of the range of a char. + ARROW_RIGHT, + ARROW_UP, + ARROW_DOWN, + PAGE_UP, + PAGE_DOWN, + HOME_KEY, + END_KEY, + DEL_KEY +}; + +enum editor_highlight { + HL_NORMAL = 0, + HL_SL_COMMENT, + HL_ML_COMMENT, + HL_KEYWORD_1, + HL_KEYWORD_2, + HL_STRING, + HL_NUMBER, + HL_MATCH +}; + +/*** Filetypes ***/ + +char* C_HL_extensions[] = {".c", ".h", ".cpp", ".hpp", ".cc", NULL}; // Array must be terminated with NULL. +char* JAVA_HL_extensions[] = {".java", NULL}; +char* PYTHON_HL_extensions[] = {".py", NULL}; +char* BASH_HL_extensions[] = {".sh", NULL}; +char* JS_HL_extensions[] = {".js", ".jsx", NULL}; +char* PHP_HL_extensions[] = {".php", NULL}; +char* JSON_HL_extensions[] = {".json", ".jsonp", NULL}; +char* XML_HL_extensions[] = {".xml", NULL}; +char* SQL_HL_extensions[] = {".sql", NULL}; +char* RUBY_HL_extensions[] = {".rb", NULL}; + +char* C_HL_keywords[] = { + "switch", "if", "while", "for", "break", "continue", "return", "else", + "struct", "union", "typedef", "static", "enum", "class", "case", "#include", + "volatile", "register", "sizeof", "typedef", "union", "goto", "const", "auto", + "#define", "#if", "#endif", "#error", "#ifdef", "#ifndef", "#undef", + + "int|", "long|", "double|", "float|", "char|", "unsigned|", "signed|", + "void|", "bool|", NULL +}; + +char* JAVA_HL_keywords[] = { + "switch", "if", "while", "for", "break", "continue", "return", "else", + "in", "public", "private", "protected", "static", "final", "abstract", + "enum", "class", "case", "try", "catch", "do", "extends", "implements", + "finally", "import", "instanceof", "interface", "new", "package", "super", + "native", "strictfp", + "synchronized", "this", "throw", "throws", "transient", "volatile", + + "byte|", "char|", "double|", "float|", "int|", "long|", "short|", + "boolean|", NULL +}; + +char* PYTHON_HL_keywords[] = { + "and", "as", "assert", "break", "class", "continue", "def", "del", "elif", + "else", "except", "exec", "finally", "for", "from", "global", "if", "import", + "in", "is", "lambda", "not", "or", "pass", "print", "raise", "return", "try", + "while", "with", "yield", + + "buffer|", "bytearray|", "complex|", "False|", "float|", "frozenset|", "int|", + "list|", "long|", "None|", "set|", "str|", "tuple|", "True|", "type|", + "unicode|", "xrange|", NULL +}; + +char* BASH_HL_keywords[] = { + "case", "do", "done", "elif", "else", "esac", "fi", "for", "function", "if", + "in", "select", "then", "time", "until", "while", "alias", "bg", "bind", "break", + "builtin", "cd", "command", "continue", "declare", "dirs", "disown", "echo", + "enable", "eval", "exec", "exit", "export", "fc", "fg", "getopts", "hash", "help", + "history", "jobs", "kill", "let", "local", "logout", "popd", "pushd", "pwd", "read", + "readonly", "return", "set", "shift", "suspend", "test", "times", "trap", "type", + "typeset", "ulimit", "umask", "unalias", "unset", "wait", "printf", NULL +}; + +char* JS_HL_keywords[] = { + "break", "case", "catch", "class", "const", "continue", "debugger", "default", + "delete", "do", "else", "enum", "export", "extends", "finally", "for", "function", + "if", "implements", "import", "in", "instanceof", "interface", "let", "new", + "package", "private", "protected", "public", "return", "static", "super", "switch", + "this", "throw", "try", "typeof", "var", "void", "while", "with", "yield", "true", + "false", "null", "NaN", "global", "window", "prototype", "constructor", "document", + "isNaN", "arguments", "undefined", + + "Infinity|", "Array|", "Object|", "Number|", "String|", "Boolean|", "Function|", + "ArrayBuffer|", "DataView|", "Float32Array|", "Float64Array|", "Int8Array|", + "Int16Array|", "Int32Array|", "Uint8Array|", "Uint8ClampedArray|", "Uint32Array|", + "Date|", "Error|", "Map|", "RegExp|", "Symbol|", "WeakMap|", "WeakSet|", "Set|", NULL +}; + +char* PHP_HL_keywords[] = { + "__halt_compiler", "break", "clone", "die", "empty", "endswitch", "final", "global", + "include_once", "list", "private", "return", "try", "xor", "abstract", "callable", + "const", "do", "enddeclare", "endwhile", "finally", "goto", "instanceof", "namespace", + "protected", "static", "unset", "yield", "and", "case", "continue", "echo", "endfor", + "eval", "for", "if", "insteadof", "new", "public", "switch", "use", "array", "catch", + "declare", "else", "endforeach", "exit", "foreach", "implements", "interface", "or", + "require", "throw", "var", "as", "class", "default", "elseif", "endif", "extends", + "function", "include", "isset", "print", "require_once", "trait", "while", NULL +}; + +char* JSON_HL_keywords[] = { + NULL +}; + +char* XML_HL_keywords[] = { + NULL +}; + +char* SQL_HL_keywords[] = { + "SELECT", "FROM", "DROP", "CREATE", "TABLE", "DEFAULT", "FOREIGN", "UPDATE", "LOCK", + "INSERT", "INTO", "VALUES", "LOCK", "UNLOCK", "WHERE", "DINSTINCT", "BETWEEN", "NOT", + "NULL", "TO", "ON", "ORDER", "GROUP", "IF", "BY", "HAVING", "USING", "UNION", "UNIQUE", + "AUTO_INCREMENT", "LIKE", "WITH", "INNER", "OUTER", "JOIN", "COLUMN", "DATABASE", "EXISTS", + "NATURAL", "LIMIT", "UNSIGNED", "MAX", "MIN", "PRECISION", "ALTER", "DELETE", "CASCADE", + "PRIMARY", "KEY", "CONSTRAINT", "ENGINE", "CHARSET", "REFERENCES", "WRITE", + + "BIT|", "TINYINT|", "BOOL|", "BOOLEAN|", "SMALLINT|", "MEDIUMINT|", "INT|", "INTEGER|", + "BIGINT|", "DOUBLE|", "DECIMAL|", "DEC|" "FLOAT|", "DATE|", "DATETIME|", "TIMESTAMP|", + "TIME|", "YEAR|", "CHAR|", "VARCHAR|", "TEXT|", "ENUM|", "SET|", "BLOB|", "VARBINARY|", + "TINYBLOB|", "TINYTEXT|", "MEDIUMBLOB|", "MEDIUMTEXT|", "LONGTEXT|", + + "select", "from", "drop", "create", "table", "default", "foreign", "update", "lock", + "insert", "into", "values", "lock", "unlock", "where", "dinstinct", "between", "not", + "null", "to", "on", "order", "group", "if", "by", "having", "using", "union", "unique", + "auto_increment", "like", "with", "inner", "outer", "join", "column", "database", "exists", + "natural", "limit", "unsigned", "max", "min", "precision", "alter", "delete", "cascade", + "primary", "key", "constraint", "engine", "charset", "references", "write", + + "bit|", "tinyint|", "bool|", "boolean|", "smallint|", "mediumint|", "int|", "integer|", + "bigint|", "double|", "decimal|", "dec|" "float|", "date|", "datetime|", "timestamp|", + "time|", "year|", "char|", "varchar|", "text|", "enum|", "set|", "blob|", "varbinary|", + "tinyblob|", "tinytext|", "mediumblob|", "mediumtext|", "longtext|", NULL +}; + +char* RUBY_HL_keywords[] = { + "__ENCODING__", "__LINE__", "__FILE__", "BEGIN", "END", "alias", "and", "begin", "break", + "case", "class", "def", "defined?", "do", "else", "elsif", "end", "ensure", "for", "if", + "in", "module", "next", "not", "or", "redo", "rescue", "retry", "return", "self", "super", + "then", "undef", "unless", "until", "when", "while", "yield", NULL +}; + +struct editor_syntax HL_DB[] = { + { + "c", + C_HL_extensions, + C_HL_keywords, + "//", + "/*", + "*/", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "java", + JAVA_HL_extensions, + JAVA_HL_keywords, + "//", + "/*", + "*/", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "python", + PYTHON_HL_extensions, + PYTHON_HL_keywords, + "#", + "'''", + "'''", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "bash", + BASH_HL_extensions, + BASH_HL_keywords, + "#", + NULL, + NULL, + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "js", + JS_HL_extensions, + JS_HL_keywords, + "//", + "/*", + "*/", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "php", + PHP_HL_extensions, + PHP_HL_keywords, + "//", + "/*", + "*/", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "json", + JSON_HL_extensions, + JSON_HL_keywords, + NULL, + NULL, + NULL, + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "xml", + XML_HL_extensions, + XML_HL_keywords, + NULL, + NULL, + NULL, + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "sql", + SQL_HL_extensions, + SQL_HL_keywords, + "--", + "/*", + "*/", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + }, + { + "ruby", + RUBY_HL_extensions, + RUBY_HL_keywords, + "#", + "=begin", + "=end", + HL_HIGHLIGHT_NUMBERS | HL_HIGHLIGHT_STRINGS + } +}; + +// Size of the "Hightlight Database" (HL_DB). +#define HL_DB_ENTRIES (sizeof(HL_DB) / sizeof(HL_DB[0])) + +/*** Declarations section ***/ + +void editorClearScreen(); + +void editorRefreshScreen(); + +void editorSetStatusMessage(const char* msg, ...); + +void consoleBufferOpen(); + +void abufFree(); + +void abufAppend(); + +char *editorPrompt(char* prompt, void (*callback)(char*, int)); + +void editorRowAppendString(editor_row* row, char* s, size_t len); + +void editorInsertNewline(); + +/*** Terminal section ***/ + +void die(const char* s) { + editorClearScreen(); + // perror looks for global errno variable and then prints + // a descriptive error mesage for it. + perror(s); + printf("\r\n"); + exit(1); +} + +void disableRawMode() { + if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &ec.orig_termios) == -1) + die("Failed to disable raw mode"); +} + +void enableRawMode() { + // Save original terminal state into orig_termios. + if (tcgetattr(STDIN_FILENO, &ec.orig_termios) == -1) + die("Failed to get current terminal state"); + // At exit, restore the original state. + atexit(disableRawMode); + + // Modify the original state to enter in raw mode. + struct termios raw = ec.orig_termios; + // This disables Ctrl-M, Ctrl-S and Ctrl-Q commands. + // (BRKINT, INPCK and ISTRIP are not estrictly mandatory, + // but it is recommended to turn them off in case any + // system needs it). + raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON); + // Turning off all output processing (\r\n). + raw.c_oflag &= ~(OPOST); + // Setting character size to 8 bits per byte (it should be + // like that on most systems, but whatever). + raw.c_cflag |= (CS8); + // Using NOT operator on ECHO | ICANON | IEXTEN | ISIG and + // then bitwise-AND them with flags field in order to + // force c_lflag 4th bit to become 0. This disables + // chars being printed (ECHO) and let us turn off + // canonical mode in order to read input byte-by-byte + // instead of line-by-line (ICANON), ISIG disables + // Ctrl-C command and IEXTEN the Ctrl-V one. + raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG); + // read() function now returns as soon as there is any + // input to be read. + raw.c_cc[VMIN] = 0; + // Forcing read() function to return every 1/10 of a + // second if there is nothing to read. + raw.c_cc[VTIME] = 1; + + consoleBufferOpen(); + + if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &raw) == -1) + die("Failed to set raw mode"); +} + +int editorReadKey() { + int nread; + char c; + while ((nread = read(STDIN_FILENO, &c, 1)) != 1) { + // Ignoring EAGAIN to make it work on Cygwin. + if (nread == -1 && errno != EAGAIN) + die("Error reading input"); + } + + // Check escape sequences, if first byte + // is an escape character then... + if (c == '\x1b') { + char seq[3]; + + if (read(STDIN_FILENO, &seq[0], 1) != 1 || + read(STDIN_FILENO, &seq[1], 1) != 1) + return '\x1b'; + + if (seq[0] == '[') { + if (seq[1] >= '0' && seq[1] <= '9') { + if (read(STDIN_FILENO, &seq[2], 1) != 1) + return '\x1b'; + if (seq[2] == '~') { + switch (seq[1]) { + // Home and End keys may be sent in many ways depending on the OS + // \x1b[1~, \x1b[7~, \x1b[4~, \x1b[8~ + case '1': + case '7': + return HOME_KEY; + case '4': + case '8': + return END_KEY; + // Del key is sent as \x1b[3~ + case '3': + return DEL_KEY; + // Page Up and Page Down send '\x1b', '[', '5' or '6' and '~'. + case '5': return PAGE_UP; + case '6': return PAGE_DOWN; + } + } + } else { + switch (seq[1]) { + // Arrow keys send multiple bytes starting with '\x1b', '['' + // and followed by an 'A', 'B', 'C' or 'D' depending on which + // arrow is pressed. + case 'A': return ARROW_UP; + case 'B': return ARROW_DOWN; + case 'C': return ARROW_RIGHT; + case 'D': return ARROW_LEFT; + // Home key can also be sent as \x1b[H + case 'H': return HOME_KEY; + // End key can also be sent as \x1b[F + case 'F': return END_KEY; + } + } + } else if (seq[0] == 'O') { + switch (seq[1]) { + // Yes, Home key can ALSO be sent as \x1bOH + case 'H': return HOME_KEY; + // And... End key as \x1bOF + case 'F': return END_KEY; + } + } + return '\x1b'; + } else { + return c; + } +} + +int getWindowSize(int* screen_rows, int* screen_cols) { + struct winsize ws; + + // Getting window size thanks to ioctl into the given + // winsize struct. + if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == -1 || ws.ws_col == 0) { + return -1; + } else { + *screen_cols = ws.ws_col; + *screen_rows = ws.ws_row; + return 0; + } +} + +void editorUpdateWindowSize() { + if (getWindowSize(&ec.screen_rows, &ec.screen_cols) == -1) + die("Failed to get window size"); + ec.screen_rows -= 2; // Room for the status bar. +} + +void editorHandleSigwinch() { + editorUpdateWindowSize(); + if (ec.cursor_y > ec.screen_rows) + ec.cursor_y = ec.screen_rows - 1; + if (ec.cursor_x > ec.screen_cols) + ec.cursor_x = ec.screen_cols - 1; + editorRefreshScreen(); +} + +void editorHandleSigcont() { + disableRawMode(); + consoleBufferOpen(); + enableRawMode(); + editorRefreshScreen(); +} + +void consoleBufferOpen() { + // Switch to another terminal buffer in order to be able to restore state at exit + // by calling consoleBufferClose(). + if (write(STDOUT_FILENO, "\x1b[?47h", 6) == -1) + die("Error changing terminal buffer"); +} + +void consoleBufferClose() { + // Restore console to the state tte opened. + if (write(STDOUT_FILENO, "\x1b[?9l", 5) == -1 || + write(STDOUT_FILENO, "\x1b[?47l", 6) == -1) + die("Error restoring buffer state"); + + /*struct a_buf ab = {.buf = NULL, .len = 0}; + char* buf = NULL; + if (asprintf(&buf, "\x1b[%d;%dH\r\n", ec.screen_rows + 1, 1) == -1) + die("Error restoring buffer state"); + abufAppend(&ab, buf, strlen(buf)); + free(buf); + + if (write(STDOUT_FILENO, ab.buf, ab.len) == -1) + die("Error restoring buffer state"); + abufFree(&ab);*/ + + editorClearScreen(); +} + +/*** Syntax highlighting ***/ + +int isSeparator(int c) { + // strchr() looks to see if any one of the characters in the first string + // appear in the second string. If so, it returns a pointer to the + // character in the second string that matched. Otherwise, it + // returns NULL. + return isspace(c) || c == '\0' || strchr(",.()+-/*=~%<>[]:;", c) != NULL; +} + +int isAlsoNumber(int c) { + return c == '.' || c == 'x' || c == 'a' || c == 'b' || c == 'c' || c == 'd' || c == 'e' || c == 'f'; +} + +void editorUpdateSyntax(editor_row* row) { + row -> highlight = realloc(row -> highlight, row -> render_size); + // void * memset ( void * ptr, int value, size_t num ); + // Sets the first num bytes of the block of memory pointed by ptr to + // the specified value. With this we set all characters to HL_NORMAL. + memset(row -> highlight, HL_NORMAL, row -> render_size); + + if (ec.syntax == NULL) + return; + + char** keywords = ec.syntax -> keywords; + + char* scs = ec.syntax -> singleline_comment_start; + char* mcs = ec.syntax -> multiline_comment_start; + char* mce = ec.syntax -> multiline_comment_end; + + int scs_len = scs ? strlen(scs) : 0; + int mcs_len = mcs ? strlen(mcs) : 0; + int mce_len = mce ? strlen(mce) : 0; + + int prev_sep = 1; // True (1) if the previous char is a separator, false otherwise. + int in_string = 0; // If != 0, inside a string. We also keep track if it's ' or " + int in_comment = (row -> idx > 0 && ec.row[row -> idx - 1].hl_open_comment); // This is ONLY used on ML comments. + + int i = 0; + while (i < row -> render_size) { + char c = row -> render[i]; + // Highlight type of the previous character. + unsigned char prev_highlight = (i > 0) ? row -> highlight[i - 1] : HL_NORMAL; + + if (scs_len && !in_string && !in_comment) { + // int strncmp ( const char * str1, const char * str2, size_t num ); + // Compares up to num characters of the C string str1 to those of the C string str2. + // This function starts comparing the first character of each string. If they are + // equal to each other, it continues with the following pairs until the characters + // differ, until a terminating null-character is reached, or until num characters + // match in both strings, whichever happens first. + if (!strncmp(&row -> render[i], scs, scs_len)) { + memset(&row -> highlight[i], HL_SL_COMMENT, row -> render_size - i); + break; + } + } + + if (mcs_len && mce_len && !in_string) { + if (in_comment) { + row -> highlight[i] = HL_ML_COMMENT; + if (!strncmp(&row -> render[i], mce, mce_len)) { + memset(&row -> highlight[i], HL_ML_COMMENT, mce_len); + i += mce_len; + in_comment = 0; + prev_sep = 1; + continue; + } else { + i++; + continue; + } + } else if (!strncmp(&row -> render[i], mcs, mcs_len)) { + memset(&row -> highlight[i], HL_ML_COMMENT, mcs_len); + i += mcs_len; + in_comment = 1; + continue; + } + + } + + if (ec.syntax -> flags & HL_HIGHLIGHT_STRINGS) { + if (in_string) { + row -> highlight[i] = HL_STRING; + // If we’re in a string and the current character is a backslash (\), + // and there’s at least one more character in that line that comes + // after the backslash, then we highlight the character that comes + // after the backslash with HL_STRING and consume it. We increment + // i by 2 to consume both characters at once. + if (c == '\\' && i + 1 < row -> render_size) { + row -> highlight[i + 1] = HL_STRING; + i += 2; + continue; + } + + if (c == in_string) + in_string = 0; + i++; + prev_sep = 1; + continue; + } else { + if (c == '"' || c == '\'') { + in_string = c; + row -> highlight[i] = HL_STRING; + i++; + continue; + } + } + } + + if (ec.syntax -> flags & HL_HIGHLIGHT_NUMBERS) { + if ((isdigit(c) && (prev_sep || prev_highlight == HL_NUMBER)) || + (isAlsoNumber(c) && prev_highlight == HL_NUMBER)) { + row -> highlight[i] = HL_NUMBER; + i++; + prev_sep = 0; + continue; + } + } + + if (prev_sep) { + int j; + for (j = 0; keywords[j]; j++) { + int kw_len = strlen(keywords[j]); + int kw_2 = keywords[j][kw_len - 1] == '|'; + if (kw_2) + kw_len--; + + // Keywords require a separator both before and after the keyword. + if (!strncmp(&row -> render[i], keywords[j], kw_len) && + isSeparator(row -> render[i + kw_len])) { + memset(&row -> highlight[i], kw_2 ? HL_KEYWORD_2 : HL_KEYWORD_1, kw_len); + i += kw_len; + break; + } + } + if (keywords[j] != NULL) { + prev_sep = 0; + continue; + } + } + + prev_sep = isSeparator(c); + i++; + } + + int changed = (row -> hl_open_comment != in_comment); + // This tells us whether the row ended as an unclosed multi-line + // comment or not. + row -> hl_open_comment = in_comment; + // A user could comment out an entire file just by changing one line. + // So it seems like we need to update the syntax of all the lines + // following the current line. However, we know the highlighting + // of the next line will not change if the value of this line’s + // // // hl_open_comment did not change. So we check if it changed, and + // // only call editorUpdateSyntax() on the next line if + // hl_open_comment changed (and if there is a next line in the file). + // Because editorUpdateSyntax() keeps calling itself with the next + // line, the change will continue to propagate to more and more lines + // until one of them is unchanged, at which point we know that all + // the lines after that one must be unchanged as well. + if (changed && row -> idx + 1 < ec.num_rows) + editorUpdateSyntax(&ec.row[row -> idx + 1]); +} + +int editorSyntaxToColor(int highlight) { + // We return ANSI codes for colors. + // See https://en.wikipedia.org/wiki/ANSI_escape_code#Colors + // for a list of them. + switch (highlight) { + case HL_SL_COMMENT: + case HL_ML_COMMENT: return 36; + case HL_KEYWORD_1: return 31; + case HL_KEYWORD_2: return 32; + case HL_STRING: return 33; + case HL_NUMBER: return 35; + case HL_MATCH: return 34; + default: return 37; + } +} + +void editorSelectSyntaxHighlight() { + ec.syntax = NULL; + if (ec.file_name == NULL) + return; + + for (unsigned int j = 0; j < HL_DB_ENTRIES; j++) { + struct editor_syntax* es = &HL_DB[j]; + unsigned int i = 0; + + while (es -> file_match[i]) { + char* p = strstr(ec.file_name, es -> file_match[i]); + if (p != NULL) { + // Returns a pointer to the first occurrence of str2 in str1, + // or a null pointer if str2 is not part of str1. + int pat_len = strlen(es -> file_match[i]); + if (es -> file_match[i][0] != '.' || p[pat_len] == '\0') { + ec.syntax = es; + + int file_row; + for (file_row = 0; file_row < ec.num_rows; file_row++) { + editorUpdateSyntax(&ec.row[file_row]); + } + + return; + } + } + i++; + } + } +} + +/*** Row operations ***/ + +int editorRowCursorXToRenderX(editor_row* row, int cursor_x) { + int render_x = 0; + int j; + // For each character, if its a tab we use rx % TTE_TAB_STOP + // to find out how many columns we are to the right of the last + // tab stop, and then subtract that from TTE_TAB_STOP - 1 to + // find out how many columns we are to the left of the next tab + // stop. We add that amount to rx to get just to the left of the + // next tab stop, and then the unconditional rx++ statement gets + // us right on the next tab stop. Notice how this works even if + // we are currently on a tab stop. + for (j = 0; j < cursor_x; j++) { + if (row -> chars[j] == '\t') + render_x += (TTE_TAB_STOP - 1) - (render_x % TTE_TAB_STOP); + render_x++; + } + return render_x; +} + +int editorRowRenderXToCursorX(editor_row* row, int render_x) { + int cur_render_x = 0; + int cursor_x; + for (cursor_x = 0; cursor_x < row -> size; cursor_x++) { + if (row -> chars[cursor_x] == '\t') + cur_render_x += (TTE_TAB_STOP - 1) - (cur_render_x % TTE_TAB_STOP); + cur_render_x++; + + if (cur_render_x > render_x) + return cursor_x; + } + return cursor_x; +} + +void editorUpdateRow(editor_row* row) { + // First, we have to loop through the chars of the row + // and count the tabs in order to know how much memory + // to allocate for render. The maximum number of characters + // needed for each tab is 8. row->size already counts 1 for + // each tab, so we multiply the number of tabs by 7 and add + // that to row->size to get the maximum amount of memory we'll + // need for the rendered row. + int tabs = 0; + int j; + for (j = 0; j < row -> size; j++) { + if (row -> chars[j] == '\t') + tabs++; + } + free(row -> render); + row -> render = malloc(row -> size + tabs * (TTE_TAB_STOP - 1) + 1); + + // After allocating the memory, we check whether the current character + // is a tab. If it is, we append one space (because each tab must + // advance the cursor forward at least one column), and then append + // spaces until we get to a tab stop, which is a column that is + // divisible by 8 + int idx = 0; + for (j = 0; j < row -> size; j++) { + if (row -> chars[j] == '\t') { + row -> render[idx++] = ' '; + while (idx % TTE_TAB_STOP != 0) + row -> render[idx++] = ' '; + } else + row -> render[idx++] = row -> chars[j]; + } + row -> render[idx] = '\0'; + row -> render_size = idx; + + editorUpdateSyntax(row); +} + +void editorInsertRow(int at, char* s, size_t line_len) { + if (at < 0 || at > ec.num_rows) + return; + + ec.row = realloc(ec.row, sizeof(editor_row) * (ec.num_rows + 1)); + memmove(&ec.row[at + 1], &ec.row[at], sizeof(editor_row) * (ec.num_rows - at)); + + for (int j = at + 1; j <= ec.num_rows; j++) { + ec.row[j].idx++; + } + + ec.row[at].idx = at; + + ec.row[at].size = line_len; + ec.row[at].chars = malloc(line_len + 1); // We want to add terminator char '\0' at the end + memcpy(ec.row[at].chars, s, line_len); + ec.row[at].chars[line_len] = '\0'; + + ec.row[at].render_size = 0; + ec.row[at].render = NULL; + ec.row[at].highlight = NULL; + ec.row[at].hl_open_comment = 0; + editorUpdateRow(&ec.row[at]); + + ec.num_rows++; + ec.dirty++; +} + +void editorFreeRow(editor_row* row) { + free(row -> render); + free(row -> chars); + free(row -> highlight); +} + +void editorDelRow(int at) { + if (at < 0 || at >= ec.num_rows) + return; + editorFreeRow(&ec.row[at]); + memmove(&ec.row[at], &ec.row[at + 1], sizeof(editor_row) * (ec.num_rows - at - 1)); + + for (int j = at; j < ec.num_rows - 1; j++) { + ec.row[j].idx--; + } + + ec.num_rows--; + ec.dirty++; +} + +// -1 down, 1 up +void editorFlipRow(int dir) { + editor_row c_row = ec.row[ec.cursor_y]; + ec.row[ec.cursor_y] = ec.row[ec.cursor_y - dir]; + ec.row[ec.cursor_y - dir] = c_row; + + ec.row[ec.cursor_y].idx += dir; + ec.row[ec.cursor_y - dir].idx -= dir; + + int first = (dir == 1) ? ec.cursor_y - 1 : ec.cursor_y; + editorUpdateSyntax(&ec.row[first]); + editorUpdateSyntax(&ec.row[first] + 1); + if (ec.num_rows - ec.cursor_y > 2) + editorUpdateSyntax(&ec.row[first] + 2); + + ec.cursor_y -= dir; + ec.dirty++; +} + +void editorCopy(int cut) { + ec.copied_char_buffer = realloc(ec.copied_char_buffer, strlen(ec.row[ec.cursor_y].chars) + 1); + strcpy(ec.copied_char_buffer, ec.row[ec.cursor_y].chars); + editorSetStatusMessage(cut ? "Content cut" : "Content copied"); +} + +void editorCut() { + editorCopy(-1); + editorDelRow(ec.cursor_y); + if (ec.num_rows - ec.cursor_y > 0) + editorUpdateSyntax(&ec.row[ec.cursor_y]); + if (ec.num_rows - ec.cursor_y > 1) + editorUpdateSyntax(&ec.row[ec.cursor_y + 1]); + ec.cursor_x = ec.cursor_y == ec.num_rows ? 0 : ec.row[ec.cursor_y].size; +} + +void editorPaste() { + if (ec.copied_char_buffer == NULL) + return; + + if (ec.cursor_y == ec.num_rows) + editorInsertRow(ec.cursor_y, ec.copied_char_buffer, strlen(ec.copied_char_buffer)); + else + editorRowAppendString(&ec.row[ec.cursor_y], ec.copied_char_buffer, strlen(ec.copied_char_buffer)); + ec.cursor_x += strlen(ec.copied_char_buffer); +} + +void editorRowInsertChar(editor_row* row, int at, int c) { + if (at < 0 || at > row -> size) + at = row -> size; + // We need to allocate 2 bytes because we also have to make room for + // the null byte. + row -> chars = realloc(row -> chars, row -> size + 2); + // memmove it's like memcpy(), but is safe to use when the source and + // destination arrays overlap + memmove(&row -> chars[at + 1], &row -> chars[at], row -> size - at + 1); + row -> size++; + row -> chars[at] = c; + editorUpdateRow(row); + ec.dirty++; // This way we can see "how dirty" a file is. +} + +void editorInsertNewline() { + // If we're at the beginning of a line, all we have to do is insert + // a new blank row before the line we're on. + if (ec.cursor_x == 0) { + editorInsertRow(ec.cursor_y, "", 0); + // Otherwise, we have to split the line we're on into two rows. + } else { + editor_row* row = &ec.row[ec.cursor_y]; + editorInsertRow(ec.cursor_y + 1, &row -> chars[ec.cursor_x], row -> size - ec.cursor_x); + row = &ec.row[ec.cursor_y]; + row -> size = ec.cursor_x; + row -> chars[row -> size] = '\0'; + editorUpdateRow(row); + } + ec.cursor_y++; + ec.cursor_x = 0; +} + +void editorRowAppendString(editor_row* row, char* s, size_t len) { + row -> chars = realloc(row -> chars, row -> size + len + 1); + memcpy(&row -> chars[row -> size], s, len); + row -> size += len; + row -> chars[row -> size] = '\0'; + editorUpdateRow(row); + ec.dirty++; +} + +void editorRowDelChar(editor_row* row, int at) { + if (at < 0 || at >= row -> size) + return; + // Overwriting the deleted character with the characters that come + // after it. + memmove(&row -> chars[at], &row -> chars[at + 1], row -> size - at); + row -> size--; + editorUpdateRow(row); + ec.dirty++; +} + +/*** Editor operations ***/ + +void editorInsertChar(int c) { + // If this is true, the cursor is on the tilde line after the end of + // the file, so we need to append a new row to the file before inserting + // a character there. + if (ec.cursor_y == ec.num_rows) + editorInsertRow(ec.num_rows, "", 0); + editorRowInsertChar(&ec.row[ec.cursor_y], ec.cursor_x, c); + ec.cursor_x++; // This way we can see "how dirty" a file is. +} + +void editorDelChar() { + // If the cursor is past the end of the file, there's nothing to delete. + if (ec.cursor_y == ec.num_rows) + return; + // Cursor is at the beginning of a file, there's nothing to delete. + if (ec.cursor_x == 0 && ec.cursor_y == 0) + return; + + editor_row* row = &ec.row[ec.cursor_y]; + if (ec.cursor_x > 0) { + editorRowDelChar(row, ec.cursor_x - 1); + ec.cursor_x--; + // Deleting a line and moving up all the content. + } else { + ec.cursor_x = ec.row[ec.cursor_y - 1].size; + editorRowAppendString(&ec.row[ec.cursor_y -1], row -> chars, row -> size); + editorDelRow(ec.cursor_y); + ec.cursor_y--; + } +} + +/*** File I/O ***/ + +char* editorRowsToString(int* buf_len) { + int total_len = 0; + int j; + // Adding up the lengths of each row of text, adding 1 + // to each one for the newline character we'll add to + // the end of each line. + for (j = 0; j < ec.num_rows; j++) { + total_len += ec.row[j].size + 1; + } + *buf_len = total_len; + + char* buf = malloc(total_len); + char* p = buf; + // Copying the contents of each row to the end of the + // buffer, appending a newline character after each + // row. + for (j = 0; j < ec.num_rows; j++) { + memcpy(p, ec.row[j].chars, ec.row[j].size); + p += ec.row[j].size; + *p = '\n'; + p++; + } + + return buf; +} + +void editorOpen(char* file_name) { + free(ec.file_name); + ec.file_name = strdup(file_name); + + editorSelectSyntaxHighlight(); + + FILE* file = fopen(file_name, "r+"); + if (!file) + die("Failed to open the file"); + + char* line = NULL; + // Unsigned int of at least 16 bit. + size_t line_cap = 0; + // Bigger than int + ssize_t line_len; + while ((line_len = getline(&line, &line_cap, file)) != -1) { + // We already know each row represents one line of text, there's no need + // to keep carriage return and newline characters. + if (line_len > 0 && (line[line_len - 1] == '\n' || line[line_len - 1] == '\r')) + line_len--; + editorInsertRow(ec.num_rows, line, line_len); + } + free(line); + fclose(file); + ec.dirty = 0; +} + +void editorSave() { + if (ec.file_name == NULL) { + ec.file_name = editorPrompt("Save as: %s (ESC to cancel)", NULL); + if (ec.file_name == NULL) { + editorSetStatusMessage("Save aborted"); + return; + } + editorSelectSyntaxHighlight(); + } + + int len; + char* buf = editorRowsToString(&len); + + // We want to create if it doesn't already exist (O_CREAT flag), giving + // 0644 permissions (the standard ones). O_RDWR stands for reading and + // writing. + int fd = open(ec.file_name, O_RDWR | O_CREAT, 0644); + if (fd != -1) { + // ftruncate sets the file's size to the specified length. + if (ftruncate(fd, len) != -1) { + // Writing the file. + if (write(fd, buf, len) == len) { + close(fd); + free(buf); + ec.dirty = 0; + editorSetStatusMessage("%d bytes written to disk", len); + return; + } + } + close(fd); + } + + free(buf); + editorSetStatusMessage("Cant's save file. Error occurred: %s", strerror(errno)); +} + +/*** Search section ***/ + +void editorSearchCallback(char* query, int key) { + // Index of the row that the last match was on, -1 if there was + // no last match. + static int last_match = -1; + // 1 for searching forward and -1 for searching backwards. + static int direction = 1; + + static int saved_highlight_line; + static char* saved_hightlight = NULL; + + if (saved_hightlight) { + memcpy(ec.row[saved_highlight_line].highlight, saved_hightlight, ec.row[saved_highlight_line].render_size); + free(saved_hightlight); + saved_hightlight = NULL; + } + + // Checking if the user pressed Enter or Escape, in which case + // they are leaving search mode so we return immediately. + if (key == '\r' || key == '\x1b') { + last_match = -1; + direction = 1; + return; + } else if (key == ARROW_RIGHT || key == ARROW_DOWN) { + direction = 1; + } else if (key == ARROW_LEFT || key == ARROW_UP) { + if (last_match == -1) { + // If nothing matched and the left or up arrow key was pressed + return; + } + direction = -1; + } else { + last_match = -1; + direction = 1; + } + + int current = last_match; + int i; + for (i = 0; i < ec.num_rows; i++) { + current += direction; + if (current == -1) + current = ec.num_rows - 1; + else if (current == ec.num_rows) + current = 0; + + editor_row* row = &ec.row[current]; + // We use strstr to check if query is a substring of the + // current row. It returns NULL if there is no match, + // oterwhise it returns a pointer to the matching substring. + char* match = strstr(row -> render, query); + if (match) { + last_match = current; + ec.cursor_y = current; + ec.cursor_x = editorRowRenderXToCursorX(row, match - row -> render); + // We set this like so to scroll to the bottom of the file so + // that the next screen refresh will cause the matching line to + // be at the very top of the screen. + ec.row_offset = ec.num_rows; + + saved_highlight_line = current; + saved_hightlight = malloc(row -> render_size); + memcpy(saved_hightlight, row -> highlight, row -> render_size); + memset(&row -> highlight[match - row -> render], HL_MATCH, strlen(query)); + break; + } + } +} + +void editorSearch() { + int saved_cursor_x = ec.cursor_x; + int saved_cursor_y = ec.cursor_y; + int saved_col_offset = ec.col_offset; + int saved_row_offset = ec.row_offset; + + char* query = editorPrompt("Search: %s (Use ESC / Enter / Arrows)", editorSearchCallback); + + if (query) { + free(query); + // If query is NULL, that means they pressed Escape, so in that case we + // restore the cursor previous position. + } else { + ec.cursor_x = saved_cursor_x; + ec.cursor_y = saved_cursor_y; + ec.col_offset = saved_col_offset; + ec.row_offset = saved_row_offset; + } +} + +/*** Append buffer section **/ + +void abufAppend(struct a_buf* ab, const char* s, int len) { + // Using realloc to get a block of free memory that is + // the size of the current string + the size of the string + // to be appended. + char* new = realloc(ab -> buf, ab -> len + len); + + if (new == NULL) + return; + + // Copying the string s at the end of the current data in + // the buffer. + memcpy(&new[ab -> len], s, len); + ab -> buf = new; + ab -> len += len; +} + +void abufFree(struct a_buf* ab) { + // Deallocating buffer. + free(ab -> buf); +} + +/*** Output section ***/ + +void editorScroll() { + ec.render_x = 0; + if (ec.cursor_y < ec.num_rows) + ec.render_x = editorRowCursorXToRenderX(&ec.row[ec.cursor_y], ec.cursor_x); + // The first if statement checks if the cursor is above the visible window, + // and if so, scrolls up to where the cursor is. The second if statement checks + // if the cursor is past the bottom of the visible window, and contains slightly + // more complicated arithmetic because ec.row_offset refers to what's at the top + // of the screen, and we have to get ec.screen_rows involved to talk about what's + // at the bottom of the screen. + if (ec.cursor_y < ec.row_offset) + ec.row_offset = ec.cursor_y; + if (ec.cursor_y >= ec.row_offset + ec.screen_rows) + ec.row_offset = ec.cursor_y - ec.screen_rows + 1; + + if (ec.render_x < ec.col_offset) + ec.col_offset = ec.render_x; + if (ec.render_x >= ec.col_offset + ec.screen_cols) + ec.col_offset = ec.render_x - ec.screen_cols + 1; +} + +void editorDrawStatusBar(struct a_buf* ab) { + // This switches to inverted colors. + // NOTE: + // The m command (Select Graphic Rendition) causes the text printed + // after it to be printed with various possible attributes including + // bold (1), underscore (4), blink (5), and inverted colors (7). An + // argument of 0 clears all attributes (the default one). See + // http://vt100.net/docs/vt100-ug/chapter3.html#SGR for more info. + abufAppend(ab, "\x1b[7m", 4); + + char status[80], r_status[80]; + // Showing up to 20 characters of the filename, followed by the number of lines. + int len = snprintf(status, sizeof(status), " Editing: %.20s %s", ec.file_name ? ec.file_name : "New file", ec.dirty ? "(modified)" : ""); + int col_size = ec.row && ec.cursor_y <= ec.num_rows - 1 ? col_size = ec.row[ec.cursor_y].size : 0; + int r_len = snprintf(r_status, sizeof(r_status), "%d/%d lines %d/%d cols ", ec.cursor_y + 1 > ec.num_rows ? ec.num_rows : ec.cursor_y + 1, ec.num_rows, + ec.cursor_x + 1 > col_size ? col_size : ec.cursor_x + 1, col_size); + if (len > ec.screen_cols) + len = ec.screen_cols; + abufAppend(ab, status, len); + while (len < ec.screen_cols) { + if (ec.screen_cols - len == r_len) { + abufAppend(ab, r_status, r_len); + break; + } else { + abufAppend(ab, " ", 1); + len++; + } + } + // This switches back to normal colors. + abufAppend(ab, "\x1b[m", 3); + + abufAppend(ab, "\r\n", 2); +} + +void editorDrawMessageBar(struct a_buf *ab) { + // Clearing the message bar. + abufAppend(ab, "\x1b[K", 3); + int msg_len = strlen(ec.status_msg); + if (msg_len > ec.screen_cols) + msg_len = ec.screen_cols; + // We only show the message if its less than 5 secons old, but + // remember the screen is only being refreshed after each keypress. + if (msg_len && time(NULL) - ec.status_msg_time < 5) + abufAppend(ab, ec.status_msg, msg_len); +} + +void editorDrawWelcomeMessage(struct a_buf* ab) { + char welcome[80]; + // Using snprintf to truncate message in case the terminal + // is too tiny to handle the entire string. + int welcome_len = snprintf(welcome, sizeof(welcome), + "tte %s ", TTE_VERSION); + if (welcome_len > ec.screen_cols) + welcome_len = ec.screen_cols; + // Centering the message. + int padding = (ec.screen_cols - welcome_len) / 2; + // Remember that everything != 0 is true. + if (padding) { + abufAppend(ab, "~", 1); + padding--; + } + while (padding--) + abufAppend(ab, " ", 1); + abufAppend(ab, welcome, welcome_len); +} + +// The ... argument makes editorSetStatusMessage() a variadic function, +// meaning it can take any number of arguments. C's way of dealing with +// these arguments is by having you call va_start() and va_end() on a +// // value of type va_list. The last argument before the ... (in this +// case, msg) must be passed to va_start(), so that the address of +// the next arguments is known. Then, between the va_start() and +// va_end() calls, you would call va_arg() and pass it the type of +// the next argument (which you usually get from the given format +// string) and it would return the value of that argument. In +// this case, we pass msg and args to vsnprintf() and it takes care +// of reading the format string and calling va_arg() to get each +// argument. +void editorSetStatusMessage(const char* msg, ...) { + va_list args; + va_start(args, msg); + vsnprintf(ec.status_msg, sizeof(ec.status_msg), msg, args); + va_end(args); + ec.status_msg_time = time(NULL); +} + +void editorDrawRows(struct a_buf* ab) { + int y; + for (y = 0; y < ec.screen_rows; y++) { + int file_row = y + ec.row_offset; + if(file_row >= ec.num_rows) { + if (ec.num_rows == 0 && y == ec.screen_rows / 3) + editorDrawWelcomeMessage(ab); + else + abufAppend(ab, "~", 1); + } else { + int len = ec.row[file_row].render_size - ec.col_offset; + // len can be a negative number, meaning the user scrolled + // horizontally past the end of the line. In that case, we set + // len to 0 so that nothing is displayed on that line. + if (len < 0) + len = 0; + if (len > ec.screen_cols) + len = ec.screen_cols; + + char* c = &ec.row[file_row].render[ec.col_offset]; + unsigned char* highlight = &ec.row[file_row].highlight[ec.col_offset]; + int current_color = -1; + int j; + for (j = 0; j < len; j++) { + // Displaying nonprintable characters as (A-Z, @, and ?). + if (iscntrl(c[j])) { + char sym = (c[j] <= 26) ? '@' + c[j] : '?'; + abufAppend(ab, "\x1b[7m", 4); + abufAppend(ab, &sym, 1); + abufAppend(ab, "\x1b[m", 3); + if (current_color != -1) { + char buf[16]; + int c_len = snprintf(buf, sizeof(buf), "\x1b[%dm", current_color); + abufAppend(ab, buf, c_len); + } + } else if (highlight[j] == HL_NORMAL) { + if (current_color != -1) { + abufAppend(ab, "\x1b[39m", 5); + current_color = -1; + } + abufAppend(ab, &c[j], 1); + } else { + int color = editorSyntaxToColor(highlight[j]); + // We only use escape sequence if the new color is different + // from the last character's color. + if (color != current_color) { + current_color = color; + char buf[16]; + int c_len = snprintf(buf, sizeof(buf), "\x1b[%dm", color); + abufAppend(ab, buf, c_len); + } + + abufAppend(ab, &c[j], 1); + } + } + abufAppend(ab, "\x1b[39m", 5); + } + + // Redrawing each line instead of the whole screen. + abufAppend(ab, "\x1b[K", 3); + // Addind a new line + abufAppend(ab, "\r\n", 2); + } +} + +void editorRefreshScreen() { + editorScroll(); + + struct a_buf ab = ABUF_INIT; + + // Hiding the cursor while the screen is refreshing. + // See http://vt100.net/docs/vt100-ug/chapter3.html#S3.3.4 + // for more info. + abufAppend(&ab, "\x1b[?25l", 6); + abufAppend(&ab, "\x1b[H", 3); + + editorDrawRows(&ab); + editorDrawStatusBar(&ab); + editorDrawMessageBar(&ab); + + // Moving the cursor where it should be. + char buf[32]; + snprintf(buf, sizeof(buf), "\x1b[%d;%dH", (ec.cursor_y - ec.row_offset) + 1, (ec.render_x - ec.col_offset) + 1); + abufAppend(&ab, buf, strlen(buf)); + + // Showing again the cursor. + abufAppend(&ab, "\x1b[?25h", 6); + + // Writing all content at once + write(STDOUT_FILENO, ab.buf, ab.len); + abufFree(&ab); +} + +void editorClearScreen() { + // Writing 4 bytes out to the terminal: + // - (1 byte) \x1b : escape character + // - (3 bytes) [2J : Clears the entire screen, see + // http://vt100.net/docs/vt100-ug/chapter3.html#ED + // for more info. + write(STDOUT_FILENO, "\x1b[2J", 4); + // Writing 3 bytes to reposition the cursor back at + // the top-left corner, see + // http://vt100.net/docs/vt100-ug/chapter3.html#CUP + // for more info. + write(STDOUT_FILENO, "\x1b[H", 3); +} + +/*** Input section ***/ + +char* editorPrompt(char* prompt, void (*callback)(char*, int)) { + size_t buf_size = 128; + char* buf = malloc(buf_size); + + size_t buf_len = 0; + buf[0] = '\0'; + + while (1) { + editorSetStatusMessage(prompt, buf); + editorRefreshScreen(); + + int c = editorReadKey(); + if (c == DEL_KEY || c == CTRL_KEY('h') || c == BACKSPACE) { + if (buf_len != 0) + buf[--buf_len] = '\0'; + } else if (c == '\x1b') { + editorSetStatusMessage(""); + if (callback) + callback(buf, c); + free(buf); + return NULL; + } else if (c == '\r') { + if (buf_len != 0) { + editorSetStatusMessage(""); + if (callback) + callback(buf, c); + return buf; + } + } else if (!iscntrl(c) && isprint(c)) { + if (buf_len == buf_size - 1) { + buf_size *= 2; + buf = realloc(buf, buf_size); + } + buf[buf_len++] = c; + buf[buf_len] = '\0'; + } + + if (callback) + callback(buf, c); + } +} + +void editorMoveCursor(int key) { + editor_row* row = (ec.cursor_y >= ec.num_rows) ? NULL : &ec.row[ec.cursor_y]; + + switch (key) { + case ARROW_LEFT: + if (ec.cursor_x != 0) + ec.cursor_x--; + // If <- is pressed, move to the end of the previous line + else if (ec.cursor_y > 0) { + ec.cursor_y--; + ec.cursor_x = ec.row[ec.cursor_y].size; + } + break; + case ARROW_RIGHT: + if (row && ec.cursor_x < row -> size) + ec.cursor_x++; + // If -> is pressed, move to the start of the next line + else if (row && ec.cursor_x == row -> size) { + ec.cursor_y++; + ec.cursor_x = 0; + } + break; + case ARROW_UP: + if (ec.cursor_y != 0) + ec.cursor_y--; + break; + case ARROW_DOWN: + if (ec.cursor_y < ec.num_rows) + ec.cursor_y++; + break; + } + + // Move cursor_x if it ends up past the end of the line it's on + row = (ec.cursor_y >= ec.num_rows) ? NULL : &ec.row[ec.cursor_y]; + int row_len = row ? row -> size : 0; + if (ec.cursor_x > row_len) + ec.cursor_x = row_len; +} + +void editorProcessKeypress() { + static int quit_times = TTE_QUIT_TIMES; + + int c = editorReadKey(); + + switch (c) { + case '\r': // Enter key + editorInsertNewline(); + break; + case CTRL_KEY('q'): + if (ec.dirty && quit_times > 0) { + editorSetStatusMessage("Warning! File has unsaved changes. Press Ctrl-Q %d more time%s to quit", quit_times, quit_times > 1 ? "s" : ""); + quit_times--; + return; + } + editorClearScreen(); + consoleBufferClose(); + exit(0); + break; + case CTRL_KEY('s'): + editorSave(); + break; + case CTRL_KEY('e'): + if (ec.cursor_y > 0 && ec.cursor_y <= ec.num_rows - 1) + editorFlipRow(1); + break; + case CTRL_KEY('d'): + if (ec.cursor_y < ec.num_rows - 1) + editorFlipRow(-1); + break; + case CTRL_KEY('x'): + if (ec.cursor_y < ec.num_rows) + editorCut(); + break; + case CTRL_KEY('c'): + if (ec.cursor_y < ec.num_rows) + editorCopy(0); + break; + case CTRL_KEY('v'): + editorPaste(); + break; + case CTRL_KEY('p'): + consoleBufferClose(); + kill(0, SIGTSTP); + case ARROW_UP: + case ARROW_DOWN: + case ARROW_LEFT: + case ARROW_RIGHT: + editorMoveCursor(c); + break; + case PAGE_UP: + case PAGE_DOWN: + { // You can't declare variables directly inside a switch statement. + if (c == PAGE_UP) + ec.cursor_y = ec.row_offset; + else if (c == PAGE_DOWN) + ec.cursor_y = ec.row_offset + ec.screen_rows - 1; + + int times = ec.screen_rows; + while (times--) + editorMoveCursor(c == PAGE_UP ? ARROW_UP : ARROW_DOWN); + } + break; + case HOME_KEY: + ec.cursor_x = 0; + break; + case END_KEY: + if (ec.cursor_y < ec.num_rows) + ec.cursor_x = ec.row[ec.cursor_y].size; + break; + case CTRL_KEY('f'): + editorSearch(); + break; + case BACKSPACE: + case CTRL_KEY('h'): + case DEL_KEY: + if (c == DEL_KEY) + editorMoveCursor(ARROW_RIGHT); + editorDelChar(); + break; + case CTRL_KEY('l'): + case '\x1b': // Escape key + break; + default: + editorInsertChar(c); + break; + } + + quit_times = TTE_QUIT_TIMES; +} + +/*** Init section ***/ + +void initEditor() { + ec.cursor_x = 0; + ec.cursor_y = 0; + ec.render_x = 0; + ec.row_offset = 0; + ec.col_offset = 0; + ec.num_rows = 0; + ec.row = NULL; + ec.dirty = 0; + ec.file_name = NULL; + ec.status_msg[0] = '\0'; + ec.status_msg_time = 0; + ec.copied_char_buffer = NULL; + ec.syntax = NULL; + + editorUpdateWindowSize(); + // The SIGWINCH signal is sent to a process when its controlling + // terminal changes its size (a window change). + signal(SIGWINCH, editorHandleSigwinch); + // The SIGCONT signal instructs the operating system to continue + // (restart) a process previously paused by the SIGSTOP or SIGTSTP + // signal. + signal(SIGCONT, editorHandleSigcont); +} + +void printHelp() { + printf("Usage: tte [OPTIONS] [FILE]\n\n"); + printf("\nKEYBINDINGS\n-----------\n\n"); + printf("Keybinding\t\tAction\n\n"); + printf("Ctrl-Q \t\tExit\n"); + printf("Ctrl-S \t\tSave\n"); + printf("Ctrl-F \t\tSearch. Esc, enter and arrows to interact once searching\n"); + printf("Ctrl-E \t\tFlip line upwards\n"); + printf("Ctrl-D \t\tFlip line downwards\n"); + printf("Ctrl-C \t\tCopy line\n"); + printf("Ctrl-X \t\tCut line\n"); + printf("Ctrl-V \t\tPaste line\n"); + printf("Ctrl-P \t\tPause tte (type \"fg\" to resume)\n"); + + printf("\n\nOPTIONS\n-------\n\n"); + printf("Option \t\tAction\n\n"); + printf("-h | --help \t\tPrints the help\n"); + printf("-v | --version\t\tPrints the version of tte\n"); + + printf("\n\nFor now, usage of ISO 8859-1 is recommended.\n"); +} + +// 1 if editor should open, 0 otherwise, -1 if the program should exit +int handleArgs(int argc, char* argv[]) { + if (argc == 1) + return 0; + + if (argc >= 2) { + if (strncmp("-h", argv[1], 2) == 0 || strncmp("--help", argv[1], 6) == 0) { + printHelp(); + return -1; + } else if(strncmp("-v", argv[1], 2) == 0 || strncmp("--version", argv[1], 9) == 0) { + printf("tte - version %s\n", TTE_VERSION); + return -1; + } + } + + return 1; +} + +int main(int argc, char* argv[]) { + initEditor(); + int arg_response = handleArgs(argc, argv); + if (arg_response == 1) + editorOpen(argv[1]); + else if (arg_response == -1) + return 0; + enableRawMode(); + + editorSetStatusMessage(" Ctrl-Q to quit | Ctrl-S to save | (tte -h | --help for more info)"); + + while (1) { + editorRefreshScreen(); + editorProcessKeypress(); + } + + return 0; +}