# HG changeset patch # User David Barts # Date 1594954643 25200 # Node ID e0efe78481303bb412d264608cacc7c59c024eca Initial commit. Untested! diff -r 000000000000 -r e0efe7848130 .hgignore --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.hgignore Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,7 @@ +~$ +\.bak$ +\.class$ +\.dylib$ +\.o$ +^bundles/ +^work/ diff -r 000000000000 -r e0efe7848130 License.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/License.txt Thu Jul 16 19:57:23 2020 -0700 @@ -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 -r 000000000000 -r e0efe7848130 Makefile.docs --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Makefile.docs Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,21 @@ +.PHONY: clean + +all: Readme.rst Readme.pdf + +clean: + -rm *.rst *.pdf *.ps *.nrf + +%.rst : %.html + echo "[This file automatically generated by pandoc from '$<'.]" > $@ + echo "" >> $@ + pandoc --from=html --to=rst $< >> $@ + +%.nrf : %.html + echo ".so custom.tmac" > $@ + pandoc --from=html --to=ms $< | sed -e 's/^\.LP/.PP/' -e 's/^\.SH/.MYSH/' >> $@ + +%.ps: %.nrf custom.tmac + groff -Tps -t -ms $< > $@ + +%.pdf : %.ps + ps2pdf $< diff -r 000000000000 -r e0efe7848130 Readme.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Readme.html Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,58 @@ + + + + + ImagePrep Read Me + + + +

ImagePrep Read Me

+

This is a simple program mainly created for my own benefit.

+

Because it is primarily for my own benefit, it does not build to a + “clickable” app. That is too much of a pain to implement.

+

Because I have code to crib, it does contain a help file. It’s pretty + rudimentary, however.

+

Because I have code to crib, it does run on a .preferences + file, but because coding preferences dialogs is something of a pain, it + does not contain a preferences or settings dialog, even though there is + some code to crib for both. The .preferences file must be + edited by hand* (it will live in the normal place for such files on the + system being run under). If no such file exists, a default one will be + created. The only things in it will be the maximum dimension to clamp to, + where the output file goes by default, and maybe what the output file’s + name is by default (i.e. a name suffix).

+

* This program is for my own benefit, and I have no + problem editing text files, therefore this is reasonable.

+

Contrary to JpegWasher, which is designed for batch processing, this will + have more of a “document editor” style of design. Meaning, you open a + file, you edit it, you save it, you close it.

+

Upon opening a file, it will be auto-scaled to the specified maximum + dimension. This will default to the value in the preferences file, but the + user will be able to change it at open time.

+

At that point, the editing step begins. It is extremely simple and is + limited to rotation. Three types of rotation will be offered, 90° + clockwise, 180°, and 90° counterclockwise.

+

The user can rotate the file as many times as s/he wants. Sort of silly, + but sometimes people are tired and get clockwise and counterclockwise + confused, so might as well give ’em a chance to fix their mistakes. Plus, + it would take special effort not to allow this.

+

Then comes the closing and saving. It might make the most sense + to wrap these two up into one operation, given that there are two + operations in one when one opens the thing, too*. (Sort of a compromise + between a classic “document editor” design and a batch-processing design.) + This will default to the name and directory consistent with the + preferences settings, but it will be based around a file dialog so that + the user can save the resized image anyplace, with any name.

+

* Leaning towards making “close & save” one operation; again, this + program is primarily for my benefit.

+

Ideally, I wouldn’t even puts around with making this a GUI app in the + first place. It’s for my own use, so the command line would be good + enough. The problem is rotation: it’s a hot mess. There’s really no way to + do it right save to show the image to a human and let him (me) decide + which way is up.

+ + diff -r 000000000000 -r e0efe7848130 build.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/build.xml Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,125 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + You can use the following targets: + + help : (default) Prints this message + all : Cleans, compiles, and stages application + clean : Deletes work directories + compile : Compiles servlets into class files + jar : Make JAR file. + + For example, to clean, compile, and package all at once, run: + prompt> ant all + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff -r 000000000000 -r e0efe7848130 custom.tmac --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/custom.tmac Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,18 @@ +.fam N \" Century Schoolbook. +.po 1.25i \" Balance the margins. +.nr PI 2n \" More reasonable paragraph indent. +.nr PS 10 +.nr GROWPS 3 \" Use vari-sized heading texts. +.nr PSINCR 2p \" Ditto. +.de MYSH \" Set headings in Avant Garde Bold. +.SH \\$1 +.ft AB +.. +.de pdfhref +.if '\\$1'W' \{\ +\\$7\\** +.FS +\\$3 +.FE +.\} +.. diff -r 000000000000 -r e0efe7848130 setup.cmd --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/setup.cmd Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,44 @@ +@echo off +rem -*- coding: windows-1252 -*- + +rem Basic directory stuff, edit as needed. +set JAVA_TOOL_OPTIONS=-Dfile.encoding=UTF8 +set JRE_HOME=C:\Program Files\Java\jdk1.8.0_241 +set KOTLIN_HOME=C:\Users\David Barts\java\kotlin-compiler-1.3.71\kotlinc +set ANT_HOME=C:\Users\David Barts\java\apache-ant-1.10.7 +set EXIV2_HOME=C:\Users\David Barts\Downloads\exiv2-0.27.2-2017msvc64\exiv2-0.27.2-2017msvc64 +set LAUNCH4J_HOME=C:\Program Files (x86)\Launch4j +set OSDEP_HOME=..\Osdep + +rem For each directory, fix PATH if needed. +call :fixpath "%JRE_HOME%" +call :fixpath "%KOTLIN_HOME%" +call :fixpath "%ANT_HOME%" +exit/b 0 + +rem The rest of this file probably won't need changing. + +rem Subroutine to fix up path, if needed. So we don't mindlessly grow +rem PATH. +:fixpath +set bindir=%~1\bin +if not exist "%bindir%\" goto amf +set p2=%path% +:loop + for /f "tokens=1* delims=;" %%A in ("%p2%") do ( + set first=%%A + set rest=%%B + ) + if "%first%"=="%bindir%" goto amf + if "%rest%"=="" goto notfound + set p2=%rest% + goto loop +:notfound +echo Adding "%bindir%" to PATH. +set path=%bindir%;%path% +:amf +set bindir= +set p2= +set first= +set rest= +exit/b 0 diff -r 000000000000 -r e0efe7848130 setup.sh --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/setup.sh Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,12 @@ +#!/bin/bash + +export JRE_HOME="$(/usr/libexec/java_home)" +export KOTLIN_HOME="/usr/local/Cellar/kotlin/1.3.71/libexec" +export EXIV2_HOME="$HOME/temp/exiv2/exiv2-0.27.2-Source" +export OSDEP_HOME="../Osdep" + +export ANT_HOME="$HOME/java/apache-ant-1.10.1" +if [[ "$PATH" != *$ANT_HOME/bin* ]] +then + export PATH="$ANT_HOME/bin:$PATH" +fi diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Files.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Files.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,99 @@ +/* + * For dealing with files. + */ +package name.blackcap.imageprep + +import java.io.BufferedReader +import java.io.File +import java.io.FileInputStream +import java.io.InputStreamReader +import java.util.Properties +import java.util.logging.FileHandler +import java.util.logging.Level +import java.util.logging.Logger +import java.util.logging.SimpleFormatter + +/* OS Type */ + +enum class OS { + MAC, UNIX, WINDOWS, OTHER; + companion object { + private val rawType = System.getProperty("os.name")?.toLowerCase() + val type = if (rawType == null) { + OTHER + } else if (rawType.contains("win")) { + WINDOWS + } else if (rawType.contains("mac")) { + MAC + } else if (rawType.contains("nix") || rawType.contains("nux") || rawType.contains("aix") || rawType.contains("sunos")) { + UNIX + } else { + OTHER + } + } +} + +/* joins path name components to java.io.File */ + +fun joinPath(base: String, vararg rest: String) = rest.fold(File(base), ::File) + +/* file names */ + +private val SHORTNAME = "imageprep" +private val LONGNAME = "name.blackcap." + SHORTNAME +private val HOME = System.getenv("HOME") +val PF_DIR = when (OS.type) { + OS.MAC -> joinPath(HOME, "Library", "Application Support", LONGNAME) + OS.WINDOWS -> joinPath(System.getenv("APPDATA"), LONGNAME) + else -> joinPath(HOME, "." + SHORTNAME) +} +val LF_DIR = when (OS.type) { + OS.MAC -> joinPath(HOME, "Library", "Application Support", LONGNAME) + OS.WINDOWS -> joinPath(System.getenv("LOCALAPPDATA"), LONGNAME) + else -> joinPath(HOME, "." + SHORTNAME) +} +val PROP_FILE = File(PF_DIR, SHORTNAME + ".properties") +val LOG_FILE = File(LF_DIR, SHORTNAME + ".log") + +/* make some needed directories */ + +private fun File.makeIfNeeded() = if (exists()) { true } else { mkdirs() } + +/* make some usable objects */ + +val CHARSET = "UTF-8" + +private val DPNAME = "default.properties" +val DPROPERTIES = Properties().apply { + val rawStream = OS::class.java.getResourceAsStream(DPNAME) + BufferedReader(InputStreamReader(rawStream, CHARSET)).use { + load(it) + } +} + +val PROPERTIES = Properties(DPROPERTIES).apply { + PF_DIR.makeIfNeeded() + if (PROP_FILE.exists()) { + BufferedReader(InputStreamReader(FileInputStream(PROP_FILE), CHARSET)).use { + load(it) + } + } else { + FileOutputStream(PROP_FILE).use { output -> + OS::class.java.getResourceAsStream(DPNAME).use { input -> + input.copyTo(output) + } + } + } +} + +val LOGGER = run { + System.setProperty("java.util.logging.SimpleFormatter.format", + "%1\$tFT%1\$tT%1\$tz %2\$s%n%4\$s: %5\$s%6\$s%n") + LF_DIR.makeIfNeeded() + Logger.getLogger(LONGNAME).apply { + addHandler(FileHandler(LOG_FILE.toString()).apply { + formatter = SimpleFormatter() }) + level = Level.CONFIG + useParentHandlers = false + } +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/HelpDialog.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/HelpDialog.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,104 @@ +/* + * The dialog that displays the Exif data in a single file (display only, + * no changing). We do this after washing. + */ +package name.blackcap.imageprep + +import java.awt.Dimension +import java.awt.Font +import java.awt.event.ActionEvent +import java.awt.event.ActionListener +import java.io.BufferedReader +import java.io.File +import java.io.IOException +import java.io.InputStream +import java.io.InputStreamReader +import java.util.logging.Level +import java.util.logging.Logger +import javax.swing.* +import javax.swing.text.html.HTMLEditorKit +import javax.swing.text.html.StyleSheet +import kotlin.text.buildString + +class HelpDialog : JDialog(Application.mainFrame) { + private val BW = 9 + private val BW2 = BW * 2 + private val WIDTH = 640 + private val HEIGHT = 480 + + private val dismissButton = JButton("Dismiss").also { + it.addActionListener(ActionListener { setVisible(false) }) + } + + /* + * The stock HTMLEditorKit shares all style sheet data between all its + * instances. How unbelievably braindamaged. Correct that. + */ + private class MyEditorKit: HTMLEditorKit() { + private var _styleSheet: StyleSheet = defaultStyleSheet + override fun getStyleSheet() = _styleSheet + override fun setStyleSheet(value: StyleSheet) { + _styleSheet = value + } + + /** + * Return the default style sheet that all HTMLEditorKit's come with. + */ + val defaultStyleSheet: StyleSheet + get() { + return super.getStyleSheet() + } + } + + private val helpPane = JScrollPane(JTextPane().also { + it.editorKit = MyEditorKit().also { ek -> + UIManager.getFont("Panel.font")?.let { pFont -> + ek.styleSheet = StyleSheet().apply { + addRule("body { font-family: \"${pFont.family}\"; font-size: ${pFont.size}; }") + addStyleSheet(ek.defaultStyleSheet) + } + } + } + val rawText = this::class.java.getResourceAsStream("help.html").bufferedReader().use { it.readText() } + it.text = rawText.replace("%CONFIG_FILE_NAME%", buildString { + for (ch in PROP_FILE.canonicalPath) { + append(when(ch) { + "<" -> "<" + ">" -> ">" + "&" -> "&" + else -> ch + }) + } + }) + it.setEditable(false) + }).apply { + alignmentX = JScrollPane.CENTER_ALIGNMENT + addBorder(BorderFactory.createEmptyBorder(BW2, BW2, BW, BW2)) + verticalScrollBarPolicy = ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS + horizontalScrollBarPolicy = ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER + preferredSize = Dimension(WIDTH, HEIGHT) + background = Application.mainFrame.background + } + + override fun setVisible(vis: Boolean) { + if (vis) + helpPane.verticalScrollBar.run { value = minimum } + super.setVisible(vis) + } + + init { + setVisible(false) + title = "Help" + contentPane.apply { + layout = BoxLayout(this, BoxLayout.Y_AXIS) + add(helpPane) + add(Box(BoxLayout.X_AXIS).apply { + alignmentX = Box.CENTER_ALIGNMENT + border = BorderFactory.createEmptyBorder(BW, BW2, BW2, BW2) + add(Box.createHorizontalGlue()) + add(dismissButton) + }) + } + pack() + } +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Main.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Main.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,36 @@ +/* + * Entry point, etc. + */ +package name.blackcap.imageprep + +import javax.swing.UIManager +import java.util.logging.Level +import java.util.logging.Logger + +object Application { + /* name we call ourselves */ + val MYNAME = "ImagePrep" + + /* global UI objects */ + var mainFrame: MainFrame by setOnce() + var helpDialog: HelpDialog by setOnce() + + fun initialize() { + UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName()); + mainFrame = MainFrame() /* must be created first */ + mainFrame.jMenuBar = MyMenuBar() + setMacMenus() /* always safe to call; no-op if not a Mac */ + helpDialog = HelpDialog() + mainFrame.setVisible(true) + } +} + +fun main(args: Array) { + LOGGER.log(Level.INFO, "beginning execution") + if (OS.type == OS.MAC) { + System.setProperty("apple.laf.useScreenMenuBar", "true") + } + inSwingThread { + Application.initialize() + } +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/MainFrame.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/MainFrame.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,78 @@ +/* + * The main application window. + */ +package name.blackcap.imageprep + +import java.awt.Dimension +import java.awt.datatransfer.DataFlavor +import java.awt.datatransfer.Transferable +import java.awt.datatransfer.UnsupportedFlavorException +import java.awt.event.WindowEvent +import java.awt.event.WindowListener +import java.io.File +import java.io.IOException +import java.util.logging.Level +import java.util.logging.Logger +import javax.swing.* +import javax.imageio.ImageIO + +/* the main frame itself */ +class MainFrame : JFrame(Application.MYNAME) { + /* default size */ + val WIDTH = 512 + val HEIGHT = 384 + + /* does a system exit when needed */ + private class KillIt() : WindowListener { + /* events we don't care about */ + override fun windowActivated(e: WindowEvent) {} + override fun windowClosed(e: WindowEvent) {} + override fun windowDeactivated(e: WindowEvent) {} + override fun windowDeiconified(e: WindowEvent) {} + override fun windowIconified(e: WindowEvent) {} + override fun windowOpened(e: WindowEvent) {} + + /* and the one we do */ + override fun windowClosing(e: WindowEvent) { + LOGGER.log(Level.INFO, "execution complete") + System.exit(0) + } + } + + /* acts on dragged files */ + private class MyTransferHandler : TransferHandler() { + override fun canImport(support: TransferHandler.TransferSupport): Boolean { + return support.isDataFlavorSupported(DataFlavor.javaFileListFlavor) + } + + override fun importData(support: TransferHandler.TransferSupport): Boolean { + if (!canImport(support)) { + return false + } + val files = try { + support.transferable.getTransferData(DataFlavor.javaFileListFlavor) as List + } catch (e: UnsupportedFlavorException) { + return false + } catch (e: IOException) { + return false + } + for (file in files) { + RotateDialog.makeDialog(file) + } + return true + } + } + + init { + contentPane.add( + JLabel("Drag image files into this window or choose File… Open & Scale from menu.").apply { + horizontalAlignment = JLabel.CENTER + verticalAlignment = JLabel.CENTER + }) + preferredSize = Dimension(WIDTH, HEIGHT) + transferHandler = MyTransferHandler() + pack() + addWindowListener(KillIt()) + } +} + diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Menus.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Menus.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,170 @@ +/* + * Menus. + */ +package name.blackcap.imageprep + +import java.awt.Graphics2D +import java.awt.RenderingHints +import java.awt.Window +import java.awt.event.ActionEvent +import java.awt.event.ActionListener +import java.awt.event.KeyEvent +import java.awt.image.BufferedImage +import java.io.File +import java.util.logging.Level +import java.util.logging.Logger +import javax.imageio.IIOImage +import javax.imageio.ImageIO +import javax.imageio.ImageWriteParam +import javax.imageio.ImageWriter +import javax.imageio.stream.ImageOutputStream +import javax.swing.* + +/** + * Our menu bar. What we display depends somewhat on the system type, as + * the Mac gives us a gratuitous menu bar entry for handling some stuff. + */ +class MyMenuBar: JMenuBar() { + init { + add(JMenu("File").apply { + add(JMenuItem("Open & Scale…").apply { + addActionListener(ActionListener { doOpen() }) + makeShortcut(KeyEvent.VK_O) + }) + add(JMenuItem("Discard").apply { + addActionListener(ActionListener { doDiscard() }) + }) + add(JMenuItem("Save & Close…").apply { + addActionListener(ActionListener { doClose() }) + makeShortcut(KeyEvent.VK_S) + }) + if (OS.type != OS.MAC) { + add(JMenuItem("Preferences…").apply { + addActionListener(ActionListener { + Application.settingsDialog.setVisible(true) + }) + makeShortcut(KeyEvent.VK_COMMA) + }) + add(JMenuItem("Quit").apply { + addActionListener(ActionListener { + LOGGER.log(Level.INFO, "execution complete") + System.exit(0) + }) + makeShortcut(KeyEvent.VK_Q) + }) + } + }) + add(JMenu("Help").apply { + if (OS.type != OS.MAC) { + add(JMenuItem("About ${Application.MYNAME}…").apply { + addActionListener(ActionListener { showAboutDialog() }) + }) + } + add(JMenuItem("${Application.MYNAME} Help…").apply { + addActionListener(ActionListener { Application.helpDialog.setVisible(true) }) + }) + }) + } + + fun getMenu(name: String): JMenu? { + subElements.forEach { + val jmenu = it.component as? JMenu + if (jmenu?.text == name) { + return jmenu + } + } + return null + } + + private fun doOpen() { + val chooser = JFileChooser().apply { + fileFilter = FileNameExtensionFilter("Image files", ImageIO.getReaderFileSuffixes()) + } + if (chooser.showOpenDialog(Application.mainFrame) == JFileChooser.APPROVE_OPTION) { + RotateDialog.makeDialog(chooser.selectedFile) + } + } + + private fun doDiscard() { + val w = FocusManager.currentManager.activeWindow as? RotateDialog + if (w == null) { + Toolkit.defaultToolkit.beep() + return + } + w.setVisible(false) + w.dispose() + } + + private fun doClose() { + val w = FocusManager.currentManager.activeWindow as? RotateDialog + if (w == null) { + Toolkit.defaultToolkit.beep() + return + } + val outName = splitext(w.file.name).first + Settings.outputSuffix + ".jpg" + val chooser = JFileChooser(w).apply { + selectedFile = File( + if (Settings.outputToInputDir) w.file.parent else Settings.outputTo, + outName) + } + if (chooser.showOpenDialog(Application.mainFrame) != JFileChooser.APPROVE_OPTION) { + return + } + val (name, ext) = splitext(chooser.selectedFile.name) + val file = if (ext.toLowerCase() in setOf(".jpg", ".jpeg")) { + chooser.selectedFile + } else { + File(chooser.selectedFile.parent, name + ".jpg") + } + if (file.exists() && JOptionPane.showConfirmDialog(w, "File ${file.name} already exists. Overwrite?", "Confirm Overwrite", JOptionPane.YES_NO_OPTION) != JOptionPane.YES_OPTION) { + return + } + w.useWaitCursor() + swingWorker { + inBackground { + try { + val ios = ImageIO.createImageOutputStream(file) + val writer = ImageIO.getImageWritersByFormatName("jpeg").next() + val iwp = writer.getDefaultWriteParam().apply { + setCompressionMode(ImageWriteParam.MODE_EXPLICIT) + setCompressionQuality(Settings.outputQuality.toFloat() / 100.0f) + } + writer.setOutput(ios) + writer.write(null, IIOImage(w.image, null, null), iwp) + null + } catch (e: IOException) { + e + } + } + whenDone { + w.useNormalCursor() + val error = get() + if (error == null) { + w.setVisible(false) + w.dispose() + } else { + ioExceptionDialog(w, file, "write", e) + } + } + } + } + + private fun splitext(s: String): Pair { + val pos = s.lastIndexOf('.') + if (pos == -1) { + return Pair(s, "") + } + return Pair(s.substring(0, pos), s.substring(pos)) + } +} + +/** + * Show an About dialog. + */ +fun showAboutDialog() { + JOptionPane.showMessageDialog(Application.mainFrame, + "\nImagePrep\n" + + "\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0© MMXX, David W. Barts\n", + "About ImagePrep", + JOptionPane.PLAIN_MESSAGE) +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Misc.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Misc.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,248 @@ +/* + * Miscellaneous utility stuff. + */ +package name.blackcap.imageprep + +import java.awt.Component +import java.awt.Cursor +import java.awt.Dimension +import java.awt.Font +import java.awt.FontMetrics +import java.awt.Graphics +import java.awt.Point +import java.awt.Toolkit +import java.awt.event.MouseEvent +import java.io.File +import java.io.IOException +import javax.swing.* +import javax.swing.border.Border +import javax.swing.table.TableColumnModel +import kotlin.annotation.* +import kotlin.properties.ReadWriteProperty +import kotlin.reflect.* + +/** + * Delegate that makes a var that can only be set once. This is commonly + * needed in Swing, because some vars inevitably need to be declared at + * outer levels but initialized in the Swing event dispatch thread. + */ +class SetOnceImpl: ReadWriteProperty { + private var setOnceValue: T? = null + + override operator fun getValue(thisRef: Any?, property: KProperty<*>): T { + if (setOnceValue == null) { + throw RuntimeException("${property.name} has not been initialized") + } else { + return setOnceValue!! + } + } + + @Synchronized + override operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T): Unit { + if (setOnceValue != null) { + throw RuntimeException("${property.name} has already been initialized") + } + setOnceValue = value + } +} + +fun setOnce(): SetOnceImpl = SetOnceImpl() + +/** + * Run something in the Swing thread, asynchronously. + * @param block lambda containing code to run + */ +fun inSwingThread(block: () -> Unit) { + SwingUtilities.invokeLater(Runnable(block)) +} + +/** + * Run something in the Swing thread, synchronously. + * @param block lambda containing code to run + */ +fun inSynSwingThread(block: () -> Unit) { + SwingUtilities.invokeAndWait(Runnable(block)) +} + +/** + * Make a shortcut for a menu item, using the standard combining key + * (control, command, etc.) for the system we're on. + * @param key KeyEvent constant describing the key + */ +fun JMenuItem.makeShortcut(key: Int): Unit { + val SC_KEY_MASK = Toolkit.getDefaultToolkit().menuShortcutKeyMask + setAccelerator(KeyStroke.getKeyStroke(key, SC_KEY_MASK)) +} + +/** + * Given a MenuElement object, get the item whose text matches the + * specified text. + * @param text to match + * @return first matched element, null if no match found + */ +fun MenuElement.getItem(name: String) : JMenuItem? { + subElements.forEach { + val jMenuItem = it.component as? JMenuItem + if (jMenuItem?.text == name) { + return jMenuItem + } + } + return null +} + +/** + * Change to the standard wait cursor. + */ +fun Component.useWaitCursor() { + this.cursor = Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR) +} + +/** + * Return back to the normal cursor(). + */ +fun Component.useNormalCursor() { + this.cursor = Cursor.getDefaultCursor() +} + +/** + * Thrown if the programmer botches something in our DSL. + */ +class SwingWorkerException(message: String): Exception(message) { } + +/** + * A simplified SwingWorker DSL. It does not support intermediate + * results. Just lets one define a background task and something + * to execute when complete. + * + * @param T Type returned by inBackground (Java doInBackground) task. + */ +class SwingWorkerBuilder: SwingWorker() { + private var inBackgroundLambda: (SwingWorkerBuilder.() -> T)? = null + private var whenDoneLambda: (SwingWorkerBuilder.() -> Unit)? = null + + private fun setOnce(prop: KMutableProperty0<(SwingWorkerBuilder.() -> U)?>, value: SwingWorkerBuilder.() -> U) { + if (prop.get() != null) { + throw SwingWorkerException(prop.name.removeSuffix("Lambda") + " already defined!") + } + prop.set(value) + } + + /** + * Define the inBackground task. + */ + fun inBackground(lambda: SwingWorkerBuilder.() -> T): Unit { + setOnce(::inBackgroundLambda, lambda) + } + + /** + * Define the whenDone task. + */ + fun whenDone(lambda: SwingWorkerBuilder.() -> Unit): Unit { + setOnce(::whenDoneLambda, lambda) + } + + /** + * Validates we've been properly initialized. + */ + fun validate(): Unit { + if (inBackgroundLambda == null) { + throw SwingWorkerException("inBackground not defined!") + } + } + + /* standard overrides for SwingWorker follow */ + + override fun doInBackground(): T = inBackgroundLambda!!.invoke(this) + + override fun done(): Unit = whenDoneLambda?.invoke(this) ?: Unit +} + +/** + * Provides for an outer swingWorker block to contain the DSL. + */ +fun swingWorker(initializer: SwingWorkerBuilder.() -> Unit): Unit { + SwingWorkerBuilder().run { + initializer() + validate() + execute() + } +} + +/** + * Close a dialog (don't just hide it). + */ +fun JDialog.close() { + setVisible(false) + dispose() +} + +/** + * Set column width of a table. + */ +fun JTable.setColWidth(col: Int, width: Int, string: String?) { + val FUZZ = 16 + columnModel.getColumn(col).preferredWidth = if (string.isNullOrEmpty()) { + width + } else { + maxOf(width, graphics.fontMetrics.stringWidth(string) + FUZZ) + } +} + +/** + * Set overall width of a table. + */ +fun JTable.setOverallWidth() { + val tcm = columnModel + val limit = tcm.columnCount - 1 + var total = 0 + for (i in 0 .. limit) { + total += tcm.getColumn(i).preferredWidth + } + preferredSize = Dimension(total, preferredSize.height) +} + +/** + * A JTable for displaying metadata. Columns that might get harmfully + * truncated have tooltips when truncation happens. + */ +class JExifTable(rowData: Array>, colNames: Array): JTable(rowData, colNames) { + override fun getToolTipText(e: MouseEvent): String? { + val pos = e.point + val col = columnAtPoint(pos) + if (!setOf("Key", "Type").contains(getColumnName(col))) { + return null + } + val contents = getValueAt(rowAtPoint(pos), col) as String? + if (contents == null) { + return null + } + val needed = graphics.fontMetrics.stringWidth(contents) + val actual = columnModel.getColumn(col).width + return if (needed > actual) contents else null + } +} + +/** + * Add a border to a JComponent. The new border is in addition to (and outside + * of) whatever existing standard border the component had. + */ +fun JComponent.addBorder(b: Border) { + if (border == null) + border = b + else + border = BorderFactory.createCompoundBorder(b, border) +} + +fun ioExceptionDialog(parent: Component, file: File, op: String, e: IOException) { + val msg = e.getMessage() + val fileName = file.getName() + val dmsg = if (msg.isNullOrEmpty()) { + "Unable to ${op} ${fileName}." + } else if (fileName in msg) { + msg + } else { + "Unable to ${op} ${fileName}:\n ${msg}" + } + JOptionPane.showMessageDialog(parent, + dmsg, "Error", JOptionPane.ERROR_MESSAGE) +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Osdep.kt.default.osdep --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Osdep.kt.default.osdep Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,8 @@ +/* + * OS-dependent code, version for all non-Mac systems. + */ +package name.blackcap.exifwasher + +fun setMacMenus() { + /* no-op */ +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Osdep.kt.mac.osdep --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Osdep.kt.mac.osdep Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,17 @@ +/* + * OS-dependent code, Mac version. + */ +package name.blackcap.exifwasher + +import com.apple.eawt.AboutHandler +import com.apple.eawt.PreferencesHandler +import com.apple.eawt.QuitStrategy + +fun setMacMenus() { + com.apple.eawt.Application.getApplication().run { + setAboutHandler(AboutHandler { showAboutDialog() }) + setPreferencesHandler( + PreferencesHandler { Application.settingsDialog.setVisible(true) }) + setQuitStrategy(QuitStrategy.CLOSE_ALL_WINDOWS) + } +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/RotateDialog.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/RotateDialog.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,143 @@ +/* + * Represents a file being edited (rotated) + */ +package name.blackcap.imageprep + +import java.awt.Graphics2D +import java.awt.RenderingHints +import java.awt.image.BufferedImage +import java.io.File +import java.io.IOException +import javax.imageio.ImageIO +import javax.swing.* +import kotlin.math.* + +class RotateDialog(val file: File, initialImage: BufferedImage) : JDialog(Application.mainFrame) { + private val BW = 9 + private val BW2 = BW * 2 + private val MINWIDTH = 512 + private val MINHEIGHT = 384 + + private class DrawingPane() : JPanel() { + var image: BufferedImage = initialImage + set(value) { + field = value + revalidate() + repaint() + } + + override val preferredSize + get { return image.preferredSize } + + protected paintComponent(g: Graphics): Unit { + g.drawImage(image, 0, 0, null) + } + } + private val drawingPane = DrawingPane() + + val image: BufferedImage + get() { return drawingPane.image } + + private val r90cw = JButton("90° CW").apply { + it.addActionListener(ActionListener { doRotate(90) }) + } + + private val r180 = JButton("180°").apply { + it.addActionListener(ActionListener { doRotate(180) }) + } + + private val r90ccw = JButton("90° CCW").apply { + it.addActionListener(ActionListener { doRotate(270) }) + } + + /* Theoretically, this should do the rotation in a background thread. + Practically, that is fraught with difficulties, as it involves + manipulating data used by Swing itself. Since the size of the images + being rotated are small, we do it in the foreground. */ + private fun doRotate(deg: Int) { + // https://stackoverflow.com/questions/15927014/rotating-an-image-90-degrees-in-java + val rad = java.lang.Math.toRadians(deg.toDouble()) + val sinx = sin(rad) + val cosx = cos(rad) + val w = floor(image.width * cosx + image.height * sinx).toInt() + val h = floor(image.height * cosx + image.width * sinx).toInt() + val rotatedImage = BufferedImage(w, h, image.type) + rotatedImage.createGraphics().run { + translate((w - image.width) / 2, (h - image.height) / 2) + rotate(rad, image.width / 2, image.height / 2) + drawRenderedImage(image, null) + dispose() + } + drawingPane.image = rotatedImage + } + + init { + defaultCloseOperation = JDialog.DISPOSE_ON_CLOSE + title = "Untitled" + contentPane.apply { + layout = BoxLayout(this, BoxLayout.Y_AXIS) + add(JScrollpane(drawingPane).apply { + alignmentX = JScrollPane.CENTER_ALIGNMENT + addBorder(BorderFactory.createEmptyBorder(BW2, BW2, BW, BW2)) + verticalScrollBarPolicy = ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS + horizontalScrollBarPolicy = ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS + background = Application.mainFrame.background + }) + add(Box(BoxLayout.X_AXIS).apply { + alignmentX = Box.CENTER_ALIGNMENT + addBorder(BorderFactory.createEmptyBorder(BW, BW2, BW2, BW2)) + add(JLabel("Rotate:")) + add(Box.createHorizontalGlue()) + add(r90cw) + add(Box.createHorizontalGlue()) + add(r180) + add(Box.createHorizontalGlue()) + add(r90ccw) + }) + } + pack() + } + + companion object Factory { + /** + * Make a dialog asynchronously. + * + * @param input java.io.File to read for image. + */ + fun makeDialog(input: File): Unit { + Application.mainFrame.useWaitCursor() + swingWorker { + inBackground { + try { + val imageIn = ImageIO.read(input) /* IOException */ + val ratio = Settings.maxDimension.toDouble() / max(imageIn.width, imageIn.height).toDouble() + if (ratio >= 1.0) { + null + } else { + val nWidth = (imageIn.width * ratio).toInt() + val nHeight = (imageIn.height * ratio).toInt() + val imageOut = BufferedImage(nWidth, nHeight, BufferedImage.TYPE_INT_RGB) + val graphics = imageOut.createGraphics().apply { + setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR) + setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY) + setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON) + } + graphics.drawImage(imageIn, 0, 0, nWidth, nHeight, null) + Pair(imageOut, null) + } + } catch (e: IOException) { + Pair(null, e) + } + } + whenDone { + Application.mainFrame.useNormalCursor() + val (image, error) = get() + if (error != null) + ioExceptionDialog(Application.mainFrame, input, "read", error) + if (image != null) + RotateDialog(input, image).title = input.getName() + } + } + } + } +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/Settings.kt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/Settings.kt Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,32 @@ +/* + * Our settings. Basically just some parsed properties. + */ +package name.blackcap.imageprep + +/* work around name shadowing */ +private val _PROPS = PROPERTIES + +object Settings { + private var homeDir = System.getProperty("user.home") + val maxDimension = _PROPS.getProperty("maxDimension").toInt() + val outputQuality = _PROPS.getProperty("outputQuality").toInt() + val outputSuffix = tilde(_PROPS.getProperty("outputSuffix")) + val outputTo = tilde(_PROPS.getProperty("outputTo")) + val outputToInputDir = strToBool(_PROPS.getProperty("outputToInputDir")) + + private fun tilde(s: String): String { + if (s.isNullOrEmpty()) + return homeDir + if (s.startsWith("~/") || s.startsWith("~\\")) + return File(homeDir, s.substring(1).trimStart('/', '\\')).toString() + else + return s + } + + private fun strToBool(s: String): Boolean { + if (s.isNullOrEmpty()) + return false + val c1 = s[0].toLowerCase() + return c1 == 't' || c1 == 'y' + } +} diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/default.properties --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/default.properties Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,24 @@ +# -*- coding: UTF-8 -*- + +# The maximum dimension the output file should have. If either the +# width or the height exceeds this number, the image will be scaled +# (preserving its aspect ratio) so that the maximum dimension is equal +# to the the following number. +maxDimension=640 + +# The quality of the output JPEG file (a JPEG is always produced), as +# an integer from 0 to 100 +outputQuality=85 + +# This is added to the name part of the file to create the default +# output file name. +outputSuffix=_scaled + +# The directory where files will be written, if outputToInputDir is not +# true. If empty, output to the home directory. If this starts with a +# tilde, the tilde will be replaced with the home directory. +outputTo= + +# If true, output files get created by default in the same place the +# input file was loaded from. +outputToInputDir=true diff -r 000000000000 -r e0efe7848130 src/name/blackcap/imageprep/help.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/name/blackcap/imageprep/help.html Thu Jul 16 19:57:23 2020 -0700 @@ -0,0 +1,21 @@ + + + + ImagePrep Help + + +

ImagePrep Help

+

Using This Program

+
    +
  1. Open the image using File… Open & Scale. As this command's name + implies, it will also scale the file to a maximum of 640 (or whatever the + defined maximum is) pixels in either dimension, preserving its aspect + ratio.
    2. +
  2. Rotate the file as needed.
    3. +
  3. Either write out the file and close it using File… Save & Close, + or discard your edits using File… Discard Edits.
    4. +
+

Configiration File

+

%CONFIG_FILE_NAME%

+ +