├── .github
└── workflows
│ └── test.yml
├── .gitignore
├── CMakeLists.txt
├── Eldev
├── LICENSE
├── README.md
├── hotfuzz-module.c
├── hotfuzz.el
└── test
└── tests.el
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | name: test
2 | on: [push, pull_request]
3 |
4 | jobs:
5 | test:
6 | runs-on: ubuntu-latest
7 | continue-on-error: ${{ matrix.emacs_version == 'snapshot' }}
8 | strategy:
9 | matrix:
10 | emacs_version: ['27.1', '28.1', 'snapshot']
11 | steps:
12 | - name: Set up Emacs
13 | uses: purcell/setup-emacs@v6.0
14 | with:
15 | version: ${{ matrix.emacs_version }}
16 | - name: Install Eldev
17 | run: curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh
18 | - uses: actions/checkout@v4
19 | - name: Run tests
20 | run: |
21 | eldev --trace --color=always compile --warnings-as-errors
22 | eldev --loading=built-source --trace --color=always test --undercover codecov,dontsend
23 | - name: Upload coverage
24 | uses: codecov/codecov-action@v4
25 | with:
26 | token: ${{ secrets.CODECOV_TOKEN }}
27 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /.eldev
2 | /Eldev-local
3 |
4 | /build
5 | /hotfuzz-module.so
6 |
--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | cmake_minimum_required(VERSION 3.19)
2 | project(hotfuzz C)
3 |
4 | find_program(EMACS_EXECUTABLE emacs)
5 | if(EMACS_EXECUTABLE)
6 | file(REAL_PATH ${EMACS_EXECUTABLE} EMACS_EXECUTABLE)
7 | set(EMACS_PROGRAM_DIR ${EMACS_EXECUTABLE}/../..)
8 | endif()
9 |
10 | find_path(EMACS_INCLUDE_DIR emacs-module.h
11 | HINTS ${EMACS_PROGRAM_DIR}
12 | PATHS ${EMACS_ROOT} ENV EMACS_ROOT
13 | PATH_SUFFIXES include
14 | REQUIRED)
15 |
16 | set(THREADS_PREFER_PTHREAD_FLAG ON)
17 | find_package(Threads REQUIRED)
18 |
19 | add_library(hotfuzz-module MODULE hotfuzz-module.c)
20 | set_target_properties(hotfuzz-module PROPERTIES
21 | C_STANDARD 11
22 | C_STANDARD_REQUIRED ON
23 | PREFIX ""
24 | LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR})
25 | target_include_directories(hotfuzz-module SYSTEM PRIVATE ${EMACS_INCLUDE_DIR})
26 | target_link_libraries(hotfuzz-module PRIVATE Threads::Threads)
27 |
--------------------------------------------------------------------------------
/Eldev:
--------------------------------------------------------------------------------
1 | ; -*- mode: emacs-lisp; lexical-binding: t -*-
2 |
3 | (eldev-use-plugin 'undercover)
4 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
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 | # hotfuzz
2 |
3 | [](https://github.com/axelf4/hotfuzz/actions/workflows/test.yml)
4 | [](https://codecov.io/gh/axelf4/hotfuzz)
5 | [](https://melpa.org/#/hotfuzz)
6 | [](https://stable.melpa.org/#/hotfuzz)
7 |
8 | This is a fuzzy Emacs completion style similar to the built-in `flex` style,
9 | but with a better scoring algorithm.
10 | Specifically, it is non-greedy and ranks completions that match at
11 | word; path component; or camelCase boundaries higher.
12 |
13 | To use hotfuzz, add it to the `completion-styles` list:
14 | ```elisp
15 | (setq completion-styles '(hotfuzz))
16 | ```
17 | If using [Fido], its insistence on using `flex` needs to be thwarted:
18 | ```elisp
19 | (add-hook 'icomplete-minibuffer-setup-hook
20 | (lambda () (kill-local-variable 'completion-styles)))
21 | ```
22 |
23 | ## Customization
24 |
25 | The following ordinary Emacs completion options are adhered to:
26 | * `completion-ignore-case` specifies whether matching is case-insignificant.
27 | * The `completions-common-part` face is used to highlight
28 | what characters of a candidate the search string matched.
29 |
30 | Unless the completion UI supports `completion-lazy-hilit`, as i.a.
31 | [Vertico] and [Corfu] do, only the first
32 | `hotfuzz-max-highlighted-completions` completions will be
33 | highlighted out of performance concerns. The default value is large
34 | enough that generally the list of completions will need to be
35 | scrolled beyond the second page to reach non-highlighted
36 | completions, but this optimization may be disabled with:
37 | ```elisp
38 | (setq hotfuzz-max-highlighted-completions most-positive-fixnum)
39 | ```
40 |
41 | ## Dynamic module
42 |
43 | Optionally, you may compile the bundled dynamic module
44 | for improved performance.
45 | Ensure GCC, CMake and GNU Make or similar are present, and run
46 | ```sh
47 | cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS=-march=native &&
48 | cmake --build build
49 | ```
50 | and place the resulting shared library somewhere in `load-path`.
51 | Add `-DEMACS_ROOT=/path/to/emacs-root`
52 | (the directory containing `bin/`, `include/`, etc.)
53 | if it is not found automatically by locating `emacs` in `PATH`.
54 | The module will be picked up when hotfuzz is loaded;
55 | use `(featurep 'hotfuzz-module)` to check for its presence.
56 |
57 | > [!NOTE]
58 | > Dynamic modules are unable to access invalid Unicode strings.
59 | >
60 | > [Consult] appends invisible *tofus*, characters outside the Unicode
61 | > range (unlikely to match search strings), to attach line numbers and
62 | > disambiguate completions. Using, e.g., the Supplementary Private Use
63 | > Area-B instead circumvents encoding issues:
64 | > ```elisp
65 | > (setq consult--tofu-char #x100000
66 | > consult--tofu-range #x00fffe)
67 | > ```
68 |
69 | ## Related projects
70 |
71 | ### The `flex` completion style
72 |
73 | The `flex` completion style included with Emacs
74 | does the same matching as hotfuzz, and scores candidates based on gap sizes.
75 | It does not, however, attempt to find the optimal score.
76 | For example, given the search string `"foo"`,
77 | the matched characters in a candidate could look like
78 |
79 | > x**f**xxx**o**xxx**o**xfoox
80 |
81 | which would score low despite the later contiguous match.
82 |
83 | ### flx
84 |
85 | The [flx] package - which out-of-the-box only supports [Ido] -
86 | has scoring criteria similar to those used by hotfuzz,
87 | but works a little differently.
88 | Its bountiful use of caching means it can be faster at scoring long candidates.
89 | Since the ordering of completions differs between flx and hotfuzz
90 | you are encouraged to try both.
91 |
92 | ### fussy
93 |
94 | The [fussy] completion style is generic over different fuzzy scoring backends,
95 | flx and the Emacs Lisp implementation of hotfuzz being two of them.
96 | fussy also implements caching of filtered candidates.
97 | Although some of the scoring backends are implemented as dynamic modules,
98 | hotfuzz has the advantage of passing all completion candidates
99 | to its dynamic module en masse,
100 | allowing sorting and filtering to be parallelized.
101 |
102 | ### orderless
103 |
104 | The [orderless] completion style allows
105 | every component of a space-delimited (by default) pattern
106 | to match according to any other completion style.
107 | It is very customizable,
108 | but does no sorting and allows the individual sub-patterns to overlap
109 | (`"foo foo"` filters no additional items compared to `"foo"`).
110 | Hotfuzz on the other hand tries to be more clever about sorting,
111 | and so users who dislike that may prefer orderless.
112 |
113 | [Vertico]: https://github.com/minad/vertico
114 | [Corfu]: https://github.com/minad/corfu
115 | [Ido]: https://www.gnu.org/software/emacs/manual/html_node/ido/index.html
116 | [Fido]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Icomplete.html
117 | [Consult]: https://github.com/minad/consult
118 | [flx]: https://github.com/lewang/flx
119 | [fussy]: https://github.com/jojojames/fussy
120 | [orderless]: https://github.com/oantolin/orderless
121 |
--------------------------------------------------------------------------------
/hotfuzz-module.c:
--------------------------------------------------------------------------------
1 | /**
2 | * C implementation of the hotfuzz completion style.
3 | *
4 | * See the Lisp source for an explanation of the algorithm.
5 | */
6 | #include
7 | #include
8 | #include
9 | #include
10 | #include
11 | #include
12 | #include
13 |
14 | #ifdef _WIN32
15 | #include
16 | long get_max_workers() {
17 | SYSTEM_INFO sysinfo;
18 | GetSystemInfo(&sysinfo);
19 | return sysinfo.dwNumberOfProcessors;
20 | }
21 | #else
22 | #include
23 | long get_max_workers() {
24 | return sysconf(_SC_NPROCESSORS_ONLN);
25 | }
26 | #endif
27 |
28 | #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
29 |
30 | #define MAX_NEEDLE_LEN 128
31 | #define MAX_HAYSTACK_LEN 512
32 | #define BATCH_SIZE 2048
33 |
34 | int plugin_is_GPL_compatible;
35 |
36 | struct Str { char *b; size_t len; };
37 |
38 | static char toupper_utf8(char c) {
39 | return *u8"a" <= c && c <= *u8"z" ? c - (*u8"a" - *u8"A") : c;
40 | }
41 | static void strtolower(struct Str s) {
42 | uint64_t ones = ~UINT64_C(0) / 0xff, x;
43 | for (size_t i = 0; i < s.len; i += sizeof x) {
44 | memcpy(&x, s.b + i, sizeof x);
45 | uint64_t is_gt_Z = (0x7f * ones & x) + (0x7f - *u8"Z") * ones,
46 | is_ge_A = (0x7f * ones & x) + (0x80 - *u8"A") * ones,
47 | is_upper = 0x80 * ones & ~x & (is_ge_A ^ is_gt_Z);
48 | x |= is_upper >> 2;
49 | memcpy(s.b + i, &x, sizeof x);
50 | }
51 | }
52 |
53 | static int char_bonus(char prev, char ch) {
54 | int word_bonus = 80;
55 | switch (ch) {
56 | case 'A' ... 'Z':
57 | if ('a' <= prev && prev <= 'z') return word_bonus;
58 | // Intentional fallthrough
59 | case 'a' ... 'z':
60 | switch (prev) {
61 | case '/': return 90;
62 | case '.': return 60;
63 | case '-': case '_': case ' ': return word_bonus;
64 | }
65 | // Intentional fallthrough
66 | default:
67 | return 0;
68 | }
69 | }
70 |
71 | static void match_row(struct Str a, struct Str b, int *bonuses, unsigned i, int *c, int *d) {
72 | int g = 100, h = 10;
73 | size_t m = b.len;
74 | int oldc, s = i ? g + 5 * i : 0;
75 | for (size_t j = 0; j < m; ++j, s = oldc) {
76 | oldc = c[j];
77 | d[j] = MIN(d[j], oldc + (j < m - 1 ? g : 0)) + h;
78 | c[j] = a.b[i] == b.b[j] ? MIN(d[j], s - bonuses[i]) : d[j];
79 | }
80 | }
81 |
82 | static int calc_cost(struct Str needle, struct Str haystack, bool ignore_case) {
83 | unsigned n = haystack.len, m = needle.len;
84 | if (n > MAX_HAYSTACK_LEN || m > MAX_NEEDLE_LEN) return 100000;
85 | int c[MAX_NEEDLE_LEN], d[MAX_NEEDLE_LEN];
86 | for (unsigned j = 0; j < m; ++j) c[j] = d[j] = 100000;
87 |
88 | int bonuses[MAX_HAYSTACK_LEN];
89 | char ch, lastch = '/';
90 | for (unsigned i = 0; i < n; ++i, lastch = ch)
91 | bonuses[i] = char_bonus(lastch, ch = haystack.b[i]);
92 |
93 | if (ignore_case) strtolower(haystack);
94 | for (unsigned i = 0; i < n; ++i)
95 | match_row(haystack, needle, bonuses, i, c, d);
96 |
97 | return c[m - 1];
98 | }
99 |
100 | /**
101 | * Returns whether @a haystack matches @a needle.
102 | *
103 | * @param needle Null-terminated search string.
104 | * @param haystack Null-terminated completion candidate.
105 | * @param ignore_case Whether to match case-insensitively.
106 | */
107 | static bool is_match(char *needle, char *haystack, bool ignore_case) {
108 | while (*needle)
109 | if ((haystack = ignore_case
110 | ? strpbrk(haystack, (char[]) { *needle, toupper_utf8(*needle), '\0' })
111 | : strchr(haystack, *needle)))
112 | ++needle, ++haystack; // Skip past matched character
113 | else
114 | return false;
115 | return true;
116 | }
117 |
118 | /** Intrusive linked list of bump allocation blocks. */
119 | struct Bump {
120 | struct Bump *next;
121 | char *cursor, *limit, b[];
122 | };
123 |
124 | static void bump_free(struct Bump *head) {
125 | while (head) {
126 | struct Bump *next = head->next;
127 | free(head);
128 | head = next;
129 | }
130 | }
131 |
132 | /** Copies the Emacs string to make its contents accessible. */
133 | static struct Str copy_emacs_string(emacs_env *env, struct Bump **bump, emacs_value value) {
134 | char *buf = NULL;
135 | ptrdiff_t origlen, len;
136 | if (*bump) {
137 | // Opportunistically try to copy into remaining space
138 | buf = (*bump)->cursor;
139 | len = origlen = (*bump)->limit - (*bump)->cursor;
140 | }
141 | // Determine the size of the string (including null-terminator)
142 | if (env->copy_string_contents(env, value, buf, &len)) {
143 | if (buf) goto success;
144 | } else {
145 | if (!buf || len == origlen) return (struct Str) { 0 };
146 | env->non_local_exit_clear(env);
147 | }
148 |
149 | size_t capacity = *bump ? 2 * ((*bump)->limit - (*bump)->b) : 2048;
150 | if (capacity < (size_t) len) capacity = len + alignof(uint64_t) - 1;
151 | struct Bump *new;
152 | if (!(new = malloc(sizeof *new + capacity))) return (struct Str) { 0 };
153 | *new = (struct Bump) { .next = *bump, .cursor = new->b, .limit = new->b + capacity };
154 | *bump = new;
155 |
156 | env->copy_string_contents(env, value, buf = new->cursor, &len);
157 | success:
158 | (*bump)->cursor = (char *) (((uintptr_t) (*bump)->cursor + len
159 | + alignof(uint64_t) - 1) & ~(alignof(uint64_t) - 1));
160 | return (struct Str) { buf, len - 1 };
161 | }
162 |
163 | struct Candidate {
164 | emacs_value value;
165 | union {
166 | struct Str s;
167 | int key;
168 | };
169 | };
170 |
171 | static int cmp_candidate(const void *a, const void *b) {
172 | return ((struct Candidate *) a)->key - ((struct Candidate *) b)->key;
173 | }
174 |
175 | struct Batch {
176 | unsigned len;
177 | struct Candidate xs[BATCH_SIZE];
178 | };
179 |
180 | struct Shared {
181 | const bool ignore_case;
182 | const struct Str needle;
183 | struct Batch *const batches;
184 | _Atomic ssize_t remaining;
185 | };
186 |
187 | static void *worker_routine(void *ptr) {
188 | struct Shared *shared = ptr;
189 | struct Str needle = shared->needle;
190 |
191 | ssize_t batch_idx;
192 | while ((batch_idx = --shared->remaining) >= 0) {
193 | struct Batch *batch = shared->batches + batch_idx;
194 | unsigned n = 0;
195 | for (unsigned i = 0; i < batch->len; ++i) {
196 | struct Candidate x = batch->xs[i];
197 | if (!is_match(needle.b, x.s.b, shared->ignore_case)) continue;
198 | x.key = calc_cost(needle, x.s, shared->ignore_case);
199 | batch->xs[n++] = x;
200 | }
201 | batch->len = n;
202 | }
203 |
204 | return NULL;
205 | }
206 |
207 | /** Module userdata allocated at initialization. */
208 | struct Data {
209 | unsigned max_workers;
210 | pthread_t threads[];
211 | };
212 |
213 | static emacs_value hotfuzz_filter(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data_ptr) {
214 | struct Data *data = data_ptr;
215 | emacs_value fcar = env->intern(env, "car"), fcdr = env->intern(env, "cdr"),
216 | fcons = env->intern(env, "cons"), nil = env->intern(env, "nil");
217 | struct Bump *bump = NULL;
218 | int success = false;
219 | emacs_value result = nil;
220 |
221 | // Collect all candidates
222 | struct Batch *batches = NULL;
223 | size_t batch_idx = 0, capacity;
224 | for (emacs_value list = args[1]; env->is_not_nil(env, list);
225 | list = env->funcall(env, fcdr, 1, (emacs_value[]) { list })) {
226 | if (!batches || (batches[batch_idx].len >= BATCH_SIZE && ++batch_idx >= capacity)) {
227 | capacity = batches ? 2 * capacity : 1;
228 | struct Batch *new_batches;
229 | if (!(new_batches = realloc(batches, capacity * sizeof *batches))) goto err;
230 | batches = new_batches;
231 | for (size_t i = batch_idx; i < capacity; ++i) batches[i].len = 0;
232 | }
233 |
234 | emacs_value value = env->funcall(env, fcar, 1, (emacs_value[]) { list });
235 | struct Batch *batch = batches + batch_idx;
236 | struct Candidate *x = batch->xs + batch->len++;
237 | if (!(x->s = copy_emacs_string(env, &bump, x->value = value)).b) goto err;
238 | }
239 | if (!batches) return nil;
240 |
241 | bool ignore_case = env->is_not_nil(env, args[2]);
242 | struct Str needle = copy_emacs_string(env, &bump, args[0]);
243 | if (!needle.b) goto err;
244 | if (ignore_case) strtolower(needle);
245 | struct Shared shared = {
246 | .ignore_case = ignore_case,
247 | .needle = needle,
248 | .batches = batches,
249 | .remaining = batch_idx + 1,
250 | };
251 |
252 | unsigned num_workers = 0;
253 | for (; num_workers < MIN(data->max_workers, batch_idx + 1); ++num_workers)
254 | if (pthread_create(data->threads + num_workers, NULL, worker_routine, &shared))
255 | // Join all workers in order to at least safely free memory
256 | goto err_join_threads;
257 | success = true;
258 |
259 | err_join_threads:
260 | // Wait for all worker threads
261 | for (unsigned i = 0; i < num_workers; ++i) pthread_join(data->threads[i], NULL);
262 | if (!success) goto err;
263 |
264 | if (env->process_input(env) == emacs_process_input_quit) goto err;
265 |
266 | // Compact all batches
267 | size_t len = batches[0].len;
268 | struct Candidate *xs = batches[0].xs;
269 | for (struct Batch *b = batches + 1; b <= batches + batch_idx; ++b) {
270 | unsigned n = b->len;
271 | memmove(xs + len, b->xs, n * sizeof *b->xs);
272 | len += n;
273 | }
274 | qsort(xs, len, sizeof *xs, cmp_candidate); // Sort the completions
275 |
276 | for (size_t i = len; i-- > 0;)
277 | result = env->funcall(env, fcons, 2, (emacs_value[]) { xs[i].value, result });
278 |
279 | err:
280 | free(batches);
281 | bump_free(bump);
282 |
283 | if (!success)
284 | env->non_local_exit_signal(env, env->intern(env, "error"), nil);
285 | return result;
286 | }
287 |
288 | int emacs_module_init(struct emacs_runtime *rt) {
289 | // Verify compatibility with the Emacs executable loading this module
290 | if ((size_t) rt->size < sizeof *rt) return 1;
291 | emacs_env *env = rt->get_environment(rt);
292 | if ((size_t) env->size < sizeof *env) return 2;
293 |
294 | long max_workers = get_max_workers();
295 | struct Data *data;
296 | if (!(data = malloc(sizeof *data + max_workers * sizeof *data->threads)))
297 | return 1;
298 | *data = (struct Data) { max_workers };
299 |
300 | env->funcall(env, env->intern(env, "defalias"), 2, (emacs_value[]) {
301 | env->intern(env, "hotfuzz--filter-c"),
302 | env->make_function(env, 3, 3, hotfuzz_filter,
303 | "Filter and sort CANDIDATES that match STRING.\n"
304 | "\n"
305 | "\(fn STRING CANDIDATES IGNORE-CASE)",
306 | data),
307 | });
308 | env->funcall(env, env->intern(env, "provide"), 1,
309 | (emacs_value[]) { env->intern(env, "hotfuzz-module") });
310 |
311 | return 0;
312 | }
313 |
--------------------------------------------------------------------------------
/hotfuzz.el:
--------------------------------------------------------------------------------
1 | ;;; hotfuzz.el --- Fuzzy completion style -*- lexical-binding: t -*-
2 |
3 | ;; Copyright (C) Axel Forsman
4 |
5 | ;; Author: Axel Forsman
6 | ;; Version: 1.0
7 | ;; Package-Requires: ((emacs "27.1"))
8 | ;; Keywords: matching
9 | ;; URL: https://github.com/axelf4/hotfuzz
10 | ;; SPDX-License-Identifier: GPL-3.0-or-later
11 |
12 | ;;; Commentary:
13 |
14 | ;; This is a fuzzy Emacs completion style similar to the built-in
15 | ;; `flex' style, but with a better scoring algorithm. Specifically, it
16 | ;; is non-greedy and ranks completions that match at word; path
17 | ;; component; or camelCase boundaries higher.
18 |
19 | ;; To use this style, prepend `hotfuzz' to `completion-styles'.
20 |
21 | ;;; Code:
22 |
23 | ;; See: GOTOH, Osamu. An improved algorithm for matching biological
24 | ;; sequences. Journal of molecular biology, 1982, 162.3: 705-708.
25 |
26 | (eval-when-compile (require 'cl-lib))
27 | (require 'hotfuzz-module nil t)
28 | (declare-function hotfuzz--filter-c "hotfuzz-module")
29 |
30 | (defgroup hotfuzz () "Fuzzy completion style." :group 'minibuffer)
31 |
32 | (defcustom hotfuzz-max-highlighted-completions 25
33 | "The number of top-ranking completions that should be highlighted.
34 | Large values will decrease performance."
35 | :type 'integer)
36 |
37 | ;; Pre-allocated vectors make the cost-only calculation optimization
38 | ;; where symmetricity w.r.t. insertions/deletions means it suffices to
39 | ;; allocate min(#needle, #haystack) for C/D inapplicable.
40 | (defconst hotfuzz--max-needle-len 128)
41 | (defconst hotfuzz--max-haystack-len 512)
42 | (defvar hotfuzz--c (make-vector hotfuzz--max-needle-len 0))
43 | (defvar hotfuzz--d (make-vector hotfuzz--max-needle-len 0))
44 | (defvar hotfuzz--bonus (make-vector hotfuzz--max-haystack-len 0))
45 |
46 | (defvar hotfuzz--filtering-p nil)
47 |
48 | (defconst hotfuzz--bonus-lut
49 | (eval-when-compile
50 | (let ((state-special (make-char-table 'hotfuzz-bonus-lut 0))
51 | (state-upper (make-char-table 'hotfuzz-bonus-lut 0))
52 | (state-lower (make-char-table 'hotfuzz-bonus-lut 0))
53 | (word-bonus 80))
54 | (set-char-table-range state-upper '(?a . ?z) word-bonus)
55 | (cl-loop for (ch . bonus) in `((?/ . 90) (?. . 60) (?\ . ,word-bonus)
56 | (?- . ,word-bonus) (?_ . ,word-bonus))
57 | do (aset state-upper ch bonus) (aset state-lower ch bonus))
58 | (let ((lut (make-char-table 'hotfuzz-bonus-lut state-special)))
59 | (set-char-table-range lut '(?A . ?Z) state-upper)
60 | (set-char-table-range lut '(?a . ?z) state-lower)
61 | lut)))
62 | "LUT of the bonus associated with the current/previous characters.")
63 |
64 | (defun hotfuzz--calc-bonus (haystack)
65 | "Precompute all potential bonuses for matching certain characters in HAYSTACK."
66 | (cl-loop for ch across haystack and i from 0 and lastch = ?/ then ch do
67 | (aset hotfuzz--bonus i (aref (aref hotfuzz--bonus-lut ch) lastch))))
68 |
69 | ;; Aᵢ denotes the prefix a₀,...,aᵢ₋₁ of A
70 | (defun hotfuzz--match-row (a b i nc nd pc pd)
71 | "Calculate costs for transforming Aᵢ to Bⱼ with deletions for all j.
72 | The matrix C[i][j] represents the minimum cost of a conversion, and D,
73 | the minimum cost when aᵢ is deleted. The costs for row I are written
74 | into NC/ND, using the row I-1 in PC/PD. The vectors NC/PC and ND/PD
75 | respectively may alias."
76 | (cl-loop
77 | with m = (length b)
78 | and g = 100 and h = 10 ; Every k-symbol gap is penalized by g+hk
79 | ;; s threads the old value C[i-1][j-1] throughout the loop
80 | for j below m and s = (if (zerop i) 0 (+ g (* 5 i))) then oldc
81 | for oldc = (aref pc j) do
82 | ;; Either extend optimal conversion of (i) Aᵢ₋₁ to Bⱼ₋₁, by
83 | ;; matching bⱼ (C[i-1,j-1]-bonus); or (ii) Aᵢ₋₁ to Bⱼ, by deleting
84 | ;; aᵢ and opening a new gap (C[i-1,j]+g+h) or enlarging the
85 | ;; previous gap (D[i-1,j]+h).
86 | (aset nc j (min (aset nd j (+ h (min (+ oldc (if (< j (1- m)) g 0))
87 | (aref pd j))))
88 | (if (char-equal (aref a i) (aref b j))
89 | (- s (aref hotfuzz--bonus i))
90 | most-positive-fixnum)))))
91 |
92 | (defun hotfuzz--cost (needle haystack)
93 | "Return the difference score of NEEDLE and the match HAYSTACK."
94 | (let ((n (length haystack)) (m (length needle)))
95 | (if (> n hotfuzz--max-haystack-len)
96 | 10000
97 | (hotfuzz--calc-bonus haystack)
98 | (let ((c (fillarray hotfuzz--c 10000)) (d (fillarray hotfuzz--d 10000)))
99 | (dotimes (i n) (hotfuzz--match-row haystack needle i c d c d))
100 | (aref c (1- m))))))
101 |
102 | (defun hotfuzz-highlight (needle haystack)
103 | "Highlight destructively the characters NEEDLE matched in HAYSTACK.
104 | HAYSTACK has to be a match according to `hotfuzz-all-completions'."
105 | (let ((n (length haystack)) (m (length needle))
106 | (case-fold-search completion-ignore-case))
107 | (unless (or (> n hotfuzz--max-haystack-len) (> m hotfuzz--max-needle-len))
108 | (hotfuzz--calc-bonus haystack)
109 | (cl-loop
110 | with rows initially
111 | (cl-loop for i below n and pc = (fillarray hotfuzz--c 10000) then nc
112 | and pd = (fillarray hotfuzz--d 10000) then nd
113 | and nc = (make-vector m 0) and nd = (make-vector m 0) do
114 | (hotfuzz--match-row haystack needle i nc nd pc pd)
115 | (push (cons nc nd) rows))
116 | ;; Backtrack to find matching positions
117 | for j from (1- m) downto 0 and i downfrom (1- n) do
118 | (cl-destructuring-bind (c . d) (pop rows)
119 | (when (<= (aref d j) (aref c j))
120 | (while (progn (setq i (1- i))
121 | (> (aref d j) (aref (setq d (cdr (pop rows))) j))))))
122 | (add-face-text-property i (1+ i) 'completions-common-part nil haystack))))
123 | haystack)
124 |
125 | ;;;###autoload
126 | (defun hotfuzz-all-completions (string table &optional pred point)
127 | "Get hotfuzz-completions of STRING in TABLE.
128 | See `completion-all-completions' for the semantics of PRED and POINT.
129 | This function prematurely sorts the completions; mutating the result
130 | before passing it to `display-sort-function' or `cycle-sort-function'
131 | will lead to inaccuracies."
132 | (let* ((beforepoint (substring string 0 point))
133 | (afterpoint (if point (substring string point) ""))
134 | (bounds (completion-boundaries beforepoint table pred afterpoint))
135 | (prefix (substring beforepoint 0 (car bounds)))
136 | (needle (substring beforepoint (car bounds)))
137 | (use-module-p (fboundp 'hotfuzz--filter-c))
138 | (case-fold-search completion-ignore-case)
139 | (completion-regexp-list
140 | (if use-module-p completion-regexp-list
141 | (let ((re (mapconcat
142 | (lambda (ch) (let ((s (char-to-string ch)))
143 | (concat "[^" s "]*" (regexp-quote s))))
144 | needle "")))
145 | (cons (concat "\\`" re) completion-regexp-list))))
146 | (all (if (and (string= prefix "") (stringp (car-safe table))
147 | (not (or pred completion-regexp-list (string= needle ""))))
148 | table (all-completions prefix table pred))))
149 | ;; `completion-pcm--all-completions' tests completion-regexp-list
150 | ;; again with functional tables even though they should handle it.
151 | (cond
152 | ((or (null all) (string= needle "")))
153 | (use-module-p (setq all (hotfuzz--filter-c needle all completion-ignore-case)))
154 | ((> (length needle) hotfuzz--max-needle-len))
155 | (t (cl-loop for x in-ref all do (setf x (cons (hotfuzz--cost needle x) x)))
156 | (cl-loop for y in-ref (setq all (sort all #'car-less-than-car))
157 | do (setf y (cdr y)))))
158 | (setq hotfuzz--filtering-p (not (string= needle "")))
159 | (defvar completion-lazy-hilit-fn) ; Introduced in Emacs 30 (bug#47711)
160 | (if (bound-and-true-p completion-lazy-hilit)
161 | (setq completion-lazy-hilit-fn (apply-partially #'hotfuzz-highlight needle))
162 | (cl-loop repeat hotfuzz-max-highlighted-completions and for x in-ref all
163 | do (setf x (hotfuzz-highlight needle (copy-sequence x)))))
164 | (and all (if (string= prefix "") all (nconc all (length prefix))))))
165 |
166 | ;;;###autoload
167 | (defun hotfuzz--adjust-metadata (metadata)
168 | "Adjust completion METADATA for hotfuzz sorting."
169 | (if hotfuzz--filtering-p
170 | `(metadata (display-sort-function . identity) (cycle-sort-function . identity)
171 | . ,(cdr metadata))
172 | metadata))
173 |
174 | ;;;###autoload
175 | (progn
176 | (add-to-list 'completion-styles-alist
177 | '(hotfuzz completion-flex-try-completion hotfuzz-all-completions
178 | "Fuzzy completion."))
179 | ;; Why is the Emacs completion API so cursed?
180 | (put 'hotfuzz 'completion--adjust-metadata #'hotfuzz--adjust-metadata))
181 |
182 | (provide 'hotfuzz)
183 | ;;; hotfuzz.el ends here
184 |
--------------------------------------------------------------------------------
/test/tests.el:
--------------------------------------------------------------------------------
1 | ;;; tests.el --- The hotfuzz test suite -*- lexical-binding: t -*-
2 |
3 | (require 'ert)
4 | (require 'hotfuzz)
5 |
6 | ;;; Validation of costs of preferable traits, all else being equal
7 |
8 | (ert-deftest hotfuzz-shorter-match-cost-test ()
9 | "Shorter matches should be given lower costs than longer ones."
10 | (should (< (hotfuzz--cost "b" "abc") (hotfuzz--cost "b" "abcd"))))
11 |
12 | (ert-deftest hotfuzz-bos-match-cost-test ()
13 | "Matches at the beginning are preferred."
14 | (should (< (hotfuzz--cost "a" "ab") (hotfuzz--cost "a" "ba"))))
15 |
16 | (ert-deftest hotfuzz-substring-match-cost-test ()
17 | "A substring match means fewer gaps and lower cost."
18 | (should (< (hotfuzz--cost "ab" "abcd") (hotfuzz--cost "ab" "acbd"))))
19 |
20 | (ert-deftest hotfuzz-camelcase-match-cost-test ()
21 | (should (< (hotfuzz--cost "ac" "AbCd") (hotfuzz--cost "ac" "abcd"))))
22 |
23 | (ert-deftest hotfuzz-special-match-cost-test ()
24 | (should (<= (hotfuzz--cost "x" "/x")
25 | (hotfuzz--cost "x" "-x")
26 | (hotfuzz--cost "x" " x")
27 | (hotfuzz--cost "x" ".x")
28 | (hotfuzz--cost "x" "yx"))))
29 |
30 | (ert-deftest hotfuzz-tighter-match-cost-test ()
31 | "Test that matches spanning fewer characters are better."
32 | (should (< (hotfuzz--cost "ab" "xxaxbx") (hotfuzz--cost "ab" "xaxxbx"))))
33 |
34 | ;;; Highlighting tests
35 |
36 | (ert-deftest hotfuzz-highlight-optimal-test ()
37 | "Test that the algorithm is non-greedy."
38 | (should (ert-equal-including-properties
39 | (hotfuzz-highlight "ab" "xaxbxabxaxbx")
40 | #("xaxbxabxaxbx" 5 7 (face completions-common-part)))))
41 |
42 | ;;; Filtering tests
43 |
44 | (ert-deftest hotfuzz-case-sensitivity-test ()
45 | (let ((xs '("aa" "aA " "Aa " "AA ")))
46 | (let ((completion-ignore-case nil))
47 | (should (equal (hotfuzz-all-completions "a" xs) '("aa" "aA " "Aa ")))
48 | (should (equal (hotfuzz-all-completions "A" xs) '("Aa " "AA " "aA "))))
49 | (let ((completion-ignore-case t))
50 | (should (equal (hotfuzz-all-completions "a" xs) xs))
51 | (should (equal (hotfuzz-all-completions "A" xs) xs)))))
52 |
53 | (ert-deftest hotfuzz-long-candidates-test ()
54 | (let ((a (make-string 4096 ?x))
55 | (b (concat (make-string 2047 ?y) "x" (make-string 2048 ?y))))
56 | ;; Too long candidates should still be filtered with matches
57 | ;; lumped together at the end in their original order.
58 | (should (equal (hotfuzz-all-completions "x" (list (make-string 4096 ?y) b a "x"))
59 | (list "x" b a)))))
60 |
61 | (ert-deftest hotfuzz-filter-long-needle-test ()
62 | (let* ((needle (make-string (1+ hotfuzz--max-needle-len) ?x))
63 | (a (concat needle "y")))
64 | ;; With a too long search string candidates should only be
65 | ;; filtered but not sorted.
66 | (should (equal (hotfuzz-all-completions needle (list a "y" needle))
67 | (list a needle)))))
68 |
69 | (ert-deftest hotfuzz-all-completions-test ()
70 | (let* ((completion-styles '(hotfuzz))
71 | (s "fb")
72 | (table '("foobar" "fxxx" "foo-baz" "" "fb"))
73 | (md (completion-metadata s table nil))
74 | (all (completion-all-completions s table nil (length s) md))
75 | (sort-fn (completion-metadata-get md 'display-sort-function)))
76 | (setcdr (last all) nil)
77 | (when sort-fn (setq all (funcall sort-fn all)))
78 | ;; Completions should be eagerly fontified by default
79 | (should (equal-including-properties
80 | all
81 | '(#("fb" 0 2 (face completions-common-part))
82 | #("foo-baz" 0 1 (face completions-common-part) 4 5 (face completions-common-part))
83 | #("foobar" 0 1 (face completions-common-part) 3 4 (face completions-common-part)))))))
84 |
85 | (ert-deftest hotfuzz-display-sort-function-test ()
86 | "Test that empty strings apply the completion function `display-sort-function'."
87 | (cl-flet ((sorted-completions (string)
88 | (let* ((completion-styles '(hotfuzz))
89 | (table '("xbbx" "xx" "xax"))
90 | (md `(metadata (display-sort-function
91 | . ,(lambda (xs) (sort xs #'string<)))))
92 | (all (completion-all-completions
93 | string table nil (length string) md)))
94 | (funcall (completion-metadata-get md 'display-sort-function) all))))
95 | (should (equal (sorted-completions "") '("xax" "xbbx" "xx"))) ; Lexicographically sorted
96 | (should (equal (sorted-completions "xx") '("xx" "xax" "xbbx")))))
97 |
98 | (ert-deftest hotfuzz-boundaries-test ()
99 | "Test completion on a single field of a filename."
100 | (let ((completion-styles '(hotfuzz)))
101 | (should
102 | (equal
103 | (completion-all-completions
104 | "/usr/s/man"
105 | (lambda (string pred action)
106 | (let ((dir (file-name-directory string)))
107 | (pcase action
108 | (`(boundaries . ,suffix)
109 | `(boundaries ,(length dir) . ,(string-match-p "/" suffix)))
110 | ('t (all-completions "" '("bin/" "share/" "local/") pred)))))
111 | nil
112 | 6) ; Point as in "/usr/s|/man"
113 | '("share/" . 5)))))
114 |
115 | (defvar completion-lazy-hilit)
116 | (defvar completion-lazy-hilit-fn)
117 | (ert-deftest hotfuzz-lazy-hilit-test ()
118 | "Test lazy fontification."
119 | (let ((completion-lazy-hilit t) completion-lazy-hilit-fn)
120 | (should (equal-including-properties (hotfuzz-all-completions "x" '("x")) '("x")))
121 | (should (equal-including-properties (funcall completion-lazy-hilit-fn "x")
122 | #("x" 0 1 (face completions-common-part))))))
123 |
--------------------------------------------------------------------------------