diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,8 @@ +ChangeLog for replaceUmlaut + +0.1.5.1 base +0.1.5.2 changes to integrate into daino and ghc 9.4.4. +0.1.5.3 report changes + removed dependency completeMeta + removed the mapp (merged with other) + updated readme etc. diff --git a/GPL_3 b/GPL_3 new file mode 100644 --- /dev/null +++ b/GPL_3 @@ -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/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ + +--- +# Replacement of ae oe ue by the UTF-8 umlaut-glyph ä ö ü + +ReplaceUmlaut processes a `txt` or `md` file (or all `md` files in a directory) and replaces the umlaut to its proper form (possibly capitalized). It uses an extensible list to avoid replacements which are not appropriate. + +## The file nichtUmlaut.txt lists exceptions +An extensible list of parts of words which contain character +combinations which should not be replaced; for example, Koeffizient. The list needs only contain parts of words (i.e. koeff) not a complete list of all words with non-replaceable combinations. + +## Command Line Use +The command `replaceUmlaut filepath` processes just the file and returns the changed file (the original is renamed with extension `bak`). +Switches: + - `-m directory` processes all `md` files in the directory. + - `-d` is a debug option; files are not changed, but a changed version is returned with extension `new`. + +## Function + +The function `procMd1` is useful to process a single `md` file in a program. The list of permitted combinations must be passed as an argument. It returns True if the file is changed. +Typical use is + +````haskell + changed <- header + then do + erl1 <- readErlaubt fnErlaubt + let addErl = dyDoNotReplace . meta1 $ doc1 + -- allow additions to the list in the YAML header + erl2 = addErl -- add erl1 + changed1 <- applyReplace debugReplace erl2 fnin + return changed1 +```` + + + + diff --git a/ReplaceUmlaut.cabal b/ReplaceUmlaut.cabal new file mode 100644 --- /dev/null +++ b/ReplaceUmlaut.cabal @@ -0,0 +1,109 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.35.2. +-- +-- see: https://github.com/sol/hpack +-- +-- hash: ac539c423172119c73a937299c82f7cd3b83abf488e9577f1d956b58d51c165c + +name: ReplaceUmlaut +version: 0.1.5.3 +synopsis: converting text to properly encoded german umlauts +description: converts the convenient ae, oe and ue replacements for german + umlauts into their proper UTF-8 encoded umlauts - + respecting cases where the ae, oe and ue must remain + based on a extensible list. + Treats a file completely. +category: Text +homepage: https://github.com/andrewufrank/u4blog.git#readme +bug-reports: https://github.com/andrewufrank/u4blog.git/issues +author: Andrew Frank +maintainer: Andrew U. Frank +copyright: 2021 Andrew U. Frank +license: GPL +license-file: GPL_3 +build-type: Simple +extra-source-files: + ChangeLog.md + README.md + nichtUmlaute.txt + +source-repository head + type: git + location: https://github.com/andrewufrank/u4blog.git + subdir: uniform-cmdLineArgs + +library + exposed-modules: + Lib.FileHandling + Lib.OneMDfile + Lib.ProcDirMD + Lib.ProcTextFile + Lib.ProcTxt + Lib.ProcWord + ReplaceUmlaut + other-modules: + Paths_ReplaceUmlaut + hs-source-dirs: + src + build-depends: + base >=4.7 && <5 + , dir-traverse + , optparse-applicative + , text + , transformers + , uniform-cmdLineArgs + , uniform-fileio + , uniform-json >=0.1.5 + , uniform-pandoc + , uniformBase >=0.1.5 + default-language: Haskell2010 + +executable replaceUmlaut + main-is: Main.hs + other-modules: + Paths_ReplaceUmlaut + hs-source-dirs: + app + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + ReplaceUmlaut + , base >=4.7 && <5 + , dir-traverse + , optparse-applicative + , text + , transformers + , uniform-cmdLineArgs + , uniform-fileio + , uniform-json >=0.1.5 + , uniform-pandoc + , uniformBase >=0.1.5 + default-language: Haskell2010 + +test-suite test1 + type: exitcode-stdio-1.0 + main-is: Testing.hs + other-modules: + Lib.FileHandling_test + Lib.OneMDfile_test + Lib.ProcText_test + Lib.ProcTxt_test + Lib.ProcWord_test + Paths_ReplaceUmlaut + hs-source-dirs: + tests + ghc-options: -threaded -rtsopts -with-rtsopts=-N + build-depends: + HTF + , ReplaceUmlaut + , base >=4.7 && <5 + , dir-traverse + , optparse-applicative + , text + , transformers + , uniform-cmdLineArgs + , uniform-fileio + , uniform-json >=0.1.5 + , uniform-pandoc + , uniformBase + default-language: Haskell2010 diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,127 @@ +----------------------------------------------------------------------------- +-- +-- Module : the main for calling replaceUmlaut functions +-- applied to specific files +-- with a switch for the txt and the filename +-- and recursively processing all md files +-- but not dealing with the yml header language switch +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + + +-- module ReplaceUmlaut where -- must have Main (main) or Main where +module Main (main) where + +-- import Uniform.Convenience.StartApp +import Uniform.CmdLineArgs +import UniformBase +-- import Data.Semigroup ( (<>) ) +import Lib.ProcTextFile +import Lib.ProcDirMD +-- import Lib.ProcPandocDatei +-- import Lib.OneMDfile +import Lib.FileHandling +import Paths_ReplaceUmlaut + +programName, progTitle :: Text +programName = "Replace umlaut in txt file " :: Text +progTitle = + "replace ae, oe, and ue to umlaut (except when in nichtUmlaute.txt)" :: Text + +-- to run add in .ghci -- tests/Testing.hs + +main :: IO () +main = do + startProg + (unwords' [programName, progTitle]) + (parseAndExecute + (unlinesT + [ "converts in the file given" + , "the umlaut written as ae, oe and ue" + , "to regular umlaut. " + , "execpt when in file nichtUmlaute" + , "which is the list of words where ae, oe or ue must remain" + ] + ) + "the file (with extension .txt)" + ) + return () + + +--- cmd line parsing +data LitArgs = LitArgs + { isDebug :: Bool -- ^ switch to debug mode (unchanged file, NEW extension) + , isAllMD :: Bool -- ^ collect all md files in directory + , argfile :: String -- ^ the filename absolute + } deriving (Show) + +cmdArgs :: Parser (LitArgs) +cmdArgs = + LitArgs + <$> switch + (long "debug" <> short 'd' <> help + "use debug mode; original file is unchange, new file with NEW extension attached") + <*> switch + (long "all md" <> short 'm' <> help + "process all md files in directory") + <*> argument str + ( + -- long "filename" <> + metavar "filename or directory") + +parseAndExecute :: Text -> Text -> ErrIO () +parseAndExecute t1 t2 = do + args <- callIO $ execParser (opts2 cmdArgs t1 t2 ) + putIOwords ["parseAndExecute LitArgs", showT args] + curr <- currentDir + -- let dir0 = makeAbsDir "/home/frank/additionalSpace/DataBig/LitOriginals" + let fn2 = argfile args :: FilePath + -- let isText = isTxt args :: Bool + let debug = isDebug args :: Bool + let allMD = isAllMD args :: Bool + + fnErl <- callIO $ getDataFileName "nichtUmlaute.txt" + let fnErlP = makeAbsFile fnErl + -- makeAbsFile "/home/frank/Workspace8/replaceUmlaut/nichtUmlaute.txt" + erl2 <- readErlaubt fnErlP + + if allMD + then do + let dir = curr makeRelDir fn2 :: Path Abs Dir + procDirMD debug erl2 dir + else do + let fn = curr makeRelFile fn2 :: Path Abs File + res <- procTextFile debug erl2 fn + when res $ putIOwords ["parseAndExecute LitArgs file changed"] + + -- let ext = getExtension fn + -- let isText2 = isText || ext == (Extension "txt") || ext == (Extension "md") + -- if isText2 + -- then + + -- else + -- procMd1 debug erl2 fn + + + + -- differences in md test for language and if nothing to do + -- no new file is written + +-- where +-- opts = info (helper <*> cmdArgs) +-- (fullDesc <> (progDesc . t2s $ t1) <> (header . t2s $ t2)) + + + + --cmd2textstate :: LitArgs -> TextState2 + ---- fillst the textstate with directory and filename and proj + ---- language is by default english, buchcode is the same as proj + --cmd2textstate args = fillTextState2 sourceTest4 generalityTest4 + -- (argdir args) (argbuch args) + -- diff --git a/nichtUmlaute.txt b/nichtUmlaute.txt new file mode 100644 --- /dev/null +++ b/nichtUmlaute.txt @@ -0,0 +1,148 @@ +Paesa +Emanuele +zuein +continue +fluence +neuer +guetzli +quest +virtuel +Guernsey +individuel +aktuel +eventuel +koeffi +issues +accrue +value +squeeze +question +unique +poet +poes +steuer +neue +freue +steady +sequen +manuell +zuerst +true +phoenix +klimaer +zuerst +revue +OECD +aktuell +value +israel +marque +lektuel +bequem +puerto +venezuela +samuel +getreuen +duel +aero +isreal +visuel +individue +cinque +aktuell +baedeker +braeburn +kaeder +embraer +ghanaer +ismael +michael +paella +paestum +phaeton +rafael +reggae +vitae +oboe +apnoe +autoe +audioe +bioe +boeing +bonhoeffer +bruttoe +chicagoer +crusoe +defoe +diarrhoe +echoe +elektroe +endoe +exoe +fotoe +gastroe +giroe +goethe +haloe +heroe +holoe +homoe +hydroe +iso +joe +judoe +kakaoe +kinoe +koex +kommando +kontoe +logorhoe +magnetoe +makroe +mikroe +monroe +nano +nettoe +neuroe +noether +opto +osloer +phoenix +photoe +piezoe +poe +poem +poet +protoe +pseudoe +psychoe +radioe +risikoe +schroeder +soeben +soloe +tempoe +thermoe +togoer +torontoer +videoe +bauer +baue +aue +teuer +feuer +flaue +quenz +eurt +heuer +kaue +quer +dauer +albuquerque +annuel +raue +schaue +traue +sexue +quell +aue diff --git a/src/Lib/FileHandling.hs b/src/Lib/FileHandling.hs new file mode 100644 --- /dev/null +++ b/src/Lib/FileHandling.hs @@ -0,0 +1,77 @@ +----------------------------------------------------------------------------- +-- Module : Convert umlaut written as ae, oe or ue into ä, ö and ü +-- in a single word +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# OPTIONS_GHC -Wall -fno-warn-orphans #-} + -- -fno-warn-missing-signatures + -- -fno-warn-missing-methods + +module Lib.FileHandling -- (openMain, htf_thisModuelsTests) + where +import UniformBase +-- import Uniform.Strings +-- import Uniform.FileIO +import Uniform.Pandoc (extMD) + +textlinesFile :: TypedFile5 Text [Text] +-- txtFile = makeTyped txtExtension +textlinesFile = makeTyped txtExtension +textlinesNewFile :: TypedFile5 Text [Text] +textlinesNewFile = makeTyped newExtension +textlinesBakFile :: TypedFile5 Text [Text] +textlinesBakFile = makeTyped bakExtension + +mdFile :: TypedFile5 Text [Text] +mdFile = makeTyped extMD + +txtExtension :: Extension +txtExtension = Extension "txt" :: Extension +newExtension :: Extension +newExtension = Extension "new" :: Extension +bakExtension :: Extension +bakExtension = Extension "bak" :: Extension +-- ^ filetype to read text in lines + +-- changeExtensionBakOrNew :: Bool -> Path Abs File -> ErrIO (Extension, Path Abs File, Path Abs File) +-- -- ^ the given fn is split in extension and +-- -- returns the bak and the new file name +-- changeExtensionBakOrNew debug fn = do +-- let fnNaked = makeAbsFile $ getParentDir fn getNakedFileName fn :: Path Abs File +-- let fnExtension = getExtension fn :: Extension +-- when debug $ putIOwords ["changeExtensionBakOrNew fnNaked", showT fnNaked, "fnExtension", showT fnExtension] + +-- let fnbak = fnNaked <.> bakExtension :: Path Abs File +-- let fnnew = fnNaked <.> newExtension :: Path Abs File + +-- putIOwords ["changeExtensionBakOrNew fnbak", showT fnbak] +-- putIOwords ["changeExtensionBakOrNew fnnew", showT fnnew] + +-- return (fnExtension, fnbak, fnnew) + +instance TypedFiles7 Text [Text] where -- creates sequence of lines + wrap7 t = lines' t + unwrap7 t = unlines' t + +readErlaubt :: Path Abs File -> ErrIO [Text] +-- read the erlaubte words wtih ae, oe and ue +readErlaubt fnErl = do + erl :: [Text] <- read8 fnErl textlinesFile -- reads lines + let erl2 = concat . map words' $ erl :: [Text] + return erl2 + +writeWithBak :: Bool -> Path Abs File -> TypedFile5 Text [Text]-> [Text] -> ErrIO () +-- ^ write the text into a file; use path given after renaming the file to bak +-- if debug then write the text into a new file +writeWithBak debug fn textLineType res = + if debug + then write8 fn textlinesNewFile res + else do + renameToBak8 fn textLineType + write8 fn textLineType res diff --git a/src/Lib/OneMDfile.hs b/src/Lib/OneMDfile.hs new file mode 100644 --- /dev/null +++ b/src/Lib/OneMDfile.hs @@ -0,0 +1,133 @@ +----------------------------------------------------------------------------- +-- Module : Convert umlaut written as ae, oe or ue into ä, ö and ü +-- in a txt file +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.OneMDfile -- (openMain, htf_thisModuelsTests) + where +import UniformBase +import Lib.ProcWord +import Lib.FileHandling +import Lib.ProcTextFile +-- import Lib.ProcPandocDatei +-- import MdDocHandling + +-- for pandoc testing +-- import Uniform.Pandoc + +-- import qualified Text.Pandoc as P +-- import qualified Text.Pandoc.Walk as PW +-- import qualified Data.Text as T +-- import Wave.MD2doc + +-- newExtension :: Extension +-- newExtension = Extension "new" :: Extension +-- mdFile = makeTyped extMD +-- ^ filetype to read text in lines + +-- procMd3 :: Bool -> [Text]-> Path Abs File -> ErrIO () +-- procMd3 debug erl2 fn = do +-- -- erl2 <- readErlaubt fnErl +-- procMd1 debug erl2 fn + +-- -- ls :: MarkdownText <- read8 fn markdownFileType +-- putIOwords ["procMd3 done ", "fn", showT fn] + +-- ls2 <- unPandocM (changeUmlautInPandoc True erl2 (ls)) + +-- if debug +-- then do +-- let fnnew = makeAbsFile (toFilePath fn <> "NEW") +-- putIOwords ["procMd result in new", showT fnnew] +-- write8 fnnew markdownFileType ls2 +-- putIOwords ["procMd result in new written", showT ls2, "fn", showT fnnew] +-- else do +-- let fnrename = fn <.> bakExtension :: Path Abs File +-- renameOneFile (fn <.> extMD) fnrename +-- putIOwords ["procMd renamed to bak", showT fnrename] + + +-- write8 fn markdownFileType ls2 +-- when debug $ putIOwords ["procMd done", showT ls2] + +procMd1 :: Bool -> [Text] -> Path Abs File -> ErrIO Bool +-- ^ replace umlaut in a markdown file and report if any change +-- it is known that the file is german text and should be processed +-- conversion unless it is an permitted group +-- in a file with extension txt +-- the original file is renamed to bak and the +-- corrected version written to the original filename +-- except when debug flag is set +-- then the new file is written to NEW +-- and the original file is not changed +-- debug true gives new file +-- returns False if something has changed +procMd1 debug erl2 fn = do + when debug $ putIOwords ["\n procMD1 " + , "\tfile to process", showT fn + , "\terl2", showT erl2 + ] + + res <- procTextFile debug erl2 fn + when debug $ putIOwords ["\n procMD1 done. Changes", showT res] + return res + + -- md1 <- read8 fn mdFile + -- dr@(Docrep yam1 pan1) <- readMarkdown2docrep md + + -- if "ngerman" /= dyLang yam1 + -- then do + -- when debug $ putIOwords ["\n procMD1 ", "not german"] + -- return dr + -- else do + -- when debug $ putIOwords ["\n procMD1 ", "german"] + -- return dr + + -- let f1 = mdDocRead . unlines' $ f0 :: MdDoc1 -- definition in MdDocHandling + -- when debug $ putIOwords ["procMD1 yamlHeader", showT . yamlHeader1 $ f1] + -- let german = mdocIsGerman f1 -- check requires pandoc? + + -- if german then do + -- -- let f2 = updateMdDoc2 (procMdTxt erl2) (procMdTxt erl2) f1 + -- -- newfn <- changeExtensionBakOrNew debug fn -- not debug? + -- -- let f3 = mdDocWrite f2 + -- let f3 = map (procLine2 erl2) f0 -- process the full file + -- writeWithBak debug fn mdFile f3 + -- when True $ putIOwords ["\n procMd1 ", showT fn, "german file umlaut changed with backup"] + -- else + -- when debug $ putIOwords ["\n procMd1 ", showT fn, "not german file"] + + + -- when debug $ putIOwords ["\n procMD1 ", showT fn, "file done with backup"] + -- return () + + +-- data Markdown = Markdown Text deriving (Show, Read, Eq, Ord) +-- ^ just for marking md files +-- mdFile :: TypedFile5 Text Markdown +-- mdExtension :: Extension +-- mdExtension = Extension "md" :: Extension + + + +-- procMdTxt2 :: [Text] -> Text -> Text +-- -- change all umlaut in text +-- -- preserve leading blanks of line, or tabs, but not mixture of these +-- procMdTxt2 erl2 t = concat' [ld,t2] +-- where +-- t2 = unlines' . map (procLine erl2) . lines' $ t1 +-- (ld, t1) = case mb1 t of +-- Nothing -> case mb2 t of +-- Nothing -> ("", t) +-- Just (lead2, _, t02) -> (lead2,t02) +-- Just (lead, _, t0) -> (lead,t0) +-- mb1 tx = T.commonPrefixes " " tx +-- mb2 ty = T.commonPrefixes "\t\t\t\t\t\t\t" ty + diff --git a/src/Lib/ProcDirMD.hs b/src/Lib/ProcDirMD.hs new file mode 100644 --- /dev/null +++ b/src/Lib/ProcDirMD.hs @@ -0,0 +1,42 @@ +----------------------------------------------------------------------------- +-- Module : Convert umlaut written as ae, oe or ue into ä, ö and ü +-- in a txt file +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.ProcDirMD -- (openMain, htf_thisModuelsTests) + where +-- import Uniform.Strings +-- import Uniform.TypedFile +-- import Uniform.FileIO +-- import Uniform.Error +import Lib.ProcTextFile +-- import Lib.ProcWord +import UniformBase +import Lib.FileHandling + +procDirMD :: Bool -> [Text] -> Path Abs Dir -> ErrIO () +-- ^ replace umlaut in all md files in directory (recursively!) +procDirMD debug erl2 dir = do + when debug $ putIOwords ["procDirMD start", showT dir] + -- pipedDoIOwithFilter :: Path Abs File -> Path Abs Dir -> Extension -> (Path Abs File -> ErrIO String) -> ErrIO () + curr <- currentDir + let msgFile = curr makeRelFile "msg4procDir.txt" + bools <- pipedDoIOwithFilter msgFile dir (Extension "md") (procTxt0 debug erl2) + + msg2 <- read8 msgFile textlinesFile + putIOwords ["processing for ", showT dir, "done with msg", showT msg2] + return () + +procTxt0 :: Bool -> [Text] -> Path Abs File -> ErrIO String +procTxt0 debug erl2 fn = do + when debug $ putIOwords ["procTxt0 start", showT fn] + procTextFile debug erl2 fn + when debug $ putIOwords ["procTxt0 end", showT fn] + return . show $ fn diff --git a/src/Lib/ProcTextFile.hs b/src/Lib/ProcTextFile.hs new file mode 100644 --- /dev/null +++ b/src/Lib/ProcTextFile.hs @@ -0,0 +1,68 @@ +----------------------------------------------------------------------------- +-- Module : Convert umlaut written as ae, oe or ue into ä, ö and ü +-- in a txt file +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE BlockArguments #-} + +module Lib.ProcTextFile -- (openMain, htf_thisModuelsTests) + where +-- import Uniform.Strings +-- import Uniform.TypedFile +-- import Uniform.FileIO +-- import Uniform.Error +import Lib.ProcWord +import UniformBase +import Lib.FileHandling +import Uniform.Pandoc (extMD) +import Control.Monad.Trans.Writer.Strict + +procTextFile :: Bool -> [Text] -> Path Abs File -> ErrIO Bool +-- ^ replace umlaut unless it is an permitted group +-- in a file with extension txt or md (only!) +-- returns True if something has changed +procTextFile debug erl2 fn = do + when debug $ putIOwords ["procText start", showT fn] + let fnExtension = getExtension fn :: Extension + + let textLineType + | fnExtension == txtExtension = textlinesFile + | fnExtension == extMD = mdFile + | otherwise = errorT ["ERROR: not text file - nothing done!"] + + ls :: [Text] <- read8 fn textLineType -- split in lines + + -- when debug $ putIOwords ["procTxt ls", showT ls] + -- let ls2 = map (procLine2 erl2) ls + let (ls2,report) = runWriter $ mapM (procLine2Rep erl2) ls + + -- when debug $ + when debug $ putIOwords ["procText ls2", unlines' ls2] + when (trim' report /= zero) $ putIOwords ["\nprocText report", report, "\n"] + -- putIOwords ["procText file returned", unlines' ls] + -- let ls3 = unwrap7 ls2 :: Text + -- when debug $ putIOwords ["procTxt unwrap7 . ls3", showT ls3] + + let changed = zero /= trim' report -- no report means nothing changed + when changed do + writeWithBak debug fn textLineType ( ls2) + when True $ putIOwords ["procText changed file", showNice fn, "rewritten" + , "\n if some words in the report above are not correct" + , "\n edit the file and add the form to 'doNotReplace'."] + -- true - changed + when debug $ putIOwords ["procText done, changed: ", showT changed] + + return changed + + -- if debug + -- then write8 fn textlinesNewFile res + -- else do + -- renameToBak8 fn textLineType + -- write8 fn textLineType res + diff --git a/src/Lib/ProcTxt.hs b/src/Lib/ProcTxt.hs new file mode 100644 --- /dev/null +++ b/src/Lib/ProcTxt.hs @@ -0,0 +1,55 @@ +----------------------------------------------------------------------------- +-- Module : Convert umlaut written as ae, oe or ue into ä, ö and ü +-- in a txt file +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.ProcTxt -- (openMain, htf_thisModuelsTests) + where +-- import Uniform.Strings +-- import Uniform.TypedFile +-- import Uniform.FileIO +-- import Uniform.Error +import Lib.ProcWord +import UniformBase +import Lib.FileHandling +import Control.Monad.Trans.Writer.Strict + +procTxt :: Bool -> [Text] -> Path Abs File -> ErrIO Bool +-- ^ replace umlaut unless it is an permitted group +-- in a file with extension txt +procTxt debug erl2 fn = do + when debug $ putIOwords ["procTxt start", showT fn] + -- erl2 <- readErlaubt fnErl + -- erl <- read6 fnErl txtFile -- reads lines + -- let erlaubt = concat . map words' $ erl :: [Text] + + ls :: [Text] <- read8 fn textlinesFile + + -- let ls2 = map (procLine2 erl2) ls + let (ls2,report) = runWriter $ mapM (procLine2Rep erl2) ls + let changed = zero /= trim' report + -- let res = False -- reports change - todo + + -- newfn <- changeExtensionBakOrNew debug fn + writeWithBak debug fn textlinesFile ls2 + return changed + + -- rest is copied + -- if debug + -- then do + -- let fnnew = makeAbsFile (toFilePath fn <> "NEW") + -- putIOwords ["procMd result in new", showT fnnew] + -- write8 fnnew textlinesFile res + -- putIOwords ["procMd result in new written", showT res, "fn", showT fnnew] + -- else do + -- let fnrename = fn <.> bakExtension :: Path Abs File + -- renameOneFile (fn <.> txtExtension) fnrename + -- putIOwords ["procMd renamed to bak", showT fnrename] + -- write8 fn textlinesFile ls2 diff --git a/src/Lib/ProcWord.hs b/src/Lib/ProcWord.hs new file mode 100644 --- /dev/null +++ b/src/Lib/ProcWord.hs @@ -0,0 +1,118 @@ +----------------------------------------------------------------------------- +-- Module : Convert umlaut written as ae, oe or ue into ä, ö and ü +-- deals with lines, preserving the leading spaces and tabs. +-- could be improved to use span to break on first non-space character +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.ProcWord -- (openMain, htf_thisModuelsTests) + where +-- import Uniform.Strings +-- import Uniform.FileIO +import UniformBase +-- import Lib.FileHandling +import qualified Data.Text as T (commonPrefixes) +-- import Control.Monad +import Control.Monad.Trans.Writer.Strict + + + +-- procTxt2 :: [Text] -> Text -> Text -- called from OneMDfile, not from ProcTxt +-- -- change all umlaut in text - yaml header and markdown text +-- -- preserve leading blanks of line, or tabs, but not mixture of these +-- procTxt2 erl2 = unlines' . map (procLine2 erl2) . lines' + + +procLine2 :: [Text] -> Text -> Text +-- process one line preserving spaces or tabs (but not a mix) at start +-- improve to use span break on first non-space +-- assumes that text is not \n terminated! +procLine2 erl2 t = ld <> (procLine erl2 t1) + where + (ld, t1) = auxProcLine2 t + -- case mb1 t of + -- Nothing -> case mb2 t of + -- Nothing -> ("", t) + -- Just (lead2, _, t02) -> (lead2,t02) + -- Just (lead, _, t0) -> (lead,t0) + -- mb1 tx = T.commonPrefixes " " tx + -- mb2 ty = T.commonPrefixes "\t\t\t\t\t\t\t" ty + +auxProcLine2 :: Text -> (Text,Text) +auxProcLine2 t = case mb1 t of + Nothing -> case mb2 t of + Nothing -> ("", t) + Just (lead2, _, t02) -> (lead2,t02) + Just (lead, _, t0) -> (lead,t0) + where + mb1 tx = T.commonPrefixes " " tx + mb2 ty = T.commonPrefixes "\t\t\t\t\t\t\t" ty + +procLine2Rep :: [Text] -> Text -> Writer Text Text +-- accumulates the changed woerds for checking +procLine2Rep erl2 t = do + t2 <- procLineRep erl2 t1 + return $ ld <> t2 + where (ld,t1) = auxProcLine2 t + + + +procLine :: [Text] -> Text -> Text +procLine erlaubt ln = unwords' . map (procWord2 erlaubt) . words' $ ln +-- process all words in a line +-- should be idempotent, as long as text is not n\ terminated + +procLineRep :: [Text] -> Text -> Writer Text Text +procLineRep erlaubt ln = do + ln2rep <- mapM (procWord2Rep erlaubt) (words' ln) + return . unwords' $ ln2rep + +procWord2 :: [Text] -> Text -> Text +-- replace umlaut unless it is an permitted group +procWord2 erlaubt word = + if checkErlaubt erlaubt word then word else procWord1 word + +procWord2Rep :: [Text] -> Text -> Writer Text Text +procWord2Rep erlaubt word = do + let word1 = procWord2 erlaubt word + if word1 == word + then return word + else do + tell ((word1<>" ")::Text) + return word1 + + + +procWord1 :: Text -> Text +-- ^ convert the umlaut in a single word +-- no test, no exclusions +-- preserve capitalization +procWord1 t = + replace' "AE" "Ä" + . replace' "OE" "Ö" + . replace' "UE" "Ü" + . replace' "Ae" "Ä" + . replace' "Oe" "Ö" + . replace' "Ue" "Ü" + . replace' "ae" "ä" + . replace' "oe" "ö" + . replace' "ue" "ü" + $ t + +erlaubt1 :: [Text] -- erlaubte Gruppen - for test only +erlaubt1 = map toLower' ["koef", "poet", "poes", "neue", "freue"] + +checkErlaubt :: [Text] -> Text -> Bool +-- ^ enthaelt das Wort eine erlaubte kombination +checkErlaubt erlaubt word = any (\e -> isInfixOf' e . toLower' $ word) erlaubt + +checkErlaubt1 :: Text -> Bool +checkErlaubt1 = checkErlaubt erlaubt1 +-- mit fester Liste der erlaubten - for test + diff --git a/src/ReplaceUmlaut.hs b/src/ReplaceUmlaut.hs new file mode 100644 --- /dev/null +++ b/src/ReplaceUmlaut.hs @@ -0,0 +1,94 @@ +----------------------------------------------------------------------------- +-- +-- Module : the main for calling replaceUmlaut functions +-- with a switch for the txt and the filename +----------------------------------------------------------------------------- +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + + +module ReplaceUmlaut where -- must have Main (main) or Main where + +import UniformBase +-- import Uniform.Convenience.StartApp +import Uniform.Filenames -- ( makeExtension ) +-- import Data.Semigroup ( (<>) ) +import Options.Applicative.Builder +import Options.Applicative +import Lib.ProcTxt +import Lib.OneMDfile +-- import Lib.ProcPandocDatei +import Lib.FileHandling + +programName, progTitle :: Text +programName = "Umlaut in md or txt file " :: Text +progTitle = + "replace ae, oe, and ue to umlaut (except when in nichtUmlaute.txt)" :: Text + +-- to run add in .ghci -- tests/Testing.hs + +main :: IO () +main = do + startProg + programName + -- progTitle + (parseAndExecute + (unlinesT + [ "converts words in the file given where" + , "the umlaut is written as ae, oe and ue" + , "to regular umlaut, " + , "execpt when in file nichtUmlaute" + , "which is the list of words where ae, oe or ue must remain." + ] + ) + "the file (with extension .txt or .md)" + ) + return () + + +--- cmd line parsing +data LitArgs = LitArgs { isTxt :: Bool -- ^ is this a txt file + , argfile :: String -- ^ the filename absolute + } deriving (Show) + +cmdArgs :: Parser (LitArgs) +cmdArgs = + LitArgs + <$> switch + (long "txt" <> short 't' <> help + "true if this is a txt file, txt or md extension is recognized" + ) + <*> argument str + ( + -- long "filename" <> + metavar "filename") + +parseAndExecute :: Text -> Text -> ErrIO () +parseAndExecute t1 t2 = do + args <- callIO $ execParser opts + putIOwords ["parseAndExecute LitArgs", showT args] + curr <- currentDir + -- let dir0 = makeAbsDir "/home/frank/additionalSpace/DataBig/LitOriginals" + let fn2 = argfile args :: FilePath + let fn = curr makeRelFile fn2 :: Path Abs File + let isText = isTxt args :: Bool + + let ext = getExtension fn + let isText2 = isText || ext == (Extension "txt") + let debug = False + let erlFn = makeAbsFile "/home/frank/Workspace8/replaceUmlaut/nichtUmlaute.txt" + erl2 <- readErlaubt erlFn + res <- if isText2 then procTxt debug erl2 fn else procMd1 debug erl2 fn + putIOwords ["parseAndExecute done. File was changed: ", showT res] + + where + opts = info (helper <*> cmdArgs) + (fullDesc <> (progDesc . t2s $ t1) <> (header . t2s $ t2)) + + + diff --git a/tests/Lib/FileHandling_test.hs b/tests/Lib/FileHandling_test.hs new file mode 100644 --- /dev/null +++ b/tests/Lib/FileHandling_test.hs @@ -0,0 +1,57 @@ +----------------------------------------------------------------------------- +-- +-- Module : a test for HTF framework +-- tests the corresponding Lib.NN.hs program +-- insert {-@ HTF_TESTS @-} for each import +----------------------------------------------------------------------------- +{-# OPTIONS_GHC -F -pgmF htfpp #-} + +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.FileHandling_test -- (openMain, htf_thisModuelsTests) + where + + +import Test.Framework +-- import Uniform.Strings +-- import Uniform.Error +import Lib.FileHandling +-- import Lib.ProcWord +import Uniform.FileIO +import UniformBase + +openMain :: IO () +openMain = do + return () +-- tests to only check that filenames are correct +-- not that correct content + +fn1 = makeAbsFile + "/home/frank/Workspace8/replaceUmlaut/testMarkdown1.md" +fn1t = makeAbsFile "/home/frank/Workspace8/replaceUmlaut/testMarkdown1.mdNEW" +fn1bak = makeAbsFile "/home/frank/Workspace8/replaceUmlaut/testMarkdown1.bak" +-- show produces the "xx" +test_1 = do -- fn1 muss existieren + -- result fn1 renamed, new fn1 written + r <- runErr $ + do -- necessary to keep the files for tests + cont :: [Text] <- read8 fn1 mdFile + writeWithBak True fn1 mdFile cont + doesFileExist' fn1t + -- return () + assertEqual (Right True) r + +test_2 = do -- filename does not change but bak is written + r <- runErr $ + do + cont :: [Text] <- read8 fn1 mdFile + writeWithBak False fn1 mdFile cont + doesFileExist' fn1bak + assertEqual (Right True) r + diff --git a/tests/Lib/OneMDfile_test.hs b/tests/Lib/OneMDfile_test.hs new file mode 100644 --- /dev/null +++ b/tests/Lib/OneMDfile_test.hs @@ -0,0 +1,97 @@ +----------------------------------------------------------------------------- +-- +-- Module : a test for HTF framework +-- tests the corresponding Lib.NN.hs program +-- insert {-@ HTF_TESTS @-} for each import +----------------------------------------------------------------------------- +{-# OPTIONS_GHC -F -pgmF htfpp #-} + +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.OneMDfile_test -- (openMain, htf_thisModuelsTests) + where + + +import Test.Framework +-- import Uniform.Strings +-- import Uniform.Error +import Lib.OneMDfile +import Lib.ProcTxt +import Lib.ProcWord +import Lib.FileHandling +-- import Uniform.FileIO +import UniformBase + +-- show produces the "xx" +test_a1 = assertEqual ("a") $ unwords' . words' $ ("a"::Text) +test_1 = assertEqual ("für") $ procLine2 [] ("fuer"::Text) +-- not clear where the \n disappeared +-- test_2 = assertEqual 6 9 +test_2 = assertEqual (" für") $ procLine2 [] (" fuer"::Text) +test_3 = assertEqual ("\tfür") $ procLine2 [] ("\tfuer"::Text) +test_4 = assertEqual (" Einschr\228nkungen gelebt.") $ procLine2 [] (" Einschraenkungen gelebt."::Text) + + +exampleText1 = unlines' [ + "abstract: Was hat einer in der Katastrophe erlebt, der weniger unter den Folgen zu" + , " leiden hatte, als andere? Wir haben meist ausserhalb von Wien am Land ohne wesentlichen" + , " Einschraenkungen gelebt." ] :: Text +resultText1 = unlines' [ + "abstract: Was hat einer in der Katastrophe erlebt, der weniger unter den Folgen zu" + , " leiden hatte, als andere? Wir haben meist ausserhalb von Wien am Land ohne wesentlichen" + , " Einschränkungen gelebt." ] :: Text + +procLines1 :: [Text] -> Text -> Text +procLines1 e t = unlines' . fmap (procLine2 e) . lines' $ t +test_5 = assertEqual resultText1 $ procLines1 [] exampleText1 +-- test_6 = assertEqual "" $ showT exampleText1 +test_7 = assertEqual (" Einschr\228nkungen gelebt.\n und\n") $ procLines1 [] (" Einschraenkungen gelebt.\n und"::Text) + + +test_m1 = do + r <- runErr $ do + let fn1 = makeRelFile "testData/test4.md" + fnerl = makeRelFile "nichtUmlaute" :: Path Rel File + cdir <- currentDir + let fnabs = cdir fn1 :: Path Abs File + let fnerlabs = cdir fnerl :: Path Abs File + erl2 <- readErlaubt fnerlabs + procMd1 True erl2 fnabs + assertEqual (Right True) r + +-- test a simple md file +-- test_5 = do -- fn1 muss existieren +-- -- result fn1 renamed, new fn1 written +-- r <- runErr $ +-- do -- necessary to keep the files for tests +-- cont :: Text <- readFile2 fn1 +-- fn2 <- changeExtensionBakOrNew True fn1 +-- writeFile2 fn2 cont +-- return (toFilePath fn2) +-- assertEqual (Right fn1t) r + + -- test_2 = assertEqual 6 9 + +-- test_2 = assertEqual t2 $ map procWord1 t1 +-- t1 = ["fuer", "Moerder", "Aerger", "koennen", "maesten", "FUER", "Oesterreich"] :: [Text] +-- t2 = ["für", "Mörder", "Ärger", "können", "mästen", "FÜR", "Österreich"] :: [Text] + +-- test_e1 = assertEqual [True, True] $ map checkErlaubt1 e1 +-- e1 = ["Koeffizient", "Poetik"]::[Text] + +-- test_e2 = assertEqual True $ isInfixOf' ("poes"::Text) "poesie" +-- test_w1 = assertEqual w1r $ map (procWord2 erlaubt1) w1 +-- w1 = ["fuer", "Moerder", "Aerger", "koennen", "maesten", "FUER" +-- , "Koeffizienten", "Poetik", "Poet", "Poesie"] :: [Text] +-- w1r = ["f\252r", "M\246rder", "\196rger", "k\246nnen", "m\228sten", +-- "F\220R", "Koeffizienten", "Poetik", "Poet", "Poesie"]::[Text] + +-- w2 = unwords' w1 :: Text +-- w2r = "f\252r M\246rder \196rger k\246nnen m\228sten F\220R Koeffizienten Poetik Poet Poesie" +-- test_idempot = assertEqual w2r (procLine erlaubt1 (procLine erlaubt1 w2)) diff --git a/tests/Lib/ProcText_test.hs b/tests/Lib/ProcText_test.hs new file mode 100644 --- /dev/null +++ b/tests/Lib/ProcText_test.hs @@ -0,0 +1,68 @@ +----------------------------------------------------------------------------- +-- +-- Module : a test for HTF framework +-- tests the corresponding Lib.NN.hs program +-- insert {-@ HTF_TESTS @-} for each import +----------------------------------------------------------------------------- +{-# OPTIONS_GHC -F -pgmF htfpp #-} + +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.ProcText_test -- (openMain, htf_thisModuelsTests) + where + + +import Test.Framework +-- import Uniform.Strings +-- import Uniform.Error +import Lib.ProcTxt +-- import Lib.ProcWord ( erlaubt1 ) +-- import Uniform.FileIO +import UniformBase +import Lib.FileHandling +import Lib.ProcTextFile +-- test_1 = do +-- r <- runErr $ do +-- let fn = makeRelFile "testDaten" :: Path Rel File +-- cdir <- currentDir +-- let fnabs = cdir fn :: Path Abs File +-- procTxt erlaubt1 fnabs +-- assertEqual (Right ()) r + + +-- dictionary = "/home/frank/Workspace8/replaceUmlaut/de.dic" +testfn :: Path Abs File +testfn = makeAbsFile "/home/frank/Workspace11/replaceUmlaut/testData/corona.txt" + + + + +test_ohneErlaubt :: IO () +-- ohne erlaubte +test_ohneErlaubt = do + r <- runErr $ do + let fn1 = makeRelFile "testData/test4.md" + cdir <- currentDir + let fnabs = cdir fn1 :: Path Abs File + procTextFile True [] fnabs + assertEqual (Right True) r + +test_mitErlaubt :: IO () +-- mit erluabten +test_mitErlaubt = do + r <- runErr $ do + let fn1 = makeRelFile "testData/test4.md" + fnerl = makeRelFile "nichtUmlaute" :: Path Rel File + cdir <- currentDir + let fnabs = cdir fn1 :: Path Abs File + let fnerlabs = cdir fnerl :: Path Abs File + erl2 <- readErlaubt fnerlabs + procTextFile True erl2 fnabs + assertEqual (Right True) r + diff --git a/tests/Lib/ProcTxt_test.hs b/tests/Lib/ProcTxt_test.hs new file mode 100644 --- /dev/null +++ b/tests/Lib/ProcTxt_test.hs @@ -0,0 +1,81 @@ +----------------------------------------------------------------------------- +-- +-- Module : a test for HTF framework +-- tests the corresponding Lib.NN.hs program +-- insert {-@ HTF_TESTS @-} for each import +----------------------------------------------------------------------------- +{-# OPTIONS_GHC -F -pgmF htfpp #-} + +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.ProcTxt_test -- (openMain, htf_thisModuelsTests) + where + + +import Test.Framework +-- import Uniform.Strings +-- import Uniform.Error +import Lib.ProcTxt +-- import Lib.ProcWord ( erlaubt1 ) +-- import Uniform.FileIO +import UniformBase +import Lib.FileHandling + +-- test_1 = do +-- r <- runErr $ do +-- let fn = makeRelFile "testDaten" :: Path Rel File +-- cdir <- currentDir +-- let fnabs = cdir fn :: Path Abs File +-- procTxt erlaubt1 fnabs +-- assertEqual (Right ()) r + +test_2 :: IO () +test_2 = do + r <- runErr $ do + let fn = makeRelFile "testData/corona.txt" :: Path Rel File + let fnerl = makeRelFile "nichtUmlaute" :: Path Rel File + cdir <- currentDir + let fnabs = cdir fn :: Path Abs File + let fnerlabs = cdir fnerl :: Path Abs File + erl2 <- readErlaubt fnerlabs + procTxt True erl2 fnabs + assertEqual (Right True) r + +-- dictionary = "/home/frank/Workspace8/replaceUmlaut/de.dic" +testfn :: Path Abs File +testfn = makeAbsFile "/home/frank/Workspace11/replaceUmlaut/testData/corona.txt" + +test_3 :: IO () +test_3 = do + r <- runErr $ do + -- let fn = makeRelFile "testDaten" :: Path Rel File + -- let fnerl = makeRelFile "nichtUmlaute"::Path Rel File + cdir <- currentDir + -- let fnabs = cdir fn :: Path Abs File -- t + let fnabs = testfn :: Path Abs File + let fnerl = makeRelFile "nichtUmlaute" :: Path Rel File + let fnerlabs = cdir fnerl :: Path Abs File + erl2 <- readErlaubt fnerlabs + procTxt True erl2 fnabs + assertEqual (Right True) r + + + +-- test_m1 = do +-- r <- runErr $ do +-- let fn1 = makeRelFile "testData/test4.md" +-- -- fnerl = makeRelFile "nichtUmlaute" :: Path Rel File +-- cdir <- currentDir +-- let fnabs = cdir fn1 :: Path Abs File +-- let fnerlabs = cdir fnerl :: Path Abs File +-- erl2 <- readErlaubt fnerlabs +-- procTxt True erl2 fnabs +-- assertEqual (Right False) r + + diff --git a/tests/Lib/ProcWord_test.hs b/tests/Lib/ProcWord_test.hs new file mode 100644 --- /dev/null +++ b/tests/Lib/ProcWord_test.hs @@ -0,0 +1,95 @@ +----------------------------------------------------------------------------- +-- +-- Module : a test for HTF framework +-- tests the corresponding Lib.NN.hs program +-- insert {-@ HTF_TESTS @-} for each import +----------------------------------------------------------------------------- +{-# OPTIONS_GHC -F -pgmF htfpp #-} + +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +module Lib.ProcWord_test -- (openMain, htf_thisModuelsTests) + where + + +import Test.Framework +-- import Uniform.Strings +import UniformBase +import Lib.ProcWord +import Control.Monad.Trans.Writer.Strict + +openMain :: IO () +openMain = do + return () + + + +-- show produces the "xx" +test_1 = assertEqual ("für") $ procWord1 ("fuer"::Text) +-- test_2 = assertEqual 6 9 + +test_2 = assertEqual t2 $ map procWord1 t1 +t1 = ["nichts", "fuer", "Moerder", "Aerger", "koennen", "maesten", "FUER", "Oesterreich"] :: [Text] +t2 = ["nichts", "für", "Mörder", "Ärger", "können", "mästen", "FÜR", "Österreich"] :: [Text] + +test_e1 = assertEqual [True, True] $ map checkErlaubt1 e1 +e1 = ["Koeffizient", "Poetik"]::[Text] + +test_e2 = assertEqual True $ isInfixOf' ("poes"::Text) "poesie" +test_w1 = assertEqual w1r $ map (procWord2 erlaubt1) w1 +w1 = ["nichts", "fuer", "Moerder", "Aerger", "koennen", "maesten", "FUER" + , "Koeffizienten", "Poetik", "Poet", "Poesie"] :: [Text] +w1r = ["nichts", "f\252r", "M\246rder", "\196rger", "k\246nnen", "m\228sten", + "F\220R", "Koeffizienten", "Poetik", "Poet", "Poesie"]::[Text] + +test_t1 = assertEqual t2 $ map (procWord2 []) t1 + +-- test reporting +-- the file do not change if debug is set to true +test_r1:: IO () +test_r1 = do + r <- runErr $ do + + let t2exec = execWriter $ mapM (procWord2Rep []) ( t1) + putIOwords ["test r1: t2exec", t2exec] + return ((""::Text ) /= t2exec) -- true -> changed + assertEqual (Right True) r + +-- test result changed +test_p1:: IO () +test_p1 = do + r <- runErr $ do + + let (te,re) = runWriter $ mapM (procWord2Rep []) ( t1) + putIOwords ["test p1: t1", unwords' t1] + putIOwords ["test p1: te", unwords' te] + putIOwords ["test p1: re", re] + return ( t1 /= te) -- true - changed + assertEqual (Right True) r + +test_r2:: IO () +test_r2 = do + r <- runErr $ do + + let t2 = execWriter $ procLine2Rep [] (unwords' t1) + putIOwords ["test r2: t2", t2] + return ((""::Text ) /= t2) -- true - changed + assertEqual (Right True) r + + +test_p2:: IO () +test_p2 = do + r <- runErr $ do + + let (te,re) = runWriter $ procLine2Rep [] (unwords' t1) + putIOwords ["test p2: t1", unwords' t1] + putIOwords ["test p2: te", te] + putIOwords ["test p2: re", re] + return (unwords' t1 /= te) -- true - changed + assertEqual (Right True) r diff --git a/tests/Testing.hs b/tests/Testing.hs new file mode 100644 --- /dev/null +++ b/tests/Testing.hs @@ -0,0 +1,43 @@ +----------------------------------------------------------------------------- +-- +-- Module : a test for HTF framework +-- insert {-@ HTF_TESTS @-} for each import +----------------------------------------------------------------------------- +{-# OPTIONS_GHC -F -pgmF htfpp #-} + +module Main where -- must have Main (main) or Main where + + +-- import System.Exit +-- import Uniform.FileIO +import UniformBase +-- import Lib.ProcPandocDatei + +import Test.Framework +import {-@ HTF_TESTS @-} Lib.ProcWord_test +import {-@ HTF_TESTS @-} Lib.ProcTxt_test +import {-@ HTF_TESTS @-} Lib.OneMDfile_test +import {-@ HTF_TESTS @-} Lib.ProcText_test +-- import {-@ HTF_TESTS @-} Lib.FileHandling_test + +main :: IO () +main = main1 + +main1 :: IO () +main1 = do -- with tests in other modules + putStrLn "HTF ExampleTest.hs:\n" + p <- htfMain htf_importedTests + putStrLn ("HTF end StringConversion.hs test:\n" + ++ show p) + return () + +-- main2 :: IO () +-- main2 = do +-- putStrLn "main2 start -----------" +-- let erlfn = makeAbsFile "/home/frank/Workspace8/replaceUmlaut/nichtUmlaute.txt" +-- let testfn = makeAbsFile "/home/frank/Workspace8/replaceUmlaut/testMarkdown0.md" +-- res <- runErr $ procMd2 True erlfn testfn +-- putStrLn (show res) +-- putStrLn "main2 end ............." + +-- test_2 = assertEqual 6 9