branch: elpa/cycle-at-point
commit ea22b90f35f4cef73387047b3ef3fad83787d4e2
Author: Campbell Barton <ideasma...@gmail.com>
Commit: Campbell Barton <ideasma...@gmail.com>
Initial version.
---
.elisp-autofmt | 0
LICENSE | 674 +++++++++++++++++++++++++++++++
cycle-at-point-find-alphabet.el | 35 ++
cycle-at-point-find-integer.el | 158 ++++++++
cycle-at-point-preset-c++-mode.el | 22 +
cycle-at-point-preset-c-mode.el | 37 ++
cycle-at-point-preset-cmake-mode.el | 26 ++
cycle-at-point-preset-emacs-lisp-mode.el | 29 ++
cycle-at-point-preset-lang-en.el | 39 ++
cycle-at-point-preset-python-mode.el | 36 ++
cycle-at-point.el | 329 +++++++++++++++
readme.rst | 162 ++++++++
tests/cycle-at-point-tests.el | 82 ++++
13 files changed, 1629 insertions(+)
diff --git a/.elisp-autofmt b/.elisp-autofmt
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000..f288702d2f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/cycle-at-point-find-alphabet.el b/cycle-at-point-find-alphabet.el
new file mode 100644
index 0000000000..108912427a
--- /dev/null
+++ b/cycle-at-point-find-alphabet.el
@@ -0,0 +1,35 @@
+;;; cycle-at-point-find-alphabet.el --- Alphabet finder -*- lexical-binding: t
-*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Finder for alphabetical characters (handy for single variable names).
+
+;;; Code:
+
+(require 'thingatpt) ;; `bounds-of-thing-at-point'.
+
+(defun cycle-at-point-find-alphabet-ascii ()
+ "Return alphabetical characters matching the symbol at-point."
+ (let
+ (
+ (result (list))
+ (word (bounds-of-thing-at-point 'symbol))
+ (word-upcase nil))
+ (when word
+ (setq word (buffer-substring-no-properties (car word) (cdr word)))
+ (when (eq 1 (length word))
+ (setq word-upcase (upcase word))
+ (when (string-match-p "[A-Z]" word-upcase)
+ (setq result
+ (list
+ "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" ;; Alphabet
literal.
+ "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z"))
+ (unless (string-equal word word-upcase)
+ (setq result (mapcar (lambda (w) (downcase w)) result))))))
+ (list :data result)))
+
+(provide 'cycle-at-point-find-alphabet)
+;;; cycle-at-point-find-alphabet.el ends here
diff --git a/cycle-at-point-find-integer.el b/cycle-at-point-find-integer.el
new file mode 100644
index 0000000000..cbfaba194d
--- /dev/null
+++ b/cycle-at-point-find-integer.el
@@ -0,0 +1,158 @@
+;;; cycle-at-point-find-integer.el --- Integer finder -*- lexical-binding: t
-*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Finder for integer number (handy for showing different representations).
+
+;;; Code:
+
+;; ---------------------------------------------------------------------------
+;; Private Functions
+
+(defun cycle-at-point-find-integer--format-binary (number &optional width
fillchar)
+ "Format NUMBER as binary.
+Fill up to WIDTH with FILLCHAR (defaults to ?0) if binary
+representation of NUMBER is smaller."
+ (let
+ (
+ (nums (list))
+ (fillchar (or fillchar ?0)))
+ (while (> number 0)
+ (push (number-to-string (% number 2)) nums)
+ (setq number (truncate number 2)))
+ (let ((len (length nums)))
+ (apply #'concat
+ (if (and width (< len width))
+ (make-string (- width len) fillchar)
+ "")
+ nums))))
+
+(defun cycle-at-point-find-integer--format (num width base)
+ "Format NUM with at least WIDTH space in BASE."
+ (cond
+ ((eq base 2)
+ (cycle-at-point-find-integer--format-binary num width))
+ ((eq base 8)
+ (format (format "%%0%do" width) num))
+ ((eq base 16)
+ (format (format "%%0%dX" width) num))
+ ((eq base 10)
+ (format (format "%%0%dd" width) num))
+ (t
+ (error "Invalid base"))))
+
+
+;; ---------------------------------------------------------------------------
+;; Public Functions
+
+(defun cycle-at-point-find-integer-bases (&rest args)
+ "Return alternate bases at point.
+Optional keyword ARGS:
+:bases
+ A list of bases which this mode supports.
+`:undescore-sep'
+ When true, ignore underscores."
+ (let
+ (
+ (supported-bases (plist-get args :bases))
+ (underscore-sep (plist-get args :underscore-sep))
+ (any-chars "")
+ (any-prefix "")
+ (pt-init (point))
+ (pt-beg (line-beginning-position))
+ (result nil))
+
+ (dolist (base supported-bases)
+ (cond
+ ((eq base 2)
+ (setq any-prefix (concat any-prefix "bB"))
+ (setq any-chars (concat any-chars "0-1")))
+ ((eq base 8)
+ (setq any-prefix (concat any-prefix "oO"))
+ (setq any-chars (concat any-chars "0-7")))
+ ((eq base 10)
+ (setq any-chars (concat any-chars "0-9")))
+ ((eq base 16)
+ (setq any-prefix (concat any-prefix "xX"))
+ (setq any-chars (concat any-chars "0-9a-fA-F")))))
+
+ (save-excursion
+ ;; Important not to skip over non-numbers.
+ (goto-char (min (1+ (point)) (line-end-position)))
+ (when
+ (zerop
+ (skip-chars-backward
+ (concat
+ any-chars any-prefix
+ (cond
+ (underscore-sep
+ "_")
+ (t
+ "")))
+ pt-beg))
+ (goto-char pt-init))
+ (let
+ (
+ (base 10)
+ (pt-start (point))
+ (c nil)
+ (c-is-upper nil)
+ (c-search nil))
+
+ (when (looking-at (concat "0[" any-prefix "]"))
+ (setq c (char-after (1+ (point))))
+ (unless (string-equal (downcase (char-to-string c)) (char-to-string
c))
+ (setq c-is-upper t))
+ (setq c (string-to-char (downcase (char-to-string c))))
+ ;; Skip the prefix.
+ (forward-char 2))
+
+ (cond
+ ((eq c ?b)
+ (setq base 2)
+ (setq c-search "[0-1_]+"))
+ ((eq c ?o)
+ (setq base 8)
+ (setq c-search "[0-7_]+"))
+ ((null c)
+ (setq base 10)
+ (setq c-search "[0-9_]+"))
+ ((eq c ?x)
+ (setq base 16)
+ (setq c-search "[0-9_a-fA-F]+"))
+ (t
+ (error "Internal error")))
+
+ (when (looking-at c-search)
+ (let ((text (buffer-substring-no-properties pt-start (match-end 0))))
+ ;; Strip prefix, also remove "_"
+ (let ((text-eval (substring text (- (point) pt-start) nil)))
+ (when underscore-sep
+ (setq text-eval (replace-regexp-in-string "_" "" text-eval)))
+
+ (let ((num (string-to-number text-eval base)))
+ (dolist (base-data (list (cons 16 "0x") (cons 10 "") (cons 8
"0o") (cons 2 "0b")))
+ (let
+ (
+ (base-iter (car base-data))
+ (base-prefix (cdr base-data)))
+ ;; If this base is supported.
+ (when (member base-iter supported-bases)
+ (push
+ (cond
+ ((eq base base-iter)
+ text)
+ (t
+ (when c-is-upper
+ (setq base-prefix (upcase base-prefix)))
+ (concat
+ base-prefix
+ (cycle-at-point-find-integer--format num 1
base-iter))))
+ result))))))))))
+ (list :data result)))
+
+(provide 'cycle-at-point-find-integer)
+;;; cycle-at-point-find-integer.el ends here
diff --git a/cycle-at-point-preset-c++-mode.el
b/cycle-at-point-preset-c++-mode.el
new file mode 100644
index 0000000000..ecce95f089
--- /dev/null
+++ b/cycle-at-point-preset-c++-mode.el
@@ -0,0 +1,22 @@
+;;; cycle-at-point-preset-c++-mode.el --- C++ preset -*- lexical-binding: t -*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Preset for C++
+
+;;; Code:
+
+(require 'cycle-at-point-preset-c-mode)
+(defun cycle-at-point-preset-c++-mode ()
+ "Return a preset list compatible with `cycle-at-point-list'."
+ (append
+ (cycle-at-point-preset-c-mode)
+ (list
+ ;; Mostly shared with C.
+ (list :data (list "public" "private")))))
+
+(provide 'cycle-at-point-preset-c++-mode)
+;;; cycle-at-point-preset-c++-mode.el ends here
diff --git a/cycle-at-point-preset-c-mode.el b/cycle-at-point-preset-c-mode.el
new file mode 100644
index 0000000000..d8167ba989
--- /dev/null
+++ b/cycle-at-point-preset-c-mode.el
@@ -0,0 +1,37 @@
+;;; cycle-at-point-preset-c-mode.el --- C preset -*- lexical-binding: t -*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Preset for C
+
+;;; Code:
+
+(require 'cycle-at-point-find-alphabet)
+(require 'cycle-at-point-find-integer)
+
+(defun cycle-at-point-preset-c-mode ()
+ "Return a preset list compatible with `cycle-at-point-list'."
+ (list
+ (list :data (list "true" "false"))
+ (list :data (list "&" "|"))
+ (list :data (list "&=" "|="))
+ (list :data (list "&&" "||"))
+ (list :data (list "<" ">"))
+ (list :data (list "<=" ">="))
+ (list :data (list "<<" ">>"))
+ (list :data (list "<<=" ">>="))
+ (list :data (list "!=" "=="))
+ (list :data (list "/" "*"))
+ (list :data (list "/=" "*="))
+ (list :data (list "+" "-"))
+ (list :data (list "+=" "-="))
+ (list :data (list "++" "--"))
+ (list :data (list "unsigned" "signed"))
+ (lambda () (cycle-at-point-find-alphabet-ascii))
+ (lambda () (cycle-at-point-find-integer-bases :bases (list 10 16)))))
+
+(provide 'cycle-at-point-preset-c-mode)
+;;; cycle-at-point-preset-c-mode.el ends here
diff --git a/cycle-at-point-preset-cmake-mode.el
b/cycle-at-point-preset-cmake-mode.el
new file mode 100644
index 0000000000..ba57457851
--- /dev/null
+++ b/cycle-at-point-preset-cmake-mode.el
@@ -0,0 +1,26 @@
+;;; cycle-at-point-preset-cmake-mode.el --- CMAKE preset -*- lexical-binding:
t -*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Preset for CMAKE.
+
+;;; Code:
+
+(require 'cycle-at-point-find-alphabet)
+
+(defun cycle-at-point-preset-cmake-mode ()
+ "Return a preset list compatible with `cycle-at-point-list'."
+ ;; Note that CMAKE is case insensitive.
+ (list
+ (list :data (list "TRUE" "FALSE") :case-fold t)
+ (list :data (list "ON" "OFF") :case-fold t)
+ (list :data (list "AND" "OR") :case-fold t)
+ (list :data (list "VERSION_LESS" "VERSION_GREATER") :case-fold t)
+ (list :data (list "VERSION_LESS_EQUAL" "VERSION_GREATER_EQUAL") :case-fold
t)
+ (lambda () (cycle-at-point-find-alphabet-ascii))))
+
+(provide 'cycle-at-point-preset-cmake-mode)
+;;; cycle-at-point-preset-cmake-mode.el ends here
diff --git a/cycle-at-point-preset-emacs-lisp-mode.el
b/cycle-at-point-preset-emacs-lisp-mode.el
new file mode 100644
index 0000000000..bdfc85f9e2
--- /dev/null
+++ b/cycle-at-point-preset-emacs-lisp-mode.el
@@ -0,0 +1,29 @@
+;;; cycle-at-point-preset-emacs-lisp-mode.el --- ELISP preset -*-
lexical-binding: t -*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Preset for ELISP.
+
+;;; Code:
+
+(require 'cycle-at-point-find-alphabet)
+
+(defun cycle-at-point-preset-emacs-lisp-mode ()
+ "Return a preset list compatible with `cycle-at-point-list'."
+ (list
+ (list :data (list "t" "nil"))
+ (list :data (list "and" "or"))
+ (list :data (list "when" "unless"))
+ (list :data (list "<" ">"))
+ (list :data (list "/" "*"))
+ (list :data (list "+" "-"))
+ (list :data (list ">=" "<="))
+ (list :data (list "car" "cdr"))
+ (list :data (list "string-lessp" "string-greaterp"))
+ (lambda () (cycle-at-point-find-alphabet-ascii))))
+
+(provide 'cycle-at-point-preset-emacs-lisp-mode)
+;;; cycle-at-point-preset-emacs-lisp-mode.el ends here
diff --git a/cycle-at-point-preset-lang-en.el b/cycle-at-point-preset-lang-en.el
new file mode 100644
index 0000000000..2f951c4dfe
--- /dev/null
+++ b/cycle-at-point-preset-lang-en.el
@@ -0,0 +1,39 @@
+;;; cycle-at-point-preset-lang-en.el --- English preset -*- lexical-binding: t
-*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Preset for Emacs Lisp
+
+;;; Code:
+
+(defun cycle-at-point-preset-lang-en ()
+ "Return a preset list compatible with `cycle-at-point-list'."
+ (list
+ ;; Days of the week.
+ (list
+ :data (list "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY"
"SATURDAY" "SUNDAY")
+ :case-fold t)
+ (list :data (list "MON" "TUE" "WED" "THU" "FRI" "SAT" "SUN") :case-fold t)
+ ;; Months of the year.
+ (list
+ :data
+ (list
+ "JANUARY"
+ "FEBRUARY"
+ "MARCH"
+ "APRIL"
+ "MAY"
+ "JUNE"
+ "JULY"
+ "AUGUST"
+ "SEPTEMBER"
+ "OCTOBER"
+ "NOVEMBER"
+ "DECEMBER")
+ :case-fold t)))
+
+(provide 'cycle-at-point-preset-lang-en)
+;;; cycle-at-point-preset-lang-en.el ends here
diff --git a/cycle-at-point-preset-python-mode.el
b/cycle-at-point-preset-python-mode.el
new file mode 100644
index 0000000000..0dbe069680
--- /dev/null
+++ b/cycle-at-point-preset-python-mode.el
@@ -0,0 +1,36 @@
+;;; cycle-at-point-preset-python-mode.el --- Python preset -*-
lexical-binding: t -*-
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; SPDX-License-Identifier: GPL-3.0-or-later
+
+;;; Commentary:
+;; Preset for Python.
+
+;;; Code:
+
+(require 'cycle-at-point-find-alphabet)
+(require 'cycle-at-point-find-integer)
+
+(defun cycle-at-point-preset-python-mode ()
+ "Return a preset list compatible with `cycle-at-point-list'."
+ (list
+ (list :data (list "True" "False"))
+ (list :data (list "&" "|"))
+ (list :data (list "&=" "|="))
+ (list :data (list "and" "or"))
+ (list :data (list "is not" "is"))
+ (list :data (list "<" ">"))
+ (list :data (list "<=" ">="))
+ (list :data (list "<<" ">>"))
+ (list :data (list "<<=" ">>="))
+ (list :data (list "!=" "=="))
+ (list :data (list "/" "*"))
+ (list :data (list "/=" "*="))
+ (list :data (list "+" "-"))
+ (list :data (list "+=" "-="))
+ (lambda () (cycle-at-point-find-integer-bases :bases (list 2 8 10 16)
:underscore-sep t))
+ (lambda () (cycle-at-point-find-alphabet-ascii))))
+
+(provide 'cycle-at-point-preset-python-mode)
+;;; cycle-at-point-preset-python-mode.el ends here
diff --git a/cycle-at-point.el b/cycle-at-point.el
new file mode 100644
index 0000000000..1761d66e33
--- /dev/null
+++ b/cycle-at-point.el
@@ -0,0 +1,329 @@
+;;; cycle-at-point.el --- Cycle (rotate) the thing under the cursor -*-
lexical-binding: t -*-
+
+;; SPDX-License-Identifier: GPL-3.0-or-later
+;; Copyright (C) 2022 Campbell Barton
+
+;; Author: Campbell Barton
+;; URL: https://gitlab.com/ideasman42/emacs-cycle-at-point
+;; Version: 0.1
+;; Created: 2022-02-05
+;; Keywords: convenience
+;; Package-Requires: ((emacs "27.1") (recomplete "0.2"))
+
+;; This file is NOT part of GNU Emacs.
+
+;;; Commentary:
+
+;; M-x cycle-at-point cycles the point at the cursor,
+;; this should be bound to a key.
+
+;;; Code:
+
+;; ---------------------------------------------------------------------------
+;; Require Dependencies
+
+(require 'recomplete) ;; `recomplete-with-callback'.
+
+(eval-when-compile
+ (require 'cycle-at-point-find-alphabet)
+ (require 'cycle-at-point-find-integer)
+ (require 'cycle-at-point-preset-c++-mode)
+ (require 'cycle-at-point-preset-c-mode)
+ (require 'cycle-at-point-preset-cmake-mode)
+ (require 'cycle-at-point-preset-emacs-lisp-mode)
+ (require 'cycle-at-point-preset-lang-en)
+ (require 'cycle-at-point-preset-python-mode))
+
+;; ---------------------------------------------------------------------------
+;; Custom Variables
+
+(defvar-local cycle-at-point-list nil
+ "Buffer local list of literals to cycle.
+
+A function that returns a list is also supported.
+
+When left unset this this auto-detected from the mode.
+
+Each list item can contain keyword/value pairs:
+
+`:data'
+ Where the value is a list of strings,
+ or a function that returns a list of strings when called (required).
+`:case-fold'
+ Where the value is a boolean for case insensitive matching
+ (optional, nil by default).
+
+ When true, matching the literals is case insensitive.
+ Replacements follow the current case: lower, upper or title-case.")
+
+
+;; ---------------------------------------------------------------------------
+;; Private Functions
+
+(defun cycle-at-point--cycle-words (cycle-data)
+ "Return the bounds of the thing at point from CYCLE-DATA."
+ (let
+ ( ;; Only for error messages.
+ (cycle-data-index 0)
+ (prefix "cycle-at-point")
+ (pt (point))
+ (line-beg (line-beginning-position))
+ (line-end (line-end-position))
+
+ (result nil))
+
+ (while (and (null result) cycle-data)
+ (let
+ ( ;; Extract keyword arguments from `arg-data'.
+ (arg-data (pop cycle-data))
+
+ (arg-case-fold nil)
+ (arg-words nil))
+
+ ;; May be callable.
+ (when (functionp arg-data)
+ (condition-case-unless-debug err
+ (save-match-data
+ (save-excursion
+ (unless (eq (point) pt)
+ (error "Internal error, unexpected point motion"))
+ (setq arg-data (funcall arg-data))))
+ (error
+ (user-error
+ "%s: (error at index %d) unable to use callback (%S)"
+ prefix
+ cycle-data-index
+ err))))
+
+ ;; Parse arguments.
+ (while arg-data
+ (let ((arg-current (pop arg-data)))
+ (cond
+ ((keywordp arg-current)
+ (unless arg-data
+ (user-error
+ "%s: (error at index %d) keyword argument %S has no value!"
+ prefix
+ cycle-data-index
+ arg-current))
+ (let ((v (pop arg-data)))
+ (pcase arg-current
+ (:data
+ (cond
+ ;; Callback to generate data.
+ ((functionp v)
+ (condition-case-unless-debug err
+ (save-match-data
+ (save-excursion
+ (unless (eq (point) pt)
+ (error "Internal error, unexpected point
motion"))
+ (setq v (funcall v))
+ (unless (listp v)
+ (error
+ "Expected a list of strings, not %S = %S"
(type-of v) v))))
+ (error
+ (user-error
+ "%s: (error at index %d), :data callback
failure %S"
+ prefix
+ cycle-data-index
+ err))))
+ ((listp v))
+ (t
+ (error
+ "%s: expected `:data', to be a list of strings,
found %S"
+ prefix
+ (type-of v))))
+ (setq arg-words v))
+ (:case-fold
+ (cond
+ ((memq v (list nil t)))
+ (t
+ (error "%s: expected `:case-fold', to be nil or t"
prefix)))
+ (setq arg-case-fold v))
+ (_ (error "Unknown argument %S" arg-current)))))
+ (t
+ (user-error
+ "%s: (error at index %d) all arguments must be keyword,
value pairs, found %S"
+ prefix
+ cycle-data-index
+ (type-of arg-current))))))
+ ;; Done parsing arguments.
+
+ (let*
+ (
+ (case-fold-search arg-case-fold)
+ (words-max 0)
+ (words-length 0)
+ (words-regex
+ (concat
+ (mapconcat
+ #'
+ (lambda (literal)
+ (setq words-max (max words-max (length literal)))
+ (setq words-length (1+ words-length))
+ ;; Use groups so they can be checked.
+ (concat "\\(" (regexp-quote literal) "\\)"))
+ arg-words "\\|")))
+
+ ;; Anything outside this range wont overlap `pt'.
+ (search-min (max (- pt words-max) line-beg))
+ (search-max (min (+ pt words-max) line-end)))
+
+ (save-match-data
+ (save-excursion
+ (goto-char search-min)
+ (while (and (< (point) search-max) (re-search-forward
words-regex search-max t))
+ (let
+ (
+ (beg (match-beginning 0))
+ (end (match-end 0)))
+
+ ;; Even if the point has been found,
+ ;; it's possible the word found was shorter, meaning the
point is not over it.
+ (cond
+ ;; Keep searching.
+ ((< end pt)
+ (goto-char (1+ beg)))
+ ;; Stop searching (past the point).
+ ((< pt beg)
+ (goto-char search-max))
+
+ ;; Overlapping match, now check delimiters (via syntax
table).
+
+ ;; Delimit on unchanged syntax-class at the beginning.
+ ((and (< line-beg beg) (eq (syntax-after beg)
(syntax-after (1- beg))))
+ ;; This match doesn't end at delimiters, keep searching.
+ (goto-char (1+ beg)))
+
+ ;; Delimit on unchanged syntax-class at the end.
+ ((and (< end line-end) (eq (syntax-after end)
(syntax-after (1- end))))
+ ;; This match doesn't end at delimiters, keep searching.
+ (goto-char (1+ beg)))
+
+ ;; Cycle word list!
+ (t
+ (let
+ (
+ (i 0)
+ (not-found t))
+ (while (and not-found (< i words-length))
+ (cond
+ ((match-string (1+ i))
+ (setq i (1- i))
+ (setq not-found nil))
+ (t
+ (setq i (1+ i)))))
+
+ ;; Move the current word last.
+ (setq i (mod (1+ i) words-length))
+ (let ((word-orig (buffer-substring-no-properties beg
end)))
+ ;; Match the case of the existing word (when case is
folded).
+ (when arg-case-fold
+ (setq arg-words
+ (cond
+ ((string-equal (upcase word-orig) word-orig)
+ (mapcar (lambda (w) (upcase w)) arg-words))
+ ((string-equal (downcase word-orig) word-orig)
+ (mapcar (lambda (w) (downcase w)) arg-words))
+ (t
+ (mapcar
+ (lambda (w) (upcase-initials (downcase
w))) arg-words)))))
+
+ (setq arg-words
+ (append (seq-subseq arg-words i) (seq-subseq
arg-words 0 i)))
+
+ ;; Include this literal word
+ ;; in case of minor differences in case or spacing.
+ (setq arg-words (cons word-orig (cdr arg-words)))
+
+ (unless (string-equal (downcase (car arg-words))
(downcase word-orig))
+ (error "Internal error"))))
+
+ (setq result (cons arg-words (cons beg end)))))))))))
+ (setq cycle-data-index (1+ cycle-data-index)))
+
+ (or result (cons nil nil))))
+
+(defun cycle-at-point--impl-cycle-get-data-for-mode ()
+ "Return data associated with a major mode."
+ (cond
+ (cycle-at-point-list
+ cycle-at-point-list)
+ (t
+ (let ((preset (cycle-at-point-preset nil t)))
+ (unless preset
+ ;; TODO: detect language.
+ (setq preset (cycle-at-point-preset "lang-en")))
+ preset))))
+
+(defun cycle-at-point-impl (cycle-index fn-cache)
+ "Cycle case styles using the choice at CYCLE-INDEX.
+Argument FN-CACHE stores the result for reuse."
+ (pcase-let ((`(,result-choices ,word-beg ,word-end) (or fn-cache '(nil nil
nil))))
+ ;; Call when not cached.
+ (unless result-choices
+ (let ((cycle-data (cycle-at-point--impl-cycle-get-data-for-mode)))
+ (cond
+ ((null cycle-data)
+ (message "No cycle for mode %S" major-mode))
+ (t
+ (pcase-let ((`(,words . (,beg . ,end))
(cycle-at-point--cycle-words cycle-data)))
+ (cond
+ ((null words)
+ (message "No cycle symbol found at point!"))
+ (t
+ (let ((target (buffer-substring-no-properties beg end)))
+ (cond
+ ((null target)
+ ;; Trim the string since it can contain newlines.
+ (message "No cycle for %S found!" (string-trim
target)))
+ (t
+ (setq result-choices words)
+ (setq word-beg beg)
+ (setq word-end end))))))))))
+
+ (when result-choices
+ (setq fn-cache (list result-choices word-beg word-end))))
+
+ (when result-choices
+ (let ((word-at-index (nth (mod cycle-index (length result-choices))
result-choices)))
+ (goto-char word-beg)
+ (delete-region word-beg word-end)
+ (insert word-at-index))
+
+ (list result-choices fn-cache))))
+
+
+;; ---------------------------------------------------------------------------
+;; Public Functions
+
+;;;###autoload
+(defun cycle-at-point-preset (&optional preset-id quiet)
+ "Load a preset for current mode.
+The first is PRESET-ID to override the current `major-mode'.
+The second is QUIET, when non-nil, don't show a message
+when the preset isn't found."
+ (unless preset-id
+ (setq preset-id (symbol-name major-mode)))
+ (let ((preset-sym (intern (concat "cycle-at-point-preset-" preset-id))))
+ (when
+ (condition-case err
+ (progn
+ (require preset-sym)
+ t)
+ (error
+ (unless quiet
+ (message "cycle-at-point: preset %S not found! (%S)" preset-id
err))
+ nil))
+ (funcall preset-sym))))
+
+;;;###autoload
+(defun cycle-at-point (arg)
+ "Cycle through a list of known values.
+ARG is the offset to cycle, default is 1, -1 to cycle backwards."
+ (interactive "p")
+ ;; Pass 1 to start at the second item (the current word is always the first).
+ (recomplete-with-callback 'cycle-at-point-impl arg 1))
+
+(provide 'cycle-at-point)
+;;; cycle-at-point.el ends here
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000000..74d5fb76e1
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,162 @@
+####################
+Emacs Cycle at Point
+####################
+
+Immediately cycle text at the cursor, without prompting.
+
+Unlike most actions to select from a list ``cycle-at-point`` replaces the text
immediately,
+calling again to cycle over options.
+
+This has the following characteristics:
+
+- Completion options are displayed in the echo-area.
+- Only ever adds a single undo step.
+- Supports user defined lists.
+
+Available via `melpa <https://melpa.org/#/cycle-at-point>`__.
+
+
+Motivation
+==========
+
+Some words in programming languages have direct opposites where having to
remove and re-enter the text can be tedious,
+a common example is ``True`` and ``False``,
+however others exist such as ``public`` / ``private`` .. depending on the
language.
+
+While there are many options for completion available for Emacs,
+most rely on prompts that require multiple key-strokes to activate, select and
confirm.
+
+This package handles this with a single key stroke, with the ability to cycle
between multiple options if required.
+
+
+Usage
+=====
+
+This package exposes the following interactive functions:
+
+- ``cycle-at-point``
+
+
+On successive calls these commands cycle to the next item.
+To cycle in the reverse press ``[keyboard-quit]`` (Ctrl-G),
+which causes the next completion command to reverse the direction.
+
+
+Included Presets
+----------------
+
+Programming languages:
+
+``c++-mode``
+ - The same as ``c-mode`` with addition of ``public`` / ``private``.
+
+``c-mode``
+ - Cycle common terms (``true`` / ``false``, ``>=`` / ``<=``, ``==`` /
``!=``, ... etc).
+ - Number bases (decimal, hexadecimal).
+ - Alphabet characters.
+
+``cmake-mode``
+ - Cycle common terms (``TRUE`` / ``FALSE``, ``ON`` / ``OFF``,
``VERSION_LESS`` / ``VERSION_GREATER``, ... etc).
+ - Alphabet characters.
+
+``emacs-lisp-mode``
+ - Common terms (``t`` / ``nil``, ``when`` / ``unless``, ... etc).
+ - Alphabet characters.
+
+``python-mode``
+ - Cycle common terms (``True`` / ``False``, ``>=`` / ``<=``, ``is`` / ``is
not`` ... etc).
+ - Number bases (binary, octal, decimal, hexadecimal).
+ - Alphabet characters.
+
+Spoken languages:
+
+``lang-en``
+ - Cycle common English words (days & months).
+ - Alphabet characters.
+
+*Presets for other languages welcome!*
+
+
+Key Bindings
+------------
+
+You will need to map these to keys yourself.
+
+Key binding example for Emacs default layout, using ``Alt-P``:
+
+.. code-block:: elisp
+
+ (global-set-key (kbd "M-p") 'cycle-at-point)
+
+Key binding example for evil-mode layout, using ``Alt-Z``:
+
+.. code-block:: elisp
+
+ (global-unset-key (kbd "M-z"))
+ (define-key evil-normal-state-map (kbd "M-z") 'cycle-at-point)
+
+If you want to bind a key directly to cycling in the reverse direction
+it can be done using ``-1`` for the prefix argument.
+
+Key binding example, using ``Alt-Shift-P``:
+
+.. code-block:: elisp
+
+ (global-set-key (kbd "M-P")
+ (lambda ()
+ (interactive)
+ (let ((current-prefix-arg '(-1)))
+ (call-interactively 'cycle-at-point))))
+
+
+Customization
+-------------
+
+``cycle-at-point-list``
+ Setting this value is optional, when left unset a preset will be used when
available.
+
+ Buffer local list of items to use for rotation.
+ A function that returns a list is also supported.
+
+ **List Format**
+
+ Each list item contains keyword/value pairs:
+
+ ``:data``
+ Where the value is a list of strings,
+ or a function that returns a list of strings when called (required).
+
+ In the case multiple values may match the same literal, the more
specific case must be included first.
+ So data should be ordered ``'("is not" "is")``.
+
+ Function call support allows the list of items to be dynamically
generated based on the text under the cursor.
+ ``:case-fold``
+ Where the value is a boolean for case insensitive matching
+ (optional, ``nil`` by default).
+
+ When true, matching the literals is case insensitive.
+ Replacements follow the current case: lower, upper or title-case.
+
+ .. code-block:: elisp
+
+ (setq cycle-at-point-list
+ (list '(:data ("yes" "no") :case-fold t))
+ (list '(:data ("open" "close") :case-fold t))
+ (list '(:data ("hello" "goodbye") :case-fold t)))
+
+
+Details
+=======
+
+- Results are cached for fast execution.
+- The ``recomplete`` package is used to implement text replacement and cycling.
+
+
+Installation
+============
+
+The package is `available in melpa <https://melpa.org/#/cycle-at-point>`__ as
``cycle-at-point``.
+
+.. code-block:: elisp
+
+ (use-package cycle-at-point)
diff --git a/tests/cycle-at-point-tests.el b/tests/cycle-at-point-tests.el
new file mode 100644
index 0000000000..949432d527
--- /dev/null
+++ b/tests/cycle-at-point-tests.el
@@ -0,0 +1,82 @@
+;;; cycle-at-point-tests.el --- Cycle at point tests -*- lexical-binding: t;
-*-
+
+;; SPDX-License-Identifier: GPL-2.0-or-later
+;; Copyright (C) 2022 Campbell Barton
+
+;;; Usage:
+
+;; These tests are typically executed by a shell script, e.g:
+;;
+;; ./tests/cycle-at-point-tests.sh
+;;
+;; If you wish to run this directly from the command line,
+;; you may use the following command:
+;;
+;; emacs -batch -l ../recomplete/recomplete.el -l
tests/cycle-at-point-tests.el -f ert-run-tests-batch-and-exit
+;;
+;; TIP: to run tests on file change (on Linux).
+;;
+;; bash -c 'while true; do inotifywait -e close_write $(find . -name
"*.el") ; emacs -batch -l ../recomplete/recomplete.el -l
tests/cycle-at-point-tests.el -f ert-run-tests-batch-and-exit ; done'
+;;
+
+;;; Code:
+
+
+;; ---------------------------------------------------------------------------
+;; Setup Environment
+
+(setq python-indent-guess-indent-offset nil)
+
+(add-to-list 'load-path (concat (file-name-directory load-file-name) ".."))
+(require 'cycle-at-point)
+
+
+;; ---------------------------------------------------------------------------
+;; Test Macros
+
+;; Simplify test declaration.
+(defmacro ert-deftest-decl-pair (test-id text-initial text-expected char-index
mode)
+ "Create a test named TEST-ID using TEXT-INITIAL TEXT-EXPECTED as a result."
+ `
+ (ert-deftest
+ ,test-id ()
+ (with-temp-buffer
+ (buffer-enable-undo)
+ (funcall ,mode)
+ (insert ,text-initial)
+ (goto-char (+ (point-min) ,char-index))
+ (call-interactively 'cycle-at-point)
+ (should (equal ,text-expected (buffer-string))))))
+
+;; ---------------------------------------------------------------------------
+;; Test (Basic)
+;;
+;; Tests that should meet an expected output.
+
+;; Single words.
+(ert-deftest-decl-pair py-boolean "True" "False" 0 'python-mode)
+(ert-deftest-decl-pair c-boolean "true" "false" 0 'c-mode)
+(ert-deftest-decl-pair c++-boolean "true" "false" 0 'c++-mode)
+(ert-deftest-decl-pair emacs-boolean "nil" "t" 0 'emacs-lisp-mode)
+(ert-deftest-decl-pair text-day-upper "WEDNESDAY" "THURSDAY" 0 'text-mode)
+(ert-deftest-decl-pair text-day-lower "friday" "saturday" 0 'text-mode)
+(ert-deftest-decl-pair text-day-mixed-case "Saturday" "Sunday" 0 'text-mode)
+(ert-deftest-decl-pair py-is-isnot "is" "is not" 0 'python-mode)
+(ert-deftest-decl-pair py-isnot-is "is not" "is" 0 'python-mode)
+
+;; ---------------------------------------------------------------------------
+;; Test (Complex)
+;;
+;; More complex words.
+
+(ert-deftest-decl-pair py-is-isnot-complex "if A is B:" "if A is not B:" 5
'python-mode)
+(ert-deftest-decl-pair c-and "(A)&&(B)" "(A)||(B)" 3 'c-mode)
+(ert-deftest-decl-pair c-less-equal "(A)>=(B)" "(A)<=(B)" 3 'c-mode)
+(ert-deftest-decl-pair c-equals "(A)!=(B)" "(A)==(B)" 3 'c-mode)
+(ert-deftest-decl-pair c-greater "A>B" "A<B" 1 'c-mode)
+
+(ert-deftest-decl-pair py-number-decimal-to-nex "65536" "0x10000" 0
'python-mode)
+(ert-deftest-decl-pair py-number-binary-to-octal "0b101010" "0o52" 0
'python-mode)
+
+(provide 'cycle-at-point-tests)
+;;; cycle-at-point-tests.el ends here
