diff --git a/HaMinitel.cabal b/HaMinitel.cabal new file mode 100644 --- /dev/null +++ b/HaMinitel.cabal @@ -0,0 +1,29 @@ +name: HaMinitel +version: 0.1.0.0 +synopsis: An Haskell library to drive the french Minitel through a serial port +-- description: +description: + HaMinitel allows you to drive a french Minitel through a serial port in Haskell. It has been started as a mean to discover Haskell and functional programming. +homepage: https://github.com/Zigazou/HaMinitel +license: GPL-3 +license-file: LICENSE +author: Frédéric BISSON +maintainer: zigazou@free.fr +-- copyright: +category: Terminal +build-type: Simple +cabal-version: >=1.8 + +source-repository head + type: git + location: https://github.com/Zigazou/HaMinitel + +library + exposed-modules: + Minitel.MString + Minitel.Constants + Minitel.Generator + Minitel.Queue + Minitel.Minitel + build-depends: base ==4.5.*, bytestring ==0.9.*, serialport ==0.4.*, stm ==2.4.* + ghc-options: -fwarn-incomplete-patterns -fwarn-incomplete-uni-patterns diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,675 @@ + 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/Minitel/Constants.hs b/Minitel/Constants.hs new file mode 100644 --- /dev/null +++ b/Minitel/Constants.hs @@ -0,0 +1,228 @@ +{-| +Module : Constants +Description : Values definitions from the Minitel universe +Copyright : (c) Frédéric BISSON, 2014 +License : GPL-3 +Maintainer : zigazou@free.fr +Stability : experimental +Portability : POSIX + +The names were translated from french into english (the original documentation +is in french). +-} +module Minitel.Constants where + +import Data.Char + +-- No need for Integer default values, they are overkill for the Minitel +default (Int, Double) + +-- * ASCII-Minitel control codes +-- Minitel follows the ASCII control codes standard except for some values +-- (ie.: ASCII em = Minitel SS2) +nul = 0x00 -- null +soh = 0x01 -- start of heading +stx = 0x02 -- start of text +etx = 0x03 -- end of text +eot = 0x04 -- end of transmission +enq = 0x05 -- enquiry +ack = 0x06 -- acknowledge +bel = 0x07 -- bell +bs = 0x08 -- backspace +tab = 0x09 -- horizontal tab +lf = 0x0a -- line feed, new line +vt = 0x0b -- vertical tab +ff = 0x0c -- form feed, new page +cr = 0x0d -- carriage return +so = 0x0e -- shift out +si = 0x0f -- shift in +dle = 0x10 -- data link escape +dc1 = 0x11 -- device control 1 +con = 0x11 -- Cursor on +dc2 = 0x12 -- device control 2 +rep = 0x12 -- Rep +dc3 = 0x13 -- device control 3 +sep = 0x13 -- Sep +dc4 = 0x14 -- device control 4 +cof = 0x14 -- Cursor off +nak = 0x15 -- negative acknowledge +syn = 0x16 -- synchronous idle +etb = 0x17 -- end of transmission block +can = 0x18 -- cancel +em = 0x19 -- end of medium +ss2 = 0x19 -- SS2 +sub = 0x1a -- substitute +esc = 0x1b -- escape +fs = 0x1c -- file separator +gs = 0x1d -- group separator +ss3 = 0x1d -- SS3 +rs = 0x1e -- record separator +us = 0x1f -- unit separator + +-- * Protocol sequences +pro1 = [esc, 0x39] -- protocol 1 (needs one more arguments) +pro2 = [esc, 0x3a] -- protocol 2 (needs two more arguments) +pro3 = [esc, 0x3b] -- protocol 3 (needs three more arguments) +csi = [esc, 0x5b] -- CSI + +-- * PRO1 commands +disconnection = 0x67 +connection = 0x68 +ret1 = 0x6c +ret2 = 0x6d +oppo = 0x6f +statusTerminal = 0x70 +statusKeyboard = 0x72 +statusRunning = 0x72 +statusSpeed = 0x74 +statusProtocol = 0x76 +enqrom = 0x7b +reset = 0x7f + +-- * PRO2 commands +copy = 0x7c +switchTo = 0x62 +noDiffusion = 0x64 +noAcknowledge = 0x64 +diffusion = 0x65 +acknowledge = 0x65 +transparency = 0x66 +start = 0x69 +stop = 0x6a +prog = 0x6b +answerKeyboard = 0x73 +answerRunning = 0x73 +answerProtocol = 0x77 +telinfo = [0x31, 0x7d] +mixed1 = [0x32, 0x7d] +mixed2 = [0x32, 0x7e] + +-- * PRO2+START-STOP codes +rollMode = 0x43 +procedure = 0x44 +lowercase = 0x45 + +-- * PRO2+PROG codes +b9600 = 0x7f -- 9600 baud +b4800 = 0x76 -- 4800 baud +b1200 = 0x64 -- 1200 baud +b300 = 0x52 -- 300 baud + +-- * PRO3 Commands +switchOff = 0x60 +switchOn = 0x61 +switchFrom = 0x63 + +-- * PRO commands length +pro1Length = 3 +pro2Length = 4 +pro3Length = 5 + +-- * Other codes +copyFrench = 0x6a +copyAmerican = 0x6b +extd = 0x41 +c0 = 0x43 + +-- * Reception codes +recvScreen = 0x58 +recvKeyboard = 0x59 +recvModem = 0x5a +recvPlug = 0x5b +recvPhone = 0x5c +recvSoftware = 0x5d + +-- * Emission codes +sendScreen = 0x50 +sendKeyboard = 0x51 +sendModem = 0x52 +sendPlug = 0x53 +sendPhone = 0x54 +sendSoftware = 0x55 + +-- * Accents (for the VideoTex mode) +accCedilla = [ss2, 0x4b] +accGrave = [ss2, 0x41] +accAcute = [ss2, 0x42] +accCirconflexe = [ss2, 0x43] +accUmlaut = [ss2, 0x48] + +-- * Direction keys +keyUp = csi ++ [0x41] +keyDown = csi ++ [0x42] +keyLeft = csi ++ [0x44] +keyRight = csi ++ [0x43] + +keyShiftUp = csi ++ [0x4d] +keyShiftDown = csi ++ [0x4c] +keyShiftLeft = csi ++ [0x50] +keyShiftRight = csi ++ [0x34, 0x68] + +ctrlLeft = 0x7f + +-- * Return key +keyReturn = 0x0d +keyShiftReturn = csi ++ [0x48] +keyCtrlReturn = csi ++ [0x32, 0x4a] + +-- * Function keys +keyFuncSend = [dc3, 0x41] +keyFuncReturn = [dc3, 0x42] +keyFuncRepeat = [dc3, 0x43] +keyFuncGuide = [dc3, 0x44] +keyFuncCancel = [dc3, 0x45] +keyFuncTOC = [dc3, 0x46] +keyFuncCorrection = [dc3, 0x47] +keyFuncNext = [dc3, 0x48] +keyFuncConnection = [dc3, 0x49] + +-- | Minitel ability describes what the Minitel is able to do, since the +-- Minitel is a generic name for a complete family of terminals +data Ability = Ability + { id :: Char -- ^ A Minitel is identified by a single letter + , name :: String -- ^ Human french name + , reversible :: Bool -- ^ Some Minitels can be used as a standard modem + , keyboard :: String -- ^ First Minitels were ABCD, then Azerty or none + , maxSpeed :: Int -- ^ Max supported speed in bauds + , cols80 :: Bool -- ^ Is terminal mode (80 columns) supported ? + , charDefine :: Bool -- ^ are characters redefinable ? + } deriving (Show) + +-- | A list of known Minitels and their abilities +minitelAbilities = [ + Ability 'c' "Minitel 1" False "ABCD" 1200 False False, + Ability 'd' "Minitel 10" False "Azerty" 1200 False False, + Ability 'e' "Minitel 1 couleur" False "Azerty" 1200 False False, + Ability 'f' "Minitel 10" True "Azerty" 1200 False False, + Ability 'g' "Émulateur" True "Azerty" 9600 True True, + Ability 'j' "Imprimante" False "" 1200 False False, + Ability 'r' "Minitel 1" True "Azerty" 1200 False False, + Ability 's' "Minitel 1 couleur" True "Azerty" 1200 False False, + Ability 't' "Terminatel 252" False "" 1200 False False, + Ability 'u' "Minitel 1B" True "Azerty" 4800 True False, + Ability 'v' "Minitel 2" True "Azerty" 9600 True True, + Ability 'w' "Minitel 10B" True "Azerty" 4800 True False, + Ability 'y' "Minitel 5" True "Azerty" 9600 True True, + Ability 'z' "Minitel 12" True "Azerty" 9600 True True + ] + +-- | Base abilities, when you don't know the Minitel to which you are connected +baseAbilities = + Ability '*' "Minitel inconnu" False "ABCD" 1200 False False + +-- | Maker identification codes +makerCodes = [ + ('A', "Matra"), + ('B', "RTIC"), + ('C', "Telic-Alcatel"), + ('D', "Thomson"), + ('E', "CCS"), + ('F', "Fiet"), + ('G', "Fime"), + ('H', "Unitel"), + ('I', "Option"), + ('J', "Bull"), + ('K', "Télématique"), + ('L', "Desmet") + ] + diff --git a/Minitel/Generator.hs b/Minitel/Generator.hs new file mode 100644 --- /dev/null +++ b/Minitel/Generator.hs @@ -0,0 +1,283 @@ +{-| +Module : Generator +Description : MString generator +Copyright : (c) Frédéric BISSON, 2014 +License : GPL-3 +Maintainer : zigazou@free.fr +Stability : experimental +Portability : POSIX + +This module provides functions generating MString for the Minitel. It allows +you to generate special commands for the Minitel like clearing screen, cursor +position etc. without remembering the codes. +-} +module Minitel.Generator where + +import Minitel.Constants +import Minitel.MString +import Data.Char + +-- | The Minitel supports 3 modes, with VideoTex being the standard one with +-- semigraphic 40 columns. Terminal (TeleInformatique) mode is able to +-- display textual 80 columns. +data MMode = VideoTex | Mixed | Terminal + deriving (Ord, Eq, Show) + +-- | Though the Minitel is generally shipped with a monochrome screen, it +-- actually supports colors +type MColor = Int + +-- | Type class helping to convert a color to the actual color code of the +-- Minitel +class ToMColor a where + toMColor :: a -> MColor + +-- | Colors the Minitel is able to render +data Color = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White + deriving (Ord, Eq, Show) + +-- | Grey scale the Minitel is able to render +data Grey = Grey0 | Grey1 | Grey2 | Grey3 | Grey4 | Grey5 | Grey6 | Grey7 + deriving (Ord, Eq, Show) + +instance ToMColor Color where + toMColor a = case a of + Black -> 0 + Red -> 1 + Green -> 2 + Yellow -> 3 + Blue -> 4 + Magenta -> 5 + Cyan -> 6 + White -> 7 + +instance ToMColor Grey where + toMColor a = case a of + Grey0 -> 0 + Grey1 -> 4 + Grey2 -> 1 + Grey3 -> 5 + Grey4 -> 2 + Grey5 -> 6 + Grey6 -> 3 + Grey7 -> 7 + +-- | Switch from one mode to another. Note that all modes combinations are not +-- supported. For example, you cannot go directly from the Terminal mode to +-- the Mixed mode, you have to go back to VideoTex and then to Mixed. +-- Trying to go from a mode to the same mode will do nothing +mMode :: MMode -> MMode -> MConfirmation +mMode Terminal VideoTex = (csi ++ [0x3f, 0x7b], [sep, 0x5e]) +mMode VideoTex Mixed = (pro2 ++ mixed1 , [sep, 0x70]) +mMode VideoTex Terminal = (pro2 ++ telinfo , csi ++ [0x3f, 0x7a]) +mMode Mixed VideoTex = (pro2 ++ mixed2 , [sep, 0x71]) +mMode Mixed Terminal = mMode VideoTex Terminal +mMode _ _ = error "Unsupported mode switch" + +-- | Convert a unicode string into an MString according to a mode. VideoTex +-- offers the best conversion. +mString :: MMode -> String -> MString +mString VideoTex s = concatMap toVideotex s +mString _ s = concatMap toTerminal s + +-- | Get the identification MString from the Minitel +mIdentification :: MCall +mIdentification = (pro1 ++ [enqrom], 5) + +-- | Enable or disable the extended keyboard. Disabled by default. +mExtendedKeyboard :: Bool -> MCall +mExtendedKeyboard True = (pro3 ++ [start, recvKeyboard, extd], pro3Length) +mExtendedKeyboard False = (pro3 ++ [stop , recvKeyboard, extd], pro3Length) + +-- | Enable or disable the cursor keys. If disabled, the user cannot use cursor +-- keys on its Minitel (they will beep). Disabled by default. +mCursorKeys :: Bool -> MCall +mCursorKeys True = (pro3 ++ [start, recvKeyboard, c0], pro3Length) +mCursorKeys False = (pro3 ++ [stop , recvKeyboard, c0], pro3Length) + +-- | Enable or disable caps lock mode. By default, the Minitel is in caps lock +-- mode. +mLowercaseKeyboard :: Bool -> MCall +mLowercaseKeyboard True = (pro2 ++ [start, lowercase], pro2Length) +mLowercaseKeyboard False = (pro2 ++ [stop , lowercase], pro2Length) + +-- | Set foreground color +mForeground :: (ToMColor a) => a -> MString +mForeground color = [esc, 0x40 + toMColor color] + +-- | Set background color +mBackground :: (ToMColor a) => a -> MString +mBackground color = [esc, 0x50 + toMColor color] + +-- | Move cursor to an absolute position. Rows and columns starts at 1 +-- The 0 row is the status line (at the very top of the screen) and is +-- handled differently from the rest of the screen by the Minitel. +mLocate :: Int -> Int -> MString +mLocate 1 1 = [rs] +mLocate x y = [us, 0x40 + y, 0x40 + x] + +-- | Move cursor relatively to its current position. The function optimizes +-- the length of the generated MString +mMove :: Int -> Int -> MString +mMove 0 0 = [] +mMove 0 y | y >= -4 && y <= -1 = replicate (abs y) vt + | y >= 1 && y <= 4 = replicate y lf + | y < 0 = csi ++ showInt y ++ [0x42] + | y > 0 = csi ++ showInt y ++ [0x41] +mMove x 0 | x >= -4 && x <= -1 = replicate (abs x) bs + | x >= 1 && x <= 4 = replicate x tab + | x < 0 = csi ++ showInt x ++ [0x43] + | x > 0 = csi ++ showInt x ++ [0x44] +mMove x y = mMove x 0 ++ mMove 0 y + +-- | Move cursor to the start of the current line. +mGotoStartOfLine :: MString +mGotoStartOfLine = [cr] + +-- | The Minitel is able to double width or height of characters +data CharSize = SimpleSize | DoubleSize + +-- | Change character size. The first argument is the width, the second the +-- height +mSize :: CharSize -> CharSize -> MString +mSize SimpleSize SimpleSize = [esc, 0x4c + 0] +mSize SimpleSize DoubleSize = [esc, 0x4c + 1] +mSize DoubleSize SimpleSize = [esc, 0x4c + 2] +mSize DoubleSize DoubleSize = [esc, 0x4c + 3] + +-- | Enable or disable characters underscoring. No underscoring by default. +mUnderscore :: Bool -> MString +mUnderscore True = [esc, 0x5a] +mUnderscore False = [esc, 0x59] + +-- | Enable or disable characters blinking. No blinking by default. +mBlink :: Bool -> MString +mBlink True = [esc, 0x48] +mBlink False = [esc, 0x49] + +-- | Enable or disable reverse video effect. No effect by default +mReverse :: Bool -> MString +mReverse True = [esc, 0x5d] +mReverse False = [esc, 0x5c] + +-- | Display or hide the cursor. Hidden by default. +mVisibleCursor :: Bool -> MString +mVisibleCursor True = [con] +mVisibleCursor False = [cof] + +-- | Enable or disable the echoing of keys pressed on the keyboard. If enabled, +-- a key pressed is sent both at the screen and at us. The Minitel keyboard +-- allows the user to send control codes and thus change the Minitel +-- configuration. For example, it is possible to change character colors or +-- anything else. +mEchoing :: Bool -> MCall +mEchoing True = (pro3 ++ [switchOn , recvScreen, sendModem], pro3Length) +mEchoing False = (pro3 ++ [switchOff, recvScreen, sendModem], pro3Length) + +-- | Defines what can be cleared on the Minitel screen +data WhatToClear = Everything -- ^ Clear everything except the status + | EndOfLine -- ^ Clear from cursor to end of line + | EndOfScreen -- ^ Clear from cursor to end of screen + | StartOfScreen -- ^ Clear from cursor to start of screen + | StartOfLine -- ^ Clear from cursor to start of line + | Line -- ^ Clear the current line + | StatusLine -- ^ Clear the status line + | ReallyEverything -- ^ Clear everything and the status line + +-- | Clear something on the screen relatively to the current cursor position +mClear :: WhatToClear -> MString +mClear Everything = [ff] +mClear EndOfLine = [can] +mClear EndOfScreen = csi ++ [0x4a] +mClear StartOfScreen = csi ++ [0x31, 0x4a] +mClear StartOfLine = csi ++ [0x31, 0x4b] +mClear Line = csi ++ [0x32, 0x4b] +mClear StatusLine = [us, 0x40, 0x41, can, lf] +mClear ReallyEverything = mClear Everything ++ mClear StatusLine + +-- | Repeat a character. The Minitel has a special function for repeating +-- characters which helps save bandwidth. +mRepeat :: Int -> Int -> MString +mRepeat count c | count == 0 = [] + | count == 1 = [c] + | count == 2 = [c, c] + | count < 87 = [c, rep, 0x40 + count - 1] + | otherwise = error "Count is too big" + +-- | Beep !!! +mBeep :: MString +mBeep = [bel] + +-- | Defines what can be removed on the Minitel screen +data WhatToRemove = Column | Row + +-- | Defines what can be inserted on the Minitel screen +type WhatToInsert = WhatToRemove + +-- | Removes a number of columns or rows on the Minitel screen. Note that +-- removing columns only concerns the current line. Removing row concerns +-- all columns. When removing a column, characters on its right are moved +-- on the left. When removing a row, characters below it are moved upward. +mRemove :: WhatToRemove -> Int -> MString +mRemove Column count = csi ++ showInt count ++ [0x50] +mRemove Row count = csi ++ showInt count ++ [0x4d] + +-- | Inserts a number of columns or rows on the Minitel screen. Note that +-- inserting columns only concerns the current line. Inserting row concerns +-- all columns. When inserting a column, characters on its right are moved +-- on the right. When inserting a row, characters below it are moved +-- downward. +mInsert :: WhatToInsert -> Int -> MString +mInsert Column count = csi ++ [0x34, 0x68] ++ replicate count 0x20 + ++ csi ++ [0x34, 0x6c] +mInsert Row count = csi ++ showInt count ++ [0x4c] + +-- | Enable or disable the semigraphic mode. Disabled by default. +mSemigraphic :: Bool -> MString +mSemigraphic True = [so] +mSemigraphic False = [si] + +-- | The Minitel uses two character sets: G0 and G1 +data CharSet = G0 | G1 + +-- | Chooses which character set will be redefined. Useful only for the +-- mRedesign function. +mDefineSet :: CharSet -> MString +mDefineSet G0 = [us, 0x23, 0x20, 0x20, 0x20, 0x42, 0x49] +mDefineSet G1 = [us, 0x23, 0x20, 0x20, 0x20, 0x43, 0x49] + +-- | Chooses the character set to use +mUseSet :: CharSet -> MString +mUseSet G0 = [esc, 0x28, 0x20, 0x42] +mUseSet G1 = [esc, 0x29, 0x20, 0x43] + +-- | A character design is a list of 10 Strings. Each string contains 8 +-- characters, either '1' or '0', thus allowing you to simple write the +-- character design using Haskell code. +type CharDesign = [String] + +-- | Generate the MString used to redefine one character. Useful only for the +-- mRedesign function +mDesign :: CharDesign -> MString +mDesign design = map bits' ((multiSplit 6 . concat) design) ++ [0x30] + where bits = foldl (\a v -> 2 * a + (if v == '1' then 1 else 0)) 0 + bits' s = 0x40 + bits s * (if length s == 2 then 16 else 1) + multiSplit _ [] = [] + multiSplit nb s = start:multiSplit nb end + where (start, end) = splitAt nb s + +-- | Generate the MString used to redefine several characters. Useful only for +-- the mRedesign function +mDesigns :: [CharDesign] -> [MString] +mDesigns = map mDesign + +-- | Redefine characters given the ord of the first character as the first +-- argument. The character set must also be indicated. It will be +-- automatically selected after the redefinition. +mRedesign :: Int -> [CharDesign] -> CharSet -> MString +mRedesign fromChar designs charset = + mDefineSet charset + ++ (concat . mDesigns) designs + ++ [us, 0x41, 0x41] + ++ mUseSet charset + diff --git a/Minitel/MString.hs b/Minitel/MString.hs new file mode 100644 --- /dev/null +++ b/Minitel/MString.hs @@ -0,0 +1,110 @@ +{-| +Module : MString +Description : Sequence of values for the Minitel +Copyright : (c) Frédéric BISSON, 2014 +License : GPL-3 +Maintainer : zigazou@free.fr +Stability : experimental +Portability : POSIX + +MString Provides a structure holding a sequence of values for the Minitel. +-} +module Minitel.MString where + +import Data.Char +import qualified Data.ByteString as B +import Minitel.Constants + +-- | An MString is just an Int list +type MString = [Int] + +-- | An MConfirmation is composed of two MString, the first is to be sent to +-- the Minitel and the second is what we should receive if everything went +-- well +type MConfirmation = (MString, MString) + +-- | An MCall is composed ot an MString and an Int, the MString is to be sent +-- to the Minitel and the Int is the length of the MString we should receive +-- if everything went well +type MCall = (MString, Int) + +-- | showInt will return an MString generated from an Int. For example, if it +-- is called showInt 27, it will return [0x32, 0x37] +showInt :: Int -> MString +showInt i = map ord $ show i + +-- | Check if an MString received from the Minitel is complete. For example, +-- if the Minitel sent us an 0x19, it should be followed by another value. +completeReturn :: MString -> Bool +completeReturn [] = False +completeReturn [0x19] = False +completeReturn [0x13] = False +completeReturn [0x1b] = False +completeReturn [0x1b, 0x5b] = False +completeReturn [0x1b, 0x5b, 0x32] = False +completeReturn [0x1b, 0x5b, 0x34] = False +completeReturn _ = True + +-- | Translates a unicode character to its VideoTex counterpart. Standard ASCII +-- characters are kept as the Minitel is based upon it. If the character has +-- no VideoTex counterpart, it is simply ignored and suppressed from the +-- outputted MString +toVideotex :: Char -> MString +toVideotex c + | c == '£' = [ss2, 0x23] + | c == '°' = [ss2, 0x30] + | c == '±' = [ss2, 0x31] + | c == '←' = [ss2, 0x2C] + | c == '↑' = [ss2, 0x2D] + | c == '→' = [ss2, 0x2E] + | c == '↓' = [ss2, 0x2F] + | c == '¼' = [ss2, 0x3C] + | c == '½' = [ss2, 0x3D] + | c == '¾' = [ss2, 0x3E] + | c == 'ç' = accCedilla ++ [0x63] + | c == '’' = accCedilla ++ [0x27] + | c == 'à' = accGrave ++ [0x61] + | c == 'á' = accAcute ++ [0x61] + | c == 'â' = accCirconflexe ++ [0x61] + | c == 'ä' = accUmlaut ++ [0x61] + | c == 'è' = accGrave ++ [0x65] + | c == 'é' = accAcute ++ [0x65] + | c == 'ê' = accCirconflexe ++ [0x65] + | c == 'ë' = accUmlaut ++ [0x65] + | c == 'ì' = accGrave ++ [0x69] + | c == 'í' = accAcute ++ [0x69] + | c == 'î' = accCirconflexe ++ [0x69] + | c == 'ï' = accUmlaut ++ [0x69] + | c == 'ò' = accGrave ++ [0x6F] + | c == 'ó' = accAcute ++ [0x6F] + | c == 'ô' = accCirconflexe ++ [0x6F] + | c == 'ö' = accUmlaut ++ [0x6F] + | c == 'ù' = accGrave ++ [0x75] + | c == 'ú' = accAcute ++ [0x75] + | c == 'û' = accCirconflexe ++ [0x75] + | c == 'ü' = accUmlaut ++ [0x75] + | c == 'Œ' = [ss2, 0x6A] + | c == 'œ' = [ss2, 0x7A] + | c == 'ß' = [ss2, 0x7B] + | c == 'β' = [ss2, 0x7B] + | isAscii c = [(fromIntegral . ord) c] + | otherwise = [] + +-- | Translates a unicode character to its TeleInformatique (terminal mode) +-- counterpart. Standard ASCII characters are kept as the Minitel is based +-- upon it. If the character has no TeleInformatique counterpart, it is +-- simply ignored and suppressed from the outputted MString +toTerminal :: Char -> MString +toTerminal c + | c == '£' = [0x0E, 0x23, 0x0F] + | c == '°' = [0x0E, 0x5B, 0x0F] + | c == 'ç' = [0x0E, 0x5C, 0x0F] + | c == '’' = [0x27] + | c == '`' = [0x60] + | c == '§' = [0x0E, 0x5D, 0x0F] + | c == 'à' = [0x0E, 0x40, 0x0F] + | c == 'è' = [0x0E, 0x7F, 0x0F] + | c == 'é' = [0x0E, 0x7B, 0x0F] + | c == 'ù' = [0x0E, 0x7C, 0x0F] + | isAscii c = [(fromIntegral . ord) c] + | otherwise = [] diff --git a/Minitel/Minitel.hs b/Minitel/Minitel.hs new file mode 100644 --- /dev/null +++ b/Minitel/Minitel.hs @@ -0,0 +1,132 @@ +{-| +Module : Minitel +Description : Interface to the Minitel +Copyright : (c) Frédéric BISSON, 2014 +License : GPL-3 +Maintainer : zigazou@free.fr +Stability : experimental +Portability : POSIX + +This module provides to deal with Minitel communications. +-} +module Minitel.Minitel where + +import Minitel.Generator +import Minitel.Queue +import Minitel.MString + +import System.Hardware.Serialport +import qualified Data.ByteString as B + +import Control.Concurrent +import Control.Concurrent.STM.TQueue +import Control.Concurrent.STM + +import Control.Monad + +-- | Structure to hold Minitel components +data Minitel = Minitel + { serial :: SerialPort -- ^ Serial port to which the Minitel is connected + , input :: Queue -- ^ What we receive from the Minitel + , output :: Queue -- ^ What we send to the Minitel + , receiver :: ThreadId -- ^ Receiver thread, allowing full-duplex + , sender :: ThreadId -- ^ Sender thread, allowing full-duplex + } + +-- | Operator to send an MString to the Minitel +(<<<) :: Minitel -> MString -> IO () +(<<<) minitel s = do + putM (output minitel) s + +-- | Sends an MString to the Minitel and waits for its answer. The answer +-- should be the awaited one specified in the MConfirmation. If there is +-- no answer from the Minitel or the answer is not the right one, returns +-- False +mConfirmation :: Minitel -> MConfirmation -> IO Bool +mConfirmation minitel (mSend, mReceive) = do + putM (output minitel) mSend + answer <- readMString (get $ input minitel) completeReturn + return (answer == mReceive) + +-- | Sends an MString to the Minitel and waits for its answer. It returns +-- an MString of max length as specified in the MCall. +mCall :: Minitel -> MCall -> IO MString +mCall minitel (mSend, count) = do + putM (output minitel) mSend + return =<< readCount (get $ input minitel) count + +-- | Waits for an MString of @count@ elements coming from the Minitel. If it +-- takes too long, returns what has already been collected. +readCount :: (Eq a) => IO a -> Int -> IO [a] +readCount getter count = readMString getter isComplete + where isComplete seq = length seq == count + +-- | Waits for a complete MString coming from the Minitel. If it takes too +-- long, returns what has already been collected. To determine if the MString +-- is complete, it needs an @isComplete@ function which tells if an MString +-- is complete (True) or not (False). +readMString :: (Eq a) => IO a -> ([a] -> Bool) -> IO [a] +readMString getter isComplete = readMString' [] + where readMString' s + | isComplete s = return s + | s == [] = getter >>= \value -> readMString' [value] + | otherwise = do + result <- waitFor 10000000 getter + case result of + Just value -> readMString' $ s ++ [value] + Nothing -> return s + +-- | Waits for either a read to succeed or a delay to end. It does this by +-- running two threads. The first one to press the buzzer will stop the +-- function and returns the result (either Just a or Nothing) +waitFor :: (Eq a) => Int -> IO a -> IO (Maybe a) +waitFor delay getter = do + done <- newEmptyMVar + + -- Run a race between the reader and the waiter + reader <- forkIO $ getter >>= \c -> putMVar done $ Just c + waiter <- forkIO $ threadDelay delay >> putMVar done Nothing + + -- Wait for the first to win + result <- takeMVar done + + killThread reader + killThread waiter + + return result + +-- | Base settings for the serial port on which is connected a Minitel. +-- Standard configuration is 1200 bps, 7 bits, 1 stop, even parity. +baseSettings = SerialPortSettings + { commSpeed = CS1200 + , bitsPerWord = 7 + , stopb = One + , parity = Even + , flowControl = NoFlowControl + , timeout = 1000000 + } + +-- | Opens a full-duplex connection to a Minitel. The default serial is set +-- to /dev/ttyUSB0. +minitel :: String -> SerialPortSettings -> IO Minitel +minitel "" settings = minitel "/dev/ttyUSB0" settings +minitel dev settings = do + port <- openSerial dev settings + sendQueue <- atomically $ newTQueue + recvQueue <- atomically $ newTQueue + sendThread <- forkIO $ sendLoop port sendQueue + recvThread <- forkIO $ recvLoop port recvQueue + + return Minitel + { serial = port + , input = recvQueue + , output = sendQueue + , receiver = recvThread + , sender = sendThread + } + where sendLoop s q = forever $ get q >>= send s . B.singleton . fromIntegral + recvLoop s q = forever $ do + b <- recv s 1 + when (1 <= B.length b) $ (put q . fromIntegral . B.head) b + + diff --git a/Minitel/Queue.hs b/Minitel/Queue.hs new file mode 100644 --- /dev/null +++ b/Minitel/Queue.hs @@ -0,0 +1,35 @@ +{-| +Module : Queue +Description : Shared queue for the Minitel +Copyright : (c) Frédéric BISSON, 2014 +License : GPL-3 +Maintainer : zigazou@free.fr +Stability : experimental +Portability : POSIX + +Provides a shared queue for dealing with a Minitel +-} +module Minitel.Queue where + +import Minitel.MString + +import qualified Data.ByteString as B +import Control.Concurrent.STM.TQueue (TQueue, writeTQueue, readTQueue) +import Control.Concurrent.STM (atomically) +import Control.Monad (forM_) + +-- | A queue is just a TQueue of Int +type Queue = TQueue Int + +-- | Send an MString to the queue +putM :: Queue -> MString -> IO () +putM q s = forM_ s $ \ x -> do put q x + +-- | Send and Int to the queue +put :: Queue -> Int -> IO () +put q = (atomically . writeTQueue q) + +-- | Blocking get to retrieve an Int from the queue +get :: Queue -> IO Int +get = atomically . readTQueue + diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain