commit 414f61bee389a7bc2e228e438338741bf23fb354 Author: Lupo <931+lupo@noreply.octowow.st> Date: Sat Oct 24 00:00:00 2026 +0000 VimFinder 0.1.18 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..fa1385d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* -text diff --git a/Bindings.xml b/Bindings.xml new file mode 100644 index 0000000..b22bfcb --- /dev/null +++ b/Bindings.xml @@ -0,0 +1,5 @@ + + + VimFinder:Toggle() + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b8660c --- /dev/null +++ b/README.md @@ -0,0 +1,162 @@ +# VimFinder + +Search your spells, tracking, profession recipes, bag items and game +windows by name, and use them from the keyboard. Press **Alt+Space**, type a +few letters, press **Enter**. + +![The finder, opened with Alt+Space: the results you use most come first](screenshots/finder-open.png) + +## Requirements + +- A World of Warcraft 1.12.1 (build 5875) client (`## Interface: 11200`). +- **VimWowSettings**, the options window VimFinder keeps its key in. + Install it beside VimFinder (below). +- **No DLL.** VimFinder needs neither `ClassicAPI.dll` nor + `VimWowNative.dll`. It was tested on a 1.12.1 client both with and + without `ClassicAPI.dll` in `dlls.txt`. With ClassicAPI it finds more + (see [With ClassicAPI](#with-classicapi)). + +## Install + +With Git, from your game folder: + +``` +cd Interface/AddOns +git clone https://octowow.st/git/Lupo/VimFinder.git +git clone https://octowow.st/git/Lupo/VimWowSettings.git +``` + +To update later, run `git pull` in each of the two folders. + +Without Git, download the ZIP of +[VimFinder](https://octowow.st/git/Lupo/VimFinder) and of +[VimWowSettings](https://octowow.st/git/Lupo/VimWowSettings), unzip both +into `Interface/AddOns/`, and rename the folders to exactly `VimFinder` +and `VimWowSettings`. + +At character select, under AddOns, make sure both are ticked. + +Use counts are saved per account in `VimFinderDB`. + +## Use + +| Key | Does | +|---|---| +| **Alt+Space** | Opens the finder (change it in the options, below) | +| Type | Narrows the list. Letters match in order, so `ql` finds Toggle Quest Log; letters found together rank first | +| **Tab** / **Shift+Tab** | Next / previous result | +| **Ctrl+J** / **Ctrl+K** | Next / previous result (hold Ctrl, then press J or K) | +| **Enter** | Uses the chosen result | +| **Esc** | Closes the finder | + +![Typing narrows the list; the chosen result's tooltip shows beside the finder](screenshots/finder-search.png) + +With nothing typed, the results you use most come first; while you type, +they win ties. Each result shows its icon, its name and what Enter does. +A result in white can be used; one in grey is only shown, with its tooltip +beside the finder. + +In combat the finder turns partly see-through; it still opens windows and +casts spells, but leaves bag items, trade skills and crafts until the fight +is over. + +## What it finds + +### Windows + +Every window the game's key bindings open (quest log, spellbook, talents, +character, reputation, skills, social, world map and the rest), by the +game's own names. Enter opens it, or closes it when it is open, and closes +the finder. + +![Enter on Toggle Quest Log opens the quest log](screenshots/finder-window.png) + +### Spells + +Your spells and your pet's. Enter casts a spell that needs no target: +professions (Cooking, First Aid, Fishing and so on), Disenchant (then click +the item), summons and Basic Campfire; with ClassicAPI, helpful spells on +yourself too. Other spells are shown in grey with their rank. A search +finds everything that matches, here a bag item, three spells and a window: + +![Searching totem: an item in your bags, your totem spells and the Battle Map](screenshots/finder-spells.png) + +### Bag items + +Everything in your bags, with the bag and slot it is in. Enter opens your +bags so you can find the item. + +![A bag item and its tooltip](screenshots/finder-bag.png) + +### Recipes + +Every recipe your professions know, with the icon of the item it makes. +Enter opens the profession's window and selects the recipe there; it never +crafts. Without ClassicAPI the finder lists the recipes of the profession +window that is open. + +![A potion in your bags, and the Alchemy recipe that makes it](screenshots/finder-recipes.png) + +### Tracking + +With ClassicAPI, your tracking spells (Find Herbs, Find Minerals...), and +whether each one is on. Enter turns it on or off. + +![Find Herbs, on: Enter turns it off](screenshots/finder-tracking.png) + +## Change the key + +Press **Esc**, click **VimWow Options** (the options window VimFinder +shares with the other Vim mods), and open the **Finder** tab at the bottom. +Its Bindings page has **Open the finder**: + +![The Finder tab: set a key, a second key, the default, or turn it off](screenshots/finder-settings.png) + +- Click the key to set a new one, or **Set key 2** for a second key. +- **Default** goes back to Alt+Space. **Off** binds no key. + +**Esc > Key Bindings** lists Open the finder under VimFinder too. Without +ClassicAPI the key you set on the Finder tab is saved there: VimFinder only +takes a key nothing else is bound to, and gives a key back when you change +it on the Finder tab. With ClassicAPI the key stays out of your game key +bindings, and a key saved there by a start without ClassicAPI is given +back. + +## With ClassicAPI + +`ClassicAPI.dll` is optional. With it the finder: + +- lists the recipes of every profession, their windows closed; +- lists your tracking spells and turns them on or off; +- casts helpful spells on yourself; +- keeps its key apart from your game key bindings. + +## Even better with VimBag and VimWow + +VimFinder works alone. Two other mods of the same family take it further; +each is optional and installs the same way. + +**VimBag**, one bag for all your bags, run from the keyboard: Enter on a +bag item opens VimBag with that item selected, and VimBag's search matches +the way the finder does. + +![Enter on Hearthstone: VimBag opens with it selected](screenshots/with-vimbag.png) + +**VimWow**, keyboard control of the game's windows: a window the finder +opens gets VimWow's keyboard focus, so you go on in it by keyboard. Enter +on a recipe of the open profession window selects it there, and VimWow +puts a key beside every row. + +![Enter on Linen Bag: the Tailoring window selects it, a key beside every recipe](screenshots/with-vimwow.png) + +> **Warning: VimWow is far more than a boost for the finder.** It moves +> the whole game to the keyboard. It takes over many of your keys, +> movement, targeting and interaction among them, and changes how you use +> every window. It also needs `ClassicAPI.dll`. Install it only if you want +> that overhaul; VimFinder and VimBag do not need it. + +All three together: a profession window, VimBag and the finder, which finds +the recipes and the bag items in one search, with VimWow's key list at the +top right. + +![Searching woolen with Tailoring and VimBag open](screenshots/all-together.png) diff --git a/VimFinder.toc b/VimFinder.toc new file mode 100644 index 0000000..797ab48 --- /dev/null +++ b/VimFinder.toc @@ -0,0 +1,15 @@ +## Interface: 11200 +## Title: VimFinder |cff808080by Lupo|r +## Notes: Search your spells, tracking, recipes, bag items and windows by name, and use them by keyboard. +## Author: Lupo +# ## Version: 0.1.10 +# ## Version: 0.1.11 +# ## Version: 0.1.12 +# ## Version: 0.1.13 +# ## Version: 0.1.14 +# ## Version: 0.1.15 +## Version: 0.1.18 +## SavedVariables: VimFinderDB +## Dependencies: VimWowSettings + +finder.lua diff --git a/finder.lua b/finder.lua new file mode 100644 index 0000000..01637b7 --- /dev/null +++ b/finder.lua @@ -0,0 +1,1162 @@ +-- Search the player's known and currently exposed game content. +-- Nothing in this module scans the full spell database or chooses an item. +-- -- VimFinder is a standalone addon: it needs only the client. Another addon +-- -- (VimWow) may replace the hooks below to fit the finder into its own +-- -- keys, bag and window focus. +-- VimFinder is a standalone addon: it needs only the client and the shared +-- options window (VimWowSettings), where its tab sets its key. Another addon +-- (VimWow) may replace the hooks below to fit the finder into its bag and +-- window focus. +-- VimWowFinder = {} +-- local Finder = VimWowFinder +-- Finder.owner = CreateFrame("Frame", "VimWowFinderOwner", UIParent) +-- Finder.capture = CreateFrame("Frame", "VimWowFinderCapture", UIParent) +-- Finder.toggle = CreateFrame("Button", "VimWowFinderToggle", UIParent) +-- Finder.closeButton = CreateFrame("Button", "VimWowFinderClose", UIParent) +-- Finder.up = CreateFrame("Button", "VimWowFinderUp", UIParent) +-- Finder.down = CreateFrame("Button", "VimWowFinderDown", UIParent) +VimFinder = {} +local Finder = VimFinder +Finder.owner = CreateFrame("Frame", "VimFinderOwner", UIParent) +Finder.capture = CreateFrame("Frame", "VimFinderCapture", UIParent) +Finder.toggle = CreateFrame("Button", "VimFinderToggle", UIParent) +Finder.closeButton = CreateFrame("Button", "VimFinderClose", UIParent) +Finder.up = CreateFrame("Button", "VimFinderUp", UIParent) +Finder.down = CreateFrame("Button", "VimFinderDown", UIParent) +Finder.results = {} +Finder.rows = {} + +-- -- The key binding window lists the finder under its own header. +-- BINDING_HEADER_VIMFINDER = "VimFinder" +-- BINDING_NAME_VIMFINDER = "Open the finder" +-- -- Alt+Space opens the finder until the player binds the finder a key of +-- -- their own in the key binding window. +-- The finder's key is set on its tab in VimWow Settings, which names it +-- by this; the game's key binding window does not list it. +-- BINDING_NAME_VIMFINDER = "Open the finder" +-- The finder's key is set on its tab in VimWow Settings. Without +-- ClassicAPI's override bindings that key is a game key binding to the +-- Bindings.xml command, which the key binding window lists too. +BINDING_HEADER_VIMFINDER = "VimFinder" +BINDING_NAME_VIMFINDER = "Open the finder" +local DEFAULT_KEYS = {"ALT-SPACE"} + +-- Hooks. Alone, the finder takes its keys unless a key is being set in +-- VimWow Settings, opens the bags and claims no window focus. +function Finder:IsActive() + -- return true + return not VimWowBindingsCapturing +end +-- The keys the finder binds itself while closed, as first, second: those +-- set on its tab in VimWow Settings, else Alt+Space. +function Finder:OpenKeys() + -- if type(GetBindingKey) == "function" and GetBindingKey("VIMFINDER") then + -- return nil, nil + -- end + -- return DEFAULT_KEYS[1], DEFAULT_KEYS[2] + if VimWowSettings and VimWowSettings.BindingKeys then + return VimWowSettings:BindingKeys("VimFinder", "VIMFINDER", DEFAULT_KEYS) + end + return DEFAULT_KEYS[1], DEFAULT_KEYS[2] +end +-- A choice is about to open a window (now, or once the server answers +-- within the given seconds). +function Finder:ExpectWindow(seconds) +end +-- Opens the bags, before the finder closes. Opening, never toggling, keeps +-- an open bag open. +function Finder:ShowBags() + if type(OpenBackpack) == "function" then OpenBackpack() end + if type(OpenBag) == "function" and type(GetContainerNumSlots) == "function" then + for bag = 1, 4 do + if (GetContainerNumSlots(bag) or 0) > 0 then OpenBag(bag) end + end + end +end +-- After the finder closed on a bag choice: the item's bag and slot, or +-- nothing for Disenchant, whose item the player picks. +function Finder:SelectBagSlot(bag, slot) +end + +local function visible(name) + local frame = getglobal(name) + return frame and frame:IsVisible() +end + +local function inCombat() + return type(UnitAffectingCombat) == "function" + and UnitAffectingCombat("player") +end + +local function add(list, kind, name, detail, index, book) + if name and name ~= "" then + local item = {kind = kind, name = name, detail = detail or kind, + index = index, book = book} + table.insert(list, item) + return item + end +end + +-- local professions = {"Alchemy", "Blacksmithing", "Cooking", "Enchanting", +-- "Engineering", "First Aid", "Leatherworking", "Tailoring"} +-- Fishing casts toward the player's facing and needs no target. +local professions = {"Alchemy", "Blacksmithing", "Cooking", "Enchanting", + "Engineering", "First Aid", "Fishing", "Leatherworking", "Tailoring"} + +-- These spellbook entries are combat controls or require a chosen target. +-- They add noise to a finder intended for inspection and safe utility casts. +local hiddenSpells = {attack = true, shoot = true, attach = true, + ["auto attack"] = true, ["auto shot"] = true} + +-- -- The spell API does not identify target-free casts. Keep this list narrow: +-- -- these summon a companion beside the player, with no unit or ground target. +-- local companionSummons = {["summon imp"] = true, +-- ["summon voidwalker"] = true, ["summon succubus"] = true, +-- ["summon incubus"] = true, ["summon felhunter"] = true, +-- ["summon felguard"] = true} +-- The spell API does not identify target-free casts. Keep this list narrow: +-- these summon a companion or place an object beside the player, with no +-- unit or ground target. +local companionSummons = {["summon imp"] = true, + ["summon voidwalker"] = true, ["summon succubus"] = true, + ["summon incubus"] = true, ["summon felhunter"] = true, + ["summon felguard"] = true, ["basic campfire"] = true} + +local function isProfession(name) + for _, profession in ipairs(professions) do + if name == profession or name == getglobal(string.upper( + string.gsub(profession, " ", "_"))) then return true end + end +end + +local function canActivate(item) + -- if item.kind == "tracking" or item.kind == "trade" + -- or item.kind == "craft" then return true end + -- if item.kind == "tracking" or item.kind == "trade" + -- or item.kind == "craft" or item.kind == "bag" then return true end + -- if item.kind == "tracking" or item.kind == "trade" + -- or item.kind == "craft" or item.kind == "bag" + -- or item.kind == "window" then return true end + if item.kind == "tracking" or item.kind == "trade" + or item.kind == "craft" or item.kind == "bag" + or item.kind == "window" or item.kind == "recipe" then return true end + if item.kind ~= "spell" then return false end + if hiddenSpells[string.lower(item.name)] then return false end + if item.name == "Disenchant" or isProfession(item.name) then return true end + if type(IsPassiveSpell) == "function" + and IsPassiveSpell(item.index, "spell") then return false end + if type(IsHarmfulSpell) == "function" + and IsHarmfulSpell(item.index, "spell") then return false end + if companionSummons[string.lower(item.name)] then return true end + local spellID + if type(GetSpellInfo) == "function" then + local _, _, _, _, _, _, _, _, _, id = GetSpellInfo(item.index, "spell") + spellID = id + end + if C_Spell and type(C_Spell.IsSelfBuff) == "function" and spellID + and C_Spell.IsSelfBuff(spellID) then return true end + if type(IsHelpfulSpell) == "function" + and type(IsHarmfulSpell) == "function" + and IsHelpfulSpell(item.index, "spell") then + return "self" + end + return false +end + +-- Every known recipe of the character's professions, their windows open +-- or not (the user, 2026-10-18: derived from the professions the +-- character has, never listed by hand). With ClassicAPI: a profession is a +-- spellbook spell whose skill line (C_SpellBook.GetSpellSkillLine) the +-- character has (GetSkillLineRank) and that has craftable recipes +-- (C_TradeSkillUI.GetTradeSkillListRecipes, the line's full list from the +-- client's data); the recipes known are IsPlayerSpell's. A scan runs at +-- each opening, so a recipe learned since shows at once. +local recipeLines = {} -- skillID -> {{spellID, createdItem}, ...}, read once +local skillOfSpell = {} -- spellID -> {skillID, line name} or false, read once +local function recipeAPI() + return C_SpellBook and type(C_SpellBook.GetSpellSkillLine) == "function" + and type(C_SpellBook.GetSkillLineRank) == "function" + and C_TradeSkillUI and type(C_TradeSkillUI.GetTradeSkillListRecipes) == "function" + and type(GetSpellInfo) == "function" and type(IsPlayerSpell) == "function" +end + +local function lineRecipes(skillID) + if recipeLines[skillID] == nil then + local recipes = {} + for _, row in ipairs(C_TradeSkillUI.GetTradeSkillListRecipes(skillID, "") or {}) do + local spellID = row.spellID or row[1] + -- if spellID then + -- A recipe has skill-up levels; a class line's item spells + -- (Demonology's Create Soulstone) have none, so that line is no + -- profession and Enter never casts one of its spells to open + -- it (FD11, 2026-10-24). VimWow's native recipe icons take the + -- same rows. + local grey = row.trivialLevel or row[3] or 0 + local green = row.greenLevel or row[4] or 0 + if spellID and (grey > 0 or green > 0) then + table.insert(recipes, {spellID = spellID, createdItem = row.createdItem or row[5]}) + end + end + recipeLines[skillID] = recipes + end + return recipeLines[skillID] +end + +-- The professions with recipes among the spellbook's spells (list's +-- "spell" entries): {{name, skillID, slot}, ...}, the spell named as its +-- line (Cooking, not Basic Campfire) opening the window. +local function professionLines(list) + local lines, byID = {}, {} + if not recipeAPI() then return lines end + for _, item in ipairs(list) do + if item.kind == "spell" then + local _, _, _, _, _, _, _, _, _, spellID = GetSpellInfo(item.index, "spell") + if spellID and skillOfSpell[spellID] == nil then + local lineName, skillID = C_SpellBook.GetSpellSkillLine(spellID) + skillOfSpell[spellID] = skillID and {skillID, lineName} or false + end + local skill = spellID and skillOfSpell[spellID] + if skill and C_SpellBook.GetSkillLineRank(skill[1]) + and table.getn(lineRecipes(skill[1])) > 0 then + local line = byID[skill[1]] + if not line then + line = {name = skill[2] or item.name, skillID = skill[1], slot = item.index} + byID[skill[1]] = line + table.insert(lines, line) + end + if item.name == skill[2] then line.slot = item.index end + end + end + end + return lines +end +Finder.ProfessionLines = professionLines + +function Finder:Scan() + local list = {} + if type(GetNumSpellTabs) == "function" and type(GetSpellTabInfo) == "function" + and type(GetSpellName) == "function" then + for tab = 1, GetNumSpellTabs() or 0 do + local _, _, offset, count = GetSpellTabInfo(tab) + for slot = (offset or 0) + 1, (offset or 0) + (count or 0) do + local name, rank = GetSpellName(slot, "spell") + local detail = "Known spell" + if rank and rank ~= "" then detail = detail .. " · " .. rank end + if name and not hiddenSpells[string.lower(name)] then + add(list, "spell", name, detail, slot, "spell") + end + end + end + end + if type(HasPetSpells) == "function" and type(GetSpellName) == "function" then + local count = HasPetSpells() + if type(count) == "number" then + local book = BOOKTYPE_PET or "pet" + for slot = 1, count do + local name, rank = GetSpellName(slot, book) + local detail = "Known pet spell" + if rank and rank ~= "" then detail = detail .. " · " .. rank end + add(list, "petspell", name, detail, slot, book) + end + end + end + if type(GetNumTrackingTypes) == "function" + and type(GetTrackingInfo) == "function" then + for i = 1, GetNumTrackingTypes() or 0 do + local name, _, active, _, spellID = GetTrackingInfo(i) + local tracker = add(list, "tracking", name, + active and "Tracking is on · Enter to turn off" + or "Tracking is off · Enter to turn on", i, spellID) + if tracker then + tracker.active = active + for _, spell in ipairs(list) do + if spell.kind == "spell" and spell.name == name then + tracker.spellSlot = spell.index + break + end + end + end + end + end + if visible("TradeSkillFrame") and type(GetNumTradeSkills) == "function" + and type(GetTradeSkillInfo) == "function" then + for i = 1, GetNumTradeSkills() or 0 do + local name, kind = GetTradeSkillInfo(i) + if kind ~= "header" then + add(list, "trade", name, "Profession recipe · Enter to select", i) + end + end + end + if visible("CraftFrame") and type(GetNumCrafts) == "function" + and type(GetCraftInfo) == "function" then + for i = 1, GetNumCrafts() or 0 do + local name, _, kind = GetCraftInfo(i) + if kind ~= "header" then + add(list, "craft", name, "Craft recipe · Enter to select", i) + end + end + end + -- the known recipes of every profession (above), but those of the + -- window open, listed already + local listed = {} + for _, item in ipairs(list) do + if item.kind == "trade" or item.kind == "craft" then listed[item.name] = true end + end + for _, line in ipairs(professionLines(list)) do + for _, recipe in ipairs(lineRecipes(line.skillID)) do + if IsPlayerSpell(recipe.spellID) then + local name = GetSpellInfo(recipe.spellID) + if name and not listed[name] then + listed[name] = true + local item = add(list, "recipe", name, line.name .. " recipe · Enter to open", + recipe.spellID, line.slot) + if item then item.createdItem = recipe.createdItem end + end + end + end + end + if type(GetContainerNumSlots) == "function" + and type(GetContainerItemLink) == "function" then + for bag = 0, 4 do + for slot = 1, GetContainerNumSlots(bag) or 0 do + local link = GetContainerItemLink(bag, slot) + -- local name = link and string.match(link, "%[([^%]]+)%]") + -- Lua 5.0 has no string.match (ClassicAPI adds it). + local _, _, name = string.find(link or "", "%[([^%]]+)%]") + -- if name then add(list, "bag", name, + -- "In bag " .. bag .. ", slot " .. slot, slot, bag) end + if name then add(list, "bag", name, "In bag " .. bag + .. ", slot " .. slot .. " · Enter to show", slot, bag) end + end + end + end + -- Every window the client's key bindings open, keyed or not: the + -- toggles under the Interface header of its key binding list, by the + -- client's own names. + if type(GetNumBindings) == "function" and type(GetBinding) == "function" + and type(RunBinding) == "function" then + local header + for i = 1, GetNumBindings() or 0 do + local command = GetBinding(i) + if command and string.sub(command, 1, 6) == "HEADER" then + header = command + elseif command and header == "HEADER_INTERFACE" + and (string.find(command, "^TOGGLE") or string.find(command, "^OPEN")) then + add(list, "window", getglobal("BINDING_NAME_" .. command) or command, + "Window · Enter to open or close", i, command) + end + end + end + self.catalog = list + self:Search() +end + +-- A contiguous match ranks ahead of initials/subsequence matches. +local function score(name, query) + if query == "" then return 0 end + local lower = string.lower(name) + local start = string.find(lower, query, 1, true) + if start then return 100 - start end + local from, gaps = 1, 0 + for i = 1, string.len(query) do + local found = string.find(lower, string.sub(query, i, i), from, true) + if not found then return nil end + gaps = gaps + found - from + from = found + 1 + end + return 20 - gaps +end +-- The bag search highlights slots with the same fuzzy match. +Finder.Score = score + +-- Use a content identity rather than a spell slot or bag position, which can +-- change between sessions. Kind keeps similarly named actions separate. +local function usageKey(item) + return item.kind .. ":" .. item.name +end + +-- local function useCount(item) +-- local counts = type(VimWowDB) == "table" and VimWowDB.finderUsage +local function useCount(item) + local counts = type(VimFinderDB) == "table" and VimFinderDB.usage + local count = type(counts) == "table" and counts[usageKey(item)] + return type(count) == "number" and count > 0 and count or 0 +end + +-- function Finder:RecordUse(item) +-- if type(VimWowDB) ~= "table" then return end +-- if type(VimWowDB.finderUsage) ~= "table" then +-- VimWowDB.finderUsage = {} +-- end +-- local key = usageKey(item) +-- VimWowDB.finderUsage[key] = useCount(item) + 1 +-- end +-- How often each choice was used, saved per account in VimFinderDB. +function Finder:RecordUse(item) + if type(VimFinderDB) ~= "table" then VimFinderDB = {} end + if type(VimFinderDB.usage) ~= "table" then + VimFinderDB.usage = {} + end + local key = usageKey(item) + VimFinderDB.usage[key] = useCount(item) + 1 +end + +function Finder:Search() + local query = string.lower(self.edit:GetText() or "") + local matches = {} + for _, item in ipairs(self.catalog or {}) do + local rank = score(item.name, query) + if rank then + item.usage = useCount(item) + -- Familiar choices can break close search matches, but cannot + -- overtake a much better text match. + item.score = rank + (query ~= "" and math.min(item.usage * 2, 10) or 0) + table.insert(matches, item) + end + end + table.sort(matches, function(a, b) + if query == "" and a.usage ~= b.usage then + return a.usage > b.usage + end + if a.score ~= b.score then return a.score > b.score end + if a.usage ~= b.usage then return a.usage > b.usage end + if a.name ~= b.name then return a.name < b.name end + if a.kind ~= b.kind then + if a.kind == "tracking" then return true end + if b.kind == "tracking" then return false end + end + return a.kind < b.kind + end) + self.results = matches + self.selected = 1 + self:Draw() +end + +function Finder:Tooltip(item) + if not GameTooltip then return end + GameTooltip:SetOwner(self.frame, "ANCHOR_NONE") + GameTooltip:ClearAllPoints() + GameTooltip:SetPoint("BOTTOMLEFT", self.frame, "BOTTOMRIGHT", 12, 0) + local shown, supported + if (item.kind == "spell" or item.kind == "petspell") + and GameTooltip.SetSpell then + supported = true + shown = GameTooltip:SetSpell(item.index, item.book) + elseif item.kind == "tracking" and item.spellSlot + and GameTooltip.SetSpell then + supported = true + shown = GameTooltip:SetSpell(item.spellSlot, "spell") + elseif item.kind == "tracking" and item.book + and GameTooltip.SetSpellByID then + supported = true + shown = GameTooltip:SetSpellByID(item.book) + elseif item.kind == "trade" and GameTooltip.SetTradeSkillItem then + supported = true + shown = GameTooltip:SetTradeSkillItem(item.index) + elseif item.kind == "craft" and GameTooltip.SetCraftSpell then + supported = true + shown = GameTooltip:SetCraftSpell(item.index) + elseif item.kind == "bag" and GameTooltip.SetBagItem then + supported = true + shown = GameTooltip:SetBagItem(item.book, item.index) + -- a recipe: the item it makes, else the recipe's spell + elseif item.kind == "recipe" and item.createdItem and item.createdItem > 0 + and GameTooltip.SetHyperlink then + supported = true + shown = GameTooltip:SetHyperlink("item:" .. item.createdItem .. ":0:0:0") + elseif item.kind == "recipe" and GameTooltip.SetSpellByID then + supported = true + shown = GameTooltip:SetSpellByID(item.index) + end + if not supported or shown == false then + if GameTooltip.SetText then GameTooltip:SetText(item.name) end + if GameTooltip.AddLine then GameTooltip:AddLine(item.detail) end + end + GameTooltip:Show() +end + +-- The window's layout: the dialog look of the Game Menu and popups. +local WIDTH, HEIGHT = 520, 300 +local ROW_LEFT, ROW_TOP, ROW_HEIGHT = 26, 60, 24 +local ROW_WIDTH = WIDTH - 2 * ROW_LEFT +local WINDOW_ICON = "Interface\\Icons\\INV_Misc_Book_09" +local UNKNOWN_ICON = "Interface\\Icons\\INV_Misc_QuestionMark" + +-- Each result's icon, as the client's own windows show it. +local function iconFor(item) + local texture + if (item.kind == "spell" or item.kind == "petspell") + and type(GetSpellTexture) == "function" then + texture = GetSpellTexture(item.index, item.book) + elseif item.kind == "tracking" and type(GetTrackingInfo) == "function" then + local _ + _, texture = GetTrackingInfo(item.index) + elseif item.kind == "trade" and type(GetTradeSkillIcon) == "function" then + texture = GetTradeSkillIcon(item.index) + elseif item.kind == "craft" and type(GetCraftIcon) == "function" then + texture = GetCraftIcon(item.index) + elseif item.kind == "bag" and type(GetContainerItemInfo) == "function" then + texture = GetContainerItemInfo(item.book, item.index) + elseif item.kind == "window" then + texture = WINDOW_ICON + -- elseif item.kind == "recipe" and type(GetSpellInfo) == "function" then + -- local _ + -- _, _, texture = GetSpellInfo(item.index) + -- A recipe shows the item it makes, as the profession window does: many + -- crafting spells have only the client's placeholder face as their own + -- icon. The spell's icon is kept for a recipe that makes no item + -- (enchanting) or whose item the client has not cached yet. + elseif item.kind == "recipe" then + local _ + if item.createdItem and item.createdItem > 0 and type(GetItemInfo) == "function" then + _, _, _, _, _, _, _, _, texture = GetItemInfo(item.createdItem) + end + if not texture and type(GetSpellInfo) == "function" then + _, _, texture = GetSpellInfo(item.index) + end + end + return texture or UNKNOWN_ICON +end + +-- function Finder:Draw() +-- local count = table.getn(self.results) +-- if self.selected > count then self.selected = count end +-- if self.selected < 1 then self.selected = 1 end +-- local first = math.max(1, self.selected - 5) +-- self.selectionBackground:Hide() +-- for i, row in ipairs(self.rows) do +-- local item = self.results[first + i - 1] +-- if item then +-- row:SetText((first + i - 1 == self.selected and "> " or " ") +-- .. item.name .. " — " .. item.detail) +-- if canActivate(item) then row:SetTextColor(1, 1, 1) +-- else row:SetTextColor(0.52, 0.52, 0.52) end +-- if first + i - 1 == self.selected then +-- self.selectionBackground:ClearAllPoints() +-- self.selectionBackground:SetPoint("TOPLEFT", self.frame, +-- "TOPLEFT", 13, -40 - i * 23 + 2) +-- self.selectionBackground:Show() +-- end +-- row:Show() +-- else row:Hide() end +-- end +-- Each row: the result's icon, its name in white (grey when Enter only +-- shows it), and what it is on the right; the gold quest log bar marks the +-- selected one. +function Finder:Draw() + local count = table.getn(self.results) + if self.selected > count then self.selected = count end + if self.selected < 1 then self.selected = 1 end + local first = math.max(1, self.selected - 5) + self.selectionBackground:Hide() + for i, row in ipairs(self.rows) do + local item = self.results[first + i - 1] + local detail, icon = self.details[i], self.icons[i] + if item then + row:SetText(item.name) + detail:SetText(item.detail) + icon:SetTexture(iconFor(item)) + if canActivate(item) then + row:SetTextColor(1, 1, 1) + detail:SetTextColor(0.65, 0.65, 0.65) + else + -- row:SetTextColor(0.52, 0.52, 0.52) + -- detail:SetTextColor(0.52, 0.52, 0.52) + -- A lighter grey, readable under the gold selection bar too. + row:SetTextColor(0.7, 0.7, 0.7) + detail:SetTextColor(0.7, 0.7, 0.7) + end + if first + i - 1 == self.selected then + self.selectionBackground:ClearAllPoints() + self.selectionBackground:SetPoint("TOPLEFT", self.frame, + "TOPLEFT", ROW_LEFT - 4, -ROW_TOP - (i - 1) * ROW_HEIGHT) + self.selectionBackground:Show() + end + row:Show(); detail:Show(); icon:Show() + else row:Hide(); detail:Hide(); icon:Hide() end + end + -- self.count:SetText(count .. " results") + self.count:SetText(count .. (count == 1 and " result" or " results")) + local selected = self.results[self.selected] + if selected then self:Tooltip(selected) + elseif GameTooltip and GameTooltip.IsOwned + and GameTooltip:IsOwned(self.frame) then GameTooltip:Hide() end +end + +function Finder:Move(delta) + if not self.frame:IsVisible() then return end + self.selected = math.max(1, math.min(table.getn(self.results), + (self.selected or 1) + delta)) + self:Draw() +end + +local function scrollRecipe(kind, index, total) + local frameName = kind == "trade" and "TradeSkillListScrollFrame" + or "CraftListScrollFrame" + local displayed = kind == "trade" and + (TRADE_SKILLS_DISPLAYED or 19) or (CRAFTS_DISPLAYED or 8) + local height = kind == "trade" and + (TRADE_SKILL_HEIGHT or 16) or (CRAFT_SKILL_HEIGHT or 16) + local scroll = getglobal(frameName) + if not scroll or type(FauxScrollFrame_GetOffset) ~= "function" + or type(FauxScrollFrame_SetOffset) ~= "function" then return end + local offset = FauxScrollFrame_GetOffset(scroll) or 0 + if index <= offset then offset = index - 1 + elseif index > offset + displayed then offset = index - displayed end + offset = math.max(0, math.min(total - displayed, offset)) + FauxScrollFrame_SetOffset(scroll, offset) + local bar = getglobal(frameName .. "ScrollBar") + if bar then bar:SetValue(offset * height) end +end + +-- A recipe chosen from a closed (or another) profession window: its +-- window opens, then the recipe is selected in it, as Enter on an open +-- window's recipe does. True once it is selected. +function Finder:SelectPendingRecipe() + local pending = self.pendingRecipe + if not pending then return false end + if visible("TradeSkillFrame") and type(GetNumTradeSkills) == "function" + and type(TradeSkillFrame_SetSelection) == "function" then + for i = 1, GetNumTradeSkills() or 0 do + local name, kind = GetTradeSkillInfo(i) + if kind ~= "header" and name == pending.name then + scrollRecipe("trade", i, GetNumTradeSkills()) + TradeSkillFrame_SetSelection(i) + if type(TradeSkillFrame_Update) == "function" then TradeSkillFrame_Update() end + self.pendingRecipe = nil + return true + end + end + end + if visible("CraftFrame") and type(GetNumCrafts) == "function" + and type(CraftFrame_SetSelection) == "function" then + for i = 1, GetNumCrafts() or 0 do + local name, _, kind = GetCraftInfo(i) + if kind ~= "header" and name == pending.name then + scrollRecipe("craft", i, GetNumCrafts()) + CraftFrame_SetSelection(i) + if type(CraftFrame_Update) == "function" then CraftFrame_Update() end + self.pendingRecipe = nil + return true + end + end + end + return false +end + +-- Waits for the window a recipe opened (its server answer), a few seconds. +local recipeWaiter = CreateFrame("Frame", "VimFinderRecipeWaiter", UIParent) +recipeWaiter:Hide() +recipeWaiter:SetScript("OnUpdate", function() + local pending = Finder.pendingRecipe + if not pending or GetTime() > pending.untilTime then + Finder.pendingRecipe = nil + recipeWaiter:Hide() + elseif Finder:SelectPendingRecipe() then + recipeWaiter:Hide() + end +end) + +function Finder:Activate() + local item = self.results[self.selected] + -- if not item or inCombat() then return end + -- -- Windows open in combat, as their keys do. + -- if not item or (inCombat() and item.kind ~= "window") then return end + -- Windows open and spells (pet spells, tracking) cast in combat, as + -- their keys do (the user, 2026-10-15: Rockbiter Weapon); bag items, + -- trade skills and crafts still wait. + local castable = item and (item.kind == "spell" or item.kind == "petspell" or item.kind == "tracking") + if not item or (inCombat() and item.kind ~= "window" and not castable) then return end + local action = canActivate(item) + if not action then return end + if item.kind == "window" then + self:RecordUse(item) + self:Close() + -- The window it opens takes focus; one it closes claims nothing. + -- if VimWowPanelFocus then VimWowPanelFocus:ClaimNext(0.5) end + self:ExpectWindow(0.5) + RunBinding(item.book) + elseif item.kind == "tracking" and item.active + and type(CancelTrackingBuff) == "function" then + CancelTrackingBuff() + self:RecordUse(item) + self:Scan() + elseif item.kind == "tracking" and type(SetTracking) == "function" then + SetTracking(item.index) + self:RecordUse(item) + self:Scan() + elseif item.kind == "trade" and visible("TradeSkillFrame") + and type(TradeSkillFrame_SetSelection) == "function" then + scrollRecipe("trade", item.index, GetNumTradeSkills()) + TradeSkillFrame_SetSelection(item.index) + if type(TradeSkillFrame_Update) == "function" then TradeSkillFrame_Update() end + self:RecordUse(item) + self:Close() + elseif item.kind == "craft" and visible("CraftFrame") + and type(CraftFrame_SetSelection) == "function" then + scrollRecipe("craft", item.index, GetNumCrafts()) + CraftFrame_SetSelection(item.index) + if type(CraftFrame_Update) == "function" then CraftFrame_Update() end + self:RecordUse(item) + self:Close() + elseif item.kind == "recipe" then + -- its profession's window (cast as Enter on the profession does), + -- then the recipe selected there; at once when it is open already + self.pendingRecipe = {name = item.name, untilTime = GetTime() + 3} + self:RecordUse(item) + self:Close() + if not self:SelectPendingRecipe() and type(CastSpell) == "function" then + self:ExpectWindow(3) + CastSpell(item.book, "spell") + recipeWaiter:Show() + end + -- elseif item.kind == "bag" then + -- -- Opens the combined bag with that item's slot selected. + -- if not VimWowCombinedBags then return end + -- VimWowCombinedBags:Show() + -- self:RecordUse(item) + -- self:Close() + -- if VimWowPanelFocus and VimWowPanelFocus.Select + -- and VimWowPanelFocus:Select("bags") and VimWowNavigator then + -- VimWowNavigator:Refresh() + -- VimWowNavigator:SelectBagSlot(item.book, item.index) + -- end + elseif item.kind == "bag" then + -- Opens the bags; a host (VimWow) selects that item's slot. + self:ShowBags() + self:RecordUse(item) + self:Close() + self:SelectBagSlot(item.book, item.index) + elseif item.kind == "spell" and item.name == "Disenchant" then + -- The player must click an item; never auto-select or destroy one. + if type(CastSpell) ~= "function" then return end + CastSpell(item.index, "spell") + self:RecordUse(item) + -- VimWowCombinedBags:Show() + -- self:Close() + -- if VimWowPanelFocus and VimWowPanelFocus.Select + -- and VimWowPanelFocus:Select("bags") + -- and VimWowNavigator then VimWowNavigator:Refresh() end + self:ShowBags() + self:Close() + self:SelectBagSlot() + elseif item.kind == "spell" and action == "self" then + if type(CastSpellByName) == "function" then + -- A spell that opens a window (Smelting, Poisons) gives it focus + -- once the server answers. + -- if VimWowPanelFocus then VimWowPanelFocus:ClaimNext(3) end + self:ExpectWindow(3) + CastSpellByName(item.name, true) + self:RecordUse(item) + self:Close() + end + elseif item.kind == "spell" and type(CastSpell) == "function" then + -- A profession (Tailoring, Enchanting) gives its window focus once + -- the server answers. + -- if VimWowPanelFocus then VimWowPanelFocus:ClaimNext(3) end + self:ExpectWindow(3) + CastSpell(item.index, "spell") + self:RecordUse(item) + self:Close() + end +end + +function Finder:KeyMove(key, delta) + local now = GetTime() + if self.lastKey == key and now - (self.lastKeyAt or 0) < 0.02 then return end + self.lastKey, self.lastKeyAt = key, now + self:Move(delta) +end + +function Finder:Close() + self.frame:Hide() + self.edit:ClearFocus() + self.capture:EnableKeyboard(false) + self.ctrlLeft, self.ctrlRight = nil, nil + self:RefreshBindings() + if GameTooltip and GameTooltip.IsOwned + and GameTooltip:IsOwned(self.frame) then GameTooltip:Hide() end +end + +function Finder:Toggle() + if self.frame:IsVisible() then return end + -- if not VimWow_IsEnabled() then return end + if not self:IsActive() then return end + local focus = GetCurrentKeyBoardFocus and GetCurrentKeyBoardFocus() + if focus and focus ~= self.edit then return end + self.frame:Show() + self:RefreshBindings() + self.edit:SetText("") + self:Scan() + self.edit:SetFocus() + self.ctrlLeft = IsLeftControlKeyDown and IsLeftControlKeyDown() or nil + self.ctrlRight = IsRightControlKeyDown and IsRightControlKeyDown() or nil + if self.ctrlLeft or self.ctrlRight then + self.edit:ClearFocus() + self.capture:EnableKeyboard(true) + end +end + +-- Finder.frame = CreateFrame("Frame", "VimWowFinderFrame", UIParent) +Finder.frame = CreateFrame("Frame", "VimFinderFrame", UIParent) +-- Finder.frame:SetWidth(600) +-- Finder.frame:SetHeight(260) +Finder.frame:SetWidth(WIDTH) +Finder.frame:SetHeight(HEIGHT) +Finder.frame:SetPoint("BOTTOM", UIParent, "BOTTOM", 0, 95) +-- Finder.frame:SetFrameStrata("DIALOG") +-- Over every window and unit frame (some unit frame bars draw above DIALOG), +-- under tooltips. +Finder.frame:SetFrameStrata("FULLSCREEN_DIALOG") +-- Finder.frame:SetBackdrop({bgFile = "Interface/Tooltips/UI-Tooltip-Background", +-- edgeFile = "Interface/Tooltips/UI-Tooltip-Border", edgeSize = 12, +-- insets = {left = 3, right = 3, top = 3, bottom = 3}}) +-- The dialog look of the Game Menu and the popups: dark marble, silver +-- border, and the title on a header plate. +Finder.frame:SetBackdrop({bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background", + edgeFile = "Interface\\DialogFrame\\UI-DialogBox-Border", + tile = true, tileSize = 32, edgeSize = 32, + insets = {left = 11, right = 12, top = 12, bottom = 11}}) +-- The marble lets about 40% of the world through; a black layer under it +-- (one layer below the finder, still over every window and unit frame) +-- leaves about 15%, enough to notice a change behind the finder. As the +-- finder's child it shows, hides and fades with it. +Finder.shade = CreateFrame("Frame", "VimFinderShade", Finder.frame) +Finder.shade:SetFrameStrata("FULLSCREEN") +Finder.shade:SetPoint("TOPLEFT", Finder.frame, "TOPLEFT", 11, -12) +Finder.shade:SetPoint("BOTTOMRIGHT", Finder.frame, "BOTTOMRIGHT", -12, 11) +Finder.shadeTexture = Finder.shade:CreateTexture(nil, "BACKGROUND") +Finder.shadeTexture:SetTexture("Interface/Buttons/WHITE8X8") +Finder.shadeTexture:SetVertexColor(0, 0, 0, 0.63) +Finder.shadeTexture:SetAllPoints(Finder.shade) +Finder.header = Finder.frame:CreateTexture(nil, "ARTWORK") +Finder.header:SetTexture("Interface\\DialogFrame\\UI-DialogBox-Header") +Finder.header:SetWidth(256) +Finder.header:SetHeight(64) +Finder.header:SetPoint("TOP", Finder.frame, "TOP", 0, 12) +Finder.title = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontNormal") +Finder.title:SetPoint("TOP", Finder.header, "TOP", 0, -14) +Finder.title:SetText("Finder") +-- Finder.selectionBackground = Finder.frame:CreateTexture(nil, "ARTWORK") +-- Finder.selectionBackground:SetTexture("Interface/Buttons/WHITE8X8") +-- Finder.selectionBackground:SetVertexColor(0.03, 0.03, 0.03, 0.55) +-- Finder.selectionBackground:SetWidth(574) +-- Finder.selectionBackground:SetHeight(22) +-- The quest log's selection bar, in gold. +Finder.selectionBackground = Finder.frame:CreateTexture(nil, "ARTWORK") +Finder.selectionBackground:SetTexture("Interface\\QuestFrame\\UI-QuestTitleHighlight") +Finder.selectionBackground:SetBlendMode("ADD") +Finder.selectionBackground:SetVertexColor(1, 0.82, 0, 1) +Finder.selectionBackground:SetWidth(ROW_WIDTH + 8) +Finder.selectionBackground:SetHeight(ROW_HEIGHT) +Finder.selectionBackground:Hide() +Finder.capture:SetFrameStrata("TOOLTIP") +Finder.capture:EnableKeyboard(false) +-- Finder.edit = CreateFrame("EditBox", "VimWowFinderInput", Finder.frame, +-- "InputBoxTemplate") +Finder.edit = CreateFrame("EditBox", "VimFinderInput", Finder.frame, + "InputBoxTemplate") +Finder.edit:SetAutoFocus(false) +-- Finder.edit:SetWidth(550) +-- Finder.edit:SetHeight(28) +-- Finder.edit:SetPoint("TOP", Finder.frame, "TOP", 0, -15) +-- The template's left cap reaches 5 pixels left of the box. +Finder.edit:SetWidth(ROW_WIDTH - 13) +Finder.edit:SetHeight(20) +Finder.edit:SetPoint("TOPLEFT", Finder.frame, "TOPLEFT", ROW_LEFT + 9, -30) +-- Finder.count = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontNormalSmall") +-- Finder.count:SetPoint("BOTTOMRIGHT", Finder.frame, "BOTTOMRIGHT", -15, 10) +Finder.count = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontNormalSmall") +Finder.count:SetPoint("BOTTOMRIGHT", Finder.frame, "BOTTOMRIGHT", -ROW_LEFT, 20) +-- The keys, in green, as the client's own key labels. +Finder.hints = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontHighlightSmall") +Finder.hints:SetPoint("BOTTOMLEFT", Finder.frame, "BOTTOMLEFT", ROW_LEFT, 20) +Finder.hints:SetTextColor(0.65, 0.65, 0.65) +Finder.hints:SetText("|cff00ff00Enter|r Use |cff00ff00Tab|r / " + .. "|cff00ff00Ctrl+J/K|r Move |cff00ff00Esc|r Close") +Finder.details = {} +Finder.icons = {} +-- for i = 1, 8 do +-- local row = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontNormalSmall") +-- row:SetPoint("TOPLEFT", Finder.frame, "TOPLEFT", 18, -40 - i * 23) +-- row:SetWidth(560) +-- Finder.rows[i] = row +-- end +for i = 1, 8 do + local top = -ROW_TOP - (i - 1) * ROW_HEIGHT + local icon = Finder.frame:CreateTexture(nil, "OVERLAY") + icon:SetWidth(20) + icon:SetHeight(20) + icon:SetPoint("TOPLEFT", Finder.frame, "TOPLEFT", ROW_LEFT, top - 2) + icon:SetTexCoord(0.08, 0.92, 0.08, 0.92) + Finder.icons[i] = icon + local row = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontHighlight") + row:SetPoint("TOPLEFT", Finder.frame, "TOPLEFT", ROW_LEFT + 28, top - 6) + row:SetWidth(ROW_WIDTH / 2 - 28) + row:SetHeight(14) + row:SetJustifyH("LEFT") + Finder.rows[i] = row + local detail = Finder.frame:CreateFontString(nil, "OVERLAY", "GameFontHighlightSmall") + detail:SetPoint("TOPRIGHT", Finder.frame, "TOPRIGHT", -ROW_LEFT - 2, top - 7) + detail:SetWidth(ROW_WIDTH / 2) + detail:SetHeight(12) + detail:SetJustifyH("RIGHT") + Finder.details[i] = detail +end +Finder.edit:SetScript("OnTextChanged", function() Finder:Search() end) +Finder.edit:SetScript("OnEscapePressed", function() Finder:Close() end) +Finder.edit:SetScript("OnEnterPressed", function() Finder:Activate() end) +Finder.edit:SetScript("OnTabPressed", function() + Finder:Move(IsShiftKeyDown and IsShiftKeyDown() and -1 or 1) +end) +-- The 1.12 EditBox consumes arrows before OnKeyDown in the stock client. +-- Keep this route for clients that forward them; Tab is the native fallback. +Finder.edit:SetScript("OnKeyDown", function(_, key) + -- The 1.12 client passes the key in arg1 (ClassicAPI also passes it). + key = key or arg1 + if key == "UP" then Finder:Move(-1) + elseif key == "DOWN" then Finder:Move(1) + elseif key == "J" and IsControlKeyDown and IsControlKeyDown() then + Finder:Move(1) + elseif key == "K" and IsControlKeyDown and IsControlKeyDown() then + Finder:Move(-1) + end +end) +Finder.capture:SetScript("OnKeyDown", function(_, key) + key = key or arg1 + if not Finder.frame:IsVisible() or not (Finder.ctrlLeft or Finder.ctrlRight) + then return end + if key == "J" or key == "DOWN" then Finder:KeyMove("next", 1) + elseif key == "K" or key == "UP" then Finder:KeyMove("previous", -1) + elseif key == "ESCAPE" then Finder:Close() + elseif key == "ENTER" then Finder:Activate() end +end) +Finder.toggle:SetScript("OnClick", function() Finder:Toggle() end) +Finder.closeButton:SetScript("OnClick", function() Finder:Close() end) +Finder.up:SetScript("OnClick", function() Finder:KeyMove("previous", -1) end) +Finder.down:SetScript("OnClick", function() Finder:KeyMove("next", 1) end) +Finder.frame:Hide() + +-- Whether the finder may be open and take its keys: its host allows it and +-- no other text box has the keyboard. +function Finder:Allowed() + if not self:IsActive() then return false end + local focus = GetCurrentKeyBoardFocus and GetCurrentKeyBoardFocus() + return not (focus and focus ~= self.edit) +end + +-- function Finder:RefreshBindings(active) +-- if active == nil then +-- active = VimWow_IsEnabled() and not VimWowBindingsCapturing +-- and type(SetOverrideBindingClick) == "function" +-- and type(ClearOverrideBindings) == "function" +-- local focus = GetCurrentKeyBoardFocus and GetCurrentKeyBoardFocus() +-- if focus and focus ~= self.edit then active = false end +-- end +-- local binding = active and VimWow_BindingSignature("VIMWOWFINDER", +-- {"ALT-SPACE"}) or "" +-- Override bindings come from ClassicAPI; without them the finder still +-- opens from its key binding and keeps Esc, Enter, Tab and Ctrl+J/K. +-- Without ClassicAPI's override bindings the keys set on the finder's tab +-- are game key bindings to its Bindings.xml command: a key is taken only +-- while no other binding has it, and a key the tab no longer names is given +-- back. VimFinderDB.gameKeys keeps the keys bound this way. Nothing is set +-- before the client's own bindings have loaded (PLAYER_ENTERING_WORLD). +function Finder:ApplyGameBindings(first, second) + if type(SetBinding) ~= "function" or type(GetBindingAction) ~= "function" then + return + end + if type(VimFinderDB) ~= "table" then VimFinderDB = {} end + if type(VimFinderDB.gameKeys) ~= "table" then VimFinderDB.gameKeys = {} end + local held = VimFinderDB.gameKeys + local wanted = {} + if first then wanted[first] = true end + if second then wanted[second] = true end + local changed = false + for key in pairs(held) do + if not wanted[key] then + if GetBindingAction(key) == "VIMFINDER" then + SetBinding(key) + changed = true + end + held[key] = nil + end + end + for key in pairs(wanted) do + local action = GetBindingAction(key) + if action == nil or action == "" then + SetBinding(key, "VIMFINDER") + changed = true + held[key] = true + elseif action == "VIMFINDER" then + held[key] = true + end + end + if changed and type(SaveBindings) == "function" then + SaveBindings(type(GetCurrentBindingSet) == "function" + and GetCurrentBindingSet() or 1) + end +end + +function Finder:RefreshBindings(active) + if type(SetOverrideBindingClick) ~= "function" then + if not self.bindingsReadyAt or GetTime() < self.bindingsReadyAt then return end + local first, second = self:OpenKeys() + local wanted = tostring(first) .. "," .. tostring(second) + if wanted ~= self.gameBinding then + self.gameBinding = wanted + self:ApplyGameBindings(first, second) + end + return + end + -- With ClassicAPI the key is an override binding. The game key bindings + -- the finder set in a session without it are given back once: kept, + -- the old key still opened the finder after a key change on the Finder + -- tab. Bindings the player set in the key binding window stay. + if not self.gameKeysReleased and self.bindingsReadyAt and GetTime() >= self.bindingsReadyAt then + self.gameKeysReleased = true + self:ApplyGameBindings(nil, nil) + end + if active == nil then active = self:Allowed() end + active = active and type(SetOverrideBindingClick) == "function" + and type(ClearOverrideBindings) == "function" + local first, second + if active then first, second = self:OpenKeys() end + local binding = active and (tostring(first) .. "," .. tostring(second)) or "" + if active and self.frame:IsVisible() then binding = binding .. ":navigation" end + if binding == self.binding then return end + if type(ClearOverrideBindings) == "function" then + ClearOverrideBindings(self.owner) + end + if active then + -- VimWow_Override(self.owner, "VIMWOWFINDER", + -- {"ALT-SPACE"}, self.toggle, true) + local toggle = self.toggle:GetName() + if first then SetOverrideBindingClick(self.owner, true, first, toggle) end + if second then SetOverrideBindingClick(self.owner, true, second, toggle) end + if self.frame:IsVisible() then + SetOverrideBindingClick(self.owner, true, "ESCAPE", + self.closeButton:GetName()) + SetOverrideBindingClick(self.owner, true, "CTRL-K", self.up:GetName()) + SetOverrideBindingClick(self.owner, true, "CTRL-J", self.down:GetName()) + SetOverrideBindingClick(self.owner, true, "CTRL-UP", self.up:GetName()) + SetOverrideBindingClick(self.owner, true, "CTRL-DOWN", self.down:GetName()) + end + end + self.binding = binding +end + +Finder.owner:SetScript("OnUpdate", function() + -- Ctrl was released last frame (MODIFIER_STATE_CHANGED): typing again. + if Finder.refocus then + Finder.refocus = nil + if Finder.frame:IsVisible() and not (Finder.ctrlLeft or Finder.ctrlRight) then + Finder.capture:EnableKeyboard(false) + Finder.edit:SetFocus() + end + end + -- Without ClassicAPI (which brings IsLeftControlKeyDown and the + -- MODIFIER_STATE_CHANGED event) Ctrl is read each frame while the + -- finder is open, so Ctrl+J/K still move. + if type(IsLeftControlKeyDown) ~= "function" and Finder.frame:IsVisible() + and type(IsControlKeyDown) == "function" then + local held = IsControlKeyDown() and true or false + if held ~= ((Finder.ctrlLeft or Finder.ctrlRight) and true or false) then + Finder.ctrlLeft, Finder.ctrlRight = held or nil, nil + if held then + Finder.edit:ClearFocus() + Finder.capture:EnableKeyboard(true) + else + Finder.capture:EnableKeyboard(false) + Finder.edit:SetFocus() + end + end + end + local now = GetTime() + if now < (Finder.nextUpdate or 0) then return end + Finder.nextUpdate = now + 0.5 + -- local active = VimWow_IsEnabled() and not VimWowBindingsCapturing + -- and type(SetOverrideBindingClick) == "function" + -- and type(ClearOverrideBindings) == "function" + -- local focus = GetCurrentKeyBoardFocus and GetCurrentKeyBoardFocus() + -- if focus and focus ~= Finder.edit then active = false end + local active = Finder:Allowed() + if not active and Finder.frame:IsVisible() then Finder:Close() end + Finder:RefreshBindings(active) + if Finder.frame:IsVisible() then + -- Finder.frame:SetAlpha(inCombat() and 0.22 or 0.86) + -- Opaque out of combat: the dialog background's own see-through + -- shows enough of the world to notice a change there. + -- Finder.frame:SetAlpha(inCombat() and 0.22 or 1) + -- 60% in combat: 22% was too faint to read (the user, 2026-10-15). + Finder.frame:SetAlpha(inCombat() and 0.6 or 1) + end +end) +-- for _, event in ipairs({"SPELLS_CHANGED", "TRADE_SKILL_UPDATE", +-- "CRAFT_UPDATE", "BAG_UPDATE", "UNIT_PET", "PET_BAR_UPDATE", +-- "MODIFIER_STATE_CHANGED"}) do +for _, event in ipairs({"SPELLS_CHANGED", "TRADE_SKILL_UPDATE", + "CRAFT_UPDATE", "BAG_UPDATE", "UNIT_PET", "PET_BAR_UPDATE", + "MODIFIER_STATE_CHANGED", "PLAYER_ENTERING_WORLD"}) do + Finder.owner:RegisterEvent(event) +end +Finder.owner:SetScript("OnEvent", function() + -- The client's key bindings have loaded: game bindings may be set a + -- second later (RefreshBindings, without ClassicAPI). + if event == "PLAYER_ENTERING_WORLD" then + Finder.bindingsReadyAt = Finder.bindingsReadyAt or GetTime() + 1 + return + end + if not Finder.frame:IsVisible() then return end + if event == "MODIFIER_STATE_CHANGED" then + local focus = GetCurrentKeyBoardFocus and GetCurrentKeyBoardFocus() + if focus and focus ~= Finder.edit then Finder:Close(); return end + if arg1 == "LCTRL" then Finder.ctrlLeft = arg2 == 1 + elseif arg1 == "RCTRL" then Finder.ctrlRight = arg2 == 1 + else return end + -- A focused 1.12 EditBox consumes Ctrl+J/K before bindings dispatch. + -- Release focus while Ctrl is held, then resume typing on release. + if Finder.ctrlLeft or Finder.ctrlRight then + Finder.edit:ClearFocus() + Finder.capture:EnableKeyboard(true) + else + -- Finder.capture:EnableKeyboard(false) + -- Finder.edit:SetFocus() + -- The search box takes the keyboard back on the next frame + -- (OnUpdate). This event fires before the client handles the + -- Ctrl release; a search box focused now takes that release, + -- and the client then keeps Ctrl held (IsControlKeyDown) after + -- a Ctrl key opened the finder, until Ctrl is pressed again. + Finder.refocus = true + end + -- else Finder:Scan() end + else + -- A rescan keeps the selected result, so Enter still uses the one + -- shown after a bag, spell or pet update. + local current = Finder.results and Finder.results[Finder.selected] + local key = current and usageKey(current) + Finder:Scan() + for i, item in ipairs(key and Finder.results or {}) do + if usageKey(item) == key then + Finder.selected = i + Finder:Draw() + break + end + end + end +end) + +-- The finder's tab in VimWow Settings: its key, kept in VimFinderDB. +Finder.settings = { + id = "VimFinder", name = "Finder", order = 150, + db = function() + if type(VimFinderDB) ~= "table" then VimFinderDB = {} end + return VimFinderDB + end, + bindings = {{action = "VIMFINDER", defaults = DEFAULT_KEYS}}, + -- A new key is bound at once. + onChange = function() Finder.binding = nil end, +} +if VimWowSettings and VimWowSettings.Register then + VimWowSettings:Register(Finder.settings) +end diff --git a/screenshots/all-together.png b/screenshots/all-together.png new file mode 100644 index 0000000..ac0c4ae Binary files /dev/null and b/screenshots/all-together.png differ diff --git a/screenshots/finder-bag.png b/screenshots/finder-bag.png new file mode 100644 index 0000000..28e6c45 Binary files /dev/null and b/screenshots/finder-bag.png differ diff --git a/screenshots/finder-open.png b/screenshots/finder-open.png new file mode 100644 index 0000000..28e1c91 Binary files /dev/null and b/screenshots/finder-open.png differ diff --git a/screenshots/finder-recipes.png b/screenshots/finder-recipes.png new file mode 100644 index 0000000..082a2a7 Binary files /dev/null and b/screenshots/finder-recipes.png differ diff --git a/screenshots/finder-search.png b/screenshots/finder-search.png new file mode 100644 index 0000000..caaf284 Binary files /dev/null and b/screenshots/finder-search.png differ diff --git a/screenshots/finder-settings.png b/screenshots/finder-settings.png new file mode 100644 index 0000000..d172187 Binary files /dev/null and b/screenshots/finder-settings.png differ diff --git a/screenshots/finder-spells.png b/screenshots/finder-spells.png new file mode 100644 index 0000000..30ad990 Binary files /dev/null and b/screenshots/finder-spells.png differ diff --git a/screenshots/finder-tracking.png b/screenshots/finder-tracking.png new file mode 100644 index 0000000..c05d7bb Binary files /dev/null and b/screenshots/finder-tracking.png differ diff --git a/screenshots/finder-window.png b/screenshots/finder-window.png new file mode 100644 index 0000000..ae7f659 Binary files /dev/null and b/screenshots/finder-window.png differ diff --git a/screenshots/with-vimbag.png b/screenshots/with-vimbag.png new file mode 100644 index 0000000..5aaa53d Binary files /dev/null and b/screenshots/with-vimbag.png differ diff --git a/screenshots/with-vimwow.png b/screenshots/with-vimwow.png new file mode 100644 index 0000000..36307c2 Binary files /dev/null and b/screenshots/with-vimwow.png differ