pax_global_header00006660000000000000000000000064140666630260014523gustar00rootroot0000000000000052 comment=3ed1118ae50b6443c31fc990a01ed762eec7ee94 eta-1.0.1/000077500000000000000000000000001406666302600122735ustar00rootroot00000000000000eta-1.0.1/LICENSE000066400000000000000000001045151406666302600133060ustar00rootroot00000000000000 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 . eta-1.0.1/Makefile000066400000000000000000000013701406666302600137340ustar00rootroot00000000000000CC = gcc CFLAGS ?= -Wall SRC := src OBJ := obj PREFIX ?= /usr/local SOURCES := $(wildcard $(SRC)/*.c) OBJECTS := $(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SOURCES)) eta: $(OBJECTS) $(CC) $(CFLAGS) $(CPPFLAGS) $^ $(LDFLAGS) -o $@ $(OBJ)/%.o: $(SRC)/%.c mkdir -p $(OBJ) $(CC) $(CFLAGS) $(CPPFLAGS) -I$(SRC) -c $< $(LDFLAGS) -o $@ srcdist: tar cfz eta-1.0.tar.gz --transform 's,^,eta-1.0/,' docs/ LICENSE Makefile src/ install: eta install -D eta \ $(DESTDIR)$(PREFIX)/bin/eta install -m 664 -D docs/eta.1 \ $(DESTDIR)$(PREFIX)/share/man/man1/eta.1 uninstall: -rm -f $(DESTDIR)$(PREFIX)/bin/eta \ $(DESTDIR)$(PREFIX)/share/man/man1/eta.1 distclean: clean clean: -@rm -rf $(OBJ) ./eta .PHONY: clean srcdist install uninstall eta-1.0.1/README.md000066400000000000000000000040761406666302600135610ustar00rootroot00000000000000# eta - A tool for monitoring progress and ETA of an arbitrary process `eta` is a command line tool that takes two arguments: 1. A **target value** 2. A **command** to inspect the current progress value `eta` will execute the given **command** once every second, look for the first number in the commands output, and estimate the time until it reaches the given **target value**. When using `--cont`, **command** runs continuously, and `eta` will read the output line by line to determine progress. See [man page](https://github.com/aioobe/eta/wiki/eta-man-page) for full documentation. ## Installation ### Ubuntu sudo add-apt-repository ppa:aioobe/ppa sudo apt-get update sudo apt-get install eta ### Other Download repo, build and install manually: make make install ## Example Usage ### Example 1: File copy Use `du -bs` to monitor the size of a directory. To avoid running an `ssh` command every second, you can lower the rate with `--interval` or use `--cont` and a single `ssh` invocation with a `while` loop. (Examples 3 and 4 illustrate the use of `--cont`.) ### Example 2: Monitor file count Use `ls | wc -l` to monitor the number of files in a directory. If the `resized` directory is initially non empty, you can use `--start initial` which tells `eta` to use the first value read (instead of 0) as the 0% progress value. ### Example 3: Tailing a log With `--cont` the progress command is kept running, and the progress is determined by reading the output line by line continuously. ### Example 4: Counting lines You can use `cat -n` to add line numbers to the output of a command. The line numbers can then be used as a progress indicator. For example, since `tar v...` prints one file per line, the progress can be monitored by counting lines as follows: ### Example 5: Decreasing values Use `--down` if the progress value decreases. eta-1.0.1/docs/000077500000000000000000000000001406666302600132235ustar00rootroot00000000000000eta-1.0.1/docs/eta.1000066400000000000000000000140131406666302600140550ustar00rootroot00000000000000.TH ETA 1 "09 February 2019" GNU "eta manual" .SH NAME eta \- calculate eta of a running process by repeatedly inspecting its progress .SH SYNOPSIS .B eta [\fIOPTIONS\fR] \fITARGET\fR \fIPROGRESS_COMMAND\fR .SH DESCRIPTION .B eta prints the progress and estimated time to completion based on the given \fIPROGRESS_COMMAND\fR and \fITARGET\fR value. \fIPROGRESS_COMMAND\fR should be a command that prints the current progress of some running process. If, for example, the running process is a file copy, a suitable progress command would be .B du -b some.file \fITARGET\fR should be the target value (value representing 100%) for the progress command. For a file copy the target value should be the size of the source file. If you have for example the following process running: .RS .B scp -r dir/ myserver: .RE you could monitor its progress and eta using .RS .B eta """$(du -bs dir)""" ssh myserver du -bs dir .RE It's similar to .BR watch (1) in the sense that it executes the given command repeatedly, but instead of displaying the output of the command, it parses the output and displays the progress and eta. See \fBNOTES\fR for further details. .SH OPTIONS Options adjust the behavior and output of .BR eta . .TP .B \-s, \-\-start VALUE|initial Use .B VALUE as the starting value for the process (the value representing 0% progress). If you are, for example, appending a 1GB file onto an existing 1GB file\[u2026] .RS .B cat\ new_1GB\ >> existing_1GB .RE \[u2026]you use\[u2026] .RS .B eta \-\-start 1G 2G du -b existing_1GB .RE \[u2026]to avoid having the progress start at 50%. If you use .B initial the first value returned by the progress command will be used as start value. This could be useful if you don't know the original start value, or if you're only interested in the progress of the remaining process. The default starting value is 0. .TP .B \-i, \-\-interval SECS Run the progress command every .B SECS seconds. (May not be used in conjunction with .BR \-\-cont .) .TP .B \-d, \-\-down To be used when the value decreases during progress. For example, if a script processes files in a directory and removes them as they get processed, you could use the following to monitor the progress: .RS .B eta\ \-\-down 0 """ls | wc -l""" .RE Since the starting value will rarely be 0 when using .B \-\-down the default for .B \-\-start is changed to .BR initial. .TP .B \-w, \-\-width COLS Specifies the width of the output of .BR eta . If this option is not provided, the output will fill the width of the terminal, or, default to 80 columns if there's no TTY. .TP .B \-c, \-\-cont Instead of running the given command repeatedly, .B eta will let the command keep running, and read the progress continuously line by line. If the process to be monitored writes its progress to a log file, you could for example use something like .RS .B eta \-\-cont 100 """tail -n1 -f program.log | grep Progress:""" .RE (May not be used in conjunction with .BR \-\-interval .) .TP .B \-h, \-\-help Prints a help message and exits. .SH EXAMPLES .SS Copying files If you're copying a directory to a remote host using something like .RS .B scp -r dir/ server: .RE you can monitor the progress using .RS .B eta \-i 10 """$(du -bs dir)""" ssh server du -bs dir .RE .SS Growing number of files If you're processing lots of files using something like .RS .B mogrify -resize 50% -path output-dir *.jpg .RE (Resize all jpg images and store the smaller versions in \fBoutput-dir\fR.) You can use .RS .B eta $(ls *.jpg | wc \-l) """ls output-dir/*.jpg | wc \-l""" .RE Note that the number of files may reach the target value before the last file is fully processed. .SS Shrinking number of files If you're processing files and removing them as they get processed\[u2026] .RS .B for f in *; do ./process.sh $f && rm $f; done .RE \[u2026]you can monitor the progress using: .RS .B eta \-\-down 0 """$(ls | wc \-l)""" .RE .SS Counting lines You can use .B \-\-cont and .B cat -n to continuously monitor progress based on number of lines printed: .RS .B tar vcfz bkp.tgz dir/ | eta \-\-cont $(find dir/ | wc \-l) cat -n .RE .SS The process prints progress in a log file If your running process logs the progress to a file, you could do something like .RS .B eta \-\-cont 100 """tail -n1 -f program.log | grep Progress:""" .RE .SS The process prints progress on stdout If you have a process that prints its progress on stdout: .RS $ ./my-script.sh .br Progress: 1 out of 55... .br Progress: 2 out of 55... .br Progress: 3 out of 55... .br \[u2026] .RE you can use .B \-\-cont and the command itself as argument to .B eta: .RS .B eta \-\-cont 55 ./my-script.sh .RE or, if you're a UUOC fan: .RS .B ./my-script.sh | eta \-\-cont 55 cat .RE .SH EXIT STATUS .TP .B 0 Command completed successfully .TP .B 1 Invalid command line arguments .TP .B 2 Execution of external command failed .TP .B 3 Could not find a number indicating progress in command output .SH NOTES When parsing the \fITARGET\fR value and \fB\-\-start\fR argument, \fBeta\fR will look for the first digit and start parsing from there. The given values may have a suffix indicating a metric or binary magnitude. Supported suffixes are \fBk\fR, \fBm\fR, \fBg\fR, \fBt\fR, \fBki\fR, \fBmi\fR, \fBgi\fR and \fBti\fR (representing 10^3, 10^6, 10^9, 10^12, 2^10, 2^20, 2^30 and 2^40 resp.) All arguments following the \fITARGET\fR value will be joined and used as the \fIPROGRESS_COMMAND\fR. That is, there's no need for double quotes here: .RS .B eta 5g du -b bigfile .RE If stdout is a file or pipe, .B eta will print a new line between each progress output, instead of a carriage return. If you want the new line behavior in the terminal, simply pipe the output through .BR cat (1). .B eta will only look for the progress value in the first 1000 characters of the first line of output written by the progress command (unless \fB\-\-cont\fR is provided). .SH AUTHOR Written by Andreas Lundblad (andreas.lundblad@gmail.com). .SH REPORTING BUGS Report bugs in the issue tracker at github: .SH SEE ALSO watch(1), pv(1), progress(1) eta-1.0.1/src/000077500000000000000000000000001406666302600130625ustar00rootroot00000000000000eta-1.0.1/src/eta.c000066400000000000000000000075171406666302600140110ustar00rootroot00000000000000#include #include #include #include #include #include "eta.h" #include "options.h" #include "eta_calc.h" #include "measurements.h" #include "printing.h" // Global variable to store program name (argv[0]). Used to print error messages // on the format "./eta: some error" in various places in the code. char *program_name; value_t run_progress_cmd(char *cmd, bool cont); char *joined_cmd(int n, char **parts); timestamp_t now(); int main(int argc, char **argv) { program_name = argv[0]; Options opts; parse_options(argc, argv, &opts); char *cmd = joined_cmd(opts.n_cmd, opts.cmd); // Initialize after first measurement value_t initial_value = 0; while (1) { value_t current_value = run_progress_cmd(cmd, opts.cont); // First measurement? if (oldest_measurement() == NULL) { initial_value = opts.start_mode == START_MODE_INITIAL ? current_value : opts.start_mode; } add_measurement(now(), current_value); double ratio_completed = compute_ratio_completed( initial_value, opts.target_value, opts.down); double seconds_left = compute_seconds_left(opts.target_value, opts.down); print_progress_and_eta( opts.output_width, MAX(initial_value, opts.target_value), current_value, ratio_completed, seconds_left); if (ratio_completed >= 1.0) { break; } if (!opts.cont) { sleep(opts.interval); } } free(cmd); return SUCCESS; } // Execute cmd. Look for a numeric value in the output. value_t run_progress_cmd(char *cmd, bool cont) { // !cont: Opened / closed each invocation // cont: Opened / closed each invocation static FILE *cmd_fp = NULL; // Execute command if it's not already running if (!cmd_fp) { cmd_fp = popen(cmd, "r"); if (cmd_fp == NULL) { printf("failed to execute external command: '%s'\n", cmd); exit(COMMAND_EXECUTION_FAILED); } } // Read a line of output char output[1000]; if (fgets(output, sizeof(output), cmd_fp) == NULL) { // No output could be read. Setting the result to the empty string will // cause a failure when parsing later, and print an error message and exit. output[0] = 0; } // If no newline was read (and we're running with --cont), discard the // remaining line so we don't erroneously read that next time around. if (strchr(output, '\n') == NULL && cont) { for (;;) { int c = fgetc(cmd_fp); if (c == '\n' || c == EOF) { break; } } } // Look for first digit char *first_digit = output; while (!isdigit(*first_digit)) { if (*first_digit == 0) { printf("Could not find number in command output -- '%s'\n", output); exit(COULD_NOT_PARSE_COMMAND_OUTPUT); } first_digit++; } value_t value = strtoul(first_digit, NULL, 10); // Close cmd if we're not running in continuous mode. if (!cont) { int exitStatus = WEXITSTATUS(pclose(cmd_fp)); cmd_fp = NULL; if (exitStatus != 0) { puts("External command terminated with non-zero exit code."); exit(COMMAND_EXECUTION_FAILED); } } return value; } // Join all parts of the cmd strings // Note: It is the responsible of the caller to free the allocated memory. char *joined_cmd(int n, char **parts) { // Pass 1: Allocate memory int total_len = 0; for (int i = 0; i < n; i++) { // +1 for spaces in-between and trailing \0. total_len += strlen(parts[i]) + 1; } char *joined = malloc(total_len); // Pass 2: Concatenate strings char *end = joined; for (int i = 0; i < n; i++) { strcpy(end, parts[i]); end += strlen(parts[i]); if (i < n - 1) { *end++ = ' '; } } return joined; } // Return the current time timestamp_t now() { timestamp_t ts; clock_gettime(CLOCK_MONOTONIC_RAW, &ts); return ts; } eta-1.0.1/src/eta.h000066400000000000000000000004351406666302600140060ustar00rootroot00000000000000#ifndef ETA_H #define ETA_H #define MAX(x, y) (((x) > (y)) ? (x) : (y)) #define SUCCESS 0 #define INVALID_COMMAND_LINE_ARGUMENTS 1 #define COMMAND_EXECUTION_FAILED 2 #define COULD_NOT_PARSE_COMMAND_OUTPUT 3 typedef long long value_t; extern char *program_name; #endif /* ETA_H */ eta-1.0.1/src/eta_calc.c000066400000000000000000000031741406666302600147660ustar00rootroot00000000000000#include #include "eta_calc.h" #include // Compute and return ratio completed double compute_ratio_completed(value_t initial_value, value_t target_value) { value_t value = last_measurement()->value; return (double) (value - initial_value) / (target_value - initial_value); } // Calculates the rate of change from m1 to m2. double rate(Measurement *m1, Measurement *m2) { value_t progress_delta = m2->value - m1->value; long sec_delta = m2->timestamp.tv_sec - m1->timestamp.tv_sec; long nsec_delta = m2->timestamp.tv_nsec - m1->timestamp.tv_nsec; double time_delta = sec_delta + nsec_delta / 1.0e9; return progress_delta / time_delta; } // Calculate the average rate of change. // // This function assumes that we have at least two measurements. double average_rate() { Measurement *oldest = oldest_measurement(); Measurement *latest = last_measurement(); return rate(oldest, latest); } // Calculate and return estimated seconds left. double compute_seconds_left(value_t target_value, bool down) { Measurement *m = oldest_measurement(); // 0 measurements available? if (m == NULL) { // Can't determine rate -> can't determine seconds left. return -1; } // Target value reached? if (down ? m->value <= target_value : m->value >= target_value) { return 0; } // Only 1 measurement available? if (m == last_measurement()) { // Can't determine rate -> can't determine seconds left. return -1; } // Note: work_left may be negative, but then so will average_rate be. value_t work_left = target_value - last_measurement()->value; return work_left / average_rate(); } eta-1.0.1/src/eta_calc.h000066400000000000000000000004011406666302600147610ustar00rootroot00000000000000#ifndef ETA_CALC_H #define ETA_CALC_H #include "measurements.h" double compute_ratio_completed(); double rate(Measurement *m1, Measurement *m2); double average_rate(); double compute_seconds_left(value_t target_value, bool down); #endif /* ETA_CALC_H */ eta-1.0.1/src/measurements.c000066400000000000000000000040051406666302600157350ustar00rootroot00000000000000#include "measurements.h" #define MEASUREMENTS_HISTORY 10 // Cyclic buffer of measurements static Measurement measurements[MEASUREMENTS_HISTORY]; // Measurements added so far static int num_measurements = 0; // Return the i:th measurement starting from 0. // Wrapps if i > MEASUREMENTS_HISTORY Measurement *measurement(int i) { return measurements + (i % MEASUREMENTS_HISTORY); } // Return the oldest available measurement. Measurement *oldest_measurement() { if (num_measurements == 0) { return NULL; } int i = num_measurements - MEASUREMENTS_HISTORY; if (i < 0) { i = 0; } return measurement(i); } // Return the pointer the measurement after m. Measurement *next_measurement(Measurement *m) { Measurement *next = m + 1; if (next >= measurements + MEASUREMENTS_HISTORY) { next = measurements; } return next; } // Return a pointer to the the measurement added last Measurement *last_measurement() { return num_measurements == 0 ? NULL : measurement(num_measurements - 1); } // Adds a measurement to the cyclic buffer of mearusements void add_measurement(timestamp_t timestamp, value_t value) { Measurement *last = last_measurement(); // If we "blindly" append this value, we may (if progress is slow) end up with // // 0 0 0 0 0 // 0 0 0 0 1 // 0 0 0 1 1 // ... // 1 1 1 1 1 // // During 0...0 and 1...1 periods, eta calculations would break. // // So instead we check if this measurement has the same value as the last one // and then we update the timestamp of the last measurement instead. This // give a situation like // // 0 1 2 3 4 // 1 2 3 4 5 // ... // // The newer measurement can be seen as "strictly more interesting" than the // last since it came in at a later point in time. if (last != NULL && value == last->value) { last->timestamp = timestamp; return; } Measurement *m = last == NULL ? measurement(0) : next_measurement(last); m->timestamp = timestamp; m->value = value; num_measurements++; } eta-1.0.1/src/measurements.h000066400000000000000000000006201406666302600157410ustar00rootroot00000000000000#ifndef MEASUREMENTS_H #define MEASUREMENTS_H #include #include "eta.h" typedef struct timespec timestamp_t; typedef struct { timestamp_t timestamp; value_t value; } Measurement; Measurement *oldest_measurement(); Measurement *next_measurement(Measurement *m); Measurement *last_measurement(); void add_measurement(timestamp_t timestamp, value_t value); #endif /* MEASUREMENTS_H */ eta-1.0.1/src/options.c000066400000000000000000000144301406666302600147230ustar00rootroot00000000000000#include #include #include #include #include #include "options.h" bool isopt(char *arg, char abbr, char *full); char *get_opt_arg(int argi, int argc, char **argv, char *opt_name); value_t parse_suffixed_value(char *arg_name, char *arg); int parse_numeric_arg(char *arg_name, char *arg); void error(const char *format, ...); void print_usage(); // Parse argv and store the result in options. void parse_options(int argc, char **argv, Options *options) { // Set defaults options->interval = 1; options->start_mode = 0; options->output_width = USE_TERMINAL_WIDTH; options->down = false; options->cont = false; bool start_provided = false; bool interval_provided = false; int argi = 1; while (argi < argc) { char *arg = argv[argi++]; if (isopt(arg, 's', "start")) { char *start_arg = get_opt_arg(argi++, argc, argv, "start"); start_provided = true; options->start_mode = strcmp(start_arg, "initial") == 0 ? START_MODE_INITIAL : parse_suffixed_value("start", start_arg); continue; } if (isopt(arg, 'c', "cont")) { options->cont = true; continue; } if (isopt(arg, 'd', "down")) { options->down = true; continue; } if (isopt(arg, 'i', "interval")) { char *interval_arg = get_opt_arg(argi++, argc, argv, "interval"); interval_provided = true; options->interval = parse_numeric_arg("interval", interval_arg); continue; } if (isopt(arg, 'w', "width")) { char *width_arg = get_opt_arg(argi++, argc, argv, "width"); options->output_width = parse_numeric_arg("width", width_arg); continue; } if (isopt(arg, 'h', "help")) { print_usage(); exit(SUCCESS); } // Option parsing failed. We're probably looking at the target value // argument. Take a step back, break out of option parsing loop, and parse // target value next. argi--; break; } // Parse target value char *target_arg = get_opt_arg(argi++, argc, argv, "target"); options->target_value = parse_suffixed_value("target", target_arg); // Parse external command if (argi >= argc) { error("no progress command provided"); } options->n_cmd = argc - argi; options->cmd = argv + argi; // --cont and --interval are mutually exclusive if (interval_provided && options->cont) { error("at most one of --interval and --cont may be specified"); } // If counting downwards, the target is often 0, so 'initial' makes more sense // than 0 as default for start_mode. if (options->down && !start_provided) { options->start_mode = START_MODE_INITIAL; } } // Return true if arg is the matches "-[abbr]" or "--[full]" bool isopt(char *arg, char abbr, char *full) { return (strlen(arg) == 2 && arg[0] == '-' && arg[1] == abbr) || (strlen(arg) == 2 + strlen(full) && arg[0] == '-' && arg[1] == '-' && strcmp(arg + 2, full) == 0); } // Return the next option if there's one available, otherwise print an error. char *get_opt_arg(int argi, int argc, char **argv, char *opt_name) { if (argi >= argc) { char *fmt = strcmp(opt_name, "target") == 0 ? "no %s argument provided" : "--%s requires an argument"; error(fmt, opt_name); } return argv[argi]; } // Translates "k" to 1000, "m" to 1000000 etc. // // If the argument is an empty string or a string that starts with a 1 is // returned as this is an indication that the preceeding number does not // have a suffix. long long magnitude_for_suffix(char *suffix) { if (*suffix == '\0' || isspace(*suffix)) { return 1; } char *suffixes[] = { "k", "m", "g", "t", "ki", "mi", "gi", "ti" }; long long magnitudes[] = { 1e3, 1e6, 1e9, 1e12, 1L << 10, 1L << 20, 1L << 30, 1L << 40 }; // Lower case the given suffix for (char *p = suffix; *p; ++p) { *p = tolower(*p); } for (int i = 0; i < sizeof(magnitudes)/sizeof(magnitudes[0]); i++) { if (strcmp(suffix, suffixes[i]) == 0) { return magnitudes[i]; } } return -1; } // Parse a value like "15g" or "123". // arg_name is needed only for printing an error message. value_t parse_suffixed_value(char *arg_name, char *arg) { char *tail; value_t value = strtoul(arg, &tail, 10); if (arg == tail) { error("could not parse %s value -- '%s'", arg_name, arg); } long long magnitude = magnitude_for_suffix(tail); if (magnitude == -1) { error("invalid %s value suffix -- '%s'", tail); } return magnitude * value; } // Parse an integer, or print an error message if not possible. int parse_numeric_arg(char *arg_name, char *arg) { char *err_fmt = "invalid %s argument -- '%s'"; int len = strlen(arg); if (len == 0 || len >= 9) { error(err_fmt, arg_name, arg); } char *tmp = arg; while (*tmp) { if (!isdigit(*tmp++)) { error(err_fmt, arg_name, arg); } } int parsed = strtoul(arg, NULL, 10); if (parsed <= 0) { error(err_fmt, arg_name, arg); } return parsed; } // Print an error message and exit. void error(const char *format, ...) { va_list args; fprintf(stderr, "%s: ", program_name); va_start (args, format); vfprintf(stderr, format, args); fputc('\n', stderr); va_end (args); exit(INVALID_COMMAND_LINE_ARGUMENTS); } // Print usage message. void print_usage() { puts("Usage:"); puts(" eta [OPTIONS] TARGET COMMAND"); puts(""); puts("Runs COMMAND repeatedly. For each invocation it looks for a number"); puts("in the first line of the output, and prints an estimate for when"); puts("the number will reach the TARGET value."); puts(""); puts(" -s, --start |initial"); puts(" let VALUE (or initial value from COMMAND)"); puts(" represent 0%"); puts(" -i, --interval run COMMAND every SECS seconds"); puts(" -d, --down value decreases; --start will default to"); puts(" 'initial'"); puts(" -w, --width specify width of output"); puts(" -c, --cont instead of running COMMAND repeatedly,"); puts(" keep COMMAND running and read progress"); puts(" continuously line by line"); puts(" -h, --help print this help and exit"); } eta-1.0.1/src/options.h000066400000000000000000000010271406666302600147260ustar00rootroot00000000000000#ifndef OPTIONS_H #define OPTIONS_H #include #include "eta.h" #define START_MODE_INITIAL -1 #define USE_TERMINAL_WIDTH -1 typedef struct { value_t target_value; value_t start_mode; // Value to be treated as start value (-1 = first measurement) unsigned int interval; // Seconds to sleep between invocations of external command bool down; bool cont; unsigned int output_width; int n_cmd; char **cmd; } Options; void parse_options(int argc, char** argv, Options *options); #endif /* OPTIONS_H */ eta-1.0.1/src/printing.c000066400000000000000000000126071406666302600150660ustar00rootroot00000000000000#include #include #include #include #include #include "printing.h" #include "options.h" #define NOTTY_WIDTH 80 #define MINUTE (60) #define HOUR (60 * MINUTE) #define DAY (24 * HOUR) // Transform actual progress to the progress we want to present to the user. // Sounds strange? Read on... double presented_progress(double actual) { // This avoids things like "-0.00%" double presented = actual <= 0 ? 0 : actual >= 1 ? 1 : actual; // We don't want to print 100% until it's completely done. So we translate the // range from 0...100% to 0...99%. Actual 100% will be handled elsewhere. if (presented < 1) { presented *= 0.99; } return presented; } // Returns terminal width or -1 if no TTY is available int get_terminal_width() { struct winsize w; return ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) < 0 ? -1 : w.ws_col; } // Returns the total width to be used for the output. unsigned int total_width(unsigned int specified_width, int terminal_width) { return specified_width == USE_TERMINAL_WIDTH ? terminal_width == -1 ? NOTTY_WIDTH : terminal_width : specified_width; } // Returns the number of digits in n. unsigned int num_digits(int n) { int i = 1; for (; n /= 10; i++); return i; } // Initialized the next output field. void init_next_field(bool *is_first_field, bool cr_on_first) { if (!*is_first_field) { putchar(' '); } else if (cr_on_first) { putchar('\r'); } *is_first_field = false; } // Prints progress and eta. void print_progress_and_eta(unsigned int specified_width, value_t max_value, value_t current_value, double ratio_completed, double seconds_left) { int terminal_width = get_terminal_width(); bool tty = terminal_width != -1; unsigned int width = total_width(specified_width, terminal_width); // Default widths unsigned int w_current_value = num_digits(max_value); unsigned int w_percent = 4; // Ex: "100%" unsigned int w_eta = 14; // Ex: "ETA 12h 16m 5s" // Min width. Compute final width later. unsigned int w_progress_bar = 7; // "[### ]" // 4 blocks -> 3 separating spaces int separators = 3; if (width < w_current_value + w_progress_bar + w_percent + w_eta+separators) { w_current_value = 0; separators--; } if (width < w_progress_bar + w_percent + w_eta + separators) { w_progress_bar = 0; separators--; } if (width < w_percent + w_eta) { w_eta = 0; separators--; } if (width < w_percent) { // aww, come on... width = w_percent; } // Let progress bar grow if (w_progress_bar) { w_progress_bar = width - w_current_value - w_percent - w_eta - separators; } bool first_field = true; // Current value if (w_current_value) { init_next_field(&first_field, tty); printf("%*llu", w_current_value, current_value); } // Progress bar if (w_progress_bar) { init_next_field(&first_field, tty); putchar('['); int filled = (int) (ratio_completed * (w_progress_bar - 2)); for (int i = 0; i < w_progress_bar - 2; i++) { putchar(i < filled ? '#' : ' '); } putchar(']'); } // Percent if (w_percent) { init_next_field(&first_field, tty); double percent = 100.0 * presented_progress(ratio_completed); printf("%*.0f%%", w_percent - 1, percent); } // ETA if (w_eta) { init_next_field(&first_field, tty); int w_eta_left = w_eta; if (seconds_left <= 0) { char *str = seconds_left == 0 ? "Done" : "ETA n/a"; if (w_eta_left >= strlen(str)) { printf("%s", str); w_eta_left -= strlen(str); } } else { int seconds = (int) (seconds_left + .5); int days = seconds / DAY; seconds %= DAY; int hours = seconds / HOUR; seconds %= HOUR; int minutes = seconds / MINUTE; seconds %= MINUTE; if (w_eta_left >= 3) { printf("%s", "ETA"); w_eta_left -= 3; } int fields[] = { days, hours, minutes, seconds }; char units[] = { 'd', 'h', 'm', 's' }; int n_fields = sizeof(units); bool no_field_printed = true; for (int i = 0; i < n_fields; i++) { bool last_chance = i == n_fields - 1; if (fields[i] || (last_chance && no_field_printed)) { int digits = num_digits(fields[i]); int actual_width = digits + 2; // +2: ' ' separator and unit char // The last field can fluctuate between, say 9 and 10, which means // that it may sometimes fit, sometimes not (which causes it to // "flicker"). To avoid this we require it to fit even if it's 2 // digits. int required_width = MAX(2, digits) + 2; if (w_eta_left < required_width) { break; } printf(" %d%c", fields[i], units[i]); no_field_printed = false; w_eta_left -= actual_width; } } } if (tty) { static int prev_w_eta = 0; int current_w_eta = w_eta - w_eta_left; int to_cover = prev_w_eta - current_w_eta; // Since we're using '\r', make sure we fill the field completely so we // cover the previous output. while (to_cover-- > 0) { putchar(' '); } prev_w_eta = w_eta - w_eta_left; } } if (!tty || seconds_left == 0) { putchar('\n'); } fflush(stdout); } eta-1.0.1/src/printing.h000066400000000000000000000004341406666302600150660ustar00rootroot00000000000000#ifndef PRINTING_H #define PRINTING_H #include "eta.h" void print_progress_and_eta(unsigned int specified_width, value_t max_value, value_t current_value, double ratio_completed, double seconds_left); #endif /* PRINTING_H */