├── demos
├── semext-query-replace.gif
└── semext-search-forward.gif
├── README.org
├── COPYING
└── semext.el
/demos/semext-query-replace.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ahyatt/semext/HEAD/demos/semext-query-replace.gif
--------------------------------------------------------------------------------
/demos/semext-search-forward.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ahyatt/semext/HEAD/demos/semext-search-forward.gif
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | #+TITLE: Semext - LLM-powed SEMantic EXTensions for Emacs
2 |
3 | Semext aims to provide LLM-powered version of Emacs command in ways that feel natural to Emacs users. The goal is to be as Emacs-like as possible.
4 |
5 | * Demo
6 | An example of searching semantically with =semext-search-forward=:
7 |
8 | #+CAPTION: semext-search-forward demo
9 | [[./demos/semext-search-forward.gif]]
10 |
11 | Using =semext-query-replace=:
12 |
13 | #+CAPTION: semext-query-replace demo
14 | [[./demos/semext-query-replace.gif]]
15 |
16 | * Installation
17 | #+begin_src emacs-lisp
18 | (use-package semext
19 | :vc (:fetcher github :repo "ahyatt/semext")
20 | :init
21 | ;; Replace provider with whatever you want, see https://github.com/ahyatt/llm
22 | (setopt semext-provider (make-llm-ollama :chat-model "gemma3:1b")))
23 | #+end_src
24 |
25 | * Usage
26 | This library integrates Emacs with LLMs to provide functionality that is close to what Emacs already has, but more flexible and powerful since it is driven by LLMs. While it is powerful and in many cases much easier to use than the non-LLM powered equivalents, the downside is that it is also slower and not predictable.
27 |
28 | The following commands are supported:
29 |
30 | - =semext-forward-part=, =semext-backward-part=. Similar in spirit to =forward-page= and =backward-page=, these commands ask the LLM to identify significant semantic parts of the buffer (like functions, sections, or important paragraphs) and navigate between them. The parts are computed on demand across the entire buffer each time the command is run.
31 | - =semext-query-replace=. Similar to =query-replace=, this finds text matching a semantic description provided by the user and interactively asks whether to replace it based on a replacement description. It processes the entire buffer before starting the interactive replacement.
32 | - =semext-search-forward=, =semext-search-backward=. Similar to =search-forward=, these find the next or previous instance of text matching a semantic description provided by the user. They process the entire buffer to find all occurrences before jumping to the relevant one.
33 |
34 | * Caveats
35 | - *Performance*: The first time a command like =semext-search-forward= or =semext-forward-part= is run, it queries the LLM over the entire buffer (in chunks), which can be slow. Subsequent calls for the same operation (e.g., searching for the same text again, or moving to the next part) will be much faster as they use a cache.
36 | - *Caching*: Results are cached locally for each buffer. The cache is automatically invalidated if the text at a cached location changes. You can manually clear the cache using =M-x semext-clear-cache=.
37 | - *Consistency*: LLMs operate on fixed-size context windows. While =semext= processes the buffer in overlapping chunks, there might still be inconsistencies in how the LLM interprets boundaries or context across very large distances in the buffer, especially during the initial LLM query.
38 | - *Provider Choice*: A LLM provider capable of handling JSON responses is recommended (see =semext-provider=).
39 |
40 | There are no mode requirements for any command. They operate in any mode.
41 |
42 | * Commands
43 |
44 | - =semext-forward-part=, =semext-backward-part=: Navigate between semantic parts identified by the LLM. Uses cache after first run.
45 | - =semext-query-replace=: Semantic query-replace. Uses cache after first run for a specific query.
46 | - =semext-search-forward=, =semext-search-backward=: Semantic search. Uses cache after first run for a specific query.
47 | - =semext-clear-cache=: Manually clear the entire results cache for the current buffer.
48 |
49 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/semext.el:
--------------------------------------------------------------------------------
1 | ;;; semext.el -- Semantic extensions to Emacs functionality -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (c) 2025 Andrew Hyatt
4 |
5 | ;; Author: Andrew Hyatt
6 | ;; Homepage: https://github.com/ahyatt/ekg
7 | ;; Package-Requires: ((llm "0.24.0"))
8 | ;; Keywords: replacement
9 | ;; Version: 0.0.1
10 | ;; SPDX-License-Identifier: GPL-3.0-or-later
11 | ;;
12 | ;; This program is free software; you can redistribute it and/or
13 | ;; modify it under the terms of the GNU General Public License as
14 | ;; published by the Free Software Foundation; either version 3 of the
15 | ;; License, or (at your option) any later version.
16 | ;;
17 | ;; This program is distributed in the hope that it will be useful, but
18 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 | ;; General Public License for more details.
21 | ;;
22 | ;; You should have received a copy of the GNU General Public License
23 | ;; along with GNU Emacs. If not, see .
24 |
25 | ;;; Commentary:
26 |
27 | ;; This library provides some extensions to the built-in Emacs, using llm
28 | ;; functionality. The goal is to provide new functions that operate like
29 | ;; existing functions, but at a semantic level.
30 |
31 | ;;; Code:
32 |
33 | (require 'llm)
34 | (require 'seq)
35 | (require 'cl-lib)
36 |
37 | (defgroup semext nil
38 | "Semantic extensions to Emacs functionality."
39 | :group 'convenience)
40 |
41 | (defcustom semext-chunk-size 500
42 | "Number of lines to send to the LLM at once.
43 | Larger values may provide better semantic understanding but require
44 | more LLM context window space."
45 | :type 'integer
46 | :group 'semext)
47 |
48 | (defcustom semext-chunk-overlap 10
49 | "Number of lines to overlap between chunks.
50 | This helps maintain context between chunks."
51 | :type 'integer
52 | :group 'semext)
53 |
54 | (defvar semext-provider nil
55 | "The LLM provider to use for semext functionality.
56 |
57 | This should be a provider that can do json responses, and is both fast
58 | with good quality. The following should be non-nil (although it may not
59 | work on newer models the llm library doesn't know about):
60 |
61 | `(member 'json-response (llm-capabilities semext-provider))'
62 | ")
63 |
64 | (defconst semext--parts-prompt "You will be given the contents of an Emacs buffer.
65 | Divide the buffer into meaningful semantic units, relatively
66 | fine-grained. For text documents, these may be parts that introduce new
67 | concepts. For code, these may be significant parts, such as a function,
68 | or within a function, a significant stanza of code, or the start of
69 | documentation. The goal is to give the user the most useful points to
70 | navigate between.
71 |
72 | To specify the divisions between semantic units, you will supply a line
73 | number (we'll provide them in the Emacs buffer), and the characters
74 | immediately after the division. This will be used to go to the line and
75 | search for the characters to identify the exact point, which is the
76 | start of the characters.
77 |
78 | Return the result as a JSON object."
79 | "The prompt to use for getting the parts of a buffer.")
80 |
81 | (defconst semext--parts-json-schema '(:type object
82 | :properties
83 | (:parts
84 | (:type array
85 | :items
86 | (:type object
87 | :properties
88 | (:line_num (:type integer)
89 | :start_chars (:type string))
90 | :required ["line_num" "start_chars"]
91 | :additionalProperties :json-false)))
92 | :additionalProperties :json-false
93 | :required ["parts"])
94 | "The JSON schema we expect to get back for finding semantic parts.")
95 |
96 | (defconst semext--query-replace-prompt "You will be given the contents of an Emacs buffer and a search/replace request.
97 | Identify all occurrences matching the search description. For each
98 | occurrence, specify the exact start and end location of the text to
99 | replace, and the text to replace it with, based on the replacement
100 | description. The `start_chars` is the first few characters (enough to
101 | be unique) occuring at `start_line_num` that start the location that
102 | will be replaced. The start point is the beginning of those characters.
103 | The `end_chars` is the last few characters (again, enough to be unique),
104 | that end the location, occuring at `end_line_num`. The end point is at
105 | the last of those characters.
106 |
107 | Return the result as a JSON object."
108 | "The prompt to use for semantic search and replace.")
109 |
110 | (defconst semext--query-replace-json-schema
111 | '(:type object
112 | :properties
113 | (:replacements
114 | (:type array
115 | :items
116 | (:type object
117 | :properties
118 | (:start_line_num (:type integer)
119 | :start_chars (:type string)
120 | :end_line_num (:type integer)
121 | :end_chars (:type string)
122 | :replacement_text (:type string))
123 | :required ["start_line_num" "start_chars" "end_line_num" "end_chars" "replacement_text"]
124 | :additionalProperties :json-false)))
125 | :additionalProperties :json-false
126 | :required ["replacements"])
127 | "The JSON schema for semantic search and replace responses.")
128 |
129 | (defconst semext--search-prompt "You will be given the contents of an Emacs buffer and a search description.
130 | Identify all occurrences matching the search description. For each
131 | occurrence, specify the exact start and end location. The `start_chars`
132 | is the first few characters (enough to be unique) occuring at
133 | `start_line_num` that start the location. The start point is the beginning
134 | of those characters. The `end_chars` is the last few characters (again,
135 | enough to be unique), that end the location, occuring at `end_line_num`.
136 | The end point is at the last of those characters.
137 |
138 | Return the result as a JSON object."
139 | "The prompt to use for semantic search.")
140 |
141 | (defconst semext--search-json-schema
142 | '(:type object
143 | :properties
144 | (:occurrences
145 | (:type array
146 | :items
147 | (:type object
148 | :properties
149 | (:start_line_num (:type integer)
150 | :start_chars (:type string)
151 | :end_line_num (:type integer)
152 | :end_chars (:type string))
153 | :required ["start_line_num" "start_chars" "end_line_num" "end_chars"]
154 | :additionalProperties :json-false)))
155 | :additionalProperties :json-false
156 | :required ["occurrences"])
157 | "The JSON schema for semantic search responses.")
158 |
159 | ;; State for multi-chunk operations
160 | (defvar-local semext--aggregated-results nil
161 | "List to store results aggregated across multiple chunks.")
162 | (defvar-local semext--last-processed-end-point nil
163 | "The end point of the last chunk processed during a multi-chunk operation.")
164 | (defvar-local semext--active-operation-finalizer nil
165 | "The function to call once all chunks have been processed.")
166 | (defvar-local semext--active-operation-error-prefix nil
167 | "The error prefix for the currently active multi-chunk operation.")
168 | (defvar-local semext--active-operation-query-details nil
169 | "The query details associated with the current operation (for caching).")
170 |
171 | (defvar-local semext--results-cache (make-hash-table :test 'equal)
172 | "Buffer-local cache for semext operation results.
173 | Keys are (OPERATION-TYPE . QUERY-DETAILS), e.g., '(:parts . t) or
174 | '(:search . \"find functions\"). Values depend on the operation type
175 | but generally involve markers and validation characters.")
176 |
177 | (defvar-local semext--cache-last-validated-tick nil
178 | "Buffer modification tick when the cache was last validated.
179 | Used to avoid redundant validation.")
180 |
181 | (defun semext--buffer-text (&optional start end)
182 | "Return the buffer text with line numbers prepended to each line.
183 | If START and END are provided, only return text between those positions."
184 | (let ((lines nil)
185 | (line-num 1)
186 | (start-line-num 1))
187 | (save-excursion
188 | (goto-char (point-min))
189 | ;; Count lines until START if provided
190 | (when start
191 | (while (and (< (point) start) (not (eobp)))
192 | (setq line-num (1+ line-num))
193 | (forward-line 1))
194 | (setq start-line-num line-num))
195 | ;; If END is provided, collect lines until END
196 | ;; Otherwise collect all lines
197 | (while (and (if end (< (point) end) t)
198 | (not (eobp)))
199 | (let ((line (buffer-substring-no-properties
200 | (line-beginning-position)
201 | (line-end-position))))
202 | (push (format "%d: %s" line-num line) lines)
203 | (setq line-num (1+ line-num))
204 | (forward-line 1))))
205 | (cons start-line-num (string-join (nreverse lines) "\n"))))
206 |
207 | (defun semext--get-chunk-bounds (point)
208 | "Get the start and end positions for a chunk centered around POINT."
209 | (save-excursion
210 | (goto-char point)
211 | ;; Move to line beginning
212 | (beginning-of-line)
213 | ;; Calculate half chunk size (with overlap consideration)
214 | (let* ((half-chunk (/ semext-chunk-size 2))
215 | (chunk-start-line (max 1 (- (line-number-at-pos) half-chunk)))
216 | (chunk-end-line (+ chunk-start-line semext-chunk-size))
217 | chunk-start chunk-end)
218 |
219 | ;; Find start position
220 | (goto-char (point-min))
221 | (forward-line (1- chunk-start-line))
222 | (setq chunk-start (point))
223 |
224 | ;; Find end position
225 | (goto-char (point-min))
226 | (forward-line (1- chunk-end-line))
227 | (if (eobp)
228 | (setq chunk-end (point-max))
229 | (end-of-line)
230 | (setq chunk-end (point)))
231 |
232 | (cons chunk-start chunk-end))))
233 |
234 | (defun semext--process-buffer-region (start end prompt schema success-callback error-callback &optional context-note)
235 | "Process the buffer region from START to END using the LLM.
236 |
237 | Call LLM with PROMPT and expect response matching SCHEMA. On success,
238 | call SUCCESS-CALLBACK with the parsed JSON data and START-LINE-NUM. On
239 | error, call ERROR-CALLBACK with the error message. CONTEXT-NOTE is an
240 | optional string to add to the prompt context."
241 | ;; Note: This function uses llm-chat-async. If multiple calls overlap,
242 | ;; the behavior might be unpredictable depending on the provider.
243 | ;; The current design relies on user interaction flow to prevent overlaps.
244 |
245 | (message "Processing chunk from line %d to %d (async)..."
246 | (line-number-at-pos start)
247 | (line-number-at-pos end))
248 |
249 | (condition-case err
250 | (let* ((text-with-info (semext--buffer-text start end))
251 | (start-line-num (car text-with-info))
252 | (text (cdr text-with-info))
253 | (full-context (concat prompt
254 | (when context-note (concat "\n" context-note)))))
255 | (llm-chat-async
256 | semext-provider
257 | (llm-make-chat-prompt text :context full-context :response-format schema)
258 | ;; Success lambda
259 | (lambda (resp)
260 | (message "Received response from LLM for chunk")
261 | (condition-case err
262 | (let ((json-data (json-parse-string resp :object-type 'plist :array-type 'list)))
263 | (funcall success-callback json-data start-line-num))
264 | (error
265 | (message "Error processing LLM response: %s" (error-message-string err))
266 | (funcall error-callback (error-message-string err)))))
267 | ;; No processing flag to clear
268 | ;; Error lambda
269 | (lambda (_ err)
270 | (message "Error during LLM request: %s" err)
271 | (funcall error-callback err))))
272 | ;; No processing flag to clear << This comment seems misplaced/outdated
273 | ;; Error handling for setting up the request
274 | (error
275 | (message "Failed to start LLM request: %s" (error-message-string err))
276 | (funcall error-callback (error-message-string err)))))
277 |
278 | (defun semext--average-line-length ()
279 | "Calculate the average length of lines in characters."
280 | (let ((lines (line-number-at-pos (point-max))))
281 | (if (> lines 0)
282 | (/ (- (point-max) (point-min)) lines)
283 | 80))) ; Default if buffer is empty or has no lines
284 |
285 | (defun semext-forward-part (&optional n)
286 | "Move point forward to the beginning of the next semantic part.
287 |
288 | With prefix argument N, move forward N parts. Parts are computed on
289 | demand across the entire buffer or retrieved from cache."
290 | (interactive "p")
291 | (setq n (or n 1))
292 | (let ((original-point (point))
293 | (cache-key '(:parts . t))) ; Simple key for parts
294 | (if-let ((cached-parts (semext--get-cached-results cache-key)))
295 | ;; Use cached results
296 | (let* ((part-points (cl-loop for entry in cached-parts collect (marker-position (car entry))))
297 | (next-points (seq-filter (lambda (pt) (> pt original-point)) part-points)))
298 | (if (and next-points (<= n (length next-points)))
299 | (progn
300 | (goto-char (nth (1- n) next-points))
301 | (message "Moved forward %d part(s) (cached)" n))
302 | (message "No further parts found forward (cached)")))
303 | ;; No valid cache, perform LLM search
304 | (semext--perform-search-action
305 | semext--parts-prompt
306 | semext--parts-json-schema
307 | t ; Query details for parts cache key
308 | ;; Finalizer callback
309 | (lambda (all-parts-points) ; Receives a sorted list of points
310 | (let* (;; Find points after the original point
311 | (next-points (seq-filter (lambda (pt) (> pt original-point))
312 | all-parts-points)))
313 | (if (and next-points (<= n (length next-points)))
314 | (progn
315 | (goto-char (nth (1- n) next-points))
316 | (message "Moved forward %d part(s)" n))
317 | (message "No further parts found forward"))))
318 | ;; Error message prefix
319 | "Error during semantic forward-part"))))
320 |
321 | (defun semext-backward-part (&optional n)
322 | "Move point backward to the beginning of the previous semantic part.
323 |
324 | With prefix argument N, move backward N parts. Parts are computed on
325 | demand across the entire buffer or retrieved from cache."
326 | (interactive "p")
327 | (setq n (or n 1))
328 | (let ((original-point (point))
329 | (cache-key '(:parts . t))) ; Simple key for parts
330 | (if-let ((cached-parts (semext--get-cached-results cache-key)))
331 | ;; Use cached results
332 | (let* ((part-points (cl-loop for entry in cached-parts collect (marker-position (car entry))))
333 | (prev-points (seq-filter (lambda (pt) (< pt original-point)) part-points)))
334 | (if (and prev-points (<= n (length prev-points)))
335 | (progn
336 | (goto-char (nth (- (length prev-points) n) prev-points))
337 | (message "Moved backward %d part(s) (cached)" n))
338 | (message "No previous parts found backward (cached)")))
339 | ;; No valid cache, perform LLM search
340 | (semext--perform-search-action
341 | semext--parts-prompt
342 | semext--parts-json-schema
343 | t ; Query details for parts cache key
344 | ;; Finalizer callback
345 | (lambda (all-parts-points) ; Receives a sorted list of points
346 | (let* (;; Find points before the original point
347 | (prev-points (seq-filter (lambda (pt) (< pt original-point))
348 | all-parts-points)))
349 | (if (and prev-points (<= n (length prev-points)))
350 | (progn
351 | ;; Get the nth previous point (list is sorted, so take from end)
352 | (goto-char (nth (- (length prev-points) n) prev-points))
353 | (message "Moved backward %d part(s)" n))
354 | (message "No previous parts found backward"))))
355 | ;; Error message prefix
356 | "Error during semantic backward-part"))))
357 |
358 | (defun semext--find-point-from-line-chars (line-num chars)
359 | "Find the buffer position corresponding to LINE-NUM and starting CHARS."
360 | (save-excursion
361 | (goto-char (point-min))
362 | (forward-line (1- line-num))
363 | (when (search-forward chars (line-end-position) t)
364 | (backward-char (length chars))
365 | (point))))
366 |
367 | (defun semext--perform-search-action (prompt schema query-details finalizer-callback error-message-prefix)
368 | "Initiate a multi-chunk semantic action across the entire buffer.
369 |
370 | Handles provider check, sets up state, and starts processing the first chunk.
371 |
372 | PROMPT: The base prompt string for the LLM (chunk info will be added).
373 |
374 | SCHEMA: The expected JSON schema for the response.
375 |
376 | QUERY-DETAILS: Data identifying the specific query (e.g., search
377 | string).
378 |
379 | FINALIZER-CALLBACK: Function to call with the aggregated results list
380 | once the entire buffer is processed. It receives (results).
381 |
382 | ERROR-MESSAGE-PREFIX: String to prefix error messages with."
383 | (unless (member 'json-response (llm-capabilities semext-provider))
384 | (error "semext requires a provider that can do json responses"))
385 | (when semext--active-operation-finalizer
386 | (message "Warning: Overwriting an existing semantic operation"))
387 |
388 | ;; Reset state for the new operation
389 | (setq semext--aggregated-results nil
390 | semext--last-processed-end-point (point-min) ; Start tracking from point-min
391 | semext--active-operation-finalizer finalizer-callback
392 | semext--active-operation-error-prefix error-message-prefix
393 | semext--active-operation-query-details query-details) ; Store query details
394 |
395 | (message "Starting semantic operation...")
396 | ;; Start processing from the beginning of the buffer
397 | (semext--process-next-chunk prompt schema))
398 |
399 | (defun semext--process-next-chunk (prompt schema)
400 | "Process with PROMPT and SCHEMA the next chunk of text in the buffer.
401 |
402 | Calculate bounds for the next chunk starting after the last processed
403 | point and call the LLM processor."
404 | ;; Calculate next chunk start point considering overlap
405 | (let* ((next-chunk-start (max (point-min)
406 | (- semext--last-processed-end-point
407 | (* semext-chunk-overlap (semext--average-line-length)))))
408 | (bounds (semext--get-chunk-bounds next-chunk-start))
409 | (chunk-start (car bounds))
410 | (chunk-end (cdr bounds)))
411 |
412 | ;; Check if the new chunk start is already beyond the last processed end point.
413 | ;; This indicates we've covered the buffer.
414 | (if (>= chunk-start semext--last-processed-end-point)
415 | ;; If last processed point was already point-max, we are done.
416 | ;; Otherwise, if chunk_start >= last_end, and last_end wasn't point_max,
417 | ;; it means get-chunk-bounds might have clamped to point-max, process this last chunk.
418 | (if (= semext--last-processed-end-point (point-max))
419 | (progn ;; Already finished, do nothing here.
420 | (message "Semantic operation complete (final check detected).")
421 | ;; The finalizer call and state clearing will happen in the
422 | ;; semext--handle-chunk-response instance that detected
423 | ;; last-processed-end-point reached point-max.
424 | nil) ; Explicitly do nothing
425 | ;; Process the potentially final chunk (e.g., if buffer size < chunk size)
426 | (semext--process-buffer-region-wrapper chunk-start chunk-end prompt schema))
427 | ;; Process the calculated chunk
428 | (semext--process-buffer-region-wrapper chunk-start chunk-end prompt schema))))
429 |
430 | (defun semext--process-buffer-region-wrapper (chunk-start chunk-end prompt schema)
431 | "Wrapper to call semext--process-buffer-region with the chunk-aware callback."
432 | (semext--process-buffer-region
433 | chunk-start chunk-end
434 | prompt schema
435 | ;; Success callback - pass chunk_end along
436 | (lambda (json-data start-line-num)
437 | (semext--handle-chunk-response json-data start-line-num chunk-end prompt schema))
438 | ;; Error callback
439 | (lambda (err)
440 | (message "%s: %s" semext--active-operation-error-prefix err)
441 | (setq semext--active-operation-finalizer nil)) ; Clear state on error
442 | ;; Context note
443 | "Note: The line numbers provided are relative to the excerpt you're analyzing."))
444 |
445 | (defun semext--handle-chunk-response (json-data start-line-num chunk-end prompt schema)
446 | "Handle the response for a single chunk.
447 |
448 | Aggregate results, and trigger next chunk or finalizer."
449 | ;; Process results for this chunk based on the response structure
450 | (let ((new-results (cond ((plist-member json-data :replacements)
451 | (semext--process-query-replace-results json-data start-line-num))
452 | ((plist-member json-data :occurrences)
453 | (semext--process-search-results json-data start-line-num))
454 | ((plist-member json-data :parts)
455 | (semext--process-parts-results json-data start-line-num))
456 | (t
457 | (message "Warning: Unknown JSON response structure received")
458 | nil))))
459 | (when new-results
460 | ;; Append results directly; duplicates will be handled after sorting.
461 | (setq semext--aggregated-results (append semext--aggregated-results new-results)))
462 |
463 | ;; Update the point up to which we have processed
464 | (setq semext--last-processed-end-point (max semext--last-processed-end-point chunk-end))
465 |
466 | ;; Check if we've processed the entire buffer
467 | (if (< semext--last-processed-end-point (point-max))
468 | ;; More buffer to process, trigger next chunk
469 | (progn
470 | (message "Processed up to line %d. Requesting next chunk..." (line-number-at-pos semext--last-processed-end-point))
471 | (semext--process-next-chunk prompt schema))
472 | ;; End of buffer reached, sort, remove duplicates, store in cache, and call the finalizer
473 | (message "Semantic operation complete.")
474 | (let* ((sorted-unique-results (seq-uniq
475 | (sort semext--aggregated-results
476 | :key (lambda (x) (plist-get x :start)))))
477 | ;; Determine cache key based on prompt/schema (needs refinement)
478 | ;; For now, let's use a simplified key based on operation type derived from schema
479 | (op-type (cond ((eq schema semext--parts-json-schema) :parts)
480 | ((eq schema semext--query-replace-json-schema) :replace)
481 | ((eq schema semext--search-json-schema) :search)
482 | (t :unknown)))
483 | ;; Need query details for search/replace keys
484 | ;; This requires passing the original query through the chain,
485 | ;; or storing it in another state variable. Let's add state vars.
486 | (query-details semext--active-operation-query-details)
487 | (cache-key (cons op-type query-details)))
488 |
489 | ;; Store results before calling finalizer
490 | (when (and (not (eq op-type :unknown)) query-details)
491 | (semext--store-results-in-cache cache-key sorted-unique-results))
492 |
493 | ;; Call the original finalizer
494 | (funcall semext--active-operation-finalizer sorted-unique-results))
495 |
496 | ;; Clear state (finalizer and error prefix cleared, cache persists)
497 | (setq semext--active-operation-finalizer nil
498 | semext--aggregated-results nil
499 | semext--last-processed-end-point nil
500 | semext--active-operation-error-prefix nil))))
501 |
502 | ;;; Cache Management
503 |
504 | (defun semext--validate-marker-entry (marker-char-pair)
505 | "Validate a single (MARKER . CHAR) pair. Return t if valid."
506 | (let ((marker (car marker-char-pair))
507 | (expected-char (cdr marker-char-pair)))
508 | (and marker
509 | (marker-position marker)
510 | (eq (char-after (marker-position marker)) expected-char))))
511 |
512 | (defun semext--validate-cache-entry (cache-entry)
513 | "Validate a full cache entry (list of marker pairs/tuples).
514 |
515 | Return t if all valid."
516 | (cl-every (lambda (item)
517 | (cond
518 | ;; Parts: (marker . char)
519 | ((and (markerp (car item)) (characterp (cdr item)))
520 | (semext--validate-marker-entry item))
521 | ;; Search: ((start-marker . start-char) . (end-marker . end-char))
522 | ((and (consp (car item)) (consp (cdr item))
523 | (markerp (caar item)) (characterp (cdar item))
524 | (markerp (cadr item)) (characterp (cddr item)))
525 | (and (semext--validate-marker-entry (car item))
526 | (semext--validate-marker-entry (cdr item))))
527 | ;; Replace: (((start-marker . start-char) . (end-marker . end-char)) . replacement)
528 | ((and (consp (car item)) (consp (caar item)) (consp (cdar item))
529 | (markerp (caaar item)) (characterp (cdaar item))
530 | (markerp (cadar item)) (characterp (cddar item)))
531 | (and (semext--validate-marker-entry (caar item))
532 | (semext--validate-marker-entry (cdar item))))
533 | (t (error "Unknown cache entry item format: %S" item)))) ; Should not happen
534 | cache-entry))
535 |
536 | (defun semext-clear-cache (&optional key)
537 | "Clear the semext results cache for the current buffer.
538 | If KEY is provided (internally), clear only that entry.
539 | Interactively, always clears the entire cache."
540 | (interactive) ; Always clear the whole cache when called interactively
541 | (if key
542 | (remhash key semext--results-cache)
543 | (clrhash semext--results-cache))
544 | (setq semext--cache-last-validated-tick nil)
545 | (message "Semext cache cleared%s" (if key " for specific key." ".")))
546 |
547 | (defun semext--get-cached-results (key)
548 | "Get cached results for KEY if valid, otherwise return nil and clear entry.
549 | KEY is (OPERATION-TYPE . QUERY-DETAILS)."
550 | (let ((cached-entry (gethash key semext--results-cache))
551 | (current-tick (buffer-modified-tick)))
552 | (when cached-entry
553 | ;; Avoid re-validating if buffer hasn't changed since last validation
554 | (if (and semext--cache-last-validated-tick
555 | (= current-tick semext--cache-last-validated-tick))
556 | cached-entry ; Assume still valid
557 | ;; Buffer changed or first access, validate now
558 | (if (semext--validate-cache-entry cached-entry)
559 | (progn
560 | (setq semext--cache-last-validated-tick current-tick)
561 | cached-entry) ; Valid
562 | ;; Invalid, clear this entry and return nil
563 | (progn
564 | (message "Semext cache invalidated for key: %S" key)
565 | (semext-clear-cache key)
566 | nil))))))
567 |
568 | (defun semext--store-results-in-cache (key results)
569 | "Process raw RESULTS, create markers/validation, store in cache for KEY."
570 | (let ((cache-entry nil)
571 | (op-type (car key)))
572 | (setq cache-entry
573 | (cond
574 | ;; Parts: results = list of points
575 | ((eq op-type :parts)
576 | (cl-loop for pt in results
577 | when pt
578 | collect (cons (copy-marker pt t) (char-after pt))))
579 | ;; Search: results = list of (start . end) cons cells
580 | ((eq op-type :search)
581 | (cl-loop for pair in results
582 | for start = (car pair)
583 | for end = (cdr pair)
584 | when (and start end)
585 | collect (cons (cons (copy-marker start t) (char-after start))
586 | (cons (copy-marker end t) (char-after end)))))
587 | ;; Replace: results = list of (:start S :end E :replacement R) plists
588 | ((eq op-type :replace)
589 | (cl-loop for res in results
590 | for start = (plist-get res :start)
591 | for end = (plist-get res :end)
592 | for replacement = (plist-get res :replacement)
593 | when (and start end)
594 | collect (cons (cons (cons (copy-marker start t) (char-after start))
595 | (cons (copy-marker end t) (char-after end)))
596 | replacement)))
597 | (t (error "Unknown operation type for caching: %S" op-type))))
598 | (when cache-entry
599 | (puthash key cache-entry semext--results-cache)
600 | (setq semext--cache-last-validated-tick (buffer-modified-tick)))))
601 |
602 | (defun semext-query-replace (search-query replace-query)
603 | "Perform semantic search for SEARCH-QUERY and replace with REPLACE-QUERY.
604 |
605 | Processes the entire buffer chunk by chunk (or uses cache), then
606 | interactively asks for each replacement."
607 | (interactive "sSearch query: \nsReplace query: ")
608 | (let* ((query-details (format "S:%s R:%s" search-query replace-query)) ; Combine queries for key
609 | (cache-key (cons :replace query-details))
610 | (prompt (format "%s\n\nSearch Description: %s\nReplacement Description: %s"
611 | semext--query-replace-prompt search-query replace-query))
612 | (finalizer
613 | (lambda (results-data is-cached) ; Modified finalizer takes results and cache status
614 | (let ((marker-pairs nil) ; List to store (start-marker end-marker replacement-text)
615 | (applied-count 0))
616 | (if (not results-data)
617 | (message "LLM did not identify any replacements in the buffer%s." (if is-cached " (cached)" ""))
618 | ;; 1. Create markers from results (cached or fresh)
619 | (if is-cached
620 | ;; Cached data format: (((start-marker . char) . (end-marker . char)) . replacement)
621 | (dolist (entry results-data)
622 | (let* ((markers (car entry))
623 | (start-marker (caar markers))
624 | (end-marker (cadr markers))
625 | (replacement (cdr entry)))
626 | (push (list start-marker end-marker replacement) marker-pairs)))
627 | ;; Fresh data format: list of (:start S :end E :replacement R) plists
628 | (dolist (res results-data)
629 | (push (list (copy-marker (plist-get res :start))
630 | (copy-marker (plist-get res :end))
631 | (plist-get res :replacement))
632 | marker-pairs)))
633 | ;; Markers created, now process interactively (reverse push order for buffer order)
634 | (setq marker-pairs (nreverse marker-pairs))
635 | (dolist (pair marker-pairs)
636 | (let ((start-marker (nth 0 pair))
637 | (end-marker (nth 1 pair))
638 | (replacement-text (nth 2 pair)))
639 | (when (and (marker-position start-marker) (marker-position end-marker)) ; Check if markers are still valid
640 | (goto-char (marker-position start-marker))
641 | (push-mark (marker-position end-marker) t t) ; Highlight region
642 | (let ((original-text (buffer-substring-no-properties
643 | (marker-position start-marker)
644 | (marker-position end-marker))))
645 | (if (y-or-n-p (format "Replace '%s' with '%s'? "
646 | (truncate-string-to-width original-text 40 nil nil "...")
647 | (truncate-string-to-width replacement-text 40 nil nil "...")))
648 | (progn
649 | (delete-region (marker-position start-marker) (marker-position end-marker))
650 | (insert replacement-text)
651 | (cl-incf applied-count))))
652 | ;; Ensure mark is deactivated regardless of user choice
653 | (deactivate-mark))
654 | ;; Clean up markers after processing
655 | (set-marker start-marker nil)
656 | (set-marker end-marker nil)))
657 | (message "Finished query-replace. Applied %d replacements%s." applied-count (if is-cached " (cached)" "")))))))
658 |
659 | (if-let ((cached-results (semext--get-cached-results cache-key)))
660 | ;; Use cached results
661 | (funcall finalizer cached-results t)
662 | ;; No valid cache, perform LLM search
663 | (semext--perform-search-action
664 | prompt
665 | semext--query-replace-json-schema
666 | query-details ; Pass query details for caching
667 | ;; Finalizer callback (runs after all chunks are processed)
668 | (lambda (fresh-results) (funcall finalizer fresh-results nil)) ; Call wrapper with is-cached=nil
669 | ;; Error message prefix
670 | "Error during semantic query-replace"))))
671 |
672 | (defun semext--process-parts-results (json-data start-line-num)
673 | "Process JSON parts results and return a list of points.
674 |
675 | START-LINE-NUM is the starting line number of the processed chunk."
676 | (let ((parts (plist-get json-data :parts))
677 | (points nil))
678 | (when parts
679 | (dolist (part parts)
680 | (let* ((line-num (+ (1- start-line-num) (plist-get part :line_num)))
681 | (start-chars (plist-get part :start_chars))
682 | (point (semext--find-point-from-line-chars line-num start-chars)))
683 | (when point
684 | (push point points)))))
685 | ;; Return points found in this chunk (sorting happens after aggregation)
686 | points))
687 |
688 | (defun semext--process-query-replace-results (json-data start-line-num)
689 | "Process JSON query-replace results and return a list of plists.
690 |
691 | Each plist is (:start START :end END :replacement TEXT). START-LINE-NUM
692 | is the starting line number of the processed chunk."
693 | (let ((replacements (plist-get json-data :replacements))
694 | (results nil))
695 | (when replacements
696 | (dolist (rep replacements)
697 | (let* ((rep-start-line (+ (1- start-line-num) (plist-get rep :start_line_num)))
698 | (rep-start-chars (plist-get rep :start_chars))
699 | (rep-end-line (+ (1- start-line-num) (plist-get rep :end_line_num)))
700 | (rep-end-chars (plist-get rep :end_chars))
701 | (replacement-text (plist-get rep :replacement_text))
702 | (start-point (semext--find-point-from-line-chars rep-start-line rep-start-chars))
703 | (end-point (save-excursion
704 | (when-let ((p (semext--find-point-from-line-chars rep-end-line rep-end-chars)))
705 | (when p (+ p (length rep-end-chars)))))))
706 | (when (and start-point end-point (> end-point start-point))
707 | (push (list :start start-point :end end-point :replacement replacement-text)
708 | results)))))
709 | ;; Return in buffer order (reverse the pushed list)
710 | (nreverse results)))
711 |
712 | (defun semext--process-search-results (json-data start-line-num)
713 | "Process JSON search results and return a sorted list of (START . END) point pairs.
714 |
715 | START-LINE-NUM is the starting line number of the processed chunk."
716 | (let ((occurrences (plist-get json-data :occurrences))
717 | (point-pairs nil))
718 | (when occurrences
719 | (dolist (occ occurrences)
720 | (let* ((occ-start-line (+ (1- start-line-num) (plist-get occ :start_line_num)))
721 | (occ-start-chars (plist-get occ :start_chars))
722 | (occ-end-line (+ (1- start-line-num) (plist-get occ :end_line_num)))
723 | (occ-end-chars (plist-get occ :end_chars))
724 | (start-point (semext--find-point-from-line-chars occ-start-line occ-start-chars))
725 | (end-point (save-excursion
726 | (when-let ((p (semext--find-point-from-line-chars occ-end-line occ-end-chars)))
727 | (when p (+ p (length occ-end-chars)))))))
728 | (when (and start-point end-point (> end-point start-point))
729 | (push (cons start-point end-point) point-pairs)))))
730 | ;; Sort by start point
731 | (sort point-pairs :key #'car)))
732 |
733 | (defun semext-search-forward (search-query)
734 | "Perform semantic search forward for SEARCH-QUERY across the entire buffer.
735 |
736 | Processes the buffer chunk by chunk, then moves point to the first
737 | occurrence after the initial point and highlights it."
738 | (interactive "sSearch forward: ")
739 | (let* ((original-point (point))
740 | (cache-key (cons :search search-query))
741 | (prompt (format "%s\n\nSearch Description: %s"
742 | semext--search-prompt search-query))
743 | (finalizer
744 | (lambda (results-data is-cached)
745 | (let* (;; Extract point pairs (start . end) from cached or fresh results
746 | (point-pairs (if is-cached
747 | ;; Cached: list of ((start-marker . char) . (end-marker . char))
748 | (cl-loop for entry in results-data
749 | collect (cons (marker-position (caar entry))
750 | (marker-position (cadr entry))))
751 | ;; Fresh: list of (start . end)
752 | results-data))
753 | ;; Find first pair starting after original point
754 | (found-pair (seq-find (lambda (pair) (> (car pair) original-point))
755 | point-pairs)))
756 | (if found-pair
757 | (progn
758 | (goto-char (car found-pair))
759 | (push-mark (cdr found-pair) t t)
760 | (message "Found occurrence forward%s" (if is-cached " (cached)" "")))
761 | (message "Search forward failed: No further occurrences found%s" (if is-cached " (cached)" "")))))))
762 |
763 | (if-let ((cached-results (semext--get-cached-results cache-key)))
764 | (funcall finalizer cached-results t)
765 | (semext--perform-search-action
766 | prompt
767 | semext--search-json-schema
768 | search-query ; Query details for caching
769 | (lambda (fresh-results) (funcall finalizer fresh-results nil))
770 | "Error during semantic search forward"))))
771 |
772 | (defun semext-search-backward (search-query)
773 | "Perform semantic search backward for SEARCH-QUERY across the entire buffer.
774 |
775 | Processes the buffer chunk by chunk, then moves point to the first
776 | occurrence ending before the initial point and highlights it."
777 | (interactive "sSearch backward: ")
778 | (let* ((original-point (point))
779 | (cache-key (cons :search search-query))
780 | (prompt (format "%s\n\nSearch Description: %s"
781 | semext--search-prompt search-query))
782 | (finalizer
783 | (lambda (results-data is-cached)
784 | (let* (;; Extract point pairs (start . end) from cached or fresh results
785 | (point-pairs (if is-cached
786 | ;; Cached: list of ((start-marker . char) . (end-marker . char))
787 | (cl-loop for entry in results-data
788 | collect (cons (marker-position (caar entry))
789 | (marker-position (cadr entry))))
790 | ;; Fresh: list of (start . end)
791 | results-data))
792 | ;; Find last pair ending before original point
793 | (found-pair (car (seq-filter (lambda (pair) (< (cdr pair) original-point))
794 | (reverse point-pairs))))) ; Reverse sorted list
795 | (if found-pair
796 | (progn
797 | (goto-char (car found-pair))
798 | (push-mark (cdr found-pair) t t)
799 | (message "Found occurrence backward%s" (if is-cached " (cached)" "")))
800 | (message "Search backward failed: No previous occurrences found%s" (if is-cached " (cached)" "")))))))
801 |
802 | (if-let ((cached-results (semext--get-cached-results cache-key)))
803 | (funcall finalizer cached-results t)
804 | (semext--perform-search-action
805 | prompt
806 | semext--search-json-schema
807 | search-query ; Query details for caching
808 | (lambda (fresh-results) (funcall finalizer fresh-results nil))
809 | "Error during semantic search backward"))))
810 |
811 | (provide 'semext)
812 |
813 | ;;; semext.el ends here
814 |
--------------------------------------------------------------------------------