rasa 0.1.7 → 0.1.8
raw patch · 32 files changed
+1776/−620 lines, 32 filesdep +QuickCheckdep +bifunctorsdep +freedep ~basedep ~text-lens
Dependencies added: QuickCheck, bifunctors, free, hspec, pipes, pipes-concurrency, pipes-parse, quickcheck-instances, rasa
Dependency ranges changed: base, text-lens
Files
- LICENSE +670/−17
- README.md +17/−5
- rasa.cabal +42/−6
- src/Rasa.hs +17/−16
- src/Rasa/Ext.hs +45/−30
- src/Rasa/Internal/Action.hs +98/−96
- src/Rasa/Internal/Actions.hs +135/−0
- src/Rasa/Internal/Async.hs +93/−23
- src/Rasa/Internal/BufAction.hs +150/−0
- src/Rasa/Internal/Buffer.hs +3/−35
- src/Rasa/Internal/Directive.hs +0/−135
- src/Rasa/Internal/Editor.hs +7/−37
- src/Rasa/Internal/Events.hs +11/−6
- src/Rasa/Internal/Extensions.hs +68/−0
- src/Rasa/Internal/Listeners.hs +186/−0
- src/Rasa/Internal/Range.hs +101/−44
- src/Rasa/Internal/Scheduler.hs +0/−169
- src/Rasa/Internal/Text.hs +1/−1
- test/ArbitraryInstances.hs +20/−0
- test/Rasa/Internal/ActionSpec.hs +6/−0
- test/Rasa/Internal/ActionsSpec.hs +6/−0
- test/Rasa/Internal/AsyncSpec.hs +6/−0
- test/Rasa/Internal/BufActionSpec.hs +6/−0
- test/Rasa/Internal/BufferSpec.hs +6/−0
- test/Rasa/Internal/EditorSpec.hs +6/−0
- test/Rasa/Internal/EventsSpec.hs +6/−0
- test/Rasa/Internal/ExtensionsSpec.hs +6/−0
- test/Rasa/Internal/ListenersSpec.hs +6/−0
- test/Rasa/Internal/RangeSpec.hs +22/−0
- test/Rasa/Internal/TextSpec.hs +25/−0
- test/RasaSpec.hs +9/−0
- test/Spec.hs +2/−0
LICENSE view
@@ -1,21 +1,674 @@-The MIT License+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007 -Copyright (c) 2016 Chris Penner+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed. -Permission is hereby granted, free of charge, to any person obtaining a copy-of this software and associated documentation files (the "Software"), to deal-in the Software without restriction, including without limitation the rights-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell-copies of the Software, and to permit persons to whom the Software is-furnished to do so, subject to the following conditions:+ Preamble -The above copyright notice and this permission notice shall be included in-all copies or substantial portions of the Software.+ The GNU General Public License is a free, copyleft license for+software and other kinds of works. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN-THE SOFTWARE.+ 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.++ {one line to give the program's name and a brief idea of what it does.}+ Copyright (C) {year} {name of author}++ 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 <http://www.gnu.org/licenses/>.++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:++ {project} Copyright (C) {year} {fullname}+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
README.md view
@@ -45,7 +45,8 @@ ### Troubleshooting -- You may need to install icu4c (`brew install icu4c`), it's a dependency of the rope library rasa uses.+- You may need to install icu4c (`brew install icu4c`), it's a dependency of the rope library rasa uses. +- On linux, when the error message `Missing C libraries: icuuc, icui18n, icudata` appears, install `libicu-dev` (e.g. with `sudo apt install libicu-dev`). - You'll need to point to the icu4c lib in your stack.yaml wherever it's stored on your system. If you install using brew on your Mac, then you can add the following to your stack.yaml: @@ -93,7 +94,7 @@ you're running rasa you can experiment with creating your own adaptations. You should customize your keymap to add a few mappings you like. It's a short step from here to developing your own extensions. `Action`s like you'd use in an-extension can be registered to hooks in your `Main.hs`. You can build and+extension can be registered to listeners in your `Main.hs`. You can build and experiment with entire extensions in your config file and extract them as a package when you're ready, kind of like a vimrc file. Again, just read the extension guide, it covers what you need to know!@@ -147,11 +148,11 @@ Here are some features of that API: -### Event Hook System+### Event Listener System All actions in the editor are triggered via an event/listener system. Extensions may subscribe to events from the editor, or from another extension-and perform an action in response. The Event which triggered the hook is+and perform an action in response. The Event which triggered the listener is available as an argument). Extensions may also dispatch any kind of event at any time which other extensions may listen for. @@ -162,8 +163,19 @@ may perform IO, access the available buffers, store and access extension state, and edit text. +Running Tests+-------------++Run all tests:++- `stack test`++Run only tests for core editor:++- `stack test rasa`+ Contributing-============+------------ Things are moving quickly, but I'd love a hand! You can get a rough idea of where you can help out at the
rasa.cabal view
@@ -1,8 +1,8 @@ name: rasa-version: 0.1.7+version: 0.1.8 cabal-version: >=1.10 build-type: Simple-license: MIT+license: GPL-3.0 license-file: LICENSE copyright: 2016 Chris Penner maintainer: christopher.penner@gmail.com@@ -59,27 +59,63 @@ Rasa Rasa.Ext Rasa.Internal.Action+ Rasa.Internal.Actions Rasa.Internal.Async+ Rasa.Internal.BufAction Rasa.Internal.Buffer- Rasa.Internal.Directive Rasa.Internal.Editor Rasa.Internal.Events Rasa.Internal.Extensions+ Rasa.Internal.Listeners Rasa.Internal.Range- Rasa.Internal.Scheduler Rasa.Internal.Text build-depends: base >=4.8 && <5, async >=2.1.1 && <2.2,+ bifunctors >=5.4.1 && <5.5, containers >=0.5.7.1 && <0.6, data-default >=0.7.1.1 && <0.8,+ free >=4.12.4 && <4.13, lens ==4.14.*, mtl >=2.2.1 && <2.3, text >=1.2.2.1 && <1.3,- text-lens >=0.1.0.0 && <0.2,+ text-lens >=0.1.1 && <0.2, transformers >=0.5.2.0 && <0.6,- yi-rope >=0.7.0.2 && <0.8+ yi-rope >=0.7.0.2 && <0.8,+ pipes >=4.1.9 && <4.2,+ pipes-concurrency >=2.0.6 && <2.1,+ pipes-parse >=3.0.7 && <3.1 default-language: Haskell2010 hs-source-dirs: src ghc-options: -Wall +test-suite rasa-test+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ build-depends:+ base >=4.9.0.0 && <4.10,+ rasa >=0.1.8 && <0.2,+ hspec >=2.2.4 && <2.3,+ lens ==4.14.*,+ yi-rope >=0.7.0.2 && <0.8,+ text >=1.2.2.1 && <1.3,+ quickcheck-instances >=0.3.12 && <0.4,+ QuickCheck >=2.8.2 && <2.9+ default-language: Haskell2010+ default-extensions: OverloadedStrings+ hs-source-dirs: test+ other-modules:+ ArbitraryInstances+ RasaSpec+ Rasa.Internal.ActionSpec+ Rasa.Internal.ActionsSpec+ Rasa.Internal.AsyncSpec+ Rasa.Internal.BufActionSpec+ Rasa.Internal.BufferSpec+ Rasa.Internal.EditorSpec+ Rasa.Internal.EventsSpec+ Rasa.Internal.ExtensionsSpec+ Rasa.Internal.ListenersSpec+ Rasa.Internal.RangeSpec+ Rasa.Internal.TextSpec+ ghc-options: -threaded -rtsopts -with-rtsopts=-N
src/Rasa.hs view
@@ -4,15 +4,17 @@ import Rasa.Internal.Editor import Rasa.Internal.Action import Rasa.Internal.Events-import Rasa.Internal.Scheduler+import Rasa.Internal.Listeners -import Control.Concurrent.Async import Control.Lens import Control.Monad import Control.Monad.IO.Class-import Data.Default (def)-import Data.List+import Data.Maybe +import Pipes+import Pipes.Concurrent+import Pipes.Parse+ -- | The main function to run rasa. -- -- @rasa eventProviders extensions@@@ -26,25 +28,24 @@ -- > slate rasa :: Action () -> IO ()-rasa initilize =- evalAction def $ do+rasa initilize = do+ (output, input) <- spawn unbounded+ evalAction (mkActionState output) $ do initilize dispatchEvent Init- eventLoop+ eventLoop $ fromInput input dispatchEvent Exit -- | This is the main event loop, it runs recursively forever until something--- sets 'Rasa.Editor.exiting'. It runs the pre-event hooks, then checks if any--- async events have finished, then runs the post event hooks and repeats.-eventLoop :: Action ()-eventLoop = do+-- sets 'Rasa.Editor.exiting'. It runs the pre-event listeners, then checks if any+-- async events have finished, then runs the post event listeners and repeats.+eventLoop :: Producer (Action ()) IO () -> Action ()+eventLoop producer = do dispatchEvent BeforeRender dispatchEvent OnRender dispatchEvent AfterRender dispatchEvent BeforeEvent- asyncActions <- use asyncs- (done, action) <- liftIO $ waitAny asyncActions- asyncs %= delete done- action+ (mAction, nextProducer) <- liftIO $ runStateT draw producer+ fromMaybe (return ()) mAction isExiting <- use exiting- unless isExiting eventLoop+ unless isExiting $ eventLoop nextProducer
src/Rasa/Ext.hs view
@@ -25,22 +25,22 @@ -- > logKeypress :: Keypress -> Action () -- > logKeypress (Keypress char _) = liftIO $ appendFile "logs" ("You pressed " ++ [char] ++ "\n") -- >--- > logger :: Action HookId+-- > logger :: Action () -- > logger = do -- > onInit $ liftIO $ writeFile "logs" "==Logs==\n"--- > onEveryTrigger_ logKeypress+-- > -- Listeners should also be registered using 'onInit'.+-- > -- It ensures all listeners are ready before any actions occur.+-- > onInit $ onEveryTrigger_ logKeypress -- > onExit $ liftIO $ appendFile "logs" "==Done==" -- -- Check out this tutorial on building extensions, it's also just a great way to learn--- how the editor works: <https://github.com/ChrisPenner/rasa/blob/master/docs/Building-An-Extension.md Building an--- Extension>.+-- how the editor works: <https://github.com/ChrisPenner/rasa/blob/master/docs/Building-An-Extension.md Extension-Guide>. ---------------------------------------------------------------------------- module Rasa.Ext ( -- * Editor Actions Action- , doAsync , exit -- * Managing Buffers@@ -52,6 +52,15 @@ , getBuffer -- * Working with Buffers+ , Buffer+ , HasBuffer(..)+ , BufRef+ , text+ , HasEditor+ , getText+ , getRange++ -- * Actions over Buffers , BufAction , liftAction , bufDo@@ -75,8 +84,8 @@ -- a counter as an Int, wrap it in your own custom Counter newtype when storing -- it. --- -- Because Extension states are stored by their TypeRep, they must define an- -- instance of Typeable, luckily GHC can derive this for you.+ -- Because Extension states are stored by their 'Data.Typeable.TypeRep', they must define an+ -- instance of 'Data.Typeable.Typeable', luckily GHC can derive this for you. -- -- It is also required for all extension states to define an instance of -- 'Data.Default.Default', this is because accessing an extension which has not@@ -89,7 +98,7 @@ -- Extensions may store state persistently for later access or for other -- extensions to access. Because Rasa can't possibly know the types of the -- state that extensions will store it uses a clever workaround wherein- -- extension states are stored in a map of 'Data.Typeable.TypeRep' -> Ext+ -- extension states are stored in a map of 'Data.Typeable.TypeRep' -> 'Rasa.Internal.Extensions.Ext' -- which is coerced into the proper type when it's extracted. The interface to -- extract or alter a given extension is to use the 'ext' and 'bufExt' lenses. -- Simply use them as though they were lenses to an object of your type and@@ -98,36 +107,24 @@ -- Since it's polymorphic, if ghc can't figure out the type the result is -- supposed to be then you'll need to help it out. In practice you won't -- typically need to do this unless you're doing something complicated.-+ , HasExts(..) , ext+ , HasBufExts(..) , bufExt - -- * Accessing/Editing Context- , Buffer- , HasBuffer- , BufRef- , HasEditor- , text- -- | A lens over the buffer's Text as a 'Yi.Rope.YiString'. Use within a 'BufAction':- --- -- > txt <- use text- -- * Events , Keypress(..) , Mod(..) -- * Dealing with events- , Hooks- , Hook- , HookId+ , ListenerId , dispatchEvent , onEveryTrigger , onEveryTrigger_ , onNextEvent , removeListener- , eventProvider - -- * Built-in Event Hooks+ -- * Built-in Event Listeners , onInit , beforeEveryEvent , beforeEveryEvent_@@ -143,17 +140,33 @@ , afterNextRender , onExit , onBufAdded+ , onBufTextChanged + -- * Working with Async Events/Actions+ , Dispatcher+ , dispatchActionAsync+ , dispatchEventAsync+ , asyncEventProvider+ , asyncActionProvider+ -- * Ranges , Range(..)- , Coord(..)+ , CrdRange+ , Coord+ , Coord'(..) , Offset(..) , Span(..)+ , overRow+ , overCol+ , coordRow+ , coordCol+ , overBoth , combineSpans , asCoord , clampCoord , clampRange- , range+ , rStart+ , rEnd , sizeOfR , afterC , beforeC@@ -169,11 +182,13 @@ ) where import Rasa.Internal.Action+import Rasa.Internal.Actions import Rasa.Internal.Async-import Rasa.Internal.Directive+import Rasa.Internal.BufAction+import Rasa.Internal.Buffer import Rasa.Internal.Editor import Rasa.Internal.Events-import Rasa.Internal.Buffer-import Rasa.Internal.Text+import Rasa.Internal.Extensions import Rasa.Internal.Range-import Rasa.Internal.Scheduler+import Rasa.Internal.Listeners+import Rasa.Internal.Text
src/Rasa/Internal/Action.hs view
@@ -1,135 +1,137 @@-{-# LANGUAGE GeneralizedNewtypeDeriving, ExistentialQuantification, TemplateHaskell, StandaloneDeriving,- MultiParamTypeClasses, FlexibleInstances #-}+{-# language DeriveFunctor+ , MultiParamTypeClasses+ , FlexibleInstances+ , GeneralizedNewtypeDeriving+ , Rank2Types+ , ExistentialQuantification+ , TemplateHaskell #-}+module Rasa.Internal.Action+ ( Action(..)+ , runAction+ , evalAction+ , execAction+ , ActionState+ , mkActionState+ , Listener(..)+ , ListenerId(..)+ , Listeners+ , listeners+ , nextListenerId+ , actionQueue+ ) where -module Rasa.Internal.Action where+import Rasa.Internal.Editor+import Rasa.Internal.Extensions import Control.Lens-import Control.Concurrent.Async+import Control.Monad.Free import Control.Monad.State-import Data.Dynamic-import Data.Map+ import Data.Default+import Data.Map+import Data.Typeable -import Rasa.Internal.Buffer-import Rasa.Internal.Editor+import Pipes.Concurrent hiding (Buffer) +-- | A wrapper around event listeners so they can be stored in 'Listeners'.+data Listener = forall a. Listener ListenerId (a -> Action ()) --- | A wrapper around event listeners so they can be stored in 'Hooks'.-data Hook = forall a. Hook HookId (a -> Action ())-data HookId =- HookId Int TypeRep+-- | An opaque reverence to a specific registered event-listener. +-- A ListenerId is used only to remove listeners later with 'Rasa.Internal.Listeners.removeListener'.+data ListenerId =+ ListenerId Int TypeRep -instance Eq HookId where- HookId a _ == HookId b _ = a == b+instance Eq ListenerId where+ ListenerId a _ == ListenerId b _ = a == b -- | A map of Event types to a list of listeners for that event-type Hooks = Map TypeRep [Hook]+type Listeners = Map TypeRep [Listener] --- | This is a monad-transformer stack for performing actions against the editor.--- You register Actions to be run in response to events using 'Rasa.Internal.Scheduler.onEveryTrigger'+-- | Free Monad Actions for Action+data ActionF state next =+ LiftState (state -> (next, state))+ | LiftIO (IO next)+ deriving (Functor)++-- | This is a monad for performing actions against the editor.+-- You can register Actions to be run in response to events using 'Rasa.Internal.Listeners.onEveryTrigger' -- -- Within an Action you can: -- -- * Use liftIO for IO -- * Access/edit extensions that are stored globally, see 'ext' -- * Embed any 'Action's exported other extensions--- * Embed buffer actions using 'Rasa.Internal.Ext.Directive.bufDo' or 'Rasa.Internal.Ext.Directive.buffersDo'--- * Add\/Edit\/Focus buffers and a few other Editor-level things, see the 'Rasa.Internal.Ext.Directive' module.-+-- * Embed buffer actions using 'Rasa.Internal.Actions.bufDo' or 'Rasa.Internal.Actions.buffersDo'+-- * Add\/Edit\/Focus buffers and a few other Editor-level things, see the "Rasa.Internal.Actions" module. newtype Action a = Action- { runAct :: StateT ActionState IO a- } deriving (Functor, Applicative, Monad, MonadState ActionState, MonadIO)---- | Execute an Action (returning the editor state)-execAction :: ActionState -> Action () -> IO ActionState-execAction actionState action = execStateT (runAct action) actionState---- | Evaluate an Action (returning the value)-evalAction :: ActionState -> Action a -> IO a-evalAction actionState (Action action) = evalStateT action actionState+ { getAction :: Free (ActionF ActionState) a+ } deriving (Functor, Applicative, Monad) -type AsyncAction = Async (Action ()) -- | This contains all data representing the editor's state. It acts as the state object for an 'Action data ActionState = ActionState { _ed :: Editor- , _asyncs :: [AsyncAction]- , _hooks :: Hooks- , _nextHook :: Int+ , _listeners :: Listeners+ , _nextListenerId :: Int+ , _actionQueue :: Output (Action ()) } makeLenses ''ActionState --- | Allows polymorphic lenses which need to access something in ActionState-class HasActionState a where- actionState :: Lens' a ActionState+instance Show ActionState where+ show as = show (_ed as) -instance HasActionState ActionState where- actionState = lens id (flip const)+mkActionState :: Output (Action ()) -> ActionState+mkActionState out = ActionState+ { _ed=def+ , _listeners=def+ , _nextListenerId=0+ , _actionQueue=out+ } instance HasEditor ActionState where editor = ed -instance Default ActionState where- def = ActionState- { _ed=def- , _asyncs=def- , _hooks=def- , _nextHook=0- }+instance HasExts ActionState where+ exts = ed.exts --- | Contains all data about the editor; as well as a buffer which is in 'focus'.--- We keep the full ActionState here too so that 'Action's may be lifted inside a 'BufAction'-data BufActionState = BufActionState- { _actState :: ActionState- , _buf :: Buffer- }-makeLenses ''BufActionState+-- | Embeds a ActionF type into the Action Monad+liftActionF :: ActionF ActionState a -> Action a+liftActionF = Action . liftF -instance Show ActionState where- show as = show (_ed as)+-- | Allows running state actions over ActionState; used to lift mtl state functions+liftState :: (ActionState -> (a, ActionState)) -> Action a+liftState = liftActionF . LiftState --- | This is a monad-transformer stack for performing actions on a specific buffer.--- You run 'BufAction's by embedding them in a 'Action' via 'bufferDo' or 'buffersDo'------ Within a BufAction you can:------ * Use 'liftAction' to run an 'Action'; It is your responsibility to ensure that any nested 'Action's don't edit- -- the Buffer which the current 'BufAction' is editing; behaviour is undefined if this occurs.--- * Use liftIO for IO--- * Access/Edit the buffer's 'text'--- * Access/edit buffer extensions; see 'bufExt'--- * Embed and sequence 'BufAction's from other extensions+-- | Allows running IO in BufAction.+liftFIO :: IO r -> Action r+liftFIO = liftActionF . LiftIO -newtype BufAction a = BufAction- { runBufAct :: StateT BufActionState IO a- } deriving (Functor, Applicative, Monad, MonadState BufActionState, MonadIO)+instance (MonadState ActionState) Action where+ state = liftState -instance HasBuffer BufActionState where- buffer = buf+instance MonadIO Action where+ liftIO = liftFIO -instance HasActionState BufActionState where- actionState = actState+-- | Runs an Action into an IO+runAction :: ActionState -> Action a -> IO (a, ActionState)+runAction actionState (Action actionF) = actionInterpreter actionState actionF --- | This lifts up a bufAction into an Action which performs the 'BufAction'--- over the referenced buffer and returns the result (if the buffer existed)-liftBuf :: BufAction a -> BufRef -> Action (Maybe a)-liftBuf (BufAction bufAct) (BufRef bufInd) = do- actionState' <- get- mBuf <- getBuffer- case mBuf of- Nothing -> return Nothing- Just b -> do- let bufActSt = BufActionState actionState' b- (val, newBufActState) <- liftIO $ runStateT bufAct bufActSt- put (newBufActState^.actionState)- setBuffer (newBufActState^.buf)- return (Just val)- where- getBuffer = use (buffers.at bufInd)- setBuffer b = buffers.at bufInd ?= b+-- | Evals an Action into an IO+evalAction :: ActionState -> Action a -> IO a+evalAction actionState action = fst <$> runAction actionState action --- | This lifts up an 'Action' to be run inside a 'BufAction'------ it is your responsibility to ensure that any nested 'Action's don't edit--- the Buffer which the current 'BufAction' is editing; behaviour is undefined if this occurs.-liftAction :: Action a -> BufAction a-liftAction (Action action) = BufAction $ zoom actionState action+-- | Execs an Action into an IO+execAction :: ActionState -> Action a -> IO ActionState+execAction actionState action = snd <$> runAction actionState action++-- | Interpret the Free Monad; in this case it interprets it down to an IO+actionInterpreter :: ActionState -> Free (ActionF ActionState) r -> IO (r, ActionState)+actionInterpreter actionState (Free actionF) =+ case actionF of+ (LiftState stateFunc) -> + let (next, newState) = stateFunc actionState+ in actionInterpreter newState next++ (LiftIO ioNext) ->+ ioNext >>= actionInterpreter actionState++actionInterpreter actionState (Pure res) = return (res, actionState)
+ src/Rasa/Internal/Actions.hs view
@@ -0,0 +1,135 @@+{-# language Rank2Types, OverloadedStrings #-}+module Rasa.Internal.Actions+ (+ -- * Performing Actions on Buffers+ bufDo+ , bufDo_+ , buffersDo+ , buffersDo_++ -- * Editor Actions+ , exit+ , newBuffer+ , getBufRefs+ , getBuffers+ , getBuffer+ , nextBufRef+ , prevBufRef++ -- * Buffer Actions+ , overRange+ , replaceRange+ , deleteRange+ , insertAt+ , sizeOf+ ) where++import Rasa.Internal.Editor+import Rasa.Internal.Action+import Rasa.Internal.BufAction+import Rasa.Internal.Range+import Rasa.Internal.Listeners+import Rasa.Internal.Events+import Rasa.Internal.Buffer as B++import Control.Lens+import Control.Monad+import Control.Arrow (first)+import Data.Maybe+import Data.IntMap as M+import qualified Yi.Rope as Y+++-- | This lifts a 'Rasa.Action.BufAction' to an 'Rasa.Action.Action' which+-- performs the 'Rasa.Action.BufAction' on every buffer and collects the return+-- values as a list.++buffersDo :: BufAction a -> Action [a]+buffersDo bufAct = do+ bufRefs <- getBufRefs+ catMaybes . foldMap (:[]) <$> mapM (runBufAction bufAct) bufRefs++buffersDo_ :: BufAction a -> Action ()+buffersDo_ = void . buffersDo++-- | This lifts a 'Rasa.Internal.Action.BufAction' to an 'Rasa.Internal.Action.Action' which+-- performs the 'Rasa.Internal.Action.BufAction' on the buffer referred to by the 'BufRef'+-- If the buffer referred to no longer exists this returns: @Nothing@.+bufDo :: BufRef -> BufAction a -> Action (Maybe a)+bufDo bufRef bufAct = runBufAction bufAct bufRef++bufDo_ :: BufRef -> BufAction a -> Action ()+bufDo_ bufRef bufAct = void $ bufDo bufRef bufAct++-- | This adds a new buffer with the given text, returning a reference to that buffer.+newBuffer :: Y.YiString -> Action BufRef+newBuffer txt = do+ n <- nextBufId <<+= 1+ buffers %= insert n (mkBuffer txt)+ let bufRef = BufRef n+ dispatchEvent (BufAdded bufRef)+ return bufRef++-- | Returns an up-to-date list of all 'BufRef's+getBufRefs :: Action [BufRef]+getBufRefs = fmap BufRef <$> use (buffers.to keys)++-- | Returns the 'Buffer' for a BufRef if it still exists.+-- This is read-only; altering the buffer has no effect on the stored buffer.+-- This function is useful for renderers.+getBuffer :: BufRef -> Action (Maybe Buffer)+getBuffer (BufRef bufInt) = use (buffers.at bufInt)++-- | Returns an up-to-date list of all 'Buffer's, returned values+-- are read-only; altering them has no effect on the actual stored buffers.+-- This function is useful for renderers.+getBuffers :: Action [(BufRef, Buffer)]+getBuffers = fmap (first BufRef) <$> use (buffers.to assocs)++-- | Gets 'BufRef' that comes after the one provided+nextBufRef :: BufRef -> Action BufRef+nextBufRef br@(BufRef bufInt) = do+ bufMap <- use buffers+ if M.null bufMap+ then return br+ else do+ let mGreaterInd = lookupGT bufInt bufMap+ case mGreaterInd of+ Just (greaterInd, _) -> return $ BufRef greaterInd+ Nothing -> return . BufRef . fst . findMin $ bufMap++-- | Gets 'BufRef' that comes before the one provided+prevBufRef :: BufRef -> Action BufRef+prevBufRef br@(BufRef bufInt) = do+ bufMap <- use buffers+ if M.null bufMap+ then return br+ else do+ let mLesserInd = lookupLT bufInt bufMap+ case mLesserInd of+ Just (lesserInd, _) -> return $ BufRef lesserInd+ Nothing -> return . BufRef . fst . findMax $ bufMap++-- | This signals to the editor that you'd like to shutdown. The current events+-- will finish processing, then the 'Rasa.Internal.Listeners.onExit' event will be dispatched,+-- then the editor will exit.++exit :: Action ()+exit = exiting .= True++-- | Runs function over given range of text+overRange :: CrdRange -> (Y.YiString -> Y.YiString) -> BufAction ()+overRange r f = getRange r >>= setRange r . f++-- | Deletes the text in the given range from the buffer.+deleteRange :: CrdRange -> BufAction ()+deleteRange r = replaceRange r ""++-- | Replaces the text in the given range with the given text.+replaceRange :: CrdRange -> Y.YiString -> BufAction ()+replaceRange r txt = overRange r (const txt)++-- | Inserts text into the buffer at the given 'Coord'.+insertAt :: Coord -> Y.YiString -> BufAction ()+insertAt c = replaceRange r+ where r = Range c c
src/Rasa/Internal/Async.hs view
@@ -1,31 +1,97 @@-module Rasa.Internal.Async - ( doAsync- , eventProvider+{-# language Rank2Types, ExistentialQuantification #-}+module Rasa.Internal.Async+ ( asyncEventProvider+ , Dispatcher+ , asyncActionProvider+ , dispatchEventAsync+ , dispatchActionAsync ) where import Rasa.Internal.Action-import Rasa.Internal.Scheduler+import Rasa.Internal.Listeners -import Data.Typeable-import Control.Concurrent.Async import Control.Lens import Control.Monad.IO.Class +import Data.Typeable++import Pipes+import Pipes.Concurrent++-- | A helper which when given an output channel results in a function from @Action () -> IO ()@ which+-- dispatches any actions it's called with asyncronously to the main event loop.+dispatchAction :: Output (Action ()) -> Action () -> IO ()+dispatchAction output act =+ void . forkIO $ do runEffect $ yield act >-> toOutput output+ performGC+ -- | This function takes an IO which results in some Event, it runs the IO--- asynchronously and dispatches the event, then repeats the process all over--- again. Use this inside the onInit scheduler to register an event listener--- for some event (e.g. keypresses or network activity)+-- asynchronously and dispatches the event+dispatchEventAsync :: Typeable a => IO a -> Action ()+dispatchEventAsync getEventIO = do+ out <- use actionQueue+ liftIO $ void . forkIO $ do runEffect $ producer >-> toOutput out+ performGC+ where+ producer :: Producer (Action ()) IO ()+ producer = do+ evt <- lift getEventIO+ yield (dispatchEvent evt) -eventProvider :: Typeable a => IO a -> Action ()-eventProvider getEventIO = doAsync (dispatchAndRerun <$> getEventIO)- where dispatchAndRerun evt = do- dispatchEvent evt- eventProvider getEventIO+-- | This allows long-running IO processes to provide Events to Rasa asyncronously.+--+-- Don't let the type signature confuse you; it's much simpler than it seems.+--+-- Let's break it down:+--+-- @('Dispatcher' -> 'IO' ())@: 'Dispatcher' is a type alias just to make defining your own functions easier;+-- Using 'Dispatcher' with asyncEventProvider requires the @Rank2Types@ language pragma.+--+-- This type as a whole represents a function which accepts a 'Dispatcher' and returns an 'IO';+-- the dispatcher itself accepts data of ANY 'Typeable' type and emits it as an event (see the "Rasa.Internal.Events").+--+-- When you call 'asyncEventProvider' you pass it a function which accepts a @dispatch@ function as an argument+-- and then calls it with various events within the resulting 'IO'.+--+-- Note that asyncEventProvider calls forkIO internally, so there's no need to do that yourself.+--+-- Here's a simple example which fires a @Timer@ event every second.+--+-- > {-# language Rank2Types #-}+-- > data Timer = Timer+-- > myTimer :: Dispatcher -> IO ()+-- > myTimer dispatch = forever $ dispatch Timer >> threadDelay 1000000+-- >+-- > myAction :: Action ()+-- > myAction = onInit $ asyncEventProvider myTimer --- | doAsync allows you to perform a task asynchronously and then apply the--- result. In @doAsync asyncAction@, @asyncAction@ is an IO which resolves to+asyncEventProvider :: (Dispatcher -> IO ()) -> Action ()+asyncEventProvider eventProvidingIO = do+ out <- use actionQueue+ liftIO $ void . forkIO $ eventProvidingIO (dispatchAction out . dispatchEvent)++-- | This is a type alias to make defining your event provider functions easier;+-- It represents the function your event provider function will be passed to allow dispatching+-- events. Using this type requires the @Rank2Types@ language pragma.+type Dispatcher = forall a. Typeable a => a -> IO ()++-- | Don't let the type signature confuse you; it's much simpler than it seems.+-- The first argument is a function which takes an action provider; the action provider+-- will be passed a dispatch function which can be called as often as you like with @Action ()@s.+-- When it is passed an 'Action' it forks off an IO to dispatch that 'Action' to the main event loop.+-- Note that the dispatch function calls forkIO on its own; so there's no need for you to do so.+--+-- Use this function when you have some long-running process which dispatches multiple 'Action's.++asyncActionProvider :: ((Action () -> IO ()) -> IO ()) -> Action ()+asyncActionProvider actionProvidingIO = do+ out <- use actionQueue+ liftIO $ void . forkIO $ actionProvidingIO (dispatchAction out)++-- | dispatchActionAsync allows you to perform a task asynchronously and then apply the+-- result. In @dispatchActionAsync asyncAction@, @asyncAction@ is an IO which resolves to -- an Action, note that the context in which the second action is executed is--- NOT the same context in which doAsync is called; it is likely that text and+-- NOT the same context in which dispatchActionAsync is called; it is likely that text and -- other state have changed while the IO executed, so it's a good idea to check -- (inside the applying Action) that things are in a good state before making -- changes. Here's an example:@@ -33,8 +99,8 @@ -- > asyncCapitalize :: Action () -- > asyncCapitalize = do -- > txt <- focusDo $ use text--- > -- We give doAsync an IO which resolves in an action--- > doAsync $ ioPart txt+-- > -- We give dispatchActionAsync an IO which resolves in an action+-- > dispatchActionAsync $ ioPart txt -- > -- > ioPart :: Text -> IO (Action ()) -- > ioPart txt = do@@ -53,7 +119,11 @@ -- > -- Or we could just give up. -- > else asyncCapitalize -doAsync :: IO (Action ()) -> Action ()-doAsync asyncIO = do- newAsync <- liftIO $ async asyncIO- asyncs <>= [newAsync]+dispatchActionAsync :: IO (Action ()) -> Action ()+dispatchActionAsync asyncIO = do+ queue <- use actionQueue+ liftIO $ void $ forkIO $ do runEffect $ producer >-> toOutput queue+ performGC+ where producer = do+ action <- lift asyncIO+ yield action
+ src/Rasa/Internal/BufAction.hs view
@@ -0,0 +1,150 @@+{-# language DeriveFunctor+ , MultiParamTypeClasses+ , FlexibleInstances+ , GeneralizedNewtypeDeriving+ , Rank2Types+ , TemplateHaskell #-}+module Rasa.Internal.BufAction+ ( BufAction(..)+ , getText+ , setText+ , getRange+ , setRange+ , liftState+ , liftAction+ , runBufAction+ ) where++import Rasa.Internal.Buffer+import Rasa.Internal.Editor+import Rasa.Internal.Action+import Rasa.Internal.Range+import Rasa.Internal.Listeners+import Rasa.Internal.Events+import Rasa.Internal.Extensions++import Control.Lens+import Control.Monad.Free+import Control.Monad.State++import qualified Yi.Rope as Y++-- | Contains all data about the editor; as well as a buffer which is in 'focus'.+-- We keep the full ActionState here too so that 'Action's may be lifted inside a 'BufAction'+data BufActionState = BufActionState+ { _buffer' :: Buffer+ , _actionState :: ActionState+ }+makeLenses ''BufActionState++instance HasBufExts BufActionState where+ bufExts = buffer'.bufExts++-- | Free Monad Actions for BufAction+data BufActionF state next =+ GetText (Y.YiString -> next)+ | SetText Y.YiString next+ | SetRange CrdRange Y.YiString next+ | LiftState (state -> (next, state))+ | LiftIO (IO next)+ deriving (Functor)++-- | Embeds a BufActionF type into the BufAction Monad+liftBufAction :: BufActionF BufActionState a -> BufAction a+liftBufAction = BufAction . liftF++-- | Returns the text of the current buffer+getText :: BufAction Y.YiString+getText = liftBufAction $ GetText id++-- | Sets the text of the current buffer+setText :: Y.YiString -> BufAction ()+setText txt = liftBufAction $ SetText txt ()++-- | Gets the range of text from the buffer+getRange :: CrdRange -> BufAction Y.YiString+getRange rng = view (range rng) <$> getText++-- | Sets the range of text from the buffer+setRange :: CrdRange -> Y.YiString -> BufAction ()+setRange rng txt = liftBufAction $ SetRange rng txt ()++-- | Allows running state actions over BufActionState; used to lift mtl state functions+liftState :: (BufActionState -> (a, BufActionState)) -> BufAction a+liftState = liftBufAction . LiftState++-- | Allows running IO in BufAction.+liftFIO :: IO r -> BufAction r+liftFIO = liftBufAction . LiftIO++-- | This is a monad for performing actions on a specific buffer.+-- You run 'BufAction's by embedding them in a 'Action' via 'Rasa.Internal.Actions.bufferDo' or+-- 'Rasa.Internal.Actions.buffersDo'+--+-- Within a BufAction you can:+--+-- * Use 'liftAction' to run an 'Action'+-- * Use liftIO for IO+-- * Access/Edit the buffer's text; some commands are available in "Rasa.Internal.Actions".+-- * Access/edit buffer extensions; see 'bufExt'+-- * Embed and sequence 'BufAction's from other extensions+newtype BufAction a = BufAction+ { getBufAction :: Free (BufActionF BufActionState) a+ } deriving (Functor, Applicative, Monad)++instance (MonadState BufActionState) BufAction where+ state = liftState++instance MonadIO BufAction where+ liftIO = liftFIO++-- | This lifts up an 'Action' to be run inside a 'BufAction'+liftAction :: Action r -> BufAction r+liftAction action = do+ actState <- use actionState+ (res, endState) <- liftIO $ runAction actState action+ actionState .= endState+ return res++bufAt :: BufRef -> Traversal' ActionState Buffer+bufAt (BufRef bufInd) = buffers.at bufInd._Just++-- | This lifts up a bufAction into an Action which performs the 'BufAction'+-- over the referenced buffer and returns the result (if the buffer existed)+runBufAction :: BufAction a -> BufRef -> Action (Maybe a)+runBufAction (BufAction bufActF) = flip bufActionInterpreter bufActF++-- | Interpret the Free Monad; in this case it interprets it down to an Action.+bufActionInterpreter :: BufRef -> Free (BufActionF BufActionState) r -> Action (Maybe r)+bufActionInterpreter bRef (Free bufActionF) =+ case bufActionF of+ (GetText nextF) -> do+ actState <- get+ case actState^? bufAt bRef of+ Nothing -> return Nothing+ Just buf -> bufActionInterpreter bRef (nextF (buf^.text))++ (SetText newText next) -> do+ bufAt bRef.text .= newText+ bufActionInterpreter bRef next++ (SetRange rng newText next) -> do+ bufAt bRef.text.range rng .= newText+ dispatchEvent $ BufTextChanged rng newText+ bufActionInterpreter bRef next++ (LiftState stateFunc) -> do+ mBuf <- preuse (bufAt bRef)+ case mBuf of+ Nothing -> return Nothing+ Just buf -> do+ actState <- get+ let (next, BufActionState newBuf newActState) = stateFunc (BufActionState buf actState)+ put newActState+ bufAt bRef .= newBuf+ bufActionInterpreter bRef next++ (LiftIO ioNext) ->+ liftIO ioNext >>= bufActionInterpreter bRef++bufActionInterpreter _ (Pure res) = return $ Just res
src/Rasa/Internal/Buffer.hs view
@@ -13,8 +13,6 @@ ( Buffer , HasBuffer(..) , text- , bufExt- , Ext(..) , mkBuffer ) where @@ -23,10 +21,6 @@ import qualified Yi.Rope as Y import Control.Lens hiding (matching) import Data.Map-import Data.Typeable-import Data.Default-import Data.Maybe-import Unsafe.Coerce -- | A buffer, holds the text in the buffer and any extension states that are set on the buffer. data Buffer = Buffer@@ -35,6 +29,9 @@ } makeLenses ''Buffer +instance HasBufExts Buffer where+ bufExts = bufExts'+ instance Show Buffer where show b = "<Buffer {text:" ++ show (b^..text . to (Y.take 30)) ++ "...,\n" ++ "exts: " ++ show (b^.bufExts) ++ "}>\n"@@ -49,35 +46,6 @@ -- | This lens focuses the text of the in-scope buffer. text :: HasBuffer b => Lens' b Y.YiString text = buffer.text'---- | This lens focuses the Extensions States map of the in-scope buffer.-bufExts :: HasBuffer b => Lens' b ExtMap-bufExts = buffer.bufExts'---- | 'bufExt' is a lens which will focus a given extension's state within a--- buffer (within a 'Data.Action.BufAction'). The lens will automagically focus--- the required extension by using type inference. It's a little bit of magic,--- if you treat the focus as a member of your extension state it should just--- work out.------ This lens falls back on the extension's 'Data.Default.Default' instance (when getting) if--- nothing has yet been stored.--bufExt- :: forall a s.- (Show a, Typeable a, Default a, HasBuffer s)- => Lens' s a-bufExt = lens getter setter- where- getter buf =- fromMaybe def $ buf ^. bufExts . at (typeRep (Proxy :: Proxy a)) .- mapping coerce- setter buf new =- set- (bufExts . at (typeRep (Proxy :: Proxy a)) . mapping coerce)- (Just new)- buf- coerce = iso (\(Ext x) -> unsafeCoerce x) Ext -- | Creates a new buffer from the given text. mkBuffer :: Y.YiString -> Buffer
− src/Rasa/Internal/Directive.hs
@@ -1,135 +0,0 @@-{-# language Rank2Types, OverloadedStrings #-}-module Rasa.Internal.Directive- (- -- * Performing Actions on Buffers- bufDo- , bufDo_- , buffersDo- , buffersDo_-- -- * Editor Actions- , exit- , newBuffer- , getBufRefs- , getBuffers- , getBuffer- , nextBufRef- , prevBufRef-- -- * Buffer Actions- , overRange- , replaceRange- , deleteRange- , insertAt- , sizeOf- ) where--import Rasa.Internal.Text-import Rasa.Internal.Editor-import Rasa.Internal.Action-import Rasa.Internal.Range-import Rasa.Internal.Scheduler-import Rasa.Internal.Events-import Rasa.Internal.Buffer as B--import Control.Lens-import Control.Monad-import Control.Arrow (first)-import Data.Maybe-import Data.IntMap as M-import qualified Yi.Rope as Y----- | This lifts a 'Rasa.Action.BufAction' to an 'Rasa.Action.Action' which--- performs the 'Rasa.Action.BufAction' on every buffer and collects the return--- values as a list.--buffersDo :: BufAction a -> Action [a]-buffersDo bufAct = do- bufRefs <- getBufRefs- catMaybes . foldMap (:[]) <$> mapM (liftBuf bufAct) bufRefs--buffersDo_ :: BufAction a -> Action ()-buffersDo_ = void . buffersDo---- | This lifts a 'Rasa.Action.BufAction' to an 'Rasa.Action.Action' which--- performs the 'Rasa.Action.BufAction' on the buffer referred to by the 'BufRef'--- If the buffer referred to no longer exists this returns @Action Nothing@.-bufDo :: BufRef -> BufAction a -> Action (Maybe a)-bufDo bufRef bufAct = liftBuf bufAct bufRef--bufDo_ :: BufRef -> BufAction a -> Action ()-bufDo_ bufRef bufAct = void $ bufDo bufRef bufAct---- | This adds a new buffer with the given text.-newBuffer :: Y.YiString -> Action BufRef-newBuffer txt = do- n <- nextBufId <<+= 1- buffers %= insert n (mkBuffer txt)- let bufRef = BufRef n- dispatchEvent (BufAdded bufRef)- return bufRef---- | Returns an up-to-date list of all 'BufRef's-getBufRefs :: Action [BufRef]-getBufRefs = fmap BufRef <$> use (buffers.to keys)---- | Returns the 'Buffer' for a BufRef if it still exists.--- This is read-only; altering the buffer has no effect on the stored buffer.--- This function is useful for renderers.-getBuffer :: BufRef -> Action (Maybe Buffer)-getBuffer (BufRef bufInt) = use (buffers.at bufInt)---- | Returns an up-to-date list of all 'Buffer's, returned values--- are read-only; altering them has no effect on the actual stored buffers.--- This function is useful for renderers.-getBuffers :: Action [(BufRef, Buffer)]-getBuffers = fmap (first BufRef) <$> use (buffers.to assocs)---- | Gets 'BufRef' that comes after the one provided-nextBufRef :: BufRef -> Action BufRef-nextBufRef br@(BufRef bufInt) = do- bufMap <- use buffers- if M.null bufMap- then return br- else do- let mGreaterInd = lookupGT bufInt bufMap- case mGreaterInd of- Just (greaterInd, _) -> return $ BufRef greaterInd- Nothing -> return . BufRef . fst . findMin $ bufMap---- | Gets 'BufRef' that comes before the one provided-prevBufRef :: BufRef -> Action BufRef-prevBufRef br@(BufRef bufInt) = do- bufMap <- use buffers- if M.null bufMap- then return br- else do- let mLesserInd = lookupLT bufInt bufMap- case mLesserInd of- Just (lesserInd, _) -> return $ BufRef lesserInd- Nothing -> return . BufRef . fst . findMax $ bufMap---- | This signals to the editor that you'd like to shutdown. The current events--- will finish processing, then the 'Rasa.Ext.Scheduler.onExit' hook will run,--- then the editor will exit.--exit :: Action ()-exit = exiting .= True---- | Deletes the text in the given range from the buffer.-deleteRange :: Range -> BufAction ()-deleteRange r = range r.asText .= ""---- | Replaces the text in the given range from the buffer.-replaceRange :: Range -> Y.YiString -> BufAction ()-replaceRange r txt = range r .= txt---- | Inserts text into the buffer at the given Coord.-insertAt :: Coord -> Y.YiString -> BufAction ()-insertAt c txt = range (Range c c) .= txt---- | Runs the given function over the text in the range, replacing it with the results.-overRange :: Range -> (Y.YiString -> Y.YiString) -> BufAction ()-overRange r f = range r %= f-
src/Rasa/Internal/Editor.hs view
@@ -13,8 +13,6 @@ , HasEditor(..) , buffers , exiting- , ext- , bufExt , nextBufId , BufRef(..) ) where@@ -22,17 +20,13 @@ import Rasa.Internal.Buffer import Rasa.Internal.Extensions -import Unsafe.Coerce-import Data.Dynamic import Data.Default-import Data.Maybe import Data.IntMap import Control.Lens --- | An opaque reference to a buffer (The contained Int is not meant to be--- altered). It is possible for references to become stale if buffers are--- deleted. Operations over invalid BufRef's are simply ignored and return--- 'Nothing' if a value was expected.+-- | An opaque reference to a buffer.+-- When operating over a BufRef Rasa checks if the 'Rasa.Internal.Buffer.Buffer' still+-- exists and simply ignores any operations over non-existent buffers; typically returning 'Nothing' newtype BufRef = BufRef Int deriving (Show, Eq, Ord)@@ -49,7 +43,7 @@ instance Show Editor where show ed = "Buffers==============\n" ++ show (ed^.buffers) ++ "\n\n"- ++ "Editor Extensions==============\n" ++ show (ed^.extState) ++ "\n\n"+ ++ "Editor Extensions==============\n" ++ show (ed^.exts) ++ "\n\n" ++ "---\n\n" -- | This allows polymorphic lenses over anything that has access to an Editor context@@ -64,10 +58,6 @@ exiting :: HasEditor e => Lens' e Bool exiting = editor.exiting' --- | A lens over the extension state of 'Editor' level extensions-extState :: HasEditor e => Lens' e ExtMap-extState = editor.extState'- -- | A lens over the next buffer id to be allocated nextBufId :: HasEditor e => Lens' e Int nextBufId = editor.nextBufId'@@ -75,6 +65,9 @@ instance HasEditor Editor where editor = lens id (flip const) +instance HasExts Editor where+ exts = extState'+ instance Default Editor where def = Editor@@ -83,26 +76,3 @@ , _exiting'=False , _nextBufId'=0 }---- | 'ext' is a lens which will focus the extension state that matches the type--- inferred as the focal point. It's a little bit of magic, if you treat the--- focus as a member of your extension state it should just work out.------ This lens falls back on the extension's 'Data.Default.Default' instance (when getting) if--- nothing has yet been stored.--ext- :: forall a e.- (Show a, Typeable a, Default a, HasEditor e)- => Lens' e a-ext = lens getter setter- where- getter ed =- fromMaybe def $ ed ^. extState . at (typeRep (Proxy :: Proxy a)) .- mapping coerce- setter ed new =- set- (extState . at (typeRep (Proxy :: Proxy a)) . mapping coerce)- (Just new)- ed- coerce = iso (\(Ext x) -> unsafeCoerce x) Ext
src/Rasa/Internal/Events.hs view
@@ -1,5 +1,5 @@ {-# language ExistentialQuantification #-}-module Rasa.Internal.Events +module Rasa.Internal.Events ( Init(..) , BeforeEvent(..) , BeforeRender(..)@@ -9,15 +9,13 @@ , BufAdded(..) , Keypress(..) , Mod(..)+ , BufTextChanged(..) ) where import Data.Dynamic import Rasa.Internal.Editor---- | The Event type represents a common denominator for all actions that could--- occur Event transmitters express events that have occured as a member of this--- type. At the moment it's quite sparse, but it will expand as new types of--- events are needed.+import Rasa.Internal.Range+import qualified Yi.Rope as Y -- | This event is dispatched exactly once when the editor starts up. data Init = Init deriving (Show, Eq, Typeable)@@ -64,3 +62,10 @@ | Alt | Shift deriving (Show, Eq)++-- | This is triggered when text in a buffer is changed. The Event data includes the 'CrdRange' that changed and+-- the new text which is now contined in that range.+data BufTextChanged+ = BufTextChanged CrdRange Y.YiString+ deriving (Show, Eq, Typeable)+
src/Rasa/Internal/Extensions.hs view
@@ -2,10 +2,19 @@ module Rasa.Internal.Extensions ( Ext(..) , ExtMap+ , HasBufExts(..)+ , HasExts(..)+ , bufExt+ , ext ) where +import Control.Lens++import Data.Default import Data.Map import Data.Dynamic+import Data.Maybe+import Unsafe.Coerce -- | A wrapper around an extension of any type so it can be stored in an 'ExtMap' data Ext = forall a. Show a => Ext a@@ -14,3 +23,62 @@ -- | A map of extension types to their current value. type ExtMap = Map TypeRep Ext++-- | Members of this class have access to editor extensions.+class HasExts s where+ -- | This lens focuses the Extensions States+ exts :: Lens' s (Map TypeRep Ext)++-- | This is a lens which will focus the extension state that matches the type+-- inferred as the focal point. It's a little bit of magic, if you treat the+-- focus as a member of your extension state it should just work out.+--+-- This lens falls back on the extension's 'Data.Default.Default' instance (when getting) if+-- nothing has yet been stored.++ext+ :: forall a e.+ (Show a, Typeable a, Default a, HasExts e)+ => Lens' e a+ext = lens getter setter+ where+ getter s =+ fromMaybe def $ s ^.exts . at (typeRep (Proxy :: Proxy a)) .+ mapping coerce+ setter s new =+ set+ (exts . at (typeRep (Proxy :: Proxy a)) . mapping coerce)+ (Just new)+ s+ coerce = iso (\(Ext x) -> unsafeCoerce x) Ext++-- | Members of this class have access to buffer extensions. (Each 'Rasa.Internal.Buffer.Buffer' is a member of this class)+class HasBufExts s where+ -- | This lens focuses the Extensions States map of the in-scope buffer.+ bufExts :: Lens' s (Map TypeRep Ext)++-- | 'bufExt' is a lens which will focus a given extension's state within a+-- buffer (within a 'Data.Action.BufAction'). The lens will automagically focus+-- the required extension by using type inference. It's a little bit of magic,+-- if you treat the focus as a member of your extension state it should just+-- work out.+--+-- This lens falls back on the extension's 'Data.Default.Default' instance (when getting) if+-- nothing has yet been stored.++bufExt+ :: forall a s.+ (Show a, Typeable a, Default a, HasBufExts s)+ => Lens' s a+bufExt = lens getter setter+ where+ getter buf =+ fromMaybe def $ buf ^. bufExts . at (typeRep (Proxy :: Proxy a)) .+ mapping coerce+ setter buf new =+ set+ (bufExts . at (typeRep (Proxy :: Proxy a)) . mapping coerce)+ (Just new)+ buf+ coerce :: (Show a1) => Iso Ext Ext a a1+ coerce = iso (\(Ext x) -> unsafeCoerce x) Ext
+ src/Rasa/Internal/Listeners.hs view
@@ -0,0 +1,186 @@+{-# LANGUAGE ExistentialQuantification, ScopedTypeVariables #-}++module Rasa.Internal.Listeners+ ( Listener+ , Listeners+ , onEveryTrigger+ , onEveryTrigger_+ , onNextEvent+ , onInit+ , beforeEveryEvent+ , beforeEveryEvent_+ , beforeNextEvent+ , beforeEveryRender+ , beforeEveryRender_+ , beforeNextRender+ , onEveryRender+ , onEveryRender_+ , onNextRender+ , afterEveryRender+ , afterEveryRender_+ , afterNextRender+ , dispatchEvent+ , onExit+ , removeListener+ , matchingListeners+ , onBufAdded+ , onBufTextChanged+ ) where+++import Rasa.Internal.Action+import Rasa.Internal.Events+import Rasa.Internal.Editor+import Rasa.Internal.Range++import Control.Lens+import Control.Monad+import Data.Dynamic+import Data.Foldable+import Data.Map hiding (filter)+import Unsafe.Coerce+import qualified Yi.Rope as Y++-- | Use this to dispatch an event of any type, any listeners which are listening for this event will be triggered+-- with the provided event. Use this within an Action.+dispatchEvent :: Typeable a => a -> Action ()+dispatchEvent evt = do+ listeners' <- use listeners+ traverse_ ($ evt) (matchingListeners listeners')++-- | This is a helper which extracts and coerces a listener from its wrapper back into the proper event handler type.+getListener :: forall a. Listener -> (a -> Action ())+getListener = coerce+ where+ coerce :: Listener -> (a -> Action ())+ coerce (Listener _ x) = unsafeCoerce x++makeListener :: forall a b. Typeable a => (a -> Action b) -> Action (ListenerId, Listener)+makeListener listenerFunc = do+ n <- nextListenerId <<+= 1+ let listenerId = ListenerId n (typeRep (Proxy :: Proxy a))+ listenerFunc' = void . listenerFunc+ return (listenerId, Listener listenerId listenerFunc')++extendListener :: Listener -> Action () -> Listener+extendListener (Listener listenerId listenerFunc) act = Listener listenerId (\a -> listenerFunc a >> act)++-- | This extracts all event listeners from a map of listeners which match the type of the provided event.+matchingListeners :: forall a. Typeable a => Listeners -> [a -> Action ()]+matchingListeners listeners' = getListener <$> (listeners'^.at (typeRep (Proxy :: Proxy a))._Just)++-- | This registers an event listener, as long as the listener is well-typed similar to this:+--+-- @MyEventType -> Action ()@ then it will be triggered on all dispatched events of type @MyEventType@.+-- It returns an ID which may be used with 'removeListener' to cancel the listener+onEveryTrigger :: forall a b. Typeable a => (a -> Action b) -> Action ListenerId+onEveryTrigger listenerFunc = do+ (listenerId, listener) <- makeListener listenerFunc+ listeners %= insertWith mappend (typeRep (Proxy :: Proxy a)) [listener]+ return listenerId++onEveryTrigger_ :: forall a b. Typeable a => (a -> Action b) -> Action ()+onEveryTrigger_ = void . onEveryTrigger++-- | This acts as 'onEveryTrigger' but listens only for the first event of a given type.+onNextEvent :: forall a b. Typeable a => (a -> Action b) -> Action ()+onNextEvent listenerFunc = do+ (listenerId, listener) <- makeListener listenerFunc+ let selfCancellingListener = extendListener listener (removeListener listenerId)+ listeners %= insertWith mappend (typeRep (Proxy :: Proxy a)) [selfCancellingListener]++-- | This removes a listener and prevents it from responding to any more events.+removeListener :: ListenerId -> Action ()+removeListener hkIdA@(ListenerId _ typ) =+ listeners.at typ._Just %= filter listenerMatches+ where+ listenerMatches (Listener hkIdB _) = hkIdA /= hkIdB++-- | Registers an action to be performed during the Initialization phase.+--+-- This phase occurs exactly ONCE when the editor starts up.+-- Though arbitrary actions may be performed in the configuration block;+-- it's recommended to embed such actions in the onInit event listener+-- so that all event listeners are registered before anything Actions occur.+onInit :: forall a. Action a -> Action ()+onInit action = onNextEvent (const action :: Init -> Action a)++-- | Registers an action to be performed BEFORE each event phase.+beforeEveryEvent :: forall a. Action a -> Action ListenerId+beforeEveryEvent action = onEveryTrigger (const action :: BeforeEvent -> Action a)++beforeEveryEvent_ :: forall a. Action a -> Action ()+beforeEveryEvent_ = void . beforeEveryEvent++-- | Registers an action to be performed ONCE before only the NEXT event phase.+beforeNextEvent :: forall a. Action a -> Action ()+beforeNextEvent action = onNextEvent (const action :: BeforeEvent -> Action a)++-- | Registers an action to be performed BEFORE each render phase.+--+-- This is a good spot to add information useful to the renderer+-- since all actions have been performed. Only cosmetic changes should+-- occur during this phase.+beforeEveryRender :: forall a. Action a -> Action ListenerId+beforeEveryRender action = onEveryTrigger (const action :: BeforeRender -> Action a)++beforeEveryRender_ :: forall a. Action a -> Action ()+beforeEveryRender_ = void . beforeEveryRender++-- | Registers an action to be performed ONCE before only the NEXT render phase.+beforeNextRender :: forall a. Action a -> Action ()+beforeNextRender action = onNextEvent (const action :: BeforeRender -> Action a)++-- | Registers an action to be performed during each render phase.+--+-- This phase should only be used by extensions which actually render something.+onEveryRender :: forall a. Action a -> Action ListenerId+onEveryRender action = onEveryTrigger (const action :: OnRender -> Action a)++onEveryRender_ :: forall a. Action a -> Action ()+onEveryRender_ = void . onEveryRender++-- | Registers an action to be performed ONCE before only the NEXT render phase.+--+-- This phase should only be used by extensions which actually render something.+onNextRender :: forall a. Action a -> Action ()+onNextRender action = onNextEvent (const action :: OnRender -> Action a)++-- | Registers an action to be performed AFTER each render phase.+--+-- This is useful for cleaning up extension state that was registered for the+-- renderer, but needs to be cleared before the next iteration.+afterEveryRender :: forall a. Action a -> Action ListenerId+afterEveryRender action = onEveryTrigger (const action :: AfterRender -> Action a)++afterEveryRender_ :: forall a. Action a -> Action ()+afterEveryRender_ = void . afterEveryRender++-- | Registers an action to be performed after the NEXT render phase.+afterNextRender :: forall a. Action a -> Action ()+afterNextRender action = onNextEvent (const action :: AfterRender -> Action a)++-- | Registers an action to be performed during the exit phase.+--+-- This is only triggered exactly once when the editor is shutting down. It+-- allows an opportunity to do clean-up, kill any processes you've started, or+-- save any data before the editor terminates.++onExit :: forall a. Action a -> Action ()+onExit action = onNextEvent (const action :: Exit -> Action a)++-- | Registers an action to be performed after a new buffer is added.+--+-- The supplied function will be called with a 'BufRef' to the new buffer, and the resulting 'Action' will be run.+onBufAdded :: forall a. (BufRef -> Action a) -> Action ListenerId+onBufAdded f = onEveryTrigger listener+ where+ listener (BufAdded bRef) = f bRef++-- | This is fired every time text in a buffer changes.+--+-- The range of text which was altered and the new value of that text are provided inside a 'BufTextChanged' event.+onBufTextChanged :: forall a. (CrdRange -> Y.YiString -> Action a) -> Action ListenerId+onBufTextChanged f = onEveryTrigger listener+ where+ listener (BufTextChanged r newText) = f r newText
src/Rasa/Internal/Range.hs view
@@ -1,12 +1,27 @@-{-# LANGUAGE Rank2Types, OverloadedStrings, DeriveFunctor, ScopedTypeVariables #-}+{-# LANGUAGE+ Rank2Types+ , OverloadedStrings+ , DeriveFunctor+ , ScopedTypeVariables+ , TemplateHaskell +#-} module Rasa.Internal.Range- ( Coord(..)+ ( Coord+ , Coord'(..)+ , overRow+ , overCol+ , overBoth+ , coordRow+ , coordCol , Offset(..) , asCoord , clampCoord , clampRange , Range(..)+ , CrdRange , range+ , rStart+ , rEnd , sizeOf , sizeOfR , moveRange@@ -20,35 +35,75 @@ , afterC ) where -import Rasa.Internal.Buffer-+import Rasa.Internal.Text import Control.Lens+ import Data.Maybe import Data.Monoid import Data.List-import Rasa.Internal.Text-import qualified Yi.Rope as Y+import Data.Bifunctor+import Data.Biapplicative+import Data.Bitraversable+import Data.Bifoldable +import qualified Yi.Rope as Y -- | This represents a range between two coordinates ('Coord')-data Range =- Range Coord Coord- deriving (Show, Eq)+data Range a b = Range+ { _rStart :: a+ , _rEnd :: b+ } deriving (Show, Eq)+makeLenses ''Range -instance Ord Range where- Range start end <= Range start' end' +instance Bifunctor Range where+ bimap f g (Range a b) = Range (f a) (g b)++instance Bifoldable Range where+ bifoldMap f g (Range a b) = f a `mappend` g b++instance Bitraversable Range where+ bitraverse f g (Range a b) = Range <$> f a <*> g b++instance (Ord a, Ord b) => Ord (Range a b) where+ Range start end <= Range start' end' | end == end' = start <= start' | otherwise = end <= end' -- | (Coord Row Column) represents a char in a block of text. (zero indexed) -- e.g. Coord 0 0 is the first character in the text, -- Coord 2 1 is the second character of the third row-data Coord =- Coord Int- Int- deriving (Show, Eq)+data Coord' a b = Coord + { _coordRow::a+ , _coordCol::b+ } deriving (Show, Eq)+makeLenses ''Coord' -instance Ord Coord where+-- | A type alias to 'Coord'' which specializes the types to integers.+type Coord = Coord' Int Int++-- | A type alias to 'Range'' which specializes the types to 'Coord's.+type CrdRange = Range Coord Coord++instance Bifunctor Coord' where+ bimap f g (Coord a b) = Coord (f a) (g b)++-- | Applies a function over the row of a 'Coord'+overRow :: (Int -> Int) -> Coord -> Coord+overRow = first++-- | Applies a function over the column of a 'Coord'+overCol :: (Int -> Int) -> Coord -> Coord+overCol = second++-- | Applies a function over both functors in any 'Bifunctor'.+overBoth :: Bifunctor f => (a -> b) -> f a a -> f b b+overBoth f = bimap f f++instance Biapplicative Coord' where+ bipure = Coord+ Coord f g <<*>> Coord a b = Coord (f a) (g b)++instance (Ord a, Ord b) => Ord (Coord' a b) where Coord a b <= Coord a' b' | a < a' = True | a > a' = False@@ -59,26 +114,32 @@ Offset Int deriving (Show, Eq) +-- | A span which maps a piece of Monoidal data over a range.+data Span a b =+ Span a b+ deriving (Show, Eq, Functor)++instance Bifunctor Span where+ bimap f g (Span a b) = Span (f a) (g b)+ -- | Moves a 'Range' by a given 'Coord' -- It may be unintuitive, but for (Coord row col) a given range will be moved down by row and to the right by col.-moveRange :: Coord -> Range -> Range-moveRange amt (Range start end) =- Range (moveCursor amt start) (moveCursor amt end)+moveRange :: Coord -> CrdRange -> CrdRange+moveRange amt = overBoth (moveCursor amt) -- | Moves a range forward by the given amount-moveRangeByN :: Int -> Range -> Range-moveRangeByN amt (Range start end) =- Range (moveCursorByN amt start) (moveCursorByN amt end)+moveRangeByN :: Int -> CrdRange -> CrdRange+moveRangeByN amt = overBoth (moveCursorByN amt) -- | Moves a 'Coord' forward by the given amount of columns moveCursorByN :: Int -> Coord -> Coord-moveCursorByN amt (Coord row col) = Coord row (col + amt)+moveCursorByN amt = overCol (+amt) -- | Adds the rows and columns of the given two 'Coord's. moveCursor :: Coord -> Coord -> Coord-moveCursor (Coord row col) (Coord row' col') = Coord (row + row') (col + col')+moveCursor = biliftA2 (+) (+) -instance Num Coord where+instance (Num a, Num b) => Num (Coord' a b) where Coord row col + Coord row' col' = Coord (row + row') (col + col') Coord row col - Coord row' col' = Coord (row - row') (col - col') Coord row col * Coord row' col' = Coord (row * row') (col * col')@@ -109,18 +170,11 @@ Coord (clamp 0 maxRow row) (clamp 0 maxColumn col) where maxRow = Y.countNewLines txt- maxColumn = fromMaybe col (txt ^? to Y.lines' . ix row . to Y.length)+ maxColumn = fromMaybe col (txt ^? asLines . ix row . to Y.length) -- | This will restrict a given 'Range' to a valid one which lies within the given text.-clampRange :: Y.YiString -> Range -> Range-clampRange txt (Range start end) =- Range (clampCoord txt start) (clampCoord txt end)---- | A span which maps a piece of Monoidal data over a range.-data Span a = Span- { _getRange :: Range- , _data :: a- } deriving (Show, Eq, Functor)+clampRange :: Y.YiString -> CrdRange -> CrdRange+clampRange txt = overBoth (clampCoord txt) -- | A Helper only used when combining many spans. data Marker@@ -134,13 +188,13 @@ combineSpans :: forall a. Monoid a- => [Span a] -> [(Coord, a)]+ => [Span CrdRange a] -> [(Coord, a)] combineSpans spans = combiner [] $ sortOn (view _3) (splitStartEnd idSpans) where- idSpans :: [(ID, Span a)]+ idSpans :: [(ID, Span CrdRange a)] idSpans = zip [1 ..] spans - splitStartEnd :: [(ID, Span a)] -> [(Marker, ID, Coord, a)]+ splitStartEnd :: [(ID, Span CrdRange a)] -> [(Marker, ID, Coord, a)] splitStartEnd [] = [] splitStartEnd ((i, Span (Range s e) d):rest) = (Start, i, s, d) : (End, i, e, d) : splitStartEnd rest@@ -167,7 +221,7 @@ | otherwise = n -- | Returns the number of rows and columns that a 'Range' spans as a 'Coord'-sizeOfR :: Range -> Coord+sizeOfR :: CrdRange -> Coord sizeOfR (Range start end) = end - start -- | Returns the number of rows and columns that a chunk of text spans as a 'Coord'@@ -180,7 +234,7 @@ where getter txt = txt ^.. asLines . taking (row + 1) traverse & _last %~ Y.take col- & Y.unlines+ & Y.concat setter old new = let suffix = old ^. afterC c in new <> suffix@@ -191,13 +245,16 @@ where getter txt = txt ^.. asLines . dropping row traverse & _head %~ Y.drop col- & Y.unlines+ & Y.concat setter old new = let prefix = old ^. beforeC c in prefix <> new -- | A lens over text which is encompassed by a 'Range'-range :: HasBuffer s => Range -> Lens' s Y.YiString+range :: CrdRange -> Lens' Y.YiString Y.YiString range (Range start end) = lens getter setter- where getter = view (text . beforeC end . afterC start)- setter old new = old & text . beforeC end . afterC start .~ new+ where getter = view (beforeC end . afterC start)+ setter old new = result+ where+ setBefore = old & beforeC end .~ new+ result = old & afterC start .~ setBefore
− src/Rasa/Internal/Scheduler.hs
@@ -1,169 +0,0 @@-{-# LANGUAGE ExistentialQuantification, ScopedTypeVariables #-}--module Rasa.Internal.Scheduler- ( Hook- , Hooks- , onEveryTrigger- , onEveryTrigger_- , onNextEvent- , onInit- , beforeEveryEvent- , beforeEveryEvent_- , beforeNextEvent- , beforeEveryRender- , beforeEveryRender_- , beforeNextRender- , onEveryRender- , onEveryRender_- , onNextRender- , afterEveryRender- , afterEveryRender_- , afterNextRender- , dispatchEvent- , onExit- , removeListener- , matchingHooks- , onBufAdded- ) where---import Rasa.Internal.Action-import Rasa.Internal.Events-import Rasa.Internal.Editor--import Control.Lens-import Control.Monad-import Data.Dynamic-import Data.Foldable-import Data.Map hiding (filter)-import Unsafe.Coerce---- | Use this to dispatch an event of any type, any hooks which are listening for this event will be triggered--- with the provided event. Use this within an Action.-dispatchEvent :: Typeable a => a -> Action ()-dispatchEvent evt = do- hooks' <- use hooks- traverse_ ($ evt) (matchingHooks hooks')---- | This is a helper which extracts and coerces a hook from its wrapper back into the proper event handler type.-getHook :: forall a. Hook -> (a -> Action ())-getHook = coerce- where- coerce :: Hook -> (a -> Action ())- coerce (Hook _ x) = unsafeCoerce x--makeHook :: forall a. Typeable a => (a -> Action ()) -> Action (HookId, Hook)-makeHook hookFunc = do- n <- nextHook <<+= 1- let hookId = HookId n (typeRep (Proxy :: Proxy a))- return (hookId, Hook hookId hookFunc)--extendHook :: Hook -> Action () -> Hook-extendHook (Hook hookId hookFunc) act = Hook hookId (\a -> hookFunc a >> act)---- | This extracts all event listener hooks from a map of hooks which match the type of the provided event.-matchingHooks :: forall a. Typeable a => Hooks -> [a -> Action ()]-matchingHooks hooks' = getHook <$> (hooks'^.at (typeRep (Proxy :: Proxy a))._Just)---- | This registers an event listener hook, as long as the listener is well-typed similar to this:------ @MyEventType -> Action ()@ then it will be triggered on all dispatched events of that type.--- It returns an ID which may be used with 'removeListener' to cancel the listener-onEveryTrigger :: forall a. Typeable a => (a -> Action ()) -> Action HookId-onEveryTrigger hookFunc = do- (hookId, hook) <- makeHook hookFunc- hooks %= insertWith mappend (typeRep (Proxy :: Proxy a)) [hook]- return hookId--onEveryTrigger_ :: forall a. Typeable a => (a -> Action ()) -> Action ()-onEveryTrigger_ = void . onEveryTrigger----- | This acts as 'onEveryTrigger' but listens only for the first event of a given type.-onNextEvent :: forall a. Typeable a => (a -> Action ()) -> Action ()-onNextEvent hookFunc = do- (hookId, hook) <- makeHook hookFunc- let selfCancellingHook = extendHook hook (removeListener hookId)- hooks %= insertWith mappend (typeRep (Proxy :: Proxy a)) [selfCancellingHook]---- | This removes a listener and prevents it from responding to any more events.-removeListener :: HookId -> Action ()-removeListener hkIdA@(HookId _ typ) =- hooks.at typ._Just %= filter hookMatches- where- hookMatches (Hook hkIdB _) = hkIdA /= hkIdB---- | Registers an action to be performed during the Initialization phase.------ This phase occurs exactly ONCE when the editor starts up.--- Though arbitrary actions may be performed in the configuration block;--- it's recommended to embed such actions in the onInit event listener--- so that all event listeners are registered before anything Actions occur.-onInit :: Action () -> Action ()-onInit action = void $ onEveryTrigger (const action :: Init -> Action ())---- | Registers an action to be performed BEFORE each event phase.-beforeEveryEvent :: Action () -> Action HookId-beforeEveryEvent action = onEveryTrigger (const action :: BeforeEvent -> Action ())--beforeEveryEvent_ :: Action () -> Action ()-beforeEveryEvent_ = void . beforeEveryEvent--beforeNextEvent :: Action () -> Action ()-beforeNextEvent action = onNextEvent (const action :: BeforeEvent -> Action ())---- | Registers an action to be performed BEFORE each render phase.------ This is a good spot to add information useful to the renderer--- since all actions have been performed. Only cosmetic changes should--- occur during this phase.-beforeEveryRender :: Action () -> Action HookId-beforeEveryRender action = onEveryTrigger (const action :: BeforeRender -> Action ())--beforeEveryRender_ :: Action () -> Action ()-beforeEveryRender_ = void . beforeEveryRender--beforeNextRender :: Action () -> Action ()-beforeNextRender action = onNextEvent (const action :: BeforeRender -> Action ())---- | Registers an action to be performed during each render phase.------ This phase should only be used by extensions which actually render something.-onEveryRender :: Action () -> Action HookId-onEveryRender action = onEveryTrigger (const action :: OnRender -> Action ())--onEveryRender_ :: Action () -> Action ()-onEveryRender_ = void . onEveryRender--onNextRender :: Action () -> Action ()-onNextRender action = onNextEvent (const action :: OnRender -> Action ())---- | Registers an action to be performed AFTER each render phase.------ This is useful for cleaning up extension state that was registered for the--- renderer, but needs to be cleared before the next iteration.-afterEveryRender :: Action () -> Action HookId-afterEveryRender action = onEveryTrigger (const action :: AfterRender -> Action ())--afterEveryRender_ :: Action () -> Action ()-afterEveryRender_ = void . afterEveryRender--afterNextRender :: Action () -> Action ()-afterNextRender action = onNextEvent (const action :: AfterRender -> Action ())---- | Registers an action to be performed during the exit phase.------ This is only triggered exactly once when the editor is shutting down. It--- allows an opportunity to do clean-up, kill any processes you've started, or--- save any data before the editor terminates.--onExit :: Action () -> Action ()-onExit action = void $ onEveryTrigger (const action :: Exit -> Action ())---- | Registers an action to be performed after a new buffer is added.------ The supplied function will be called with a 'BufRef' to the new buffer, and the resulting 'Action' will be run.-onBufAdded :: (BufRef -> Action ()) -> Action HookId-onBufAdded f = onEveryTrigger listener- where- listener (BufAdded bRef) = f bRef
src/Rasa/Internal/Text.hs view
@@ -20,4 +20,4 @@ -- | An iso which converts to/from 'Y.YiString' -> ['Y.YiString'] asLines :: Iso' Y.YiString [Y.YiString]-asLines = iso Y.lines Y.unlines+asLines = iso Y.lines' Y.concat
+ test/ArbitraryInstances.hs view
@@ -0,0 +1,20 @@+{-# language ScopedTypeVariables, FlexibleInstances #-}+module ArbitraryInstances where++import qualified Data.Text as T+import qualified Yi.Rope as Y++import Test.QuickCheck+import Test.QuickCheck.Instances++import Rasa.Internal.Range++instance Arbitrary Y.YiString where+ arbitrary = do+ txt <- arbitrary :: Gen T.Text+ return $ Y.fromText txt++instance Arbitrary (Coord' Int Int) where+ arbitrary = do+ (r, c) <- arbitrary :: Gen (Int, Int)+ return $ Coord (abs r) (abs c)
+ test/Rasa/Internal/ActionSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.ActionSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/ActionsSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.ActionsSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/AsyncSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.AsyncSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/BufActionSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.BufActionSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/BufferSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.BufferSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/EditorSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.EditorSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/EventsSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.EventsSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/ExtensionsSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.ExtensionsSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/ListenersSpec.hs view
@@ -0,0 +1,6 @@+module Rasa.Internal.ListenersSpec where++import Test.Hspec++spec :: Spec+spec = return ()
+ test/Rasa/Internal/RangeSpec.hs view
@@ -0,0 +1,22 @@+module Rasa.Internal.RangeSpec where++import Test.Hspec+import Test.Hspec.QuickCheck+import Test.QuickCheck.Instances+import ArbitraryInstances++import Rasa.Internal.Range++import qualified Yi.Rope as Y+import Control.Lens++spec :: Spec+spec = do+ describe "overRow" $+ prop "overRow f ~= Coord (f a) b" $ \crd@(Coord r c) -> Coord (r+1) c `shouldBe` overRow (+1) crd++ describe "overCol" $+ prop "overCol f ~= Coord a (f b)" $ \crd@(Coord r c) -> Coord r (c+1) `shouldBe` overCol (+1) crd++ describe "overBoth" $+ prop "overBoth f ~= Coord (f a) (f b)" $ \crd@(Coord r c) -> Coord (r+1) (c+1) `shouldBe` overBoth (+ (1 :: Int)) crd
+ test/Rasa/Internal/TextSpec.hs view
@@ -0,0 +1,25 @@+module Rasa.Internal.TextSpec where++import Test.Hspec+import Test.Hspec.QuickCheck+import Test.QuickCheck.Instances+import ArbitraryInstances++import Rasa.Internal.Text++import qualified Yi.Rope as Y+import Control.Lens++spec :: Spec+spec = do+ describe "asText" $ do+ prop "view asText ~= Y.toText" $ \t -> t^.asText `shouldBe` Y.toText t+ prop "view (from asText) ~= Y.fromText" $ \t -> t^. from asText `shouldBe` Y.fromText t++ describe "asString" $ do+ prop "view asString ~= Y.toString" $ \t -> t^. asString `shouldBe` Y.toString t+ prop "view (from asString) ~= Y.fromString" $ \t -> t^. from asString `shouldBe` Y.fromString t++ describe "asLines" $ do+ prop "view asLines ~= Y.concat" $ \t -> t^.asLines `shouldBe` Y.lines' t+ prop "view (from asLines) ~= Y.fromLines" $ \t -> t^. from asLines `shouldBe` Y.concat t
+ test/RasaSpec.hs view
@@ -0,0 +1,9 @@+module RasaSpec where++import Test.Hspec++spec :: Spec+spec = do+ describe "Rasa" $ do+ it "runs tests" $+ True `shouldBe` True
+ test/Spec.hs view
@@ -0,0 +1,2 @@+-- file test/Spec.hs+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}