branch: master commit f5b8952b61e589798f586cf12d242c21277fb18e Author: Tino Calancha <tino.calan...@gmail.com> Commit: Tino Calancha <tino.calan...@gmail.com>
New package mines.el An elisp implementation of the minesweeper game. * packages/mines/mines-tests.el * packages/mines/Makefile * packages/mines/LICENSE * packages/mines/.travis.yml * packages/mines/README.md * packages/mines/mines.el: New file. --- packages/mines/.travis.yml | 22 ++ packages/mines/LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++ packages/mines/Makefile | 16 + packages/mines/README.md | 37 +++ packages/mines/mines-tests.el | 234 +++++++++++++++ packages/mines/mines.el | 607 +++++++++++++++++++++++++++++++++++++ 6 files changed, 1590 insertions(+) diff --git a/packages/mines/.travis.yml b/packages/mines/.travis.yml new file mode 100644 index 0000000..1401cb1 --- /dev/null +++ b/packages/mines/.travis.yml @@ -0,0 +1,22 @@ +language: emacs-lisp + +notifications: + email: + on_success: never + on_failure: always + +env: + # - EVM_EMACS=emacs-24.3-travis # cookie1 needed. + - EVM_EMACS=emacs-24.4-travis + - EVM_EMACS=emacs-24.5-travis + - EVM_EMACS=emacs-git-snapshot-travis + +before_install: + - git clone https://github.com/rejeep/evm.git $HOME/.evm + - export PATH=$HOME/.evm/bin:$PATH + + - evm config path /tmp + - evm install $EVM_EMACS --use --skip + +script: + - make test diff --git a/packages/mines/LICENSE b/packages/mines/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/packages/mines/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + 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. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <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: + + <program> Copyright (C) <year> <name of author> + 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>. diff --git a/packages/mines/Makefile b/packages/mines/Makefile new file mode 100644 index 0000000..97718b7 --- /dev/null +++ b/packages/mines/Makefile @@ -0,0 +1,16 @@ +emacs ?= emacs + +LOAD = -l mines.el + +all: test + +test: + $(emacs) -batch $(LOAD) -l mines-tests.el -f ert-run-tests-batch-and-exit + +compile: + $(emacs) -batch --eval "(progn (add-to-list 'load-path default-directory) (byte-compile-file \"mines.el\"))" + +clean: + rm -f *.elc + +.PHONY: all compile clean test diff --git a/packages/mines/README.md b/packages/mines/README.md new file mode 100644 index 0000000..2cf3aed --- /dev/null +++ b/packages/mines/README.md @@ -0,0 +1,37 @@ +# Minesweeper +Play minesweeper in Emacs + +[![Build Status](https://api.travis-ci.org/calancha/Minesweeper.svg?branch=master)](https://travis-ci.org/calancha/Minesweeper) + +This is an elisp implementation of the classical minesweeper game. +The target is localize all hidden mines (bombs) in a rectangular board +without detonating them. You reveal the content of a cell with the +command **mines-dig**. + +1. Cells with a bomb contain the character **x**; if you call **mines-dig** + in these cells then you lost the game. + +2. Cells without bomb at distance 1 from any cell with a mine + contain a number: the number of bombs at distance 1 from this cell. + If you reveal the content of this cell, then this number is shown. + +3. Cells without a bomb at distance > 1 from any bomb contain **@**. + If you reveal the content of this cell, then **@** is shown and + all adjacent cells are recursively revealed. + + +If you think that an uncovered cell has a mine, you might flag it +with **mines-flag-cell**: the character **!** is shown in that cell. +If you call this command again in the same cell then unflags it. This is +useful to visualize your progress in the game. + +The game is completed once all mine-free cells are revealed, that is, +when the only uncovered cells equals the number of hidden mines. + +### Screenshots + +minesweeper screenshot: +![ScreenShot](/screenshots/screenshot-minesweeper.png) + +Game over screenshot: +![ScreenShot](/screenshots/screenshot-minesweeper-gameover.png) diff --git a/packages/mines/mines-tests.el b/packages/mines/mines-tests.el new file mode 100644 index 0000000..e19c557 --- /dev/null +++ b/packages/mines/mines-tests.el @@ -0,0 +1,234 @@ +;;; mines-tests.el --- Tests for mines.el -*- lexical-binding: t; -*- + +;; Copyright (C) 2017 Free Software Foundation, Inc. + +;; Author: Tino Calancha <tino.calan...@gmail.com>, +;; Keywords: + +;; This file is part of GNU Emacs. + +;; GNU Emacs 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. + +;; GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>. + +;;; Commentary: + +;; + +;;; code: + +(require 'ert) +(require 'mines) +(require 'cl-lib) + +(ert-deftest mines-test-gameover () + (mines) + (let ((buf (get-buffer "*Mines*")) + (grid-orig (copy-sequence mines-grid)) + (idx-bomb (cl-position t mines-grid)) + idx-ok grid-new) + (with-current-buffer buf + (mines-goto idx-bomb) ; Go to first mine. + (setq idx-ok (cl-position-if-not (lambda (x) (eq t x)) mines-grid)) + (should (mines-first-move-p)) + (should-not (mines-dig)) ; Not gameover in first trial. + (setq grid-new (copy-sequence mines-grid)) + ;; Adjacent cells to bombs must be updated as well. + (should-not (equal grid-orig + (cl-rotatef (aref grid-new idx-bomb) + (aref grid-new idx-ok)))) + (mines-goto (cl-position t mines-grid)) + (should-not (mines-first-move-p)) + ;; 2nd trial might end the game. + (cl-letf (((symbol-function 'yes-or-no-p) + (lambda (&rest arg) (error "Fail")))) + (should-error (mines-dig)))) + (when (buffer-live-p buf) (kill-buffer buf)))) + +(ert-deftest mines-test-find-pos () + (mines) + (let* ((buf (get-buffer "*Mines*")) + (empty-pos (mines--find-pos nil mines-grid)) + (non-empty-pos (cl-set-difference + (number-sequence 0 (1- mines-number-cells)) + empty-pos))) + (with-current-buffer buf + (dolist (idx empty-pos) + (should-not (aref mines-grid idx))) + (dolist (idx non-empty-pos) + (should (aref mines-grid idx)))) + (when (buffer-live-p buf) (kill-buffer buf)))) + +(ert-deftest mines-test-game-completed () + (mines) + (let ((buf (get-buffer "*Mines*")) + (empty-pos (mines--find-pos nil mines-grid)) + uncover-pos) + (with-current-buffer buf + (should (mines-mines-mode-p)) + ;; Uncover all empty cells. + (dolist (idx empty-pos) + (mines-goto idx) + (mines-dig)) + (setq uncover-pos (mines--find-pos nil mines-state)) + ;; Exclude mines from `uncover-pos'. + (dolist (idx mines-mine-positions) + (setq uncover-pos (delete idx uncover-pos))) + ;; Uncover all but the first element in `uncover-pos'. + (dolist (idx (cdr uncover-pos)) + (mines-goto idx) + (mines-dig)) + (should-not (mines-end-p)) + (mines-goto (car uncover-pos)) + (mines-dig) ; Uncover the last one. + (should (mines-end-p)) ; Game completed. + (when (buffer-live-p buf) (kill-buffer buf))))) + +(ert-deftest mines-test-indices () + (= 0 (mines-matrix-2-index 0 0)) + (= 1 (mines-matrix-2-index 0 1)) + (= (1- mines-number-cols) + (mines-matrix-2-index 0 (1- mines-number-cols))) + (= (* mines-number-cols (1- mines-number-rows)) + (mines-matrix-2-index (1- mines-number-rows) 0)) + (= (1- mines-number-cells) + (mines-matrix-2-index (1- mines-number-rows) (1- mines-number-cols))) + ;; `mines-matrix-2-index' consistent with `mines-index-2-matrix'. + (dolist (idx (list 0 1 (1- mines-number-cols) + (* mines-number-cols (1- mines-number-rows)) + (1- mines-number-cells))) + (= idx (apply #'mines-matrix-2-index (mines-index-2-matrix idx))))) + +(ert-deftest mines-test-neighbours () + (cl-flet ((set-equalp (x y) + (and (null (cl-set-difference x y)) + (= (length x) (length y))))) + (set-equalp (list 1 mines-number-cols (1+ mines-number-cols)) + (mines-get-neighbours 0)) + (set-equalp (list 0 2 mines-number-cols (1+ mines-number-cols) (+ 2 mines-number-cols)) + (mines-get-neighbours 1)) + (set-equalp (list 1 2 3 mines-number-cols (1+ mines-number-cols) (+ 3 mines-number-cols) + (+ 2 (* 2 mines-number-cols)) (1+ (* 2 mines-number-cols)) (+ 3 (* 2 mines-number-cols))) + (mines-get-neighbours (+ 2 mines-number-cols))) + (set-equalp (list (- mines-number-cells 2) + (1- (* (1- mines-number-rows) mines-number-cols)) + (- (* (1- mines-number-rows) mines-number-cols) 2)) + (mines-get-neighbours (1- mines-number-cells))))) + +(ert-deftest mines-test-neighbours () + (mines) + (let ((buf (get-buffer "*Mines*"))) + (with-current-buffer buf + (mines-goto (1- mines-number-cols)) + (should (eq (following-char) mines-uncover-cell-char)) + (mines-flag-cell) ; First time flag cell. + (should (eq (following-char) mines-flagged-cell-char)) + (mines-flag-cell) ; Second time unflag. + (should (eq (following-char) mines-uncover-cell-char)) + (when (buffer-live-p buf) (kill-buffer buf))))) + +(ert-deftest mines-test-goto () + (mines) + (let ((buf (get-buffer "*Mines*"))) + (with-current-buffer buf + (dolist (idx (list 0 1 (1- mines-number-cols) (1- mines-number-rows) + (1- mines-number-cells))) + (mines-goto idx) + (should (= idx (mines-current-pos)))) + (let ((idx (+ 100 mines-number-cells))) + (mines-goto idx) ; No error + (should-not (= idx (mines-current-pos)))) + ;; Test right. left, up, down movements. + (dotimes (idx mines-number-cells) + (mines-goto idx) + (let* ((row (car (mines-index-2-matrix idx))) + (col (cadr (mines-index-2-matrix idx))) + (idx-right (if (= col (1- mines-number-cols)) + (mines-matrix-2-index row 0) + (mines-matrix-2-index row (1+ col)))) + (idx-left (if (zerop col) + (mines-matrix-2-index row (1- mines-number-cols)) + (mines-matrix-2-index row (1- col)))) + (idx-up (if (zerop row) + (mines-matrix-2-index (1- mines-number-rows) col) + (mines-matrix-2-index (1- row) col))) + (idx-down (if (= row (1- mines-number-rows)) + (mines-matrix-2-index 0 col) + (mines-matrix-2-index (1+ row) col)))) + (save-excursion ; Right + (mines-go-right) + (should (= idx-right (mines-current-pos)))) + (save-excursion ; Left + (mines-go-left) + (should (= idx-left (mines-current-pos)))) + (save-excursion ; Up + (mines-go-up) + (should (= idx-up (mines-current-pos)))) + (save-excursion ; Down + (mines-go-down) + (should (= idx-down (mines-current-pos))))))) + (when (buffer-live-p buf) (kill-buffer buf)))) + +;; `mines--near-bombs' is used when `mines-grid' just contains nil or t. +(ert-deftest mines-test-near-bombs () + (mines) + (let ((buf (get-buffer "*Mines*")) + (grid (make-vector mines-number-cells nil))) + (dolist (idx mines-mine-positions) + (aset grid idx t)) + (with-current-buffer buf + (let ((mines-grid grid)) + (dotimes (idx mines-number-cells) + (unless (aref grid idx) + (let ((row (car (mines-index-2-matrix idx))) + (col (cadr (mines-index-2-matrix idx))) + (numb 0)) + (mines-goto idx) + ;; Right + (when (< col (1- mines-number-cols)) + (when (aref grid (mines-matrix-2-index row (1+ col))) + (cl-incf numb))) + ;; Left + (unless (zerop col) + (when (aref grid (mines-matrix-2-index row (1- col))) + (cl-incf numb))) + ;; Up + (unless (zerop row) + (when (aref grid (mines-matrix-2-index (1- row) col)) + (cl-incf numb))) + ;; Up-Right + (when (and (not (zerop row)) (< col (1- mines-number-cols))) + (when (aref grid (mines-matrix-2-index (1- row) (1+ col))) + (cl-incf numb))) + ;; Up-Left + (when (and (not (zerop row)) (not (zerop col))) + (when (aref grid (mines-matrix-2-index (1- row) (1- col))) + (cl-incf numb))) + ;; Down + (unless (= row (1- mines-number-rows)) + (when (aref grid (mines-matrix-2-index (1+ row) col)) + (cl-incf numb))) + ;; Down-Right + (when (and (not (= row (1- mines-number-rows))) (< col (1- mines-number-cols))) + (when (aref grid (mines-matrix-2-index (1+ row) (1+ col))) + (cl-incf numb))) + ;; Down-Left + (when (and (not (= row (1- mines-number-rows))) (not (zerop col))) + (when (aref grid (mines-matrix-2-index (1+ row) (1- col))) + (cl-incf numb))) + (should (= numb (mines--near-bombs row col)))))))) + (when (buffer-live-p buf) (kill-buffer buf)))) + + +(provide 'mines-tests) +;;; mines-tests.el ends here + diff --git a/packages/mines/mines.el b/packages/mines/mines.el new file mode 100644 index 0000000..02bfc9b --- /dev/null +++ b/packages/mines/mines.el @@ -0,0 +1,607 @@ +;;; mines.el --- Minesweeper game -*- lexical-binding: t -*- + +;; Copyright (C) 2017 Free Software Foundation, Inc. + +;; Author: Tino Calancha <tino.calan...@gmail.com> +;; Created: 2017-10-28 +;; Keywords: games +;; Version: 1.0 +;; Package-Requires: ((emacs "24.4") (cl-lib "0.5")) +;; url: https://github.com/calancha/Minesweeper + +;; This file is part of GNU Emacs. + +;; GNU Emacs 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. + +;; GNU Emacs 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 <https://www.gnu.org/licenses/>. + +;;; Commentary: + +;; This is an elisp implementation of the classical minesweeper game. +;; The target is localize all hidden mines (bombs) in a rectangular board +;; without detonating them. You reveal the content of a cell with the +;; command `mines-dig'. +;; +;; 1. Cells with a bomb contain the character 'x'; if you call `mines-dig' +;; in these cells then you lost the game. + +;; 2. Cells without bomb at distance 1 from any cell with a mine +;; contain a number: the number of bombs at distance 1 from this cell. +;; If you reveal the content of this cell, then this number is shown. +;; +;; 3. Cells without a bomb at distance > 1 from any bomb contain '@'. +;; If you reveal the content of this cell, then '@' is shown and +;; all adjacent cells are recursively revealed. +;; +;; +;; If you think that an uncovered cell has a mine, you might flag it +;; with `mines-flag-cell'; if you call this command again in the same +;; cell the cell is unflagged. This is useful to visualize your +;; progress in the game. +;; +;; The game is completed once all mine-free cells are revealed, that is, +;; when the only uncovered cells equals the number of hidden mines. +;; + +;;; Code: + +(require 'gamegrid) +(require 'cl-lib) +(require 'cookie1) ; For `cookie-shuffle-vector'. + + +;;; Internal variables. +(defgroup mines nil + "Play minessweeper." + :group 'games + :prefix "mines-") + +(defcustom mines-protect-first-move t + "Non-nil avoid game over in the first cell revealed." + :type 'boolean + :version "27.1") + +(defcustom mines-mode-hook nil + "Hook run by mines mode." + :type 'hook + :group 'mines + :version "27.1") + +(defvar mines-uncover-cell-char ?. + "Char to display uncover cells.") + +(defvar mines-flagged-cell-char ?! + "Char to display flagged cells as maybe having a mine.") + +(defvar mines-empty-cell-char ?@ + "Char to display a cell without mine nor numbers.") + +(defvar mines-empty-cell-mine ?x + "Char to display a cell with a mine.") + +(defvar mines-buffer nil "Buffer where play minesweeper.") +(defvar mines-start-pos 2 "Initial prompt position.") +(defvar mines-number-mines 10 "Number of mines.") +(defvar mines-number-rows 8 "Nmber of rows.") +(defvar mines-number-cols 8 "Number of columns.") +(defvar mines-number-cells (* mines-number-rows mines-number-cols) + "Number of cells.") + +(defcustom mines-difficulty-level 'easy + "Level of difficulty. +If `easy' we have 8 columns x 8 columns and 10 mines. +If `medium' we have 16 columns x 16 columns and 40 mines. +If `hard' we have 30 columns x 16 columns and 99 mines. +If `custom' then ask user for these numbers." + :type '(choice (const :tag "Easy" easy) + (const :tag "Medium" medium) + (const :tag "Hard" hard) + (const :tag "Custom" custom)) + :group 'games + :set (lambda (sym val) + (if (not (eq val 'custom)) + (set sym val) + (setq mines-number-cols (read-number "Number of columns: ") + mines-number-rows (read-number "Number of rows: ") + mines-number-mines (read-number "Number of mines: ")) + (set sym val))) + :version "27.1") + +(defvar mines-grid (make-vector mines-number-cells nil) + "Game configuration.") + +(defvar mines-state (make-vector mines-number-cells nil) + "Game state.") + +(defvar mines-mine-positions nil "Mine positions.") +(defvar mines-gap-positions nil "Empty cell positions.") +(defvar mines-init-time nil "Initial time of the game.") +(defvar mines-end-time nil "End time of the game.") +(defvar mines-undone-neighbours nil + "List of uncovered neighbours for the current cell.") + +(defvar-local mines-game-over nil + "Non-nil if the game in current buffer has ended.") + +(defmacro mines-init (cond1 cond2 cond3 cond4 &rest body) + (declare (debug (form form form form &rest body))) + `(progn + (cond (,cond1 + (setq mines-number-cols 8 + mines-number-rows 8 + mines-number-mines 10 + mines-difficulty-level 'easy)) + (,cond2 + (setq mines-number-cols 16 + mines-number-rows 16 + mines-number-mines 40 + mines-difficulty-level 'medium)) + (,cond3 + (setq mines-number-cols 30 + mines-number-rows 16 + mines-number-mines 99 + mines-difficulty-level 'hard)) + (,cond4 (setq mines-difficulty-level 'custom) ,@body)) + (setq mines-number-cells (* mines-number-rows mines-number-cols)))) + + +;;; Moving. +(defun mines-index-2-matrix (idx) + "Translate 1-D array index into 2-D matrix indices." + (let* ((col (% idx mines-number-cols)) + (row (/ idx mines-number-cols))) + (list row col))) + +(defun mines-matrix-2-index (row col) + "Translate 2-D matrix indices into 1-D array index." + (+ col (* row mines-number-cols))) + +(defun mines-get-neighbours (idx) + "Return cell neighbour indices for cell at IDX." + (let* ((row-col (mines-index-2-matrix idx)) + (row (car row-col)) + (col (cadr row-col)) + res) + (cl-flet ((add-fn (to-row) + (or (= row to-row) (push (list to-row col) res)) + (and (< col (1- mines-number-cols)) + (push (list to-row (1+ col)) res)) + (or (zerop col) (push (list to-row (1- col)) res)))) + (progn + (add-fn row) ; Horizontal neighburs. + (unless (zerop row) (add-fn (1- row))) ; Up neighbours. + (when (< row (1- mines-number-rows)) ; Below neighbours. + (add-fn (1+ row))))) + (mapcar (lambda (x) (mines-matrix-2-index (car x) (cadr x))) res))) + +(defun mines-goto (idx) + "Move to cell at IDX." + (goto-char 1) + (let ((cidx (mines-current-pos))) + (ignore-errors + (while (not (= cidx idx)) + (goto-char (next-single-property-change (point) 'idx)) + (setq cidx (mines-current-pos))) + (goto-char (1+ (point)))))) + +(defun mines-go-right () + "Move 1 cell to the right." + (interactive) + (if (= (point) (point-max)) + (progn + (forward-line -1) + (goto-char (1+ (point)))) + (let* ((idx (mines-current-pos)) + (row-col (mines-index-2-matrix idx)) + (row (car row-col)) + (col (cadr row-col))) + (if (= col (1- mines-number-cols)) + (mines-goto (apply #'mines-matrix-2-index (list row 0))) + (mines-goto (1+ (mines-current-pos))))))) + +(defun mines-go-left () + "Move 1 cell to the left." + (interactive) + (if (= (point) (point-max)) + (goto-char (1- (point))) + (let* ((idx (mines-current-pos)) + (row-col (mines-index-2-matrix idx)) + (row (car row-col)) + (col (cadr row-col))) + (if (zerop col) + (mines-goto (apply #'mines-matrix-2-index + (list row (1- mines-number-cols)))) + (mines-goto (1- (mines-current-pos))))))) + +(defun mines-go-down () + "Move to the cell under the current one." + (interactive) + (if (= (point) (point-max)) + (goto-char mines-start-pos) + (let* ((idx (mines-current-pos)) + (row-col (mines-index-2-matrix idx)) + (row (car row-col)) + (col (cadr row-col))) + (if (= row (1- mines-number-rows)) + (mines-goto (apply #'mines-matrix-2-index (list 0 col))) + (mines-goto (apply #'mines-matrix-2-index (list (1+ row) col))))))) + +(defun mines-go-up () + "Move to the cell over the current one." + (interactive) + (if (= (point) (point-max)) + (progn + (forward-line -1) + (goto-char (1+ (point)))) + (let* ((idx (mines-current-pos)) + (row-col (mines-index-2-matrix idx)) + (row (car row-col)) + (col (cadr row-col))) + (if (zerop row) + (mines-goto (apply #'mines-matrix-2-index (list (1- mines-number-rows) col))) + (mines-goto (apply #'mines-matrix-2-index (list (1- row) col))))))) + + +;;; Main Functions. + +(defun mines--find-pos (elt vec) + (let ((pos 0) res) + (while (setq pos + (cl-position-if + (lambda (x) + (cond ((null elt) + ;; Check if the cell is empty or flagged. + (or (null x) (eq mines-flagged-cell-char x))) + (t (eq elt x)))) + vec :start pos)) + (push pos res) + (cl-incf pos)) + (nreverse res))) + +(defun mines-start () + "Set mine positions for a new game." + ;; Erase vector. + (setq mines-grid (make-vector mines-number-cells nil)) + (setq mines-state (make-vector mines-number-cells nil)) + (let ((numbers (append + (cookie-shuffle-vector + (vconcat (number-sequence 0 (1- mines-number-cells)))) nil))) + (dotimes (_ mines-number-mines) + (aset mines-grid (pop numbers) t)) + (setq mines-mine-positions (mines--find-pos t mines-grid)))) + +(defun mines--near-bombs (i j) + (let ((numb 0)) + ;; Horizontal neighbours. + (when (> j 0) + (and (aref mines-grid (mines-matrix-2-index i (1- j))) (cl-incf numb))) + (when (< j (1- mines-number-cols)) + (and (aref mines-grid (mines-matrix-2-index i (1+ j))) (cl-incf numb))) + ;; Previous row neighbours. + (when (> i 0) + (and (aref mines-grid (mines-matrix-2-index (1- i) j)) (cl-incf numb)) + (when (> j 0) + (and (aref mines-grid (mines-matrix-2-index (1- i) (1- j))) (cl-incf numb))) + (when (< j (1- mines-number-cols)) + (and (aref mines-grid (mines-matrix-2-index (1- i) (1+ j))) (cl-incf numb)))) + ;; Next row neighbours. + (when (< i (1- mines-number-rows)) + (and (aref mines-grid (mines-matrix-2-index (1+ i) j)) (cl-incf numb)) + (when (> j 0) + (and (aref mines-grid (mines-matrix-2-index (1+ i) (1- j))) (cl-incf numb))) + (when (< j (1- mines-number-cols)) + (and (aref mines-grid (mines-matrix-2-index (1+ i) (1+ j))) (cl-incf numb)))) + numb)) + +(defun mines-set-numbers () + "Set numbers for cells adjacent to cells with bombs." + (let ((tmp-grid (copy-sequence mines-grid))) + (dotimes (i mines-number-rows) + (dotimes (j mines-number-cols) + (let ((idx (mines-matrix-2-index i j))) + (unless (aref mines-grid idx) + (let ((numb (mines--near-bombs i j))) + (unless (zerop numb) (aset tmp-grid idx numb))))))) + (setq mines-grid tmp-grid))) + +(defun mines-list-game-conditions () + "Return number of rows, columns and mines for current game." + (interactive) + (when (mines-mines-mode-p) + (let ((rows mines-number-rows) + (cols mines-number-cols) + (mines mines-number-mines)) + (message "%d rows x %d columns with %d mines" + rows cols mines) + (list rows cols mines)))) + +(defun mines--insert (elt idx &optional props null-str flag-or-unflag) + (let* ((face nil) + (str (cond ((null elt) + (if (null null-str) + (format " %c " mines-uncover-cell-char) + ;; Uncover all its uncovered neighbours. + (save-excursion + (dolist (x (mines-get-neighbours idx)) + (mines-goto x) + (unless (get-text-property (point) 'done) + (push x mines-undone-neighbours)))) + (format " %s " null-str))) + ((eq flag-or-unflag 'unflag) + (format " %c " mines-uncover-cell-char)) + ((and (memq 'flag props) (eq flag-or-unflag 'flag)) + (setq face 'warning) + (format " %c " mines-flagged-cell-char)) + ((integerp elt) (format " %d " elt)) + (t (format " %c " mines-empty-cell-mine)))) + (pos (point)) + (inhibit-read-only t)) + (if face + (insert (propertize str 'font-lock-face face)) + (insert str)) + (when (= (cadr (mines-index-2-matrix idx)) (1- mines-number-cols)) + (backward-delete-char 1) + (insert "\n")) + (add-text-properties pos (point) props) + (goto-char (1+ (point))))) + +(defun mines-show () + "Display the board for a new game." + (with-current-buffer (or (and (buffer-live-p mines-buffer) mines-buffer) + (setq mines-buffer (get-buffer-create "*Mines*"))) + (read-only-mode 1) + (setq mines-game-over nil) + (let ((inhibit-read-only t)) + (erase-buffer) + (unless (derived-mode-p 'mines-mode) + (mines-mode)) + (dotimes (i mines-number-rows) + (dotimes (j mines-number-cols) + (let* ((idx (+ (* i mines-number-cols) j)) + (elt (aref mines-state idx)) + (pos (point))) + (mines--insert elt idx) + (put-text-property pos (point) 'idx idx) + (when (= j (1- mines-number-cols)) + (delete-char -1) + (insert "\n")) + (put-text-property (1- (point)) (point) 'idx idx)))))) + (display-buffer mines-buffer '(display-buffer-same-window)) + (set-window-point (get-buffer-window mines-buffer) mines-start-pos)) + +(defun mines-current-pos () + "Return the index of the cell at point." + (get-text-property (point) 'idx)) + +(defun mines--show-all () + "Show all mines after game over." + (dolist (to mines-mine-positions) + (save-excursion + (mines-goto to) + ;; Drop all flags before show the mines; that drop the flag faces. + (when (eq (following-char) mines-flagged-cell-char) + (mines--update-cell to mines-uncover-cell-char 'unflag)) + (mines-dig 'show-mines)))) + +(defun mines-game-over () + "Offer play a new game after uncover a bomb." + (let ((inhibit-read-only t)) + (put-text-property (point) (1+ (point)) 'face 'error) + (mines--show-all) + (if (yes-or-no-p "Game over! Play again? ") + (mines) + (setq mines-game-over t)))) + +(defun mines-game-completed () + (setq mines-end-time (current-time)) + (let* ((score (time-to-seconds + (time-subtract mines-end-time mines-init-time))) + (elapsed-time (format-seconds "%Y, %D, %H, %M, %z%S" + score))) + ;; save score + (gamegrid-add-score (format "mines-rows-%d-cols-%d-mines-%d-scores" + mines-number-rows + mines-number-cols + mines-number-mines) + score) + (message (format "Well done %s, you have completed it in %s!" + user-login-name elapsed-time)))) + +(defun mines-flag-cell () + "Flag current cell as having a mine. +If called again then unflag it." + (interactive) + (let* ((idx (mines-current-pos)) + (done (get-text-property (point) 'done)) + (flagged (get-text-property (point) 'flag))) + (unless idx (user-error "Wrong position!")) + (unless done + (cond (flagged + (mines--update-cell idx mines-uncover-cell-char 'unflag)) + (t (mines--update-cell idx mines-flagged-cell-char 'flag)))))) + +(defun mines--update-cell (idx elt &optional flag-or-unflag) + (if (zerop idx) + (goto-char 1) + (goto-char (previous-single-property-change (point) 'idx))) + (let ((to (or (next-single-property-change (point) 'idx) (point-max))) + (prop (append (text-properties-at (point)) + (if flag-or-unflag + `(flag ,(eq flag-or-unflag 'flag)) + '(done t)))) + (inhibit-read-only t)) + (when (eq flag-or-unflag 'unflag) + (setq prop `(idx ,idx))) + ;; If unflagging, then remove additional text properties. + (when (eq flag-or-unflag 'unflag) + (remove-text-properties (point) to '(font-lock-face flag))) + (delete-region (point) to) + (mines--insert elt idx prop (string mines-empty-cell-char) flag-or-unflag) + (unless flag-or-unflag (aset mines-state idx '@)) + (mines-goto idx))) + +(defun mines-dig (&optional show-mines) + "Reveal the content of the cell at point." + (interactive) + (when (mines-mines-mode-p) + (if mines-game-over + (user-error "Current game is over. Try `%s' to start a new one." + (substitute-command-keys "\\[mines\]")) + (skip-chars-forward "[:blank:]") ; Set point in the center of the cell. + (cl-labels ((uncover-fn + () + (let ((idx (mines-current-pos)) + (inhibit-read-only t) + (done (get-text-property (point) 'done))) + (cond ((null idx) (user-error "Wrong position!")) + (done nil) ; Already updated. + (t + (let ((elt (aref mines-grid idx))) + ;; Don't end the game in the first trial when + ;; `mines-protect-first-move' is non-nil. + (when (and (eq elt t) mines-protect-first-move (mines-first-move-p)) + (let ((ok-pos (cl-position-if-not (lambda (x) (eq t x)) mines-grid))) + (message "Avoided game over in the first move") + ;; Update mine positions. + (setf (nth (cl-position idx mines-mine-positions) + mines-mine-positions) ok-pos) + ;; We must update `mines-grid' further: the neighbour cells + ;; to IDX must show now a lower number of near bombs; the + ;; cells near the new position of the bomb must increase their + ;; numbers. + (setq mines-grid (make-vector mines-number-cells nil)) + ;; Add the mine positions. + (dolist (pos mines-mine-positions) + (aset mines-grid pos t)) + ;; Update the numbers on neighbour cells. + (mines-set-numbers) + ;; Update current element. + (setq elt (aref mines-grid idx)))) + ;; If the cell is flagged ask for confirmation. + (if (and (not show-mines) (eq (following-char) mines-flagged-cell-char)) + (if (yes-or-no-p "This cell is flagged as having a bomb. Uncover it? ") + (progn ; Unflag first. + (mines--update-cell idx mines-uncover-cell-char 'unflag) + (mines--update-cell idx elt)) + (message "OK, canceled")) + (mines--update-cell idx elt)) + ;; Check for end of game. + (cond ((and (not show-mines) (eq elt t)) + ;; We lost the game; show all the mines. + (mines-game-over)) + (t + (when (and (not show-mines) (mines-end-p)) + (mines-game-completed)))))))))) + (uncover-fn) + (when mines-undone-neighbours + (while mines-undone-neighbours + (let ((to (pop mines-undone-neighbours))) + (save-excursion + (mines-goto to) + (uncover-fn))))))))) + +;;;###autoload +(defun mines (&optional arg) + "Play the minesweeper game. +Called with a prefix prompt for the difficulty level. + +The target of the game is discover which cells contain mines. +You reveal the content of the mine at point with \\[mines-dig\]. +1. If you look at one cell containing a mine you lost. + +2. A cell without a mine having N neighbour cells containing mines + shows N when you look at it. + +3. A cell without a mine and without neighbour cells having mines + shows the character `@' when you look at it; all adjacent cells + are recursively revealed. + +For instance, following is a possible configuration: + +@ @ @ @ @ +1 2 2 1 @ +1 x x 1 @ +1 2 2 1 @ +@ @ @ @ @ + +You can move between cells using the arrow keys, or using vi +or emacs keystrokes (↑↓→←) = (kjlh) = (pnfb). + +You can flag a cell as having a mine with \\[mines-flag-cell\]; if you +call this command again, the cell is unflagged." + (interactive + (let* ((prefix current-prefix-arg) + (choice (and prefix + (read-multiple-choice "Choose difficulty level: " + '((?e "Easy" "8 columns x 8 rows and 10 mines") + (?m "Medium" "16 columns x 16 rows and 40 mines") + (?h "Hard" "30 columns x 16 rows and 99 mines") + (?c "Custom" "C columns x R rows and M mines")))))) + (when choice + (mines-init (eq ?e (car choice)) + (eq ?m (car choice)) + (eq ?h (car choice)) + (eq ?c (car choice)) + (setq mines-number-cols (read-number "Number of columns: ") + mines-number-rows (read-number "Number of rows: ") + mines-number-mines (read-number "Number of mines: ")))) + (list prefix))) + (unless arg + (mines-init (eq mines-difficulty-level 'easy) + (eq mines-difficulty-level 'medium) + (eq mines-difficulty-level 'hard) + t)) + (setq mines-init-time (current-time)) + (mines-start) + (mines-set-numbers) + (mines-show)) + +(define-derived-mode mines-mode special-mode "mines" + (let ((map mines-mode-map)) + (define-key map [right] 'mines-go-right) + (define-key map "f" 'mines-go-right) + (define-key map "l" 'mines-go-right) + (define-key map [left] 'mines-go-left) + (define-key map "b" 'mines-go-left) + (define-key map "h" 'mines-go-left) + (define-key map "p" 'mines-go-up) + (define-key map "k" 'mines-go-up) + (define-key map [up] 'mines-go-up) + (define-key map [down] 'mines-go-down) + (define-key map "n" 'mines-go-down) + (define-key map "j" 'mines-go-down) + (define-key map "x" 'mines-dig) + (define-key map "c" 'mines-dig) + ;; (define-key map "a" 'mines-flag-cell) + (define-key map "1" 'mines-flag-cell) + (define-key map "m" 'mines-flag-cell) + (define-key map "r" 'mines)) + "Major mode for playing Minesweeper.") + + +;;; Predicates + +(defun mines-mines-mode-p () + "Return non-nil if the current buffer is in `mines-mode'." + (derived-mode-p 'mines-mode)) + +(defun mines-end-p () + "Return non-nil when the game is completed." + (equal mines-mine-positions (mines--find-pos nil mines-state))) + +(defun mines-first-move-p () + "Return non-nil if any cell has been revealed yet." + (cl-every 'null mines-state)) + + +(provide 'mines) +;;; mines.el ends here