inform-mode-1.6.2/0000775000175000017500000000000012225513156013364 5ustar rupertrupertinform-mode-1.6.2/AUTHORS0000644000175000017500000000115411747511742014442 0ustar rupertrupertRupert Lane is the current maintainer of inform-mode. inform-mode was originally written by Gareth Rees and was previously maintained by Michael Fessler. Here is an list of other people that have made contributions to inform-mode (whether by code, bug reporting, patches, ideas, inspiration, testing or feedback): Daniel Barkalow Jonadab the Unsightly One Christopher Scott Top Changwatchai Derek Feddon Dan Schmidt Stephen Silver Espen Wiborg Marshall T. Vandegrift Reuben Thomas Dave Robinson Samuel Bronson If I have missed anyone out please let me know. # Local Variables: # mode: text # fill-column: 72 # End: inform-mode-1.6.2/COPYING-GPL-30000644000175000017500000010437411747511742015215 0ustar rupertrupert GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . inform-mode-1.6.2/Makefile0000644000175000017500000000264312224674131015027 0ustar rupertrupert# Makefile for inform-mode # Edit these variables to override the version of emacs and where to # put the installed files EMACS=emacs PREFIX=/usr/local/share/emacs/site-lisp # There is normally no need to edit anything below this line. VERSION=1.6.2 ELS=inform-mode.el ELCS=$(ELS:.el=.elc) OTHER_FILES=AUTHORS COPYING COPYING-GPL-3 INSTALL Makefile NEWS README DIST_FILES=$(ELS) $(OTHER_FILES) EMACSFLAGS= BATCH=$(EMACS) $(EMACSFLAGS) -batch -q -no-site-file -eval \ "(setq load-path (cons (expand-file-name \".\") load-path))" ZIP=zip %.elc: %.el $(BATCH) --eval '(byte-compile-file "$<")' all: $(ELCS) install: all mkdir -p $(PREFIX) install -m 644 $(ELS) $(ELCS) $(PREFIX) uninstall: rm -f $(PREFIX)/${ELCS} $(PREFIX)/${ELS} dist: inform-mode-$(VERSION).tar.gz inform-mode-$(VERSION).zip inform-mode-$(VERSION).tar.gz: $(DIST_FILES) mkdir -p inform-mode-$(VERSION) cp --preserve=timestamps $(DIST_FILES) inform-mode-$(VERSION) tar cvzf inform-mode-$(VERSION).tar.gz inform-mode-$(VERSION) rm -rf inform-mode-$(VERSION) inform-mode-$(VERSION).zip: $(DIST_FILES) mkdir -p inform-mode-$(VERSION) cp --preserve=timestamps $(DIST_FILES) inform-mode-$(VERSION) (cd inform-mode-$(VERSION); for x in $(OTHER_FILES); do mv $$x $$x.txt; done; rm -f Makefile.txt) $(ZIP) -l inform-mode-$(VERSION).zip inform-mode-$(VERSION)/* rm -rf inform-mode-$(VERSION) clean: rm -rf *~ $(ELCS) *.tar.gz *.zip inform-mode-$(VERSION) inform-mode-1.6.2/README0000664000175000017500000000457612133403131014245 0ustar rupertrupertinform-mode: an Emacs major mode for editing Inform 6 source code. Introduction ------------ inform-mode supports the usual program mode functions: automatic indentation, moving over expressions, comment and string filling, font locking, tags-file support, starting compiles and parsing errors. You can also run a z-code interpreter against the compiled code. It should work on GNU Emacs (v22+) or XEmacs (v21.4+) on any supported platform. See the NEWS file for details of recent changes. Installing inform-mode ---------------------- See the INSTALL file for notes on installing inform-mode. Using inform-mode ----------------- After installation, inform-mode will be activated for any files ending in .inf (and optionally .h) when you visit them using Emacs. Type 'C-h m' to view the documentation for the mode. Variables governing inform-mode can be customized; type 'M-x customize' and navigate to Programming / Languages / inform-mode. License ------- inform-mode is free software, released under the GNU General Public License version 3 (or later). See COPYING for further details of the license. Latest version -------------- The latest stable release of inform-mode can be found at the website http://www.rupert-lane.org/inform-mode/ Seee http://www.rupert-lane.org/inform-mode/news.html or subscribe to the Atom feed at http://www.rupert-lane.org/inform-mode/news.xml to get details of the latest version. inform-mode can be donwloaded via the Marmalade package system in Emacs; see http://marmalade-repo.org/ It is also available via anonymous FTP at ftp.ifarchive.org Bug reports and development --------------------------- Any bugs reports, patches, feature suggestions or other feedback would be welcomed. Please email rupert@rupert-lane.org Development versions can be obtained via the git repository git clone http://www.rupert-lane.org/inform-mode/inform-mode.git Or via github: https://github.com/rupertl/inform-mode The 'master' branch tracks the released version; 'testing' contains the latest development version but may not be stable. Authors ------- Rupert Lane is the current maintainer of inform-mode. inform-mode was originally written by Gareth Rees and was previously maintained by Michael Fessler. Many people have helped with the development and testing of inform-mode; see the AUTHORS file for full details. # Local Variables: # mode: text # fill-column: 72 # End: inform-mode-1.6.2/NEWS0000644000175000017500000001332312225264556014072 0ustar rupertrupertinform-mode 1.6.2 (2013-10-10) ============================== Features -------- * Added option inform-indent-semicolon This will govern indentation of semicolons on lines of their own as per a request from Dave Robinson. The default behaviour, as in previous versions, is to indent the semicolon to match the current syntax. If inform-indent-semicolon is set to nil then the semicolon will not be indented. Other changes ------------- * Add autoload hints for mode (thanks to Reuben Thomas for the patch) * Source code available on github * Docstrings cleanup * Added a note for XEmacs users regarding extra packages * Tested on Emacs 24.3 inform-mode 1.6.1 (2012-10-23) ============================== Other changes ------------- * Minor changes to header for ELPA package format compatibility. * Tested on Emacs 24.2 inform-mode 1.6.0 (2012-05-01) ============================== Features -------- * Can now use customize to edit preferences * Improved tags generation to match directives and objects declared with class name * Added a Makefile and documentation to make installation easier Bug fixes --------- * Added missing Inform keywords, directives and properties * Fixed font-lock error with multiple keywords, eg 'else return' * Fixed byte-compile errors and warnings * Fixed bug in next-error on Emacs (22+) Other changes ------------- * Adopted GPL version 3 * Added README, NEWS and AUTHORS files to distribution * Simplified handling of regexps * Tested on recent versions of Emacs (22/23) and XEmacs (21.4) * Improved website http://www.rupert-lane.org/inform-mode/ inform-mode 1.5.8 (2002-09-03) ============================== Features -------- * inform-run-project (C-c C-c) runs an interpreter on the z-code file for the current project. This allows you to test games from within the development environment. Bug fixes --------- * Don't fontify semicolon after keyword. * Fontify double-quoted dictionary words properly. * Expand filenames sent to inform-project-file-list. * inform-retagify should now work on NT systems. * Don't move point unnecessarily in inform-indent-line. Other changes ------------- * inform-convert-old-format: obsolete function removed inform-mode 1.5.7 (2002-04-02) ============================== Bug fixes --------- * Fixed bug in fontification on GNU Emacs 21 inform-mode 1.5.6 (2000-12-17) ============================== Bug fixes --------- * Recognise 'private' keyword * Fontify object name after '->' properly * Fontify dictionary words containing '-' properly * Fontify 1-character dictionary words properly * Fontify 'with name' properly * Correct fontification of char before attribute/property name * Allow imenu to recognize objects with -> in their header inform-mode 1.5.5 (2000-09-04) ============================== Bug fixes --------- * Strings with '^' and '//' are now fontified properly * Non-directives ending with directive names (eg 'JObject') are now fontified properly * Comment line-up (ie with inform-comments-line-up-p non-nil) is no longer confused by '!' in code * Multi-line switch labels indented properly * Indentation of multi-line strings now handled by inform-strings-line-up-p inform-mode 1.5.4 (2000-07-04) ============================== Bug fixes --------- * Dictionary words are now fontified using inform-dictionary-word-face, as font-lock-constant-face is not available on all Emacsen. * Actions (eg ##Examine) are indented properly. inform-mode 1.5.3 (2000-05-23) ============================== Bug fixes --------- * Dictionary words are fontified using font-lock-constant-face. inform-mode 1.5.2 (1999-12-15) ============================== Features -------- * You can now spell-check all double-quoted strings in the buffer using the keystroke 'C-c C-s' (inform-spell-check-buffer). This assumes that you have the GNU 'ispell' program on your system. * If you set the variable 'inform-comments-line-up-p' to non-NIL, comments spread out over several lines will start on the same column as the first comment line. Bug fixes --------- * Objects that start with a class line should now be indented properly. * '#ifdef'/'#endif' blocks should be indented properly. * Indentation bug in first property of class or object fixed. inform-mode 1.5.1 (1999-12-05) ============================== Bug fixes --------- * Byte-compilation should work on GNU Emacs. * Indentation bug in first property of class or object fixed. inform-mode 1.5.0 (1999-11-27) ============================== Features -------- * Understands all Inform 6.21 directives and library 6/10 attributes and properties. * Font locking for Inform routine code as well as object/class definitions. * New keywords can be added easily as font locking regexps are calculated at mode eval time. * Tags files can now be created on non-Unix platforms. * More object and routine definitions are now identified properly when creating tage files. Bug fixes --------- * Indents if-else blocks correctly, * inform-indent-line (TAB) moves point in a similar way to other major modes. * When filling strings, backslashes are no longer added. inform-mode 1.1b1 (1999-11-17) ============================== Beta version by Mike Fessler inform-mode 1.0 (1996-05-02) ============================ Initial version by Gareth Rees inform-mode-1.6.2/inform-mode.el0000664000175000017500000017340412225430735016134 0ustar rupertrupert;;; inform-mode.el --- Major mode for Inform 6 interactive fiction code ;; Author: Rupert Lane ;; Gareth Rees ;; Michael Fessler ;; Created: 1 Dec 1994 ;; Version: 1.6.2 ;; Released: 10-Oct-2013 ;; Url: http://www.rupert-lane.org/inform-mode/ ;; Keywords: languages ;;; Copyright: ;; Original version copyright (c) by Gareth Rees 1996 ;; Portions copyright (c) by Michael Fessler 1997-1998 ;; Portions copyright (c) by Rupert Lane 1999-2013 ;; inform-mode 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, or (at your option) ;; any later version. ;; ;; inform-mode 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. ;;; Commentary: ;; Inform is a compiler for adventure games by Graham Nelson, ;; available at ;; http://www.inform-fiction.org/inform6.html ;; ;; This file implements a major mode for editing Inform 6 programs. It ;; understands most Inform syntax and is capable of indenting lines ;; and formatting quoted strings. Type `C-h m' within Inform mode for ;; more details. ;; ;; Because Inform header files use the extension ".h" just as C header ;; files do, the function `inform-maybe-mode' is provided. It looks at ;; the contents of the current buffer; if it thinks the buffer is in ;; Inform, it selects inform-mode; otherwise it selects the mode given ;; by the variable `inform-maybe-other'. ;; Latest version of this mode can be found at ;; http://www.rupert-lane.org/inform-mode/ ;; Please send any bugs or comments to rupert@rupert-lane.org ;;; History: ;; See the NEWS file in the distribution ;; or http://www.rupert-lane.org/inform-mode/news.html ;;; Code: (require 'font-lock) (require 'regexp-opt) (require 'ispell) (require 'term) (require 'compile) (require 'imenu) ;;; ;;; Customize support ;;; (defgroup inform-mode nil "Settings for Inform source code." :group 'languages) (defgroup inform-mode-indent nil "Customize indentation and highlighting of Inform source code." :group 'inform-mode) (defgroup inform-mode-build-run nil "Customize build and run options for Inform code." :group 'inform-mode) ;;; ;;; General variables ;;; (defconst inform-mode-version "1.6.2") (defcustom inform-maybe-other 'c-mode "*`inform-maybe-mode' runs this if current file is not in Inform mode." :type 'function :group 'inform-mode) (defcustom inform-startup-message t "*Non-nil means display a message when Inform mode is loaded." :type 'boolean :group 'inform-mode) (defcustom inform-auto-newline t "*Non-nil means automatically newline before/after braces, after semicolons. If you do not want a leading newline before opening braces then use: \(define-key inform-mode-map \"{\" 'inform-electric-semi\)" :type 'boolean :group 'inform-mode) (defvar inform-mode-map nil "Keymap for Inform mode.") (if inform-mode-map nil (let ((map (make-sparse-keymap "Inform"))) (setq inform-mode-map (make-sparse-keymap)) (define-key inform-mode-map "\C-m" 'newline-and-indent) (define-key inform-mode-map "\177" 'backward-delete-char-untabify) (define-key inform-mode-map "\C-c\C-r" 'inform-retagify) (define-key inform-mode-map "\C-c\C-t" 'visit-tags-table) (define-key inform-mode-map "\C-c\C-b" 'inform-build-project) (define-key inform-mode-map "\C-c\C-c" 'inform-run-project) (define-key inform-mode-map "\C-c\C-a" 'inform-toggle-auto-newline) (define-key inform-mode-map "\C-c\C-s" 'inform-spell-check-buffer) (define-key inform-mode-map "\M-n" 'inform-next-object) (define-key inform-mode-map "\M-p" 'inform-prev-object) (define-key inform-mode-map "{" 'inform-electric-brace) (define-key inform-mode-map "}" 'inform-electric-brace) (define-key inform-mode-map "]" 'inform-electric-brace) (define-key inform-mode-map ";" 'inform-electric-semi) (define-key inform-mode-map ":" 'inform-electric-key) (define-key inform-mode-map "!" 'inform-electric-key) (define-key inform-mode-map "," 'inform-electric-comma) (define-key inform-mode-map [menu-bar] (make-sparse-keymap)) (define-key inform-mode-map [menu-bar inform] (cons "Inform" map)) (define-key map [separator4] '("--" . nil)) (define-key map [inform-spell-check-buffer] '("Spellcheck buffer" . inform-spell-check-buffer)) (define-key map [ispell-region] '("Spellcheck region" . ispell-region)) (define-key map [ispell-word] '("Spellcheck word" . ispell-word)) (define-key map [separator3] '("--" . nil)) (define-key map [load-tags] '("Load tags table" . visit-tags-table)) (define-key map [retagify] '("Rebuild tags table" . inform-retagify)) (define-key map [build] '("Build project" . inform-build-project)) (define-key map [run] '("Run project" . inform-run-project)) (define-key map [separator2] '("--" . nil)) (define-key map [next-object] '("Next object" . inform-next-object)) (define-key map [prev-object] '("Previous object" . inform-prev-object)) (define-key map [separator1] '("--" . nil)) (define-key map [comment-region] '("Comment Out Region" . comment-region)) (put 'comment-region 'menu-enable 'mark-active) (define-key map [indent-region] '("Indent Region" . indent-region)) (put 'indent-region 'menu-enable 'mark-active) (define-key map [indent-line] '("Indent Line" . indent-for-tab-command)))) (defvar inform-mode-abbrev-table nil "Abbrev table used while in Inform mode.") (define-abbrev-table 'inform-mode-abbrev-table nil) ;;; ;;; Indentation parameters ;;; (defcustom inform-indent-property 8 "*Indentation of the start of a property declaration." :type 'integer :group 'inform-mode-indent) (put 'inform-indent-property 'safe-local-variable 'integerp) (defcustom inform-indent-has-with-class 1 "*Indentation of has/with/class lines in object declarations." :type 'integer :group 'inform-mode-indent) (put 'inform-indent-has-with-class 'safe-local-variable 'integerp) (defcustom inform-indent-level 4 "*Indentation of lines of block relative to first line of block." :type 'integer :group 'inform-mode-indent) (put 'inform-indent-level 'safe-local-variable 'integerp) (defcustom inform-indent-label-offset -3 "*Indentation of label relative to where it should be." :type 'integer :group 'inform-mode-indent) (put 'inform-indent-label-offset 'safe-local-variable 'integerp) (defcustom inform-indent-cont-statement 4 "*Indentation of continuation relative to start of statement." :type 'integer :group 'inform-mode-indent) (put 'inform-indent-cont-statement 'safe-local-variable 'integerp) (defcustom inform-indent-fixup-space t "*If non-NIL, fix up space in object declarations." :type 'boolean :group 'inform-mode-indent) (put 'inform-indent-fixup-space 'safe-local-variable 'booleanp) (defcustom inform-indent-action-column 40 "*Column at which action names should be placed in verb declarations." :type 'integer :group 'inform-mode-indent) (put 'inform-indent-action-column 'safe-local-variable 'integerp) (defcustom inform-comments-line-up-p nil "*If non-nil, comments spread over several lines will line up with the first." :type 'boolean :group 'inform-mode-indent) (put 'inform-comments-line-up-p 'safe-local-variable 'booleanp) (defcustom inform-strings-line-up-p nil "*Variable controlling indentation of multi-line strings. If nil (default), string will be indented according to context. If a number, will always set the indentation to that column. If 'char', will line up with the first character of the string. If 'quote', or other non-nil value, will line up with open quote on first line." :type '(radio (const :tag "Indent according to context" nil) (integer :tag "Column to indent to") (const :tag "Line up with first character of string" char) (const :tag "Line up with open quote on first line" quote)) :group 'inform-mode-indent) (put 'inform-strings-line-up-p 'safe-local-variable 'sexp) (defcustom inform-indent-semicolon t "*If nil, a semicolon on a line of its own will not be indented." :type 'boolean :group 'inform-mode-indent) (put 'inform-indent-semicolon 'safe-local-variable 'booleanp) ;;; ;;; Syntax variables ;;; (defvar inform-mode-syntax-table nil "Syntax table to use in Inform mode buffers.") (if inform-mode-syntax-table nil (setq inform-mode-syntax-table (make-syntax-table)) (modify-syntax-entry ?\\ "\\" inform-mode-syntax-table) (modify-syntax-entry ?\n ">" inform-mode-syntax-table) (modify-syntax-entry ?! "<" inform-mode-syntax-table) (modify-syntax-entry ?# "_" inform-mode-syntax-table) (modify-syntax-entry ?% "." inform-mode-syntax-table) (modify-syntax-entry ?& "." inform-mode-syntax-table) (modify-syntax-entry ?\' "." inform-mode-syntax-table) (modify-syntax-entry ?* "." inform-mode-syntax-table) (modify-syntax-entry ?- "." inform-mode-syntax-table) (modify-syntax-entry ?/ "." inform-mode-syntax-table) (modify-syntax-entry ?\; "." inform-mode-syntax-table) (modify-syntax-entry ?< "." inform-mode-syntax-table) (modify-syntax-entry ?= "." inform-mode-syntax-table) (modify-syntax-entry ?> "." inform-mode-syntax-table) (modify-syntax-entry ?+ "." inform-mode-syntax-table) (modify-syntax-entry ?| "." inform-mode-syntax-table) (modify-syntax-entry ?^ "w" inform-mode-syntax-table)) ;;; ;;; Build and run variables ;;; (defcustom inform-project-file nil "*The top level Inform project file to which the current file belongs." :type '(radio (file :tag "Project file name") (const :tag "Disabled" nil)) :group 'inform-mode-build-run) (make-variable-buffer-local 'inform-project-file) (defcustom inform-autoload-tags t "*Non-nil means automatically load tags table when entering Inform mode." :type 'boolean :group 'inform-mode-build-run) (defcustom inform-etags-program "etags" "*The shell command with which to run the etags program." :type 'string :group 'inform-mode-build-run) (defcustom inform-command "inform" "*The shell command with which to run the Inform compiler." :type 'string :group 'inform-mode-build-run) (defcustom inform-libraries-directory nil "*If non-NIL, gives the directory in which libraries are found." :type '(radio (directory :tag "Library directory") (const :tag "Disabled" nil)) :group 'inform-mode-build-run) (defcustom inform-command-options "" "*Options with which to call the Inform compiler." :type 'string :group 'inform-mode-build-run) (defcustom inform-interpreter-command "frotz" "*The command with which to run the ZCode interpreter. If a string, the name of a command. If a symbol or a function value, an Emacs-lisp function to be called with the name of the story file." :type '(choice (string :tag "Command to run the ZCode interpreter") (function :tag "Emacs-lisp function to run on the file")) :group 'inform-mode-build-run) (defcustom inform-interpreter-options "" "*Additional options with which to call the ZCode interpreter. Only used if `inform-interpreter-command' is a string." :type 'string :group 'inform-mode-build-run) (defcustom inform-interpreter-kill-old-process t "*Whether to kill the old interpreter process when starting a new one." :type 'boolean :group 'inform-mode-build-run) (defcustom inform-interpreter-is-graphical nil "*Controls whether `inform-interpreter-command' will be run in a buffer. If NIL, `inform-run-project' will switch to the interpreter buffer after running the interpreter." :type 'boolean :group 'inform-mode-build-run) (defvar inform-compilation-error-regexp-alist '((inform-e1 "^[ \t]*\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\ \\(?:\\(Error\\)\\|\\(Warning\\)\\):" 1 2 nil (4))) "Alist matching compilation errors for inform -E1 style output.") ;;; Keyword definitions------------------------------------------------------- ;; These are used for syntax and font-lock purposes. ;; They combine words used in Inform 5 and Inform 6 for full compatibility. ;; You can add new keywords directly to this list as the regexps for ;; font-locking are defined when this file is byte-compiled or eval'd. (eval-and-compile (defvar inform-directive-list '("abbreviate" "array" "attribute" "btrace" "class" "constant" "default" "dictionary" "end" "endif" "etrace" "extend" "fake_action" "global" "ifdef" "iffalse" "ifndef" "ifnot" "iftrue" "ifv3" "ifv5" "import" "include" "link" "listsymbols" "listdict" "listverbs" "lowstring" "ltrace" "message" "nearby" "nobtrace" "noetrace" "noltrace" "notrace" "object" "property" "release" "replace" "serial" "statusline" "stub" "switches" "system_file" "trace" "verb" "version" "zcharacter") "List of Inform directives that shouldn't appear embedded in code.") (defvar inform-defining-list '("[" "array" "attribute" "class" "constant" "fake_action" "global" "lowstring" "nearby" "object" "property") "List of Inform directives that define a variable/constant name. Used to build a font-lock regexp; the name defined must follow the keyword.") (defvar inform-attribute-list '("absent" "animate" "clothing" "concealed" "container" "door" "edible" "enterable" "female" "general" "light" "lockable" "locked" "male" "moved" "neuter" "on" "open" "openable" "pluralname" "proper" "scenery" "scored" "static" "supporter" "switchable" "talkable" "transparent" "visited" "workflag" "worn") "List of Inform attributes defined in the library.") (defvar inform-property-list '("n_to" "s_to" "e_to" "w_to" "ne_to" "se_to" "nw_to" "sw_to" "u_to" "d_to" "in_to" "out_to" "add_to_scope" "after" "article" "articles" "before" "cant_go" "capacity" "daemon" "describe" "description" "door_dir" "door_to" "each_turn" "found_in" "grammar" "initial" "inside_description" "invent" "life" "list_together" "name" "number" "orders" "parse_name" "plural" "react_after" "react_before" "short_name" "short_name_indef" "time_left" "time_out" "when_closed" "when_open" "when_on" "when_off" "with_key") "List of Inform properties defined in the library.") (defvar inform-code-keyword-list '("box" "break" "continue" "do" "else" "font off" "font on" "for" "give" "has" "hasnt" "if" "in" "inversion" "jump" "move" "new_line" "notin" "objectloop" "ofclass" "or" "print" "print_ret" "provides" "quit" "read" "remove" "restore" "return" "rfalse" "rtrue" "save" "spaces" "string" "style bold" "style fixed" "style reverse" "style roman" "style underline" "switch" "to" "until" "while") "List of Inform code keywords.") ) ;; Some regular expressions are needed at compile-time too so as to ;; avoid postponing the work to load time. ;; To do the work of building the regexps we use regexp-opt with the ;; paren option which ensures the result is enclosed by a grouping ;; construct. (eval-and-compile (defun inform-make-regexp (strings) (regexp-opt strings t))) (eval-and-compile (defvar inform-directive-regexp (concat "\\<#?\\(" (inform-make-regexp inform-directive-list) "\\)\\>") "Regular expression matching an Inform directive.") (defvar inform-defining-list-regexp (inform-make-regexp inform-defining-list)) (defvar inform-object-regexp "#?\\<\\(object\\|nearby\\|class\\)\\>" "Regular expression matching start of object declaration.") (defvar inform-property-regexp (concat "\\s-*\\(" (inform-make-regexp inform-property-list) "\\)") "Regular expression matching Inform properties.")) (defvar inform-real-object-regexp (eval-when-compile (concat "^" inform-object-regexp)) "Regular expression matching the start of a real object declaration. That is, one found at the start of a line.") (defvar inform-label-regexp "[^]:\"!\(\n]+\\(:\\|,\\)" "Regular expression matching a label.") (defvar inform-action-regexp "\\s-*\\*" "Regular expression matching an action line in a verb declaration.") (defvar inform-statement-terminators '(?\; ?{ ?} ?: ?\) do else) "Tokens which precede the beginning of a statement.") ;;; ;;; Font-lock keywords ;;; (defvar inform-font-lock-defaults '(inform-font-lock-keywords nil t ((?_ . "w") (?' . "$")) inform-prev-object) "Font Lock defaults for Inform mode.") (defface inform-dictionary-word-face '((((class color) (background light)) (:foreground "Red")) (((class color) (background dark)) (:foreground "Pink")) (t (:italic t :bold t))) "Font lock mode face used to highlight dictionary words." :group 'inform-mode) (defvar inform-dictionary-word-face 'inform-dictionary-word-face "Variable for Font lock mode face used to highlight dictionary words.") (defvar inform-font-lock-keywords (eval-when-compile (list ;; Inform code keywords ;; Handles two keywords in a row, eg 'else return' (cons (concat "\\b" (inform-make-regexp inform-code-keyword-list) "\\b") 'font-lock-keyword-face) ;; Keywords that declare variable or constant names. (list (concat "^#?" inform-defining-list-regexp "\\s-+\\(->\\s-+\\)*\\(\\(\\w\\|\\s_\\)+\\)") '(1 font-lock-keyword-face) '(3 font-lock-function-name-face)) ;; Other directives. (cons inform-directive-regexp 'font-lock-keyword-face) ;; Single quoted strings, length > 1, are dictionary words '("'\\(\\(-\\|\\w\\)\\(\\(-\\|\\w\\)+\\(//\\w*\\)?\\|//\\w*\\)\\)'" (1 inform-dictionary-word-face append)) ;; Double-quoted dictionary words '("\\(\\s-name\\s-\\|^Verb\\|^Extend\\|^\\s-+\\*\\)" ("\"\\(\\(-\\|\\w\\)+\\)\"" nil nil (1 inform-dictionary-word-face t))) ;; More double-quoted dictionary words '("^\\s-+\"\\(\\(-\\|\\w\\)+\\)\"\\s-+\"\\(\\(-\\|\\w\\)+\\)\"" (1 inform-dictionary-word-face t) (3 inform-dictionary-word-face t) ("\"\\(\\(-\\|\\w\\)+\\)\"" nil nil (1 inform-dictionary-word-face t))) ;; `private', `class', `has' and `with' in objects. '("^\\s-+\\(private\\|class\\|has\\|with\\)\\(\\s-\\|$\\)" (1 font-lock-keyword-face)) ;; Attributes and properties. (cons (concat "[^#]\\<\\(" (inform-make-regexp (append inform-attribute-list inform-property-list)) "\\)\\>") '(1 font-lock-variable-name-face)))) "Expressions to fontify in Inform mode.") ;;; ;;; Inform mode ;;; ;;;###autoload (defun inform-mode () "Major mode for editing Inform programs. * Inform syntax: Type \\[indent-for-tab-command] to indent the current line. Type \\[indent-region] to indent the region. Type \\[fill-paragraph] to fill strings or comments. This compresses multiple spaces into single spaces. * Multi-file projects: The variable `inform-project-file' gives the name of the root file of the project \(i.e., the one that you run Inform on\)\; it is best to set this as a local variable in each file, for example by making ! -*- inform-project-file:\"game.inf\" -*- the first line of the file. * Tags tables: Type \\[inform-retagify] to build \(and load\) a Tags table. Type \\[visit-tags-table] to load an existing Tags table. If it exists, and if the variable `inform-autoload-tags' is non-NIL, the Tags table is loaded on entry to Inform Mode. With a Tags table loaded, type \\[find-tag] to find the declaration of the object, class or function under point. * Navigating in a file: Type \\[inform-prev-object] to go to the previous object/class declaration. Type \\[inform-next-object] to go to the next one. * Compilation: Type \\[inform-build-project] to build the current project. Type \\[next-error] to go to the next error. * Running: Type \\[inform-run-project] to run the current project in an interpreter, either as a separate process or in an Emacs terminal buffer. * Spell checking: Type \\[inform-spell-check-buffer] to spell check all strings in the buffer. Type \\[ispell-word] to check the single word at point. * Key definitions: \\{inform-mode-map} * Functions: inform-maybe-mode Looks at the contents of a file, guesses whether it is an Inform program, runs `inform-mode' if so, or `inform-maybe-other' if not. The latter defaults to `c-mode'. Used for header files which might be Inform or C programs. * Miscellaneous user options: inform-startup-message Set to nil to inhibit message first time Inform mode is used. inform-maybe-other The mode used by `inform-maybe-mode' if it guesses that the file is not an Inform program. inform-mode-hook This hook is run after entry to Inform Mode. inform-autoload-tags If non-nil, then a tags table will automatically be loaded when entering Inform mode. inform-auto-newline If non-nil, then newlines are automatically inserted before and after braces, and after semicolons in Inform code, and after commas in object declarations. * User options controlling indentation style: Values in parentheses are the default indentation style. inform-indent-property \(8\) Indentation of a property or attribute in an object declaration. inform-indent-has-with-class \(1\) Indentation of has/with/class/private lines in object declaration. inform-indent-level \(4\) Indentation of line of code in a block relative to the first line of the block. inform-indent-label-offset \(-3\) Indentation of a line starting with a label, relative to the indentation if the label were absent. inform-indent-cont-statement \(4\) Indentation of second and subsequent lines of a statement, relative to the first. inform-indent-fixup-space \(T\) If non-NIL, fix up space after `Object', `Class', `Nearby', `has', `private' and `with', so that all the object's properties line up. inform-indent-action-column \(40\) Column at which action names should be placed in verb declarations. If NIL, then action names are not moved. inform-comments-line-up-p \(NIL\) If non-NIL, comments spread out over several lines will start on the same column as the first comment line. inform-strings-line-up-p \(NIL\) Variable controlling indentation of multi-line strings. If nil (default), string will be indented according to context. If a number, will always set the indentation to that column. If 'char', will line up with the first character of the string. If 'quote', or other non-nil value, will line up with open quote on first line. * User options to do with compilation: inform-command The shell command with which to run the Inform compiler. inform-libraries-directory If non-NIL, gives the directory in which the Inform libraries are found. inform-command-options Additional options with which to call the Inform compiler. * User options to do with an interpreter: inform-interpreter-command The command with which to run the ZCode interpreter. Can be a string (a command to be run), a symbol (name of function to call) or a function. inform-interpreter-options Additional options with which to call the ZCode interpreter. Only used if `inform-interpreter-command' is a string. inform-interpreter-kill-old-process If non-NIL, `inform-run-project' will kill any running interpreter process and start a new one. If not, will switch to the interpreter's buffer (if necessary - see documentation for `inform-run-project' for details). inform-interpreter-is-graphical If NIL, `inform-run-project' will switch to the interpreter buffer after running the interpreter. * Please send any bugs or comments to rupert@rupert-lane.org" (interactive) (if inform-startup-message (message "Emacs Inform mode version %s." inform-mode-version)) (kill-all-local-variables) (use-local-map inform-mode-map) (set-syntax-table inform-mode-syntax-table) (make-local-variable 'comment-column) (make-local-variable 'comment-end) (make-local-variable 'comment-indent-function) (make-local-variable 'comment-start) (make-local-variable 'comment-start-skip) (make-local-variable 'fill-paragraph-function) (make-local-variable 'font-lock-defaults) (make-local-variable 'imenu-extract-index-name-function) (make-local-variable 'imenu-prev-index-position-function) (make-local-variable 'indent-line-function) (make-local-variable 'indent-region-function) (make-local-variable 'parse-sexp-ignore-comments) (make-local-variable 'require-final-newline) (setq comment-column 40 comment-end "" comment-indent-function 'inform-comment-indent comment-start "!" comment-start-skip "!+\\s-*" fill-paragraph-function 'inform-fill-paragraph font-lock-defaults inform-font-lock-defaults imenu-extract-index-name-function 'inform-imenu-extract-name imenu-prev-index-position-function 'inform-prev-object indent-line-function 'inform-indent-line indent-region-function 'inform-indent-region local-abbrev-table inform-mode-abbrev-table major-mode 'inform-mode mode-name "Inform" parse-sexp-ignore-comments t require-final-newline t) (auto-fill-mode 1) (if inform-autoload-tags (inform-auto-load-tags-table)) (run-hooks 'inform-mode-hook)) ;;;###autoload (defun inform-maybe-mode () "Start Inform mode if file is in Inform; `inform-maybe-other' otherwise." (let ((case-fold-search t)) (if (save-excursion (re-search-forward "^\\(!\\|object\\|nearby\\|\\[ \\)" nil t)) (inform-mode) (funcall inform-maybe-other)))) ;;; ;;; Syntax and indentation ;;; (defun inform-beginning-of-defun () "Go to the start of the current Inform definition. Just goes to the most recent line with a function beginning [, or a directive." (let ((case-fold-search t)) (catch 'found (end-of-line 1) (while (re-search-backward "\n[[a-z]" nil 'move) (forward-char 1) (if (or (and (looking-at "\\[") (eq (inform-preceding-char) ?\;)) (looking-at inform-directive-regexp)) (throw 'found nil)) (forward-char -1))))) (defun inform-preceding-char () "Return preceding non-blank, non-comment character in buffer. It is assumed that point is not inside a string or comment." (save-excursion (while (/= (point) (progn (forward-comment -1) (point)))) (skip-syntax-backward " ") (if (bobp) ?\; (preceding-char)))) (defun inform-preceding-token () "Return preceding non-blank, non-comment token in buffer. Either the character itself, or the tokens 'do or 'else. It is assumed that point is not inside a string or comment." (save-excursion (while (/= (point) (progn (forward-comment -1) (point)))) (skip-syntax-backward " ") (if (bobp) ?\; (let ((p (preceding-char))) (cond ((and (eq p ?o) (>= (- (point) 2) (point-min))) (goto-char (- (point) 2)) (if (looking-at "\\= (- (point) 4) (point-min))) (goto-char (- (point) 4)) (if (looking-at "\\ (car state) 0) (nth 3 state) (nth 4 state)) (nth 1 data)) ((nth 1 data) (/= (inform-preceding-char) ?\;)) (t (looking-at inform-object-regexp))))) (t (inform-beginning-of-defun) (setq in-obj (looking-at inform-object-regexp) state (parse-partial-sexp (point) line-start))))) (list (if (> (car state) 0) ;; If there's a containing sexp then it's easy. (cond ((nth 3 state) 'string) ((nth 4 state) 'comment) ((looking-at (concat "\\s-*" comment-start)) 'comment) ((looking-at inform-label-regexp) 'label) (t 'code)) ;; Otherwise there are a bunch of special cases (has, with, class, ;; and private properties) that must be checked for. Note that ;; we have to distinguish between global class declarations and ;; class membership in an object declaration. This is done by ;; looking for a preceding semicolon. (cond ((nth 3 state) 'string) ((nth 4 state) 'comment) ((looking-at (concat "\\s-*" comment-start)) 'comment) ((and in-obj (looking-at "\\s-*class\\>") (/= (inform-preceding-char) ?\;)) 'class) ((looking-at inform-action-regexp) 'action) ((looking-at inform-directive-regexp) 'directive) ((and (looking-at "\\[") (eq (inform-preceding-char) ?\;)) 'directive) ((and (not in-obj) (eq (inform-preceding-char) ?\;)) 'directive) ((looking-at "\\s-*$") 'blank) ((not in-obj) 'other) ((looking-at "\\s-*has\\(\\s-\\|$\\)") 'has) ((looking-at "\\s-*with\\(\\s-\\|$\\)") 'with) ((looking-at "\\s-*private\\(\\s-\\|$\\)") 'private) ((or (eq (inform-preceding-char) ?,) (looking-at inform-property-regexp)) 'property) ;; This handles declarations of objects in a class eg ;; Bird "swallow"; ;; It assumes that class names follow the convention of being ;; capitalised. This is not the most elegant way of handling ;; this case but in practice works well. ((looking-at "\\s-*[A-Z]") 'directive) (t 'other))) ;; Are we in an object? (if (and in-obj (not (looking-at inform-object-regexp)) (zerop (car state)) (eq (inform-preceding-char) ?\;)) nil in-obj) ;; List of known enclosing sexps. (let ((sexps (nth 2 data)) ; the old list of sexps (depth (car state)) ; current nesting depth (sexp-start (nth 1 state))) ; enclosing sexp, if any (if sexps ;; Strip away closed sexps. (let ((sexp-depth (car (car sexps)))) (while (and sexps (or (> sexp-depth depth) (and (eq sexp-depth depth) sexp-start))) (setq sexps (cdr sexps) sexp-depth (if sexps (car (car sexps))))))) (if sexp-start (setq sexps (cons (cons depth sexp-start) sexps))) sexps) ;; State from the parse algorithm. state))) (defun inform-calculate-indentation (data) "Return the correct indentation for the line at point. DATA is the syntax class for the start of the line (as returned by `inform-syntax-class'). It is assumed that point is somewhere in the indentation for the current line (i.e., everything to the left is whitespace)." (let ((syntax (car data)) ; syntax class of start of line (in-obj (nth 1 data)) ; inside an object? (depth (car (nth 3 data))) ; depth of nesting of start of line (case-fold-search t)) ; searches are case-insensitive (cond ;; Directives should never be indented or else the directive- ;; finding code won't run fast enough. Hence the magic ;; constant 0. ((eq syntax 'directive) 0) ((eq syntax 'blank) 0) ;; Semicolons on a line of their own will be indented per the ;; current syntax unless user variable inform-indent-semicolon is ;; nil. ((and (looking-at "\\s-*;$") (not inform-indent-semicolon)) 0) ;; Various standard indentations. ((eq syntax 'property) inform-indent-property) ((eq syntax 'other) (cond ((looking-at "\\s-*\\[") inform-indent-property) (in-obj (+ inform-indent-property inform-indent-level)) (t inform-indent-level))) ((and (eq syntax 'string) (zerop depth)) (cond (in-obj (+ inform-indent-property inform-indent-level)) (t inform-indent-level))) ((and (eq syntax 'comment) (zerop depth)) (inform-line-up-comment (if in-obj inform-indent-property 0))) ((eq syntax 'action) inform-indent-level) ((memq syntax '(has with class private)) inform-indent-has-with-class) ;; We are inside a sexp of some sort. (t (let ((indent 0) ; calculated indent column paren ; where the enclosing sexp begins string-start ; where string (if any) starts (string-indent 0) ; indentation for the current str cont-p ; true if line is a continuation paren-char ; the parenthesis character prec-token ; token preceding line this-char) ; character under consideration (save-excursion ;; Skip back to the start of a string, if any. (Note that ;; we can't be in a comment since the syntax class applies ;; to the start of the line.) (if (eq syntax 'string) (progn (skip-syntax-backward "^\"") (forward-char -1) (setq string-start (point)) (setq string-indent (current-column)) )) ;; Now find the start of the sexp containing point. Most ;; likely, the location was found by `inform-syntax-class'; ;; if not, call `up-list' now and save the result in case ;; it's useful in future. (save-excursion (let ((sexps (nth 2 data))) (if (and sexps (eq (car (car sexps)) depth)) (goto-char (cdr (car sexps))) (up-list -1) (setcar (nthcdr 2 data) (cons (cons depth (point)) (nth 2 data))))) (setq paren (point) paren-char (following-char))) ;; If we were in a string, now skip back to the start of the ;; line. We have to do this *after* calling `up-list' just ;; in case there was an opening parenthesis on the line ;; including the start of the string. (if (eq syntax 'string) (forward-line 0)) ;; The indentation depends on what kind of sexp we are in. ;; If line is in parentheses, indent to opening parenthesis. (if (eq paren-char ?\() (setq indent (progn (goto-char paren) (1+ (current-column)))) ;; Line not in parentheses. (setq prec-token (inform-preceding-token) this-char (following-char)) (cond ;; Each 'else' should have the same indentation as the ;; matching 'if' ((looking-at "\\s-*else") ;; Find the matching 'if' by counting 'if's and 'else's ;; in this sexp (let ((if-count 0) found) (while (and (not found) (progn (forward-sexp -1) t) ; skip over sub-sexps (re-search-backward "\\s-*\\(else\\|if\\)" paren t)) (setq if-count (+ if-count (if (string= (match-string 1) "else") -1 1))) (if (eq if-count 1) (setq found t))) (if (not found) (setq indent 0) (forward-line 0) (skip-syntax-forward " ") (setq indent (current-column))))) ;; Line is an inlined directive-- always put on column 0 ((looking-at "\\s-*#[^#]") (setq indent 0)) ;; Line is in an implicit block: take indentation from ;; the line that introduces the block, plus one level. ((memq prec-token '(?\) do else)) (forward-sexp -1) (forward-line 0) (skip-syntax-forward " ") (setq indent (+ (current-column) (if (eq this-char ?{) 0 inform-indent-level)))) ;; Line is a continued statement. ((not (or (memq prec-token inform-statement-terminators) (eq syntax 'label))) (setq cont-p t) (forward-line -1) (let ((token (inform-preceding-token))) ;; Is it the first continuation line? (if (memq token inform-statement-terminators) (setq indent inform-indent-cont-statement))) (skip-syntax-forward " ") (setq indent (+ indent (current-column)))) ;; Line is in a function, take indentation from start of ;; function, ignoring `with'. ((eq paren-char ?\[) (goto-char paren) (forward-line 0) (looking-at "\\(\\s-*with\\s-\\)?\\s-*") (goto-char (match-end 0)) (setq indent (+ (current-column) (if (eq this-char ?\]) 0 inform-indent-level)))) ;; Line is in a block: take indentation from block. (t (goto-char paren) (if (eq (inform-preceding-char) ?\)) (forward-sexp -1)) (forward-line 0) (skip-syntax-forward " ") (setq indent (+ (current-column) (if (memq this-char '(?} ?{)) 0 inform-indent-level))) )) ;; We calculated the indentation for the start of the ;; string; correct this for the remainder of the string if ;; appropriate. (cond ((eq syntax 'string) ;; do conditional line-up (cond ((numberp inform-strings-line-up-p) (setq indent inform-strings-line-up-p)) ((eq inform-strings-line-up-p 'char) (setq indent (1+ string-indent))) (inform-strings-line-up-p (setq indent string-indent)) ((not cont-p) (goto-char string-start) (let ((token (inform-preceding-token))) (if (not (memq token inform-statement-terminators)) (setq indent (+ indent inform-indent-cont-statement))))))) ;; Indent for label, if any. ((eq syntax 'label) (setq indent (+ indent inform-indent-label-offset)))))) ;; Handle comments specially if told to line them up (if (looking-at (concat "\\s-*" comment-start)) (setq indent (inform-line-up-comment indent))) indent))))) (defun inform-line-up-comment (current-indent) "Return the indentation to line up this comment with the previous one. If `inform-comments-line-up-p' is nil, or the preceding lines do not contain comments, return CURRENT-INDENT." (if inform-comments-line-up-p (save-excursion (let ((indent current-indent) done limit) (while (and (not done) (> (point) 1)) (forward-line -1) (setq limit (point)) (cond ((looking-at (concat "\\s-*" comment-start)) ;; a full-line comment, keep searching nil) ((and (or (end-of-line) t) (re-search-backward comment-start limit t) (eq (car (inform-syntax-class)) 'comment)) ;; a line with a comment char at the end ;; that is not part of the code (setq indent (current-column)) (setq done t)) (t ;; a non-comment line so we do not need to change (setq done t)))) indent)) current-indent)) (defun inform-indent-to (column) "Indent to COLUMN. Modifies whitespace to the left of point so that the character after point is at COLUMN. If this is impossible, one whitespace character is left. Avoids changing buffer gratuitously, and returns non-NIL if it actually changed the buffer. If a change is made, point is moved to the end of any inserted or deleted whitespace. (If not, it may be moved at random.)" (let ((col (current-column))) (cond ((eq col column) nil) ((< col column) (indent-to column) t) (t (let ((p (point)) (mincol (progn (skip-syntax-backward " ") (current-column)))) (if (eq mincol (1- col)) nil (delete-region (point) p) (indent-to (max (if (bolp) mincol (1+ mincol)) column)) t)))))) (defun inform-do-indent-line (data) "Indent the line containing point. DATA is assumed to have been returned from `inform-syntax-class', called at the *start* of the current line. It is assumed that point is at the start of the line. Fixes up the spacing on `has', `with', `object', `nearby', `private' and `class' lines. Returns T if a change was made, NIL otherwise. Moves point." (skip-syntax-forward " ") (let ((changed-p (inform-indent-to (inform-calculate-indentation data))) (syntax (car data))) ;; Fix up space if appropriate, return changed flag. (or (cond ((and (memq syntax '(directive has with class private)) inform-indent-fixup-space (looking-at "\\(object\\|class\\|nearby\\|has\\|with\\|private\\)\\(\\s-+\\|$\\)")) (goto-char (match-end 0)) (inform-indent-to inform-indent-property)) ((and (eq syntax 'action) inform-indent-action-column (or (looking-at "\\*.*\\(->\\)") (looking-at "\\*.*\\($\\)"))) (goto-char (match-beginning 1)) (inform-indent-to inform-indent-action-column)) (t nil)) changed-p))) (defun inform-comment-indent () "Calculate and return the indentation for a comment. Assume point is on the comment." (skip-syntax-backward " ") (if (bolp) (inform-calculate-indentation (inform-syntax-class)) (max (1+ (current-column)) comment-column))) (defun inform-indent-line () "Indent line containing point. Keep point at the 'logically' same place, unless point was before new indentation, in which case place point at indentation." (let ((oldpos (- (point-max) (point)))) (forward-line 0) (inform-do-indent-line (inform-syntax-class)) (and (< oldpos (- (point-max) (point))) (goto-char (- (point-max) oldpos))))) (defun inform-indent-region (start end) "Indent all the lines in region defined by START/END." (save-restriction (let ((endline (progn (goto-char (max end start)) (or (bolp) (end-of-line)) (point))) data linestart) (narrow-to-region (point-min) endline) (goto-char (min start end)) (forward-line 0) (while (not (eobp)) (setq data (if data (inform-syntax-class linestart data) (inform-syntax-class)) linestart (point)) (inform-do-indent-line data) (forward-line 1))))) ;;; ;;; Filling paragraphs ;;; (defun inform-fill-paragraph (&optional arg) "Fill quoted string or comment containing point. To fill a quoted string, point must be between the quotes. Deals appropriately with trailing backslashes. ARG is ignored." (let* ((data (inform-syntax-class)) (syntax (car data)) (case-fold-search t)) (cond ((eq syntax 'comment) (if (save-excursion (forward-line 0) (looking-at "\\s-*!+\\s-*")) (let ((fill-prefix (match-string 0))) (fill-paragraph nil) t) (error "Can't fill comments not at start of line"))) ((eq syntax 'string) (save-excursion (let* ((indent-col (prog2 (insert ?\n) (inform-calculate-indentation data) (delete-char -1))) (start (search-backward "\"")) (end (search-forward "\"" nil nil 2)) (fill-column (- fill-column 2)) linebeg) (save-restriction (narrow-to-region (point-min) end) ;; Fold all the lines together, removing backslashes ;; and multiple spaces as we go. (subst-char-in-region start end ?\n ? ) (subst-char-in-region start end ?\\ ? ) (subst-char-in-region start end ?\t ? ) (goto-char start) (while (re-search-forward " +" end t) (delete-region (match-beginning 0) (1- (match-end 0)))) ;; Split this line; reindent after first split, ;; otherwise indent to point where first split ended ;; up. (goto-char start) (setq linebeg start) (while (not (eobp)) (move-to-column (1+ fill-column)) (if (eobp) nil (skip-chars-backward "^ " linebeg) (if (eq (point) linebeg) (progn (skip-chars-forward "^ ") (skip-chars-forward " "))) (insert "\n") (indent-to-column indent-col 1) (setq linebeg (point)))))) ;; Return T so that `fill-paragaph' doesn't try anything. t)) (t (error "Point is neither in a comment nor a string"))))) ;;; ;;; Tags ;;; (defun inform-project-file () "Return the project file to which the current file belongs. This is either the value of variable `inform-project-file' or the current file." (or inform-project-file (buffer-file-name))) (defun inform-project-file-list () "Builds a list of files in the current project and return it. It recursively searches through included files, but tries to avoid loops." (let* ((project-file (expand-file-name (inform-project-file))) (project-dir (file-name-directory project-file)) (in-file-list (list project-file)) out-file-list (temp-buffer (generate-new-buffer "*Inform temp*"))) (message "Building list of files in project...") (save-excursion (while in-file-list (if (member (car in-file-list) out-file-list) nil (set-buffer temp-buffer) (erase-buffer) (insert-file-contents (car in-file-list)) (setq out-file-list (cons (car in-file-list) out-file-list) in-file-list (cdr in-file-list)) (goto-char (point-min)) (while (re-search-forward "\\<#?include\\s-+\">\\([^\"]+\\)\"" nil t) (let ((file (match-string 1))) ;; We need to duplicate Inform's file-finding algorithm: (if (not (string-match "\\." file)) (setq file (concat file ".inf"))) (if (not (file-name-absolute-p file)) (setq file (expand-file-name file project-dir))) (setq in-file-list (cons file in-file-list)))))) (kill-buffer nil)) (message "Building list of files in project...done") out-file-list)) (defun inform-auto-load-tags-table () "Visit tags table for current project, if it exists. Do nothing if there is no current project, or no tags table." (let (tf (project (inform-project-file))) (if project (progn (setq tf (expand-file-name "TAGS" (file-name-directory project))) (if (file-readable-p tf) ;; visit-tags-table seems to just take first parameter in XEmacs (visit-tags-table tf)))))) (defun inform-retagify () "Create a tags table for the files in the current project. The current project contains all the files included using Inform's `Include \">file\";' syntax by the project file, which is that given by the variable `inform-project-file' \(if this is set\), or the current file \(if not\). Files included recursively are included in the tags table." (interactive) (let* ((project-file (inform-project-file)) (project-dir (file-name-directory project-file)) (files (inform-project-file-list)) (tags-file (expand-file-name "TAGS" project-dir))) (message "Running external tags program...") ;; Uses call-process to work on windows/nt systems (not tested) ;; Regexp matches routines or object/class definitions (apply (function call-process) inform-etags-program nil nil nil "--regex=/\\([A-Za-z0-9_]+\\|\\[\\)\\([ \\t]*->\\)*[ \\t]*\\<\\([A-Za-z_][A-Za-z0-9_]*\\)/\\3/" (concat "--output=" tags-file) "--language=none" files) (message "Running external tags program...done") (inform-auto-load-tags-table))) ;;; ;;; Electric keys ;;; (defun inform-toggle-auto-newline (arg) "Toggle auto-newline feature. Optional numeric ARG, if supplied turns on auto-newline when positive, turns it off when negative, and just toggles it when zero." (interactive "P") (setq inform-auto-newline (if (or (not arg) (zerop (setq arg (prefix-numeric-value arg)))) (not inform-auto-newline) (> arg 0)))) (defun inform-electric-key (arg) "Insert the key typed (ARG) and correct indentation." (interactive "P") (if (and (not arg) (eolp)) (progn (self-insert-command 1) (inform-indent-line) (end-of-line)) (self-insert-command (prefix-numeric-value arg)))) (defun inform-electric-semi (arg) "Insert the key typed (ARG) and correct line's indentation, as for semicolon. Special handling does not occur inside strings and comments. Inserts newline after the character if `inform-auto-newline' is non-NIL." (interactive "P") (if (and (not arg) (eolp) (let ((data (inform-syntax-class))) (not (memq (car data) '(string comment))))) (progn (self-insert-command 1) (inform-indent-line) (end-of-line) (if inform-auto-newline (newline-and-indent))) (self-insert-command (prefix-numeric-value arg)))) (defun inform-electric-comma (arg) "Insert the key typed (ARG) and correct line's indentation, as for comma. Special handling only occurs in object declarations. Inserts newline after the character if `inform-auto-newline' is non-NIL." (interactive "P") (if (and (not arg) (eolp) (let ((data (inform-syntax-class))) (and (not (memq (car data) '(string comment))) (nth 1 data) (zerop (car (nth 3 data)))))) (progn (self-insert-command 1) (inform-indent-line) (end-of-line) (if inform-auto-newline (newline-and-indent))) (self-insert-command (prefix-numeric-value arg)))) (defun inform-electric-brace (arg) "Insert the key typed (ARG) and correct line's indentation. Insert newlines before and after if `inform-auto-newline' is non-NIL." ;; This logic is the same as electric-c-brace. (interactive "P") (let (insertpos) (if (and (not arg) (eolp) (let ((data (inform-syntax-class))) (memq (car data) '(code label))) (or (save-excursion (skip-syntax-backward " ") (bolp)) (if inform-auto-newline (progn (inform-indent-line) (newline) t) nil))) (progn (insert last-command-event) (inform-indent-line) (end-of-line) (if (and inform-auto-newline (/= last-command-event ?\])) (progn (newline) (setq insertpos (1- (point))) (inform-indent-line))) (save-excursion (if insertpos (goto-char insertpos)) (delete-char -1)))) (if insertpos (save-excursion (goto-char (1- insertpos)) (self-insert-command (prefix-numeric-value arg))) (self-insert-command (prefix-numeric-value arg))))) ;;; ;;; Miscellaneous ;;; (defun inform-next-object (&optional arg) "Go to the next object or class declaration in the file. With a prefix ARG, go forward that many declarations. With a negative prefix ARG, search backwards." (interactive "P") (let ((fun 're-search-forward) (n (prefix-numeric-value arg))) (cond ((< n 0) (setq fun 're-search-backward n (- n))) ((looking-at inform-real-object-regexp) (setq n (1+ n)))) (prog1 (funcall fun inform-real-object-regexp nil 'move n) (forward-line 0)))) ;; This function doubles as an `imenu-prev-name' function, so when ;; called noninteractively it must return T if it was successful and NIL ;; if not. Argument NIL must correspond to moving backwards by 1. (defun inform-prev-object (&optional arg) "Go to the previous object or class declaration in the file. With a prefix ARG, go back many declarations. With a negative prefix ARG, go forwards." (interactive "P") (inform-next-object (- (prefix-numeric-value arg)))) (defun inform-imenu-extract-name () "Extract item name for imenu." (if (looking-at "^#?\\(object\\|nearby\\|class\\)\\s-+\\(->\\s-+\\)*\\(\\(\\w\\|\\s_\\)+\\)") (concat (if (string= "class" (downcase (match-string 1))) "Class ") (buffer-substring-no-properties (match-beginning 3) (match-end 3))))) ;;; ;;; Build and run project ;;; ;; Tell Emacs how to parse inform compiler output so next-error can be ;; used to jump to any errors. This is done at load time so the regexp ;; is set up before compilation starts. ;; XEmacs compile mode's builtin regexps work OK. (if (featurep 'emacs) (if (and (boundp 'compilation-error-regexp-alist-alist) (not (assoc 'inform-e1 compilation-error-regexp-alist-alist))) (mapc (lambda (item) (push (car item) compilation-error-regexp-alist) (push item compilation-error-regexp-alist-alist)) inform-compilation-error-regexp-alist))) (defun inform-build-project () "Compile the current Inform project. The current project is given by variable`inform-project-file', or the current file if this is NIL." (interactive) (let ((project-file (file-name-nondirectory (inform-project-file)))) (compile (concat inform-command (if (and inform-libraries-directory (file-directory-p inform-libraries-directory)) (concat " +" inform-libraries-directory) "") ;; Note the use of Microsoft style errors. The ;; Archimedes-style errors don't give the correct file ;; name. " " inform-command-options " -E1 " (if (string-match "\\`[^.]+\\(\\.inf\\'\\)" project-file) (substring project-file 0 (match-beginning 1)) project-file))))) (defun inform-run-project () "Run the current Inform project using `inform-interpreter-command'. The current project is given by variable`inform-project-file', or the current file if this is NIL. Will kill any running interpreter if `inform-interpreter-kill-old-process' is non-NIL. Switches to the interpreter's output buffer if `inform-interpreter-is-graphical' is NIL." (interactive) (let* ((project-file (inform-project-file)) (story-file-base (if (string-match "\\`[^.]+\\(\\.inf\\'\\)" project-file) (substring project-file 0 (match-beginning 1)) project-file)) (story-file (concat story-file-base (if (string-match "-v8" inform-command-options) ".z8" ".z5"))) (name "Inform interpreter")) (if (or (symbolp inform-interpreter-command) (functionp inform-interpreter-command)) ;; Emacs interpreter (or custom function) (funcall inform-interpreter-command story-file) ;; inform-interpreter-command is truly a command (let* ((buffer (get-buffer-create (concat "*" name "*"))) (proc (get-buffer-process buffer))) (and inform-interpreter-kill-old-process proc (kill-process proc)) (if (or inform-interpreter-is-graphical (eq window-system 'w32)) ; Windows can't handle ; term-exec anyway (progn ;; X gets confused if an application is restarted too quickly ;; Assume X if not Win32 (unless (eq window-system 'w32) (message "Waiting for X...") ;; On my system 0.1 seconds was enough - double it for safety (sleep-for 0.2) (message "")) (when (or inform-interpreter-kill-old-process (not proc)) (apply (function start-process) name buffer inform-interpreter-command ;; Some shells barf on "empty" arguments (if (string-equal "" inform-interpreter-options) (list story-file) (list inform-interpreter-options story-file))))) ;; Console-mode 'terp (require 'term) (when (or inform-interpreter-kill-old-process (not proc)) (set-buffer buffer) (term-mode) (erase-buffer) (term-exec buffer name inform-interpreter-command nil (if (string-equal "" inform-interpreter-options) (list story-file) (list inform-interpreter-options story-file))) (term-char-mode) (term-pager-disable)) (switch-to-buffer buffer) (goto-char (point-max))))))) ;;; ;;; Spell checking ;;; (defun inform-spell-check-buffer () "Spellcheck all strings in the buffer using Ispell." (interactive) (let (start (spell-continue t)) (save-excursion (goto-char (point-min)) (while (and (search-forward "\"" nil t) spell-continue) (if (and (eq (car (inform-syntax-class)) 'string) ;; don't spell check include directives etc (not (save-excursion (forward-line 0) (looking-at inform-directive-regexp)))) (progn (forward-char -1) ; move point to quotation mark (setq start (point)) (forward-sexp) (ispell-region start (point)) ;; If user quit out (eg by pressing q while in ispell) ;; don't continue looking for strings to check. (setq spell-continue (and ispell-process (eq (process-status ispell-process) 'run))))))))) ;;;###autoload (setq auto-mode-alist (append '(("\\.h\\'" . inform-maybe-mode) ("\\.inf\\'" . inform-mode)) auto-mode-alist)) ;;;###autoload (add-hook 'inform-mode-hook 'turn-on-font-lock) (provide 'inform-mode) ;;; inform-mode.el ends here inform-mode-1.6.2/COPYING0000644000175000017500000000121611747511742014424 0ustar rupertrupertinform-mode 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, (in the COPYING-GPL-3 file in this directory). If not, see http://www.gnu.org/licenses/ inform-mode-1.6.2/INSTALL0000644000175000017500000000521312225204427014412 0ustar rupertrupertNotes on installing inform-mode. There are four options to install inform-mode: via the Marmalade Emacs packaging system; using the package system on your OS; via the Makefile if you are on a Unix-derived system, have access to the 'make' program and have root access; or manually, which should work on all platforms. Each is described further below. XEmacs users should also see note 6. 1. Via Marmalade ---------------- Marmalade (http://marmalade-repo.org/) is a packaging system for Emacs. Follow the instructions on the website to add Marmalade to your list of package sources. Then inside emacs run M-x package-install RET inform-mode RET 2. Packaged versions -------------------- Some GNU/Linux systems have inform-mode available via their packaging systems. On Debian, Ubuntu or other derivatives you can run apt-get install inform-mode However, this may not provide the latest version: if you want this, download the latest version from http://www.rupert-lane.org/inform-mode/ and try one of the following two methods. 3. Makefile ----------- Edit the file 'Makefile' and replace the name of your emacs binary and site-lisp directory if they are different. Type make to byte-compile the source. Then as root, eg using sudo: make install to install the files to the site-lisp directory for your emacs so it is available for all users on your system. 4. Manually ----------- First, byte-compile the file by running the following command (all on one line): emacs -batch -q -no-site-file -eval "(setq load-path (cons (expand-file-name \".\") load-path))" --eval '(byte-compile-file "inform-mode.el")' Next, copy inform-mode.elc to the directory you want to install it. If you put the file in a non-standard place, tell emacs where to find it by putting a line like: (setq load-path (cons (expand-file-name "/path/to/file/") load-path)) in your .emacs. 5. Updating .emacs ------------------ For all options except 1) and 2) you will need to update your .emacs to autoload inform-mode and make it recognise .inf and .h files. Add the following: (autoload 'inform-mode "inform-mode" "Inform editing mode." t) (autoload 'inform-maybe-mode "inform-mode" "Inform/C header editing mode.") (setq auto-mode-alist (append '(("\\.h\\'" . inform-maybe-mode) ("\\.inf\\'" . inform-mode)) auto-mode-alist)) 6. A note for XEmacs users -------------------------- You may need to install extra packages for inform-mode to work. If you are using the default XEmacs install on Windows, for example, you will need to install the 'ispell' and 'eterm' packages. # Local Variables: # mode: text # fill-column: 72 # End: