From: W. Trevor King Date: Tue, 28 Oct 2008 10:59:05 +0000 (-0400) Subject: Began versioning (version 0.5) X-Git-Url: http://git.tremily.us/?p=stripchart.git;a=commitdiff_plain;h=cdf588112266f35fd12ad505fcb04f52150c1b5c Began versioning (version 0.5) --- cdf588112266f35fd12ad505fcb04f52150c1b5c diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..e980fe4 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,7 @@ +version 0.5: 8 July 2008, first public release + +Was getting strange error messages out of (I thought) strtod(). Turns out +some Xlib functions were setting errno for reasons I don't understand. I put +in a HACK to ignore errnos set by functions other than strtod, which seems to +get things back in working order. + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e7a9078 --- /dev/null +++ b/Makefile @@ -0,0 +1,38 @@ +PROG_NAME = stripchart +VERSION = 0.5 +SOURCE_FILES = strip.c stripchart.c stripchart.h err_mac.h +OTHER_FILES = README CHANGELOG LICENSE Makefile test.sh test.dat +DIST_FILES = $(SOURCE_FILES) $(OTHER_FILES) +DIST_DIR = $(PROG_NAME)-$(VERSION) +DIST_NAME = $(PROG_NAME)-$(VERSION).tar.gz +GENERATED_FILES = $(PROG_NAME) $(PROG_NAME:%=%.exe) $(PROG_NAME:%=%.o) +INSTALL_DIR = $(HOME)/bin + +LIB_DIRS = /usr/X11R6/lib/ +PLOT_LIBS = X11 m # plot Xaw Xmu Xt SM ICE Xext X11 m +PTHREAD_LIBS = pthread +MY_FLAGS = -g $(INCLUDES:%=-I %) -D 'VERSION="$(VERSION)"' + +all : $(PROG_NAME) + +clean : + rm -f $(GENERATED_FILES) + +install : $(PROG_NAME) + cp $(PROG_NAME) $(INSTALL_DIR)/$(PROG_NAME) + +dist : + mkdir $(DIST_DIR) + cp $(DIST_FILES) $(DIST_DIR) + tar -chozf $(DIST_NAME) $(DIST_DIR) + rm -rf $(DIST_DIR) + +check : $(PROG_NAME) + test.sh + +stripchart.o : stripchart.c stripchart.h err_mac.h + gcc $(MY_FLAGS) -c $< + +$(PROG_NAME) : strip.c stripchart.o + gcc $(MY_FLAGS) $(LIB_DIRS:%=-L %) \ + -o $@ $^ $(PLOT_LIBS:%=-l%) $(PTHREAD_LIBS:%=-l%) diff --git a/README b/README new file mode 100644 index 0000000..b64115b --- /dev/null +++ b/README @@ -0,0 +1,17 @@ +For all those times you wanted a quick & dirty way to watch your data come in. +This is indeed ugly, but hopefully fast, and so not particularly configurable. + +stripchart creates a FIFO, pops up an X window, and waits for input. +ASCII numbers delimited with endlines ('\n') are plotted in the window, +until an unparsable number is recieved, +at which point, the window closes and stripchart returns. + +See test.sh for an example. + +stripchart.c implements the stripchart. +stripchart.h provides an interface to the stripchart defined in stripchart.c. +strip.c uses the stripchart.[hc] to plot data it reads in from a named pipe. + +Trevor King +8 July, 2008 +wking@drexel.edu diff --git a/err_mac.h b/err_mac.h new file mode 100644 index 0000000..ad50762 --- /dev/null +++ b/err_mac.h @@ -0,0 +1,140 @@ +/* need to include STDIO.H for FPRINTF() */ + +#define SUCCESS 0 +#define FAILURE 1 + +#ifndef TRUE +#define TRUE 1 +#endif +#ifndef FALSE +#define FALSE 0 +#endif +static int err_mac_ans; + +/* + * For functions returning int, when you want an immediate return. + */ + +/* CHK() fails if (a != SUCCESS) */ +#define CHK(a) \ + do { \ + if( (err_mac_ans = (a)) != SUCCESS ) { \ + fprintf(stderr,"FAILURE: %s.%d. (%s) returned %d\n",__FILE__,__LINE__, #a, err_mac_ans); \ + fflush(stderr); \ + return err_mac_ans; \ + } \ + } while (0) + +/* AST() fails if (a != 0) */ +#define AST(a) \ + do { \ + if( (err_mac_ans = (a)) == FALSE ) { \ + fprintf(stderr, "ASSERT FAILED: %s.%d (%s) returned %d\n",__FILE__,__LINE__, #a, err_mac_ans); \ + fflush(stderr); \ + return FAILURE; \ + } \ + } while(0) + +/* like AST(), but return E_CODE instead of the default FAILURE */ +#define E_AST(a,e_code) \ + do { \ + if((a) == FALSE) { \ + fprintf(stderr,"ASSERT FAILED: %s.%d (%s)\n",__FILE__,__LINE__, #a); \ + fflush(stderr); \ + return (e_code); \ + } \ + } while(0) + +/* like E_AST(), but also fprintfs __VA_ARGS__ */ +#define M_AST(a,e_code,...) \ + do { \ + if((a) == FALSE) { \ + fprintf(stderr,"ASSERT FAILED: %s.%d (%s) ",__FILE__,__LINE__, #a); \ + fprintf(stderr, __VA_ARGS__); \ + fflush(stderr); \ + return (e_code); \ + } \ + } while(0) + +/* print a message and return E_CODE */ +#define M_EXIT(e_code, ... ) \ + do { \ + fprintf(stderr,"EXIT: %s.%d ",__FILE__,__LINE__); \ + fprintf(stderr, __VA_ARGS__ ); \ + fflush(stderr); \ + return (e_code); \ + } while(0) + +/* + * When you don't want an immedate return, but would rather 'goto Error;'. + * These set the local variable RC with the return value before jumping. + */ + +#define G_CHK(a) \ + do { \ + if( (rc = (a)) != SUCCESS ) { \ + fprintf(stderr,"FAILURE: %s.%d. (%s)\n",__FILE__,__LINE__, #a); \ + fflush(stderr); \ + goto Error; \ + } \ + } while (0) + +#define G_AST(a) \ + do { \ + if( (rc = (a)) == FALSE ) { \ + fprintf(stderr, "ASSERT FAILED: %s.%d (%s)\n",__FILE__,__LINE__, #a); \ + fflush(stderr); \ + goto Error; \ + } \ + } while(0) + +#define G_E_AST(a,e_code) \ + do { \ + if((a) == FALSE) { \ + fprintf(stderr,"ASSERT FAILED: %s.%d (%s)\n",__FILE__,__LINE__, #a); \ + fflush(stderr); \ + rc = e_code; \ + goto Error; \ + } \ + } while(0) + +#define G_M_AST(a,e_code,...) \ + do { \ + if((a) == FALSE) { \ + fprintf(stderr,"ASSERT FAILED: %s.%d (%s) ",__FILE__,__LINE__, #a); \ + fprintf(stderr, __VA_ARGS__); \ + fflush(stderr); \ + rc = e_code; \ + goto Error; \ + } \ + } while(0) + +/* print a message and return E_CODE */ +#define G_M_EXIT(e_code, ... ) \ + do { \ + fprintf(stderr,"EXIT: %s.%d ",__FILE__,__LINE__); \ + fprintf(stderr, __VA_ARGS__ ); \ + fflush(stderr); \ + rc = e_code; \ + goto Error; \ + } while(0) + +/* + * And when you only want to print a message + */ +#define P_CHK(a) \ + do { \ + if( (a) != SUCCESS ) { \ + fprintf(stderr,"FAILURE: %s.%d. (%s)\n",__FILE__,__LINE__, #a); \ + fflush(stderr); \ + } \ + } while (0) + +/* AST() fails if (a != 0) */ +#define P_AST(a) \ + do { \ + if( (a) == FALSE ) { \ + fprintf(stderr, "ASSERT FAILED: %s.%d (%s)\n",__FILE__,__LINE__, #a); \ + fflush(stderr); \ + } \ + } while(0) diff --git a/strip.c b/strip.c new file mode 100644 index 0000000..b20b36b --- /dev/null +++ b/strip.c @@ -0,0 +1,255 @@ +/* + strip - program for stripcharting ASCII data read from a named pipe. + Copyright (C) 2008, William Trevor King + + 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, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA + 02111-1307, USA. + + The author may be contacted at on the Internet, or + write to Trevor King, Drexel University, Physics Dept., 3141 Chestnut St., + Philadelphia PA 19104, USA. + */ + +#include +#include +#include +#include +#include +#include /* mkfifo(), S_IRUSR, S_IWUSR */ +#include "err_mac.h" +#include "stripchart.h" + +#define BUFSZ 81 + +//#define AUTOGEN /* for testing */ + + +static int string2double(char *string, double *pDouble); +static int getargs(int argc, char **argv, unsigned int *pFlags, + char **pTitle, char **pGeometry, char **pPipe_name, + double *pY_max, double *pY_min, int *pPoints_shown_at_once); +static int open_pipe(char *name, unsigned int flags, FILE **pInStream); +static int close_pipe(char *name, FILE **pInStream); +static int get_num(FILE *stream, double *px); + +static const char options[] = "t:g:p:cuM:m:n:avh"; +static const char *func_name = NULL; +static const char *description = + "Pops up an X window strip chart, and a FIFO to dump data into"; + +static int verbose = 0; + +#define FLAG_CREATE_FIFO 0x1 +#define FLAG_AXES_ON 0x2 + +static void help(char *title, char *geometry, char *pipe_name, + double y_max, double y_min, int num_points) +{ + printf("usage: %s [-%s]\n", func_name, options); + puts(description); + printf("Version: %s\n\n", VERSION); + + puts("Options:"); + + printf("-t \tSet the window title (default: %s)\n", title); + printf("-g <geometry>\tSet the initial window geometry (default: %s)\n", geometry); + printf("-p <file>\tSet FIFO name (default: %s)\n", pipe_name); + + printf(" %s can either create its own FIFO or use an already existing one.\n", + func_name); + puts(" Using an existing FIFO avoids the following race condition:"); + puts("\tFork"); + printf("\tProcess 1 starts %s\n", func_name); + puts("\tProcess 2 sends data to FIFO, but it doesn't exist,"); + puts("\t\tso file system creates a new file"); + puts("\tProcess 1 gets around to trying to create the FIFO,"); + puts("\t\tbut fails because the file already exists"); + printf("-u\t%s uses an already created FIFO\n", func_name); + printf("-c\t%s create the input FIFO (default)\n", func_name); + + printf("-M\tSet Maximum y value (default: %g)\n", y_max); + printf("-m\tSet minimum y value (default: %g)\n", y_min); + printf("-n\tSet number of points shown at once (default: %d)\n", num_points); + puts("-a\tToggle axes (default: on)"); + + puts("-v\tIncrement verbosity"); + puts("-h\tDisplay this help and exit"); + exit(1); +} + +int main(int argc, char **argv) +{ + stripchart_t *chart = NULL; + FILE *input; + double x=0, y_max, y_min; + unsigned int flags; + int points_shown_at_once; + char *title, *geometry, *pipe_name; + + CHK( getargs(argc, argv, &flags, + &title, &geometry, &pipe_name, + &y_max, &y_min, &points_shown_at_once) ); +#ifndef AUTOGEN + CHK( open_pipe(pipe_name, flags, &input) ); + if (verbose) + fprintf(stderr, "creating stripchart on pipe %s with geom %s\n", + pipe_name, geometry); +#endif + CHK( stripchart_create(&chart, title, geometry, + y_min, y_max, 1.0, + points_shown_at_once, + flags & FLAG_AXES_ON) ); + do { +#ifndef AUTOGEN + if (get_num(input, &x) != 0) + break; +#else + x += 0.5; + if (x == 9) break; + usleep(100000); +#endif + CHK( stripchart_point(chart, x) ); + } while (TRUE); + CHK( stripchart_destroy(&chart) ); +#ifndef AUTOGEN + CHK( close_pipe(pipe_name, &input) ); +#endif + return 0; +} + +static int string2double(char *string, double *pDouble) +{ + char *endp; + if (errno != 0) { + //perror("sloppy error checking"); + //fprintf(stderr, "errno = %d\n", errno); + //return 1; /* unrecognized input */ + /* HACK!!! Some Xlib function calls (XOpenDisplay, and others) seem to set + * errno to 29, or 11, but still return successfully. I have no idea why, + * since I can't find any mention of errno in the Xlib documents, but we'll + * just ignore any previous errnos and hope everything works out... + */ + errno = 0; + } + *pDouble = strtod(string, &endp); + if (errno != 0 || endp[0] != '\0') { + if (errno != 0) { + perror("strtod"); + fprintf(stderr, "could not parse '%s'\n", string); + fprintf(stderr, "endp = \"%s\"\n", endp); + fprintf(stderr, "errno = %d\n", errno); + } + return 1; /* unrecognized input */ + } + return 0; +} + +static int getargs(int argc, char **argv, unsigned int *pFlags, + char **pTitle, char **pGeometry, char **pPipe_name, + double *pY_max, double *pY_min, int *pPoints_shown_at_once) +{ + int c; + double temp; + + func_name = argv[0]; + *pFlags = FLAG_CREATE_FIFO | FLAG_AXES_ON; + *pTitle = "Stripchart"; + *pGeometry = "500x200+0+0"; + *pPipe_name = "strip_pipe"; + *pY_max = 10.0; + *pY_min = -10.0; + *pPoints_shown_at_once = 100; + + while ((c=getopt(argc, argv, options)) != -1) { + switch (c) { + case 't': + *pTitle = optarg; + break; + case 'g': + *pGeometry = optarg; + break; + case 'p': + *pPipe_name = optarg; + break; + case 'u': + *pFlags &= ~FLAG_CREATE_FIFO; + break; + case 'c': + *pFlags |= FLAG_CREATE_FIFO; + break; + case 'M': + if (string2double(optarg, pY_max) != 0) + goto error; + break; + case 'm': + if (string2double(optarg, pY_min) != 0) + goto error; + break; + case 'n': + if (string2double(optarg, &temp) != 0) + goto error; + *pPoints_shown_at_once = (int)temp; + break; + case 'a': + *pFlags ^= FLAG_AXES_ON; + break; + case 'v': + verbose++; + break; + default: + printf("Unrecognized option '%c'\n", c); + case 'h': /* default falls through */ + error: + printf("Problem with option '%c' (%s)\n", c, optarg); + help(*pTitle, *pGeometry, *pPipe_name, *pY_max, *pY_min, *pPoints_shown_at_once); + break; + } + } + return 0; +} + +static int open_pipe(char *name, unsigned int flags, FILE **pStream) +{ + if (flags & FLAG_CREATE_FIFO) { + /* make a fifo with read/write permision for the user */ + if (mkfifo(name, S_IRUSR | S_IWUSR) != 0) { + perror("mkfifo"); + fprintf(stderr, "Error creating FIFO '%s', aborting\n", name); + AST(1==0); + } + } + AST( (*pStream = fopen(name, "a+")) != NULL ); + return 0; +} + +static int close_pipe(char *name, FILE **pInStream) +{ + CHK( fclose(*pInStream) ); + CHK( remove( name ) ); + return 0; +} + +static int get_num(FILE *stream, double *px) +{ + char buf[BUFSZ]; + + if (fgets(buf, BUFSZ, stream) == NULL) + return 1; /* end of file or error */ + if (buf[strlen(buf)-1] == '\n') + buf[strlen(buf)-1] = '\0'; + if ( string2double(buf, px) != 0) + return 1; + return 0; +} diff --git a/stripchart.c b/stripchart.c new file mode 100644 index 0000000..f995c98 --- /dev/null +++ b/stripchart.c @@ -0,0 +1,682 @@ +/* + stripchart - tools for quick & dirty data plotting. + Copyright (C) 2008, William Trevor King + + 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, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA + 02111-1307, USA. + + The author may be contacted at <wking@drexel.edu> on the Internet, or + write to Trevor King, Drexel University, Physics Dept., 3141 Chestnut St., + Philadelphia PA 19104, USA. + + + Plot simple (hopefully fast) strip charts. + X bits from Xlib tutorial by Ch. Tronche (http://tronche.lri.fr:8000/) + see http://tronche.com/gui/x/xlib/ + and http://tronche.com/gui/x/xlib-tutorial/2nd-program-anatomy.html + + Double buffering code following Mark Vojkovich + http://www.xfree86.org/~mvojkovi/skull.tar.gz + */ + +#include <pthread.h> /* to adapt to user input */ +#include <stdlib.h> +#include <stdio.h> +#include <string.h> /* strlen */ +//#include <plot.h> /* This is "plot.h", the public header file for GNU libplot, +// a shared library for 2-dimensional vector graphics */ +#include <X11/Xthreads.h> /* since the callback thread and the main thread both call X */ +#include <X11/Xlib.h> +#include <X11/Xatom.h> /* X datatypes, XA_STRING */ +#include <X11/Xutil.h> /* XTextProperty, XParseGeometry */ +#include "err_mac.h" +#include "stripchart.h" + +//#define VERBOSE_LOCKING +//#define DEBUGGING_MODE /* Synchronize X */ +#define USE_COLORS /* Non-monochrome output */ +#define USE_DOUBLE_BUFFER /* Write to a pixmap first to reduce screen redraw flicker */ +#define ENABLE_AUTOSCALE /* Calculate minX and minY from the data on mouse-clicks. */ +#define WARN_WHEN_OOB /* Generate some kind of warning output when out of bounds. */ + +#ifdef ENABLE_AUTOSCALE +#include <math.h> /* floor(), ceil() */ +#endif + +struct stripchart_struct { + double minY; + double maxY; + double *data; /**< 1-D circular buffer of points */ + int points; /**< length of the buffer */ + int active_points; /**< while the buffer is still filling */ + int current_point; /**< our place in the buffer */ +#ifdef ENABLE_AUTOSCALE + double scale_res; +#endif + + /* display information for X */ + Display *display; + int screen; + int depth; + Window rootwindow; + Window window; + XID drawable; /* either window or buffer, depending on use of double buffering */ + GC gc; /**< graphics context */ + char *title; + int ulx; + int uly; + unsigned int width; + unsigned int height; + int point_radius; /* in pixels */ + int axes_on; + XFontStruct *font; + int blackpixel; + int whitepixel; +#ifdef USE_COLORS + XColor greenx, green; /* The X server and screen's respective takes on green */ +#ifdef WARN_WHEN_OOB + XColor redx, red; +#endif /* WARN_WHEN_OOB */ +#endif /* USE_COLORS */ +#ifdef USE_DOUBLE_BUFFER + Pixmap buffer; + GC copy_gc; +#endif + /* pthread information so we can have a callback thread */ + pthread_mutex_t lock; + int stop; + /* done signal, so main thread can lock until callback wraps up? */ + + /* derived quantites to avoid repead calculations */ + double xscale; /* pxls between x values */ + double yscale; /* pxls between per unit y */ +}; + +/* Chart logic function */ +static int scale(stripchart_t *chart); +static int autoscale(stripchart_t *chart); +static int draw(stripchart_t *chart); + +/* X setup and drawing functions */ +static int setup_X (stripchart_t *chart); +static int close_X (stripchart_t *chart); +static int set_title(stripchart_t *chart); +static int get_font(stripchart_t *chart); +#ifdef USE_COLORS +static int get_color(stripchart_t *chart, char *color_name, XColor *cx, XColor *c); +#endif +static int clear_window(stripchart_t *chart); +static int draw_point(stripchart_t *chart, int x, float y); +static int draw_axes(stripchart_t *chart); +static int flush_window(stripchart_t *chart); + +/* Callback functions */ +static int setup_callback_thread(stripchart_t *chart); +static void *callback_thread(void *arg /* chart */); +static int wakeup_callback_thread(stripchart_t *chart); + +/* Synchronization functions */ +static int lock_chart(stripchart_t *chart); +static int unlock_chart(stripchart_t *chart); + +int stripchart_create(stripchart_t **pChart, + char *title, + char *geometry, /* eg "570x570+0+0" for upper left*/ + double minY, double maxY, + double scale_res, /* only read if ENABLE_AUTOSCALE */ + int points_shown_at_once, + int axes_on) +{ + stripchart_t *chart; + int rc; + + AST(pChart != NULL); + AST(*pChart == NULL); + AST(geometry != NULL); + AST(maxY > minY); + AST(points_shown_at_once >= 1); + + chart = (stripchart_t *)malloc(sizeof(stripchart_t)); + *pChart = chart; + AST(chart != NULL); + + chart->data = NULL; + chart->title = NULL; + chart->font = NULL; + + chart->minY = minY; + chart->maxY = maxY; +#ifdef ENABLE_AUTOSCALE + chart->scale_res = scale_res; +#endif + chart->points = points_shown_at_once; + chart->data = (double *)malloc(sizeof(double)*chart->points); + AST(chart->data != NULL); + chart->active_points = 0; + chart->current_point = 0; + + chart->title = title; + /* Set geometry defaults */ + chart->width=500; + chart->height=200; + chart->ulx=0; + chart->uly=0; + /* Parse geometry, rc is bitmask saying which were set */ + rc = XParseGeometry(geometry, &chart->ulx, &chart->uly, + &chart->width, &chart->height); + chart->point_radius = 2; + chart->axes_on = axes_on; + CHK( scale(chart) ); + CHK( setup_X (chart) ); + CHK( setup_callback_thread (chart) ); + + return SUCCESS; +} + +/* needs a locked chart */ +static int scale(stripchart_t *chart) +{ + /* xpxl = xscale * xindex , so (points-1) all the way on the right */ + chart->xscale = ((double)chart->width)/((double)chart->points-1.0); + /* ypxl = yscale * (y-ymax), so ymax = 0, ymin = height */ + chart->yscale = ((double)chart->height)/(chart->minY - chart->maxY); + return SUCCESS; +} + +#ifdef ENABLE_AUTOSCALE +/* needs a locked chart */ +static int autoscale(stripchart_t *chart) +{ + double dataMax, dataMin; + int i; + + /* Ensure we have some data */ + if (chart->active_points == 0) + return SUCCESS; + /* Find the extreme data points */ + dataMax = dataMin = chart->data[0]; + for (i=1; i < chart->active_points; i++) { + if (chart->data[i] > dataMax) + dataMax = chart->data[i]; + else if (chart->data[i] < dataMin) + dataMin = chart->data[i]; + } + /* round out to units of scale_res */ + chart->maxY = ceil(dataMax/chart->scale_res)*chart->scale_res; + chart->minY = floor(dataMin/chart->scale_res)*chart->scale_res; + + return SUCCESS; +} +#endif /* def ENABLE_AUTOSCALE */ + +/* needs a locked chart */ +static int draw(stripchart_t *chart) +{ + int i, j; + + CHK( clear_window(chart) ); + /* dots */ + j = chart->current_point; + for (i=0; i != chart->active_points; i++) + CHK( draw_point(chart, i, chart->data[(j++)%chart->points]) ); + + if (chart->axes_on) + CHK( draw_axes(chart) ); + CHK( flush_window(chart) ); + + return SUCCESS; +} + +int stripchart_point(stripchart_t *chart, double value) +{ + int i, j; + + AST( chart != NULL ); + CHK( lock_chart(chart) ); + + /* Add point */ + if (chart->active_points != chart->points) { /* no overwrite */ + chart->data[chart->active_points++] = value; + } else { /* overwite an old point */ + chart->data[chart->current_point++] = value; + chart->current_point %= chart->points; + } + CHK(draw(chart)); + CHK( unlock_chart(chart) ); + + return SUCCESS; +} + +int stripchart_destroy(stripchart_t **pChart) +{ + stripchart_t *chart; + + AST(pChart != NULL); + chart = *pChart; + CHK( lock_chart(chart) ); + chart = *pChart; + *pChart = NULL; + if (chart != NULL) { + chart->stop = TRUE; + } + CHK( unlock_chart(chart) ); + CHK( wakeup_callback_thread(chart) ); + return SUCCESS; +} + +/* called by the callback_thread + * when it sees that it is stop time */ +static int cleanup(stripchart_t *chart) +{ + AST(chart != NULL); + if (chart->data != NULL) + free(chart->data); + close_X(chart); + free(chart); + return SUCCESS; +} + +/* X setup and drawing functions */ + +static int setup_X (stripchart_t *chart) +{ + XEvent event; + XSizeHints hints = {0}; +#ifdef USE_DOUBLE_BUFFER + XGCValues vals; +#endif + + /* Make X safe for threads */ + AST(XInitThreads() != 0); + + /* link to a display */ + chart->display = XOpenDisplay(NULL); /* argument? */ + if (chart->display == NULL) { + fprintf(stderr, "Error connecting to %s\n", XDisplayName(NULL)); + AST(chart->display != NULL); + } + +#ifdef DEBUGGING_MODE + XSynchronize(chart->display, 1); +#endif + + chart->screen = DefaultScreen(chart->display); + chart->depth = DefaultDepth(chart->display, chart->screen); + chart->rootwindow = DefaultRootWindow(chart->display); + /* get some colors */ + chart->blackpixel = BlackPixel(chart->display, chart->screen); + chart->whitepixel = WhitePixel(chart->display, chart->screen); + + /* create a window, window border != window manager's border */ + chart->window = XCreateSimpleWindow(chart->display, chart->rootwindow, + chart->ulx, chart->uly, chart->width, chart->height, + 0 /* border width */, + chart->blackpixel /* border color */, + chart->blackpixel /* bg color */); + AST( chart->window ); +#ifdef USE_DOUBLE_BUFFER + chart->buffer = XCreatePixmap(chart->display, chart->rootwindow, + chart->width, chart->height, chart->depth); + AST( chart->buffer ); + chart->drawable = chart->buffer; +#else + chart->drawable = chart->window; +#endif + + CHK( set_title(chart) ); + //XMoveWindow(chart->display, chart->window, -1,-1); + + /* we want MapNotify events for + * Structural events: window has appeared on the screen (been mapped), + * resized, moved, etc. + * Exposure events: server lost information about the contents of a window + * ButtonPress : mouse button clicked on window + */ +#ifdef ENABLE_AUTOSCALE + XSelectInput(chart->display, chart->window, + StructureNotifyMask | + ExposureMask | + ButtonPressMask); +#else + XSelectInput(chart->display, chart->window, + StructureNotifyMask | + ExposureMask); +#endif + /* Map the window (make it appear on the screen) */ + XMapWindow(chart->display, chart->window); + + /* Create a "Graphics Context" + * X is stateless, so the server doesn't remember attributes + * like drawing color, the thickness of the lines and so on. + * We have to pass these parameters to the server on each drawing request. + * To avoid passing two dozens of parameters, many of them unchanged, + * X uses an object called the Graphics Context, or GC for short. + */ + chart->gc = XCreateGC(chart->display, chart->drawable, 0, NULL); + +#ifdef USE_COLORS + CHK( get_color(chart, "green", &chart->greenx, &chart->green) ); +#ifdef WARN_WHEN_OOB + CHK( get_color(chart, "red", &chart->redx, &chart->red) ); +#endif /* WARN_WHEN_OOB */ +#endif /* USE_COLORS */ +#ifdef USE_DOUBLE_BUFFER + /* turn off GraphicsExpose events for XCopyArea() requests */ + vals.graphics_exposures = False; + chart->copy_gc = XCreateGC(chart->display, chart->window, GCGraphicsExposures, &vals); +#endif + /* Prepare to draw with a white color */ + XSetForeground(chart->display, chart->gc, chart->whitepixel); + /* leave other parameters at their default values */ + if (chart->axes_on) + CHK( get_font(chart) ); + + /* Wait for a MapNotify event */ + for (;;) { + XNextEvent(chart->display, &event); + if (event.type == MapNotify) + break; + } + + return SUCCESS; +} + +static int close_X(stripchart_t *chart) +{ + XDestroyWindow(chart->display, chart->window); + XFreePixmap(chart->display, chart->window); + XFreeGC(chart->display, chart->gc); +#ifdef USE_DOUBLE_BUFFER + XFreeGC(chart->display, chart->copy_gc); +#endif + if (chart->font != NULL) + XFreeFontInfo(NULL, chart->font, 1); + /* free (char **names, XFontStruct *free_info, int actual_count) ? */ + XCloseDisplay(chart->display); +} + +static int set_title(stripchart_t *chart) +{ + XTextProperty windowName; + windowName.value = (unsigned char *) chart->title; + windowName.encoding = XA_STRING; + windowName.format = 8; + windowName.nitems = strlen((char *) windowName.value); + + /* request a title from the windows manager */ + XSetWMName(chart->display, chart->window, &windowName); + + return SUCCESS; +} + +static int get_font(stripchart_t *chart) +{ + GContext gcont; + + gcont = XGContextFromGC(chart->gc); + chart->font = XQueryFont(chart->display, gcont); + + return SUCCESS; +} + +#ifdef USE_COLORS +static int get_color(stripchart_t *chart, char *color_name, XColor *cx, XColor *c) +{ + Colormap colormap; + + //AST( XLookupColor(chart->display, colormap, color_name, + // NULL, &green_col) != 0 ); + + if (DisplayPlanes(chart->display, chart->screen) != 1) { + colormap = DefaultColormap(chart->display, chart->screen); + if (XAllocNamedColor(chart->display, colormap, color_name, cx, c)) { + /* use colors (how do I free the named color?) */ + /* cx is the idealized color, c is the best the current screen can do */ + //XSetForeground(chart->display, chart->gc2, color_screen.pixel); + return SUCCESS; + } + } + /* just use white */ + cx->pixel = chart->whitepixel; + c->pixel = chart->whitepixel; + + return FAILURE; +} +#endif /* def USE_COLORS */ + +static int clear_window(stripchart_t *chart) +{ + int x, y; +#ifdef USE_DOUBLE_BUFFER + XSetForeground(chart->display, chart->gc, chart->blackpixel); + XFillRectangle(chart->display, chart->buffer, chart->gc, 0, 0, chart->width, chart->height); + XSetForeground(chart->display, chart->gc, chart->whitepixel); + /* Send the requests to the server */ + //XFlush(chart->display); +#else + XClearWindow(chart->display, chart->window); +#endif + return SUCCESS; +} + +static int flush_window(stripchart_t *chart) +{ +#ifdef USE_DOUBLE_BUFFER + /* XCopyArea(display, src, dest, gc, src_x, src_y, width, height, dest_x, dest_y) */ + XCopyArea(chart->display, chart->buffer, chart->window, chart->copy_gc, 0, 0, + chart->width, chart->height, 0, 0); + XFlush(chart->display); +#else + XFlush(chart->display); +#endif + return SUCCESS; +} + +static int draw_point(stripchart_t *chart, int x, float y) +{ + int xpxl, ypxl; + /* find the center of the circle in pixels */ + xpxl = (int) (chart->xscale * (float)x); + ypxl = (int) (chart->yscale * (y - chart->maxY)); + +#ifdef WARN_WHEN_OOB +#ifdef USE_COLORS + if (y > chart->maxY) { + ypxl = 0; /* draw red point at the top of the screen */ + XSetForeground(chart->display, chart->gc, chart->red.pixel); + } else if (y < chart->minY) { + ypxl = chart->height; /* draw red point at the bottom of the screen */ + XSetForeground(chart->display, chart->gc, chart->red.pixel); + } +#endif +#endif + + /* draw a circle, coords are (x,y) for upper left of bounding box + * and the height and width of the bounding box. + * Then start and stop angles in degrees * 64 + * XDrawArc and XFillArc take identical arguments, pick your favorite. + */ + XDrawArc(chart->display, chart->drawable, chart->gc, + xpxl - chart->point_radius, ypxl - chart->point_radius, + 2*chart->point_radius, 2*chart->point_radius, + 0, 360*64); + + // XDrawLine(chart->display, chart->drawable, chart->gc, 10, 60, 180, 20); + +#ifdef WARN_WHEN_OOB +#ifdef USE_COLORS + XSetForeground(chart->display, chart->gc, chart->whitepixel); +#endif +#endif + + return SUCCESS; +} + +static int draw_axes(stripchart_t *chart) +{ + char buffer[80] = {0}; + +#ifdef USE_COLORS + XSetForeground(chart->display, chart->gc, chart->green.pixel); +#endif + /* lable y-max in upper left */ + sprintf(buffer, "%g", chart->maxY); + XDrawString(chart->display, chart->drawable, chart->gc, + 0,0+chart->font->ascent,buffer,strlen(buffer)); + + /* label y-min in lower left */ + sprintf(buffer, "%g", chart->minY); + XDrawString(chart->display, chart->drawable, chart->gc, + 0,chart->height-chart->font->descent+1, + buffer,strlen(buffer)); + + /* draw X axis */ + if (chart->maxY > 0 && chart->minY < 0) { + int ypxl = (int) (-chart->yscale * chart->maxY); + XDrawLine(chart->display, chart->drawable, chart->gc, + 0, ypxl, chart->width, ypxl); + } +#ifdef USE_COLORS + XSetForeground(chart->display, chart->gc, chart->whitepixel); +#endif + + return SUCCESS; +} + + +static int handle_X_callbacks(stripchart_t *chart) +{ + XEvent event; + + /* Wait for a Expose event (which neccessitates redrawing. */ + for (;;) { + XNextEvent(chart->display, &event); + CHK( lock_chart(chart) ); + if (chart->stop == TRUE) { + CHK( unlock_chart(chart) ); + goto done; + } + switch(event.type) { + case Expose: + CHK( draw(chart) ); + break; + case ConfigureNotify: + { + XConfigureEvent *pe = (XConfigureEvent *)&event; + chart->ulx = pe->x; + chart->uly = pe->y; + chart->width = pe->width; + chart->height = pe->height; + } +#ifdef USE_DOUBLE_BUFFER + XFreePixmap(chart->display, chart->buffer); + chart->buffer = XCreatePixmap(chart->display, chart->rootwindow, + chart->width, chart->height, chart->depth); + AST( chart->buffer != 0 ); + chart->drawable = chart->buffer; + //XClearWindow(chart->display, chart->window); /* ? */ +#endif + CHK( scale(chart) ); /* Map max and min to pixel values */ + CHK( draw(chart) ); + break; +#ifdef ENABLE_AUTOSCALE + case ButtonPress: + CHK( autoscale(chart) ); /* Calc new max and min values */ + CHK( scale(chart) ); /* Map max and min to pixel values */ + CHK( draw(chart) ); + break; +#endif + default: + break; /* ignore other events */ + } + CHK( unlock_chart(chart) ); + } + done: + return SUCCESS; +} + +/* Callback functions */ + +static int setup_callback_thread(stripchart_t *chart) +{ + pthread_t tid; + pthread_attr_t attr; + + CHK( pthread_mutex_init(&chart->lock, NULL) ); + CHK( pthread_attr_init(&attr) ); + CHK( pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED) ); + CHK( pthread_create(&tid, &attr, &callback_thread, (void *)chart) ); + CHK( pthread_attr_destroy(&attr) ); + + return SUCCESS; +} + +static void *callback_thread(void *arg /* chart */) +{ + stripchart_t *chart = (stripchart_t *)arg; + handle_X_callbacks(chart); + pthread_mutex_destroy(&chart->lock); + cleanup(chart); + return NULL; +} + +static int wakeup_callback_thread(stripchart_t *chart) +{ + XEvent event; + event.type = Expose; + /* the callback thread is blocking while waiting for events, + send it one to wake it, so it checks the stop value */ + XSendEvent (chart->display, chart->window, + FALSE, /* don't neet to propogate, we'll be listening */ + ExposureMask, + &event); + return SUCCESS; +} + +/* Synchronization functions */ + +static int lock_chart(stripchart_t *chart) +{ +#ifdef VERBOSE_LOCKING + fprintf(stderr, "Thread %lu locking %p\n", + (unsigned long int)pthread_self(), &chart->lock); +#endif + if (pthread_mutex_lock(&chart->lock) != 0) { + perror("lock"); + AST(1==0); + } +#ifdef VERBOSE_LOCKING + fprintf(stderr, "Thread %lu locked %p\n", + (unsigned long int)pthread_self(), &chart->lock); +#endif + return SUCCESS; +} + +static int unlock_chart(stripchart_t *chart) +{ +#ifdef VERBOSE_LOCKING + fprintf(stderr, "Thread %lu unlocking %p\n", + (unsigned long int)pthread_self(), &chart->lock); +#endif + if(pthread_mutex_unlock(&chart->lock) != 0) { + perror("unlock"); + AST(1==0); + } +#ifdef VERBOSE_LOCKING + fprintf(stderr, "Thread %lu unlocked %p\n", + (unsigned long int)pthread_self(), &chart->lock); +#endif + return SUCCESS; +} diff --git a/stripchart.h b/stripchart.h new file mode 100644 index 0000000..b738e09 --- /dev/null +++ b/stripchart.h @@ -0,0 +1,37 @@ +/* + stripchart - tools for quick & dirty data plotting. + Copyright (C) 2008, William Trevor King + + 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, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA + 02111-1307, USA. + + The author may be contacted at <wking@drexel.edu> on the Internet, or + write to Trevor King, Drexel University, Physics Dept., 3141 Chestnut St., + Philadelphia PA 19104, USA. + */ + +typedef struct stripchart_struct stripchart_t; + +extern int stripchart_create(stripchart_t **pChart, + char *title, + char *geometry, /* eg "570x570+0+0" for upper left*/ + double minY, double maxY, + double scale_res, + int points_shown_at_once, + int axes_on); + +extern int stripchart_point(stripchart_t *chart, double value); + +extern int stripchart_destroy(stripchart_t **pChart); diff --git a/test b/test new file mode 100755 index 0000000..02596d0 --- /dev/null +++ b/test @@ -0,0 +1,13 @@ +#!/bin/bash + +mkfifo strip_pipe + +stripchart -t 'Test stripchart' -u -M 16 -m -10 -n11 & + +cat test.dat | while read LINE + do + echo $LINE > strip_pipe + sleep 1 +done + +rm -f strip_pipe diff --git a/test.dat b/test.dat new file mode 100644 index 0000000..65bdc90 --- /dev/null +++ b/test.dat @@ -0,0 +1,19 @@ +0 +1 +2 +4 +8 +16 +-10 +1e1 +-5.5 +4.3 +1.2 +0 +1 +-2 +4 +-8 +10 +0 +q diff --git a/test.sh b/test.sh new file mode 100755 index 0000000..0b9e463 --- /dev/null +++ b/test.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +mkfifo strip_pipe + +./stripchart -t 'Test stripchart' -u -M 16 -m -10 -n11 & + +cat test.dat | while read LINE + do + echo $LINE > strip_pipe + sleep 1 +done + +rm -f strip_pipe