├── COPYING
├── README.md
└── helm-fuzzier.el
/COPYING:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | ### Description
4 |
5 | This package provides more intuitive fuzzy matching behavior for
6 | [Helm](https://github.com/emacs-helm/helm). Available on MELPA.
7 |
8 | `helm-fuzzier` makes sure the the best matches appear on the list.
9 | For query highlighting and sorting results by quality, install [helm-flx](https://github.com/PythonNut/helm-flx).
10 |
11 | ### Installation:
12 |
13 | ```elisp
14 | (require 'helm-fuzzier)
15 | (helm-fuzzier-mode 1)
16 | ```
17 |
18 | `helm-fuzzier` will only enhance matching for sources that have
19 | fuzzy-matching enabled, so **be sure to enable fuzzy-matching for the
20 | sources** you're interested in by setting the appropriate variable
21 | (`helm-M-x-fuzzy-match`, `helm-mode-fuzzy-match`,
22 | `helm-apropos-fuzzy-match`, etc').
23 |
24 | ### Usage
25 |
26 | Any query that currently works for you should generally continue to do so.
27 | However, when `helm-fuzzier-mode` is enabled, a query that:
28 |
29 | - Begins with the same letter as the desired match.
30 | - Is formed by stringing together two or more prefixes from the words
31 | that make up the match.
32 |
33 | ... should nearly always result in the match you're looking for appearing in the
34 | top few results.
35 |
36 | **Example Queries**:
37 |
38 | - `el`, `em`, `elm`, `eli`, `elmo`, should all match `emacs-lisp-mode`.
39 | - `plp`, `plpa`, `paclp`, should all match `package-list-packages`.
40 | - `hcn`, `hnl`, `hecl`, should all match `helm-candidate-number-limit`.
41 |
42 | Try toggling `helm-fuzzier-mode` on and off and compare the results you
43 | get with and without `helm-fuzzier`.
44 |
45 | ### Requirements
46 |
47 | - Emacs >= 24.3
48 | - Helm >= 1.7.0
49 |
50 | ### Notes
51 |
52 | See source code for more detailed information on the implementation.
53 |
--------------------------------------------------------------------------------
/helm-fuzzier.el:
--------------------------------------------------------------------------------
1 | ;;; helm-fuzzier.el --- Better fuzzy matching for Helm -*- lexical-binding: t -*-
2 |
3 | ;; Copyright (C) 2015 Ephram Perdition
4 |
5 | ;; Author: Ephram Perdition
6 | ;; Created: 25 Oct 2015
7 |
8 | ;; Package-Requires: ((emacs "24.3") (helm "1.7.0"))
9 |
10 | ;; Keywords: convenience helm fuzzy
11 | ;; Homepage: http://github.com/EphramPerdition/helm-fuzzier
12 |
13 | ;; This file is NOT part of GNU Emacs.
14 |
15 | ;; This program is free software; you can redistribute it and/or modify
16 | ;; it under the terms of the GNU General Public License as published by
17 | ;; the Free Software Foundation, either version 3 of the License, or
18 | ;; (at your option) any later version.
19 |
20 | ;; This program is distributed in the hope that it will be useful,
21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 | ;; GNU General Public License for more details.
24 |
25 | ;; You should have received a copy of the GNU General Public License
26 | ;; along with this program. If not, see .
27 |
28 | ;;; Commentary:
29 |
30 | ;; This package provides more intuitive fuzzy matching behavior for Helm.
31 | ;; Use in conjunction with the 'helm-flx' package for best results.
32 | ;; `helm-fuzzier' improves Helm's "matching", meaning that it tries
33 | ;; to ensure the best matches appear on the result list. 'helm-flx',
34 | ;; on the other hand, provides on-the-fly highlighting and (dramatically)
35 | ;; improves Helm's "scoring" so that the results are shown ordered from
36 | ;; "best" to "worst" match.
37 | ;;
38 | ;; Usage:
39 | ;;
40 | ;; (require 'helm-fuzzier)
41 | ;; (helm-fuzzier-mode 1)
42 | ;;
43 |
44 | ;; The queries you currently use should continue to work reliably.
45 | ;; To take advantage of 'helm-fuzzier', queries should begin with the
46 | ;; same letter as the desired match and should form an abbreviation of
47 | ;; two or more word prefixes from the match.
48 | ;;
49 | ;; Query Examples:
50 | ;;
51 | ;; - 'emacs-lisp-mode' can be matched by 'el','em', 'elm', 'eli', 'elmo', etc'.
52 | ;; - 'helm-candidate-number-limit' can be matched by 'hcn','hnl', 'hecl', etc'.
53 | ;; - 'package-list-packages' can be matched by 'plp','plpa', 'paclp', etc'.
54 | ;;
55 | ;; Discussion:
56 | ;;
57 | ;; Helm's support (As of Oct 2015) for fuzzy matching breaks down when
58 | ;; the number of matches exceeds its internal limit
59 | ;; 'helm-candidate-number-limit'. Helm will stop looking once it finds
60 | ;; LIMIT matches, even if better matches exist among the remaining candidates.
61 | ;; The result is that the best matches are often not included in the results.
62 |
63 | ;; Helm additionally separates *matching* from *scoring* into separate
64 | ;; phases. the former simply collects LIMIT matches of whatever
65 | ;; quality, the later sorts them from best to worst according to some
66 | ;; heuristic.
67 |
68 | ;; 'helm-fuzzier' augments helm's default *matching* phase with an
69 | ;; additional *preferred matching* phase which examines _all
70 | ;; candidates for matches that are likely to score highly in the
71 | ;; *scoring* phase, and makes sure they are included in the result
72 | ;; list presented to the user. Without this, the best results are
73 | ;; overlooked when there are lots of low-quality fuzzy matches, and
74 | ;; this failure occurs most often with short queries, exactly the case
75 | ;; users most care about (less keystrokes).
76 |
77 | ;; For preferred matching to produce good results there must be good
78 | ;; agreement between what it and what the *scoring* function consider
79 | ;; a "good match". 'helm-fuzzier' was written (and tested) for use
80 | ;; with the new 'helm-flx' package recently added to MELPA (by
81 | ;; @PythonNut), which enhances Helm's *scoring* phase by using
82 | ;; @lewang's 'flx' library.
83 | ;;
84 |
85 | ;;; Code:
86 |
87 | (require 'cl-lib)
88 | (require 'helm) ; we redefine some helm functions, ensure it is loaded first
89 |
90 | ;;; Customization
91 | (defgroup helm-fuzzier nil
92 | "Better Fuzzy Matching For Helm."
93 | :group 'helm)
94 |
95 | (defcustom helm-fuzzier-preferred-max-group-length 4
96 | "Knob controlling regex generation for fuzzier matching.
97 |
98 | Trade speed for accuracy.
99 | Larger values create increasingly expensive regexs. Number of clauses
100 | grows very quickly as this value increases, so set this conservatively.
101 |
102 | A value of 1 will match:
103 | \"bbs\" -> \"(b)ulletin-(b)oard-(s)ystem\"
104 | but not:
105 | \"bubs\" -> \"(bu)lletin-(b)oard-(s)ystem\"
106 | and not:
107 | \"bubsy\" -> \"(bu)lletin-(b)oard-(sy)stem\"
108 |
109 | a value of 2 will match all. a value of 3 will match
110 | \"bulbs\" -> \"(bul)letin-(b)oard-(s)sstem\"
111 |
112 | ... and so on"
113 | :group 'helm-fuzzier
114 | :type 'integer)
115 |
116 | (defcustom helm-fuzzier-max-query-len 5
117 | "Upper limit on query length for preferred matching.
118 |
119 | Just as with 'helm-fuzzier-preferred-max-group-length', the number
120 | of clauses in the regex we generate for matching grows quickly
121 | with the length of the query. If the query we are given exceeds
122 | this limit, we recuse ourselves and let helm take over, hoping that
123 | that the query is long enough to reduce the number of candidates
124 | below limit, so the scoring phase will get to see all possible matches."
125 | :group 'helm-fuzzier
126 | :type 'integer)
127 |
128 |
129 | (defcustom helm-fuzzier-word-boundaries "- /:|_"
130 | "List of characters that indicate a word boundary.
131 |
132 | The characters are interpolated as-is into a regex inside
133 | a charcater class \"[%s]\" so be careful about quoting.
134 |
135 | The default value should work for the conventions common
136 | in Emacs symbols (i.e \"foo/bar-the-baz\") and in filenames
137 | (i.e. \"the file name\")"
138 | :group 'helm-fuzzier
139 | :type 'string)
140 |
141 | (defcustom helm-fuzzier-max-candidates-to-scan 75000
142 | "Hard limit on number of candidates to test for preferred match.
143 |
144 | Generally, we want to examine all possible candidates, and this should be
145 | fast enough. It is prudent none the less to place a hard upper limit on the
146 | number of candidates we scan"
147 | :group 'helm-fuzzier
148 | :type 'integer)
149 |
150 | (defcustom helm-fuzzier-remaining-matches-quota 10
151 | "Lower limit on number of matche slots left for Helm to fulfill.
152 |
153 | Set this to a (small, positive) value below 'helm-candidate-number-limit'.
154 |
155 | 'helm-fuzzier' will then provide up to (- LIMIT quota) matches
156 | and leave the remaining slots to be filled by Helm's matching logic."
157 |
158 | :group 'helm-fuzzier
159 | :type 'integer)
160 |
161 | ;;; internal variables
162 | (defvar helm-fuzzier-preferred-candidates-cache (make-hash-table :test 'equal :size 1024)
163 | "Caches the complete candidates list for locating preferred matches.")
164 | (defvar helm-fuzzier-old-helm-match-fn nil
165 | "Ref to original helm match function.")
166 | (defvar helm-fuzzier-match-hash (make-hash-table :test 'equal)
167 | "holds matches for dedupe during filtering")
168 |
169 | (defun helm-fuzzier--mapconcat-initials-pattern-1 (groups seperators)
170 | "Construct regexp from GROUPS to match them as separated initials of a string.
171 | e.g (helm-fuzzier--mapconcat-initials-pattern-1 '(\"a\" \"bc\" \"d\") \"-/\")
172 | will return a pattern that matches \"a123/bc45-d\"
173 |
174 | SEPERATORS is a string contains one or more word seperators. Any characters
175 | which are not regex-safe should be quoted."
176 | (concat "\\("
177 | (format "^%s" (car groups))
178 | (mapconcat (lambda (c)
179 | (if (and (string= c "$")
180 | (string-match "$\\'" (apply 'concat groups)))
181 | c (format "\\(.*[%s]%s\\)" seperators c)))
182 | (cdr groups) "")
183 | "\\)"))
184 |
185 | (defun helm-fuzzier--partition-string (query max-length &optional level)
186 | "Returns a list of all possible partitions of the QUERY string.
187 |
188 | Returns all possible partitions where no substring has length > MAX-LENGTH
189 |
190 | Note: Recursive and may blow stack. Caller will normally invoke us with
191 | a short QUERY, so stack overflow shouldn't occur.
192 |
193 | Example:
194 |
195 | (helm-fuzzier--partition-string \"abcd\" 3)
196 | ((\"a\" \"b\" \"c\" \"d\") (\"a\" \"b\" \"cd\") (\"a\" \"bc\" \"d\") (\"a\" \"bcd\") (\"ab\" \"c\" \"d\") (\"ab\" \"cd\") (\"abc\" \"d\"))"
197 |
198 | (let ((qlen (length query)))
199 | (if (= qlen 1)
200 | (list (list query))
201 | (cl-loop
202 | for group-length from 1 to (min max-length
203 | ;; Forbid first group from consuming entire string
204 | ;; To enforce at least two groups.
205 | (- qlen
206 | (if level
207 | 0
208 | 1)))
209 | append
210 | (if (= group-length qlen)
211 | (list (list query)) ;; base case
212 | ;; Break off group from head of string, recurse with the remaining
213 | ;; string to get a list of lists of string (groups)
214 | (let* ((string-head (substring query 0 group-length))
215 | (string-tail (substring query
216 | group-length
217 | qlen))
218 | (partitions (helm-fuzzier--partition-string string-tail
219 | max-length
220 | (1+ (or level 0)))))
221 | ;; Build the result list by prepending the current group
222 | ;; to every one of the possible partitions of the remaining string
223 | (mapcar (lambda (other-groups) (cons string-head other-groups))
224 | partitions)))))))
225 |
226 |
227 | (defun helm-fuzzier--mapconcat-initials-pattern (pattern seperators &optional max-group-length)
228 | "Transform string PATTERN into a regexp for fuzzy matching as initials.
229 |
230 | With SEPERATORS as a string of regex-quoted word-boundary characters
231 | (\"- /\"), partition pattern into groups in various ways and construct
232 | a regex pattern that tries to match any of these variations against
233 | the word prefixes in a candidate.
234 |
235 | The regex generation variations is controlled by the MAX_GROUP-LENGTH argument:
236 |
237 | With MAX-GROUP-LENGTH=1 the pattern generated for \"abc\" will match
238 | \"a...-b...-c\"
239 |
240 | With MAX-GROUP-LENGTH=2 the pattern generated for \"abc\" will match
241 | \"a...-b...-c...\" or \"ab...-c...\" or \"a...-bc....\"
242 |
243 | etc'."
244 | (mapconcat (lambda (ls) (helm-fuzzier--mapconcat-initials-pattern-1 ls seperators))
245 | (helm-fuzzier--partition-string
246 | pattern
247 | max-group-length)
248 | "\\|"))
249 |
250 | (defun helm-fuzzier--make-initials-matcher (pattern &optional seperators max-group-length )
251 | "Constructs a matching function for PATTERN.
252 |
253 | See 'helm-fuzzier--mapconcat-initials-pattern' docstring for information
254 | about SEPERATORS and MAX-GROUP-LENGTH"
255 | (let* ((initials-pat
256 | (concat
257 | ;; match prefix of single word match
258 | (format "\\(^%s[^%s]*$\\)\\|" pattern (or seperators
259 | helm-fuzzier-word-boundaries))
260 | ;; match abbreviations
261 | (helm-fuzzier--mapconcat-initials-pattern
262 | pattern
263 | (or seperators helm-fuzzier-word-boundaries)
264 | (or max-group-length
265 | helm-fuzzier-preferred-max-group-length))))
266 | (matcher (lambda (candidate)
267 | (string-match initials-pat candidate))))
268 | matcher))
269 |
270 | (defun helm-fuzzier--drop-last-char (s)
271 | (let ((len (or (length s) 0)))
272 | (when (> len 0)
273 | (substring s 0 (1- len)))))
274 |
275 | (defun helm-fuzzier--new-nonempty-query-p (source query)
276 | "Check if query is not-empty and not covered by current cached contents."
277 | (and (> (length query) 0)
278 | (not (string-prefix-p
279 | (or (gethash (concat (assoc-default 'name source) "-query")
280 | helm-fuzzier-preferred-candidates-cache)
281 | "\x00")
282 | query))))
283 |
284 | (defun helm-fuzzier-candidates-in-buffer-search-default-fn (pattern)
285 | "Search PATTERN with `re-search-forward' with bound and noerror args.
286 |
287 | Preferred matching requires initial letter to match use that to reduce
288 | the number of candidates to check."
289 | (let ((pat (format "^%c" (aref pattern 0))))
290 | (condition-case _err
291 | (re-search-forward pat nil t)
292 | (invalid-regexp nil))))
293 |
294 | (defun helm-fuzzier--get-all-source-candidates-no-really-NO-REALLY (source query)
295 | "Get all candidates for SOURCE. really. no, REALLY.
296 |
297 | 'get-cached-candidates' won't work, even if we clrhash first.
298 | Actually, we don't REALLY get all candidates, we do limit the list to
299 | all candidates which match query. We should only be called at the start
300 | of a new query (prefix) and this can cut down the scan list dramatically."
301 |
302 | (let* ((candidates (if (eq (assoc-default 'candidates source) #'helm-candidates-in-buffer)
303 | (helm-candidates-in-buffer-1
304 | (helm-candidate-buffer)
305 | query
306 | (or (assoc-default 'get-line source)
307 | #'buffer-substring-no-properties)
308 | '(helm-fuzzier-candidates-in-buffer-search-default-fn)
309 | helm-fuzzier-max-candidates-to-scan
310 | (helm-attr 'match-part)
311 | source)
312 | (helm-get-candidates source))))
313 | candidates))
314 |
315 | (defun helm-fuzzier--matchfn-stub (&rest _)
316 | (user-error "I should not have been called"))
317 |
318 | (defun helm-fuzzier--get-preferred-matches (cands _ match-part-fn limit source)
319 | "Perform a scan over all candidates looking for \"Preferred Matches\".
320 |
321 | 'helm-fuzzier-preferred-candidates-cache' is used to cache a list of
322 | all candidates when a new query is entered. This is exclusively to
323 | support 'source-in-buffer' Helm sources, which perform the optimization
324 | described in the previous paragraph, before we even get to see the
325 | candidates. Because preferred matching relies cruically on examining
326 | all possible candidates, we have to cut through that optimization
327 | or we won't ever see the matches we're trying to boost.
328 |
329 | CANDS MATCH-PART-FN LIMIT SOURCE are the same arguments as found
330 | in 'helm-match-from-candidates' ."
331 |
332 | ;; when a new query begins we need to reset the caches.
333 | (when (helm-fuzzier--new-nonempty-query-p source helm-pattern)
334 | (puthash (assoc-default 'name source)
335 | (helm-fuzzier--get-all-source-candidates-no-really-NO-REALLY source helm-pattern)
336 | helm-fuzzier-preferred-candidates-cache)
337 | (puthash (concat (assoc-default 'name source) "-query") helm-pattern helm-fuzzier-preferred-candidates-cache)
338 | ;; (message "Count All Candidates: %d" (length (gethash (assoc-default 'name source)
339 | ;; helm-fuzzier-preferred-candidates-cache)))
340 | )
341 |
342 | (let* ((source-name (assoc-default 'name source))
343 | (matcher (helm-fuzzier--make-initials-matcher (substring helm-pattern
344 | 0
345 | ;; limit query len to control
346 | ;; regex complexity
347 | (min (length helm-pattern)
348 | helm-fuzzier-max-query-len))))
349 | (all-candidates (or (gethash source-name helm-fuzzier-preferred-candidates-cache)
350 | cands))
351 | (preferred-matches (when (and
352 | (> (length helm-pattern) 1)
353 | (assoc 'fuzzy-match source))
354 | (helm-fuzzier-orig-helm-match-from-candidates all-candidates
355 | (list matcher)
356 | match-part-fn limit source)))
357 | ;; when the query exceeds max-query-len, the matcher will truncate
358 | ;; it to limit the complexity of the regex, so we may end up with
359 | ;; false positive matches. Weed these out by passing them as
360 | ;; candidates to helm's fuzzy matcher.
361 | (result (if (<= (length helm-pattern)
362 | helm-fuzzier-max-query-len)
363 | preferred-matches
364 | (clrhash helm-fuzzier-match-hash)
365 | (helm-fuzzier-orig-helm-match-from-candidates preferred-matches
366 | (list (symbol-function helm-fuzzy-match-fn))
367 | match-part-fn limit source))))
368 | result))
369 |
370 | ;; This function copied from Helm commit b1ec2d1ab48f137e712.
371 | ;; Modified to use helm-fuzzier-match-hash instead of creating a local hash table
372 | ;; so that the dedupe of matches takes place with a hash table which has already
373 | ;; been populated by the preferred matches we've found.
374 | (defun helm-fuzzier-orig-helm-match-from-candidates (cands matchfns match-part-fn limit source)
375 | (condition-case-unless-debug err
376 | (delq nil
377 | (cl-loop with hash = helm-fuzzier-match-hash
378 | with allow-dups = (assq 'allow-dups source)
379 | with case-fold-search = (helm-set-case-fold-search)
380 | with count = 0
381 | for iter from 1
382 | for fn in matchfns
383 | when (< count limit) nconc
384 | (cl-loop for c in cands
385 | for dup = (gethash c hash)
386 | while (and (< count limit)
387 | ;; When allowing dups check if DUP
388 | ;; have been already found in previous loop
389 | ;; by comparing its value with ITER.
390 | (or (and allow-dups dup (= dup iter))
391 | (null dup)))
392 | for target = (helm-candidate-get-display c)
393 | for part = (if match-part-fn
394 | (funcall match-part-fn target)
395 | target)
396 | when (funcall fn part) do
397 | (progn
398 | ;; Modify candidate before pushing it to hash.
399 | (helm--maybe-process-filter-one-by-one-candidate c source)
400 | ;; Give as value the iteration number of
401 | ;; inner loop to be able to check if
402 | ;; the duplicate have not been found in previous loop.
403 | (puthash c iter hash)
404 | (cl-incf count))
405 | and collect c)))
406 | (error (unless (eq (car err) 'invalid-regexp) ; Always ignore regexps errors.
407 | (helm-log-error "helm-match-from-candidates in source `%s': %s %s"
408 | (assoc-default 'name source) (car err) (cdr err)))
409 | nil)))
410 |
411 |
412 | (defun helm-fuzzier--match-from-candidates (cands matchfns match-part-fn limit source)
413 | "Substitute function for 'helm-match-from-candidates'.
414 |
415 | First perform the \"preferred matches\" pass and then call the default helm
416 | logic to fill the remaining quota with matches using its algo. Returns
417 | the result of both concatenated into one list."
418 |
419 | (clrhash helm-fuzzier-match-hash) ; Clear hashtable used for deduping results across multiple matchfns
420 |
421 | (let* ((with-preferred (member #'helm-fuzzier--matchfn-stub matchfns ))
422 | (matchfns (cl-remove #'helm-fuzzier--matchfn-stub matchfns))
423 | (preferred-matches (when with-preferred
424 | (helm-fuzzier--get-preferred-matches
425 | cands
426 | matchfns
427 | match-part-fn
428 | (max 0 (- limit helm-fuzzier-remaining-matches-quota))
429 | source)))
430 | (remaining-count (max 0 (- limit (length preferred-matches))))
431 | (matches (helm-fuzzier-orig-helm-match-from-candidates
432 | cands
433 | matchfns
434 | match-part-fn remaining-count source)))
435 | (append preferred-matches matches)))
436 |
437 | (defun helm-fuzzier--advice-helm-compute-matches (orig-fun source)
438 | (let* ((matchfns (helm-match-functions source))
439 | (matchfns (if (listp matchfns)
440 | matchfns
441 | (list matchfns)))
442 | (source-is-fuzzy (assoc 'fuzzy-match source)))
443 |
444 | ;; For every source which has fuzzy-matching enabled we insert
445 | ;; a canary matchfn. This also serves to disable an inconvenient
446 | ;; optimization in helm's 'helm-compute-matches' where if matchfns
447 | ;; is simply '(identity) the entire magic logic is skipped which
448 | ;; means we wouldn't get a chance to influence the results.
449 |
450 | (when source-is-fuzzy
451 | (let ((matchfns (append (list #'helm-fuzzier--matchfn-stub)
452 | matchfns)))
453 | ;; override matchfns with a list containing our canary
454 | (push (cons 'match matchfns) source)))
455 |
456 | (funcall orig-fun source)))
457 |
458 | ;;;###autoload
459 | (define-minor-mode helm-fuzzier-mode
460 | "helm-fuzzier minor mode"
461 | :init-value nil
462 | :group 'helm-fuzzier
463 | :global t
464 | (if helm-fuzzier-mode
465 | (progn
466 | (when (>= helm-fuzzier-remaining-matches-quota
467 | helm-candidate-number-limit)
468 | (warn "helm-fuzzier-mode: 'helm-fuzzier-remaining-matches-quota' >= 'helm-candidate-number-limit', helm-fuzzier is effectively disabled."))
469 | (when (not helm-fuzzier-old-helm-match-fn)
470 | (setq helm-fuzzier-old-helm-match-fn (symbol-function #'helm-match-from-candidates)))
471 | (setf (symbol-function 'helm-match-from-candidates) #'helm-fuzzier--match-from-candidates)
472 | (advice-add #'helm-compute-matches :around #'helm-fuzzier--advice-helm-compute-matches))
473 |
474 | (advice-remove #'helm-compute-matches #'helm-fuzzier--advice-helm-compute-matches)
475 | (setf (symbol-function 'helm-match-from-candidates) helm-fuzzier-old-helm-match-fn)))
476 |
477 | (provide 'helm-fuzzier)
478 |
479 | ;;; helm-fuzzier.el ends here
480 |
--------------------------------------------------------------------------------