├── .drone.yml ├── .github ├── FUNDING.yml └── workflows │ └── test.yml ├── .gitignore ├── COPYING ├── Makefile ├── README.org ├── examples └── navigel-ex-fs.el ├── media └── files.png ├── navigel.el └── test └── navigel-test.el /.drone.yml: -------------------------------------------------------------------------------- 1 | kind: pipeline 2 | name: default 3 | 4 | platform: 5 | os: linux 6 | arch: arm 7 | 8 | steps: 9 | - name: check 10 | image: ubuntu:latest 11 | commands: 12 | - apt-get update 13 | - apt-get install -y software-properties-common coreutils make gnutls-bin curl 14 | - add-apt-repository ppa:kelleyk/emacs -y 15 | - apt-get update 16 | - apt-get install -y emacs26 17 | - emacs --version 18 | - make ci-dependencies 19 | - make check 20 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: damien-cassou 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: DamienCassou # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | pull_request: 5 | 6 | jobs: 7 | compile: 8 | name: Compile 9 | uses: DamienCassou/emacs-workflows/.github/workflows/makel.yml@main 10 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | /makel.mk 3 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | ELPA_DEPENDENCIES=package-lint tablist let-alist 2 | 3 | ELPA_ARCHIVES=melpa gnu 4 | 5 | TEST_ERT_FILES=$(wildcard test/*.el) 6 | LINT_CHECKDOC_FILES=$(wildcard *.el) $(wildcard test/*.el) 7 | LINT_PACKAGE_LINT_FILES=$(wildcard *.el) 8 | LINT_COMPILE_FILES=$(wildcard *.el) $(wildcard test/*.el) 9 | 10 | LINT_CHECKDOC_OPTIONS=--eval "(setq checkdoc-arguments-in-order-flag nil)" 11 | 12 | makel.mk: 13 | # Download makel 14 | @if [ -f ../makel/makel.mk ]; then \ 15 | ln -s ../makel/makel.mk .; \ 16 | else \ 17 | curl \ 18 | --fail --silent --show-error --insecure --location \ 19 | --retry 9 --retry-delay 9 \ 20 | -O https://github.com/DamienCassou/makel/raw/v0.5.3/makel.mk; \ 21 | fi 22 | 23 | # Include makel.mk if present 24 | -include makel.mk 25 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * navigel 2 | 3 | #+BEGIN_HTML 4 |

5 | 6 | MELPA Stable 7 | 8 | 9 | 10 | MELPA 11 | 12 | 13 | 14 | pipeline status 15 | 16 |

17 | #+END_HTML 18 | 19 | 20 | ** Summary 21 | 22 | The navigel package is a library that makes it simpler for Emacs Lisp 23 | developers to define user-interfaces based on tablists (also known as 24 | tabulated-lists). Overriding a few (CL) methods and calling 25 | `navigel-open' is all that's required to get a nice UI to navigate 26 | your domain objects (files, music library, database, etc.). 27 | 28 | Navigel displays "entities" in a tablist. An "entity" is whatever you 29 | want that has a name. If an entity defines some "children", then 30 | pressing ~RET~ on the entity will list its children in another 31 | tablist. 32 | 33 | Some features of navigel include: 34 | 35 | - pressing ~RET~ on an entity lists the entity's children in another 36 | tablist; 37 | - pressing ~^~ opens the parent of the current entity; 38 | - pressing ~m~ marks the entity at point; 39 | - pressing ~d~ deletes the marked entities. 40 | 41 | Navigel automatically adds support for [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Bookmarks.html#Bookmarks][bookmarks]] and [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Imenu.html#Imenu][imenu]]. 42 | 43 | This package depends on [[https://github.com/politza/tablist][tablist]] to get support for marking, deletion 44 | and more. On top of the tablist package, navigel provides an easy way 45 | to specify the content of your tabulated lists: through entities 46 | specified with method overrides. This makes it a breath to have 47 | tablist-based navigation within domain objects. 48 | 49 | ** Usage 50 | 51 | This code is a library and is meant for Emacs Lisp developers. The 52 | source code is well documented and organized in sections. Please have 53 | a look at it. 54 | 55 | Please have a look at the [[file:examples/navigel-ex-fs.el][examples/navigel-ex-fs.el]] file for an 56 | example on how to use the library. This file guides the reader through 57 | an implementation of a tablist-based directory navigator with support 58 | for marking and deleting: 59 | 60 | [[file:media/files.png]] 61 | 62 | ** License 63 | 64 | See [[file:COPYING][COPYING]]. Copyright (c) 2019-2023 Damien Cassou. 65 | 66 | #+BEGIN_HTML 67 | 68 | Donate using Liberapay 69 | 70 | #+END_HTML 71 | 72 | # LocalWords: navigel tablist tablists 73 | -------------------------------------------------------------------------------- /examples/navigel-ex-fs.el: -------------------------------------------------------------------------------- 1 | ;;; navigel-ex-fs.el --- Example of navigel to navigate the filesystem -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019-2023 Damien Cassou 4 | 5 | ;; Author: Damien Cassou 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; This file is an example usage of navigel. It guides the reader 23 | ;; through an implementation of a tablist-based directory navigator. 24 | 25 | ;; In this example, we will implement a tablist-based UI to navigate 26 | ;; the folders of your computer. As in dired, we want one file or 27 | ;; directory per line. Pressing `RET' on a line should open the file 28 | ;; or directory at point. Pressing `m' should mark the file at point 29 | ;; while `d' should delete all marked files. 30 | 31 | ;;; Code: 32 | 33 | (require 'f) 34 | 35 | (require 'navigel) 36 | 37 | ;; Navigel is based on the notion of "entity". In our example of a 38 | ;; directory navigator, the entities will be absolute filenames. 39 | 40 | ;; Navigel requires the developer to implement a command that calls 41 | ;; `navigel-open' on the initial entity. Navigel also requires an 42 | ;; application name dynamically bound in the variable `navigel-app'. 43 | ;; This name is meant to disambiguate method definitions and is *not* 44 | ;; visible to the user. In this example, we use `navigel-ex-fs' 45 | ;; as name. The code below defines the command: 46 | 47 | (defun navigel-ex-fs-list-files (&optional directory) 48 | "List files of DIRECTORY, home directory if nil." 49 | (interactive (list (getenv "HOME"))) 50 | (let ((navigel-app 'navigel-ex-fs)) 51 | (navigel-open (f-expand directory) nil))) 52 | 53 | ;; For this command to display the files in the home directory (i.e., 54 | ;; "~/"), navigel needs a way to get the children of a file entity. 55 | ;; Specifying behavior with navigel is done through method overriding. 56 | ;; How to get the children of an entity should be specified by 57 | ;; overriding the method `navigel-children': 58 | 59 | (navigel-method navigel-ex-fs navigel-children (directory callback) 60 | "Call CALLBACK with the files in DIRECTORY as parameter." 61 | (funcall callback (f-entries directory))) 62 | 63 | ;; `navigel-method' (which is syntactic sugar around `cl-defmethod') 64 | ;; is used to override the methods of navigel. To distinguish this 65 | ;; override of `navigel-children' from other overrides made by other 66 | ;; navigel clients, the first parameter to `navigel-method' must be 67 | ;; the name of the application saved in `navigel-app' in the command 68 | ;; above. 69 | 70 | ;; At this point, you should be able to type `M-x 71 | ;; navigel-ex-fs-list-files RET' to get a buffer showing all 72 | ;; files and folders in your home directory. If you move the point to 73 | ;; a folder and press `RET', a new buffer should open listing its 74 | ;; files and folders. If you type `M-x imenu RET', you can select one 75 | ;; entity of the buffer using completion: I recommend binding this 76 | ;; command or `counsel-imenu' to a key (e.g., to `M-i') because this 77 | ;; can be useful in many kinds of buffers. 78 | 79 | ;; A problem though: the absolute filenames (e.g., "/home/me/.bashrc") 80 | ;; are shown whereas a user probably expects to see basenames (e.g., 81 | ;; ".bashrc") as in all file browsers. We can easily change that by 82 | ;; overriding the `navigel-name' method: 83 | 84 | (navigel-method navigel-ex-fs navigel-name (file) 85 | (f-filename file)) 86 | 87 | ;; This is much better. With `RET', we can easily navigate from a 88 | ;; folder to its sub-folders. Nevertheless, we have no way yet to 89 | ;; navigate back, i.e., from a folder to its parent. To do that, we 90 | ;; need to override the `navigel-parent' method whose responsibility 91 | ;; is to return the parent entity of the entity passed as parameter: 92 | 93 | (navigel-method navigel-ex-fs navigel-parent (file) 94 | (f-dirname file)) 95 | 96 | ;; You should now be able to press `^' to go to the parent directory 97 | ;; of the current one. 98 | 99 | ;; Pressing `RET' on a folder correctly opens the folder in another 100 | ;; navigel buffer. But, just like in `dired', you might want that 101 | ;; pressing `RET' on a file opens the file itself. This can be done 102 | ;; by overriding `navigel-open': 103 | 104 | (navigel-method navigel-ex-fs navigel-open (file _target) 105 | (if (f-file-p file) 106 | (find-file file) 107 | (cl-call-next-method))) 108 | 109 | ;; The `cl-call-next-method' call is used to express that we don't 110 | ;; have anything specific to do for a non-file first parameter and 111 | ;; that we want the default behavior. This works perfectly fine! 112 | 113 | ;; We can improve the list of files a bit by adding some more 114 | ;; information about each file. For example, we could have a first 115 | ;; column representing the size of each file. We start by 116 | ;; implementing a function returning the size of its file argument: 117 | 118 | (defun navigel-ex-fs-size (file) 119 | "Return FILE size as number of bytes." 120 | (nth 7 (file-attributes file))) 121 | 122 | ;; We now specify the column values for each file by overriding 123 | ;; `navigel-entity-to-columns': 124 | 125 | (navigel-method navigel-ex-fs navigel-entity-to-columns (file) 126 | (vector (number-to-string (navigel-ex-fs-size file)) 127 | (navigel-name file))) 128 | 129 | ;; The code above specifies that the first column of a file line will 130 | ;; contain the file size and the second will contain the filename. We 131 | ;; aren't exactly done yet as we also need to specify what each column 132 | ;; should look like. This is done by overriding 133 | ;; `navigel-tablist-format': 134 | 135 | (navigel-method navigel-ex-fs navigel-tablist-format (_entity) 136 | (vector (list "Size (B)" 10 nil :right-align t) 137 | (list "Name" 0 t))) 138 | 139 | ;; This code defines the format of columns. The first column will have 140 | ;; "Size (B)" as title to indicate that the displayed numbers 141 | ;; represent the size in bytes. The first column will be 10 142 | ;; characters wide and the numbers will be right aligned. The second 143 | ;; column will have "Name as title and will take the rest of the 144 | ;; buffer width. Read the documentation of `tabulated-list-format' to 145 | ;; get more information about the column format specification. 146 | 147 | ;; By default, navigel first sets the header information and then 148 | ;; proceeds to read the children of the current entity to display 149 | ;; them. If you need to use the list of children to decide the format 150 | ;; of the header, you can override `navigel-tablist-format-children', 151 | ;; which is called _after_ the entities returned by `navigel-children' 152 | ;; are available. 153 | 154 | ;; As a final step, we might want to be able to delete files from the 155 | ;; file system. This can be done by overriding `navigel-delete': 156 | 157 | (navigel-method navigel-ex-fs navigel-delete (file &optional callback) 158 | (f-delete file) 159 | (funcall callback)) 160 | 161 | ;; The `funcall' is here to tell navigel that deletion is 162 | ;; finished. You can now mark files with `m' and delete them with `D'. 163 | 164 | ;; By default, all entities of the new application will be displayed 165 | ;; in their own buffers, named using the generic function 166 | ;; `navigel-name'. Users of your application can ask navigel to reuse 167 | ;; the same buffer for all entities in the app by customizing the 168 | ;; variable `navigel-single-buffer-apps'. The name of this single 169 | ;; buffer when it is displaying a given entity is constructed using 170 | ;; the generic function `navigel-single-buffer-name'. 171 | 172 | (provide 'navigel-ex-fs) 173 | ;;; navigel-ex-fs.el ends here 174 | -------------------------------------------------------------------------------- /media/files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/navigel/5f2f2ecfbd91c35bfbe4946915462872acf58310/media/files.png -------------------------------------------------------------------------------- /navigel.el: -------------------------------------------------------------------------------- 1 | ;;; navigel.el --- Facilitate the creation of tabulated-list based UIs -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019-2023 Damien Cassou 4 | 5 | ;; Author: Damien Cassou 6 | ;; Url: https://github.com/DamienCassou/navigel 7 | ;; Package-requires: ((emacs "25.1") (tablist "1.0")) 8 | ;; Version: 1.0.0 9 | 10 | ;; This program is free software; you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation, either version 3 of the License, or 13 | ;; (at your option) any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with this program. If not, see . 22 | 23 | ;;; Commentary: 24 | 25 | ;; This library makes it simpler for Emacs Lisp developers to define 26 | ;; user-interfaces based on tablists (also known as tabulated-lists). 27 | ;; Overriding a few (CL) methods and calling `navigel-open' is all 28 | ;; that's required to get a nice UI to navigate your domain objects 29 | ;; (e.g., files, music library, database). 30 | ;; 31 | ;; Features include : 32 | ;; 33 | ;; - pressing RET to open the entity at point in another buffer; 34 | ;; - pressing ^ to open the current entity's parent; 35 | ;; - marking entities for bulk operations (e.g., delete); 36 | ;; - `imenu' support for quick navigation; 37 | 38 | ;;; Code: 39 | 40 | (require 'tablist) 41 | (require 'seq) 42 | (require 'map) 43 | (require 'bookmark) 44 | 45 | 46 | ;; Customization 47 | 48 | (defgroup navigel nil 49 | "Navigel." 50 | :group 'magit-extensions) 51 | 52 | (defcustom navigel-changed-hook nil 53 | "Normal hook run after a navigel's tablist buffer changed." 54 | :type 'hook) 55 | 56 | (defcustom navigel-init-done-hook nil 57 | "Normal hook run after a navigel's tablist buffer has been initially populated." 58 | :type 'hook) 59 | 60 | (defcustom navigel-display-messages t 61 | "Whether to display navigel's informative messages in the echo area." 62 | :type 'boolean) 63 | 64 | (defcustom navigel-single-buffer-apps nil 65 | "Applications using a single buffer to display all entities. 66 | 67 | Either a list of symbols denoting applications, t for all 68 | applications or nil, the default, for none." 69 | :type '(choice (const :tag "None" nil) 70 | (const :tag "All applications" t) 71 | (repeat (symbol :tag "Application")))) 72 | 73 | 74 | ;; Private variables 75 | 76 | (defvar navigel-entity nil 77 | "Specify the entity that was used to generate the buffer.") 78 | 79 | (defvar navigel-app nil 80 | "Specify the application that was used to generate the buffer.") 81 | 82 | (defvar navigel-single-buffers nil 83 | "An alist of (APP . BUFFER) associating app symbols with their buffer name. 84 | 85 | This name is used only for applications that are working in single-buffer mode.") 86 | 87 | (defvar-local navigel--state-cache nil 88 | "Cache of entity states for single-buffer applications. 89 | 90 | This cache is an alist of (APP . STATE) pairs, where in turn 91 | STATE is an alist of (ENTITY-ID . ENTITY-STATE) pairs, 92 | associating to each entity that has been displayed by APP in this 93 | buffer its last state (as returned by `navigel--save-state').") 94 | 95 | 96 | ;; Private functions 97 | 98 | (defun navigel--tablist-operation-function (operation &rest args) 99 | "Setup `tablist' operations in current buffer. 100 | 101 | OPERATION and ARGS are defined by `tablist-operations-function'." 102 | (cl-case operation 103 | (supported-operations '(find-entry delete)) 104 | (find-entry (navigel-open (car args) nil)) 105 | (delete (navigel-delete (car args) #'navigel--revert-buffer)))) 106 | 107 | (defun navigel--imenu-extract-index-name () 108 | "Return the name of entity at point for `imenu'. 109 | This function is used as a value for 110 | `imenu-extract-index-name-function'. Point should be at the 111 | beginning of the line." 112 | (navigel-imenu-name (tabulated-list-get-id))) 113 | 114 | (defun navigel--imenu-prev-index-position () 115 | "Move point to previous line in current buffer. 116 | This function is used as a value for 117 | `imenu-prev-index-position-function'." 118 | (unless (bobp) 119 | (forward-line -1))) 120 | 121 | (defun navigel-go-to-entity (entity) 122 | "Move point to ENTITY. 123 | Return non-nil if ENTITY is found, nil otherwise." 124 | (goto-char (point-min)) 125 | (while (and (not (= (point) (point-max))) 126 | (not (navigel-equal (navigel-entity-at-point) entity))) 127 | (forward-line 1)) 128 | (not (= (point) (point-max)))) 129 | 130 | ;; CL Context rewriter: this lets users write "&context (navigel-app 131 | ;; something)" instead of "&context (navigel-app (eql something))" 132 | (cl-generic-define-context-rewriter navigel-app (app) 133 | `(navigel-app (eql ,app))) 134 | 135 | (defun navigel--bookmark-jump (bookmark) 136 | "Open a navigel buffer showing BOOKMARK." 137 | (let ((entity (bookmark-prop-get bookmark 'navigel-entity)) 138 | (target (bookmark-prop-get bookmark 'navigel-target)) 139 | (navigel-app (bookmark-prop-get bookmark 'navigel-app))) 140 | (navigel-open entity target) 141 | (message "Current buffer at the end of navigel--bookmark-jump: %s" (current-buffer)))) 142 | 143 | (defun navigel--message (&rest args) 144 | "Display a message in the echo area. 145 | This function only has an effect when `navigel-display-messages' 146 | is true. ARGS are the message format followed by any arguments 147 | it takes." 148 | (when navigel-display-messages 149 | (apply #'message args))) 150 | 151 | 152 | ;; Generic methods: Those methods are the one you may override. 153 | 154 | (cl-defgeneric navigel-name (entity) 155 | "Return a short string describing ENTITY. 156 | 157 | The returned value is the default for `navigel-buffer-name', 158 | `navigel-tablist-name' and `navigel-imenu-name'. Those can be 159 | overridden separately if necessary." 160 | (format "%s" entity)) 161 | 162 | (cl-defgeneric navigel-entity-id (entity) 163 | "Return a possibly unique identifier for the given ENTITY. 164 | 165 | Under some circumstances, Navigel will cache information about 166 | displayed entities, using its id as key. By default, this 167 | function calls `navigel-name', which should be good enough in the 168 | majority of cases." 169 | (navigel-name entity)) 170 | 171 | (cl-defgeneric navigel-buffer-name (entity) 172 | "Return a string representing ENTITY in the buffer's name." 173 | (navigel-name entity)) 174 | 175 | (cl-defgeneric navigel-single-buffer-name (app entity) 176 | "Return a string representing ENTITY in the buffer's name, for single-buffer APP." 177 | (let ((app (or app navigel-app 'navigel)) 178 | (suffix (if entity (format " - %s" (navigel-buffer-name entity)) ""))) 179 | (format "*%s%s*" app suffix))) 180 | 181 | (cl-defgeneric navigel-tablist-name (entity) 182 | "Return a string representing ENTITY in tablist columns." 183 | (navigel-name entity)) 184 | 185 | (cl-defgeneric navigel-imenu-name (entity) 186 | "Return a string representing ENTITY for `imenu'." 187 | (navigel-name entity)) 188 | 189 | (cl-defgeneric navigel-bookmark-name (entity) 190 | "Return a string representing ENTITY for `bookmark'." 191 | (navigel-name entity)) 192 | 193 | (cl-defgeneric navigel-children (entity callback) 194 | "Execute CALLBACK with the list of ENTITY's children as argument. 195 | This method must be overridden for any tablist view to work.") 196 | 197 | (cl-defmethod navigel-children ((entities list) callback) 198 | "Execute CALLBACK with the children of ENTITIES as argument." 199 | (navigel-async-mapcar #'navigel-children entities callback)) 200 | 201 | (cl-defgeneric navigel-parent (_entity) 202 | "Return the parent of ENTITY if possible, nil if not." 203 | nil) 204 | 205 | (cl-defgeneric navigel-equal (entity1 entity2) 206 | "Return non-nil if ENTITY1 and ENTITY2 represent the same entity." 207 | (equal entity1 entity2)) 208 | 209 | (cl-defgeneric navigel-entity-at-point () 210 | "Return the entity at point or nil if none.") 211 | 212 | (cl-defmethod navigel-entity-at-point (&context (major-mode (derived-mode navigel-tablist-mode))) 213 | "Return the entity at point in the context of a mode derived from MAJOR-MODE." 214 | (or (tabulated-list-get-id) navigel-entity)) 215 | 216 | (cl-defgeneric navigel-marked-entities (&optional _at-point-if-empty) 217 | "Return a list of entities that are selected. 218 | If no entity is selected and AT-POINT-IF-EMPTY is non-nil, return 219 | a list with just the entity at point." 220 | nil) 221 | 222 | (cl-defmethod navigel-marked-entities (&context (major-mode (derived-mode navigel-tablist-mode)) 223 | &optional at-point-if-empty) 224 | "Return a list with marked entities for MAJOR-MODE derived from a tablist. 225 | 226 | AT-POINT-IF-EMPTY indicates whether to return the entity at point if none 227 | is marked." 228 | ;; `tablist-get-marked-items' automatically includes the entity at 229 | ;; point if no entity is marked. We have to remove it unless 230 | ;; `at-point-if-empty' is non-nil. 231 | (let ((entities (mapcar #'car (tablist-get-marked-items)))) 232 | (if (or (> (length entities) 1) 233 | (save-excursion ;; check if the entity is really marked 234 | (navigel-go-to-entity (car entities)) 235 | (tablist-get-mark-state)) 236 | at-point-if-empty) 237 | entities 238 | (list)))) 239 | 240 | (cl-defgeneric navigel-entity-buffer (entity) 241 | "Return a buffer name for ENTITY. 242 | The default name is based on `navigel-app' and `navigel-buffer-name'." 243 | (format "*%s-%s*" navigel-app (navigel-buffer-name entity))) 244 | 245 | (cl-defgeneric navigel-entity-tablist-mode (_entity) 246 | "Enable the `major-mode' most suited to display children of ENTITY." 247 | (navigel-tablist-mode)) 248 | 249 | (cl-defgeneric navigel-tablist-format (_entity) 250 | "Return a vector specifying columns to display ENTITY's children. 251 | The return value is set as `tabulated-list-format'." 252 | (vector (list "Name" 0 t))) 253 | 254 | (cl-defgeneric navigel-tablist-format-children (_entity &optional _children) 255 | "Return a vector specifying columns to display ENTITY's CHILDREN. 256 | The return value is set as `tabulated-list-format' after the list 257 | of children has been retrieved, unless this call returns nil." 258 | nil) 259 | 260 | (cl-defgeneric navigel-entity-to-columns (entity) 261 | "Return the column descriptors to display ENTITY in a tabulated list. 262 | The return value is a vector for `tabulated-list-entries'. 263 | 264 | The vector should be compatible to the one defined with 265 | `navigel-tablist-format'." 266 | (vector (navigel-tablist-name entity))) 267 | 268 | (cl-defgeneric navigel-open (entity target) 269 | "Open a buffer displaying ENTITY. 270 | If TARGET is non-nil and is in buffer, move point to it. 271 | 272 | By default, list ENTITY's children in a tabulated list." 273 | (navigel--list-children entity target)) 274 | 275 | (cl-defgeneric navigel-parent-to-open (entity) 276 | "Return an indication of what to open if asked to open the parent of ENTITY. 277 | Return nil if there is no parent to open. 278 | 279 | The return value is (PARENT . ENTITY), where PARENT is the entity 280 | to open and ENTITY is the entity to move point to." 281 | (cons (navigel-parent entity) entity)) 282 | 283 | (cl-defmethod navigel-parent-to-open (entity &context (major-mode navigel-tablist-mode)) 284 | "Parent or ENTITY to open in the context of MAJOR-MODE derived from tablist." 285 | ;; Override default implementation because, in navigel-tablist-mode, 286 | ;; opening the parent of the entity at point would usually result in 287 | ;; opening the current buffer again. This is because the current 288 | ;; buffer typically already displays the parent of the entity at 289 | ;; point. 290 | (let* ((parent (navigel-parent entity)) 291 | (ancestor (and parent (navigel-parent parent)))) 292 | (cond ((and ancestor (navigel-equal parent navigel-entity)) 293 | (cons ancestor parent)) 294 | ((and parent (not (navigel-equal parent navigel-entity))) 295 | (cons parent entity)) 296 | (t nil)))) 297 | 298 | (cl-defgeneric navigel-delete (_entity &optional _callback) 299 | "Remove ENTITY from its parent. 300 | If non-nil, call CALLBACK with no parameter when done." 301 | (user-error "This operation is not supported in this context")) 302 | 303 | (cl-defmethod navigel-delete ((entities list) &optional callback) 304 | "Remove each item of ENTITIES from its parent. 305 | If non-nil, call CALLBACK with no parameter when done." 306 | (navigel-async-mapc #'navigel-delete entities callback)) 307 | 308 | (cl-defmethod navigel-make-bookmark () 309 | "Return a record to bookmark the current buffer. 310 | 311 | This function is to be used as value for 312 | `bookmark-make-record-function' in navigel buffers." 313 | `( 314 | ,(navigel-bookmark-name navigel-entity) 315 | ((handler . ,#'navigel--bookmark-jump) 316 | (navigel-entity . ,navigel-entity) 317 | (navigel-target . ,(navigel-entity-at-point)) 318 | (navigel-app . ,navigel-app)))) 319 | 320 | 321 | ;;; Public functions 322 | 323 | (defun navigel-single-buffer-app-p (app) 324 | "Check whether APP is registered as a single-buffer application. 325 | 326 | See also `navigel-single-buffer-apps'." 327 | (or (eq t navigel-single-buffer-apps) 328 | (memq app navigel-single-buffer-apps))) 329 | 330 | (defun navigel-register-single-buffer-app (app) 331 | "Register APP as a single buffer application." 332 | (or (navigel-single-buffer-app-p app) 333 | (add-to-list 'navigel-single-buffer-apps app))) 334 | 335 | (defun navigel-app-buffer (app) 336 | "If APP is a single-buffer application, return its buffer." 337 | (navigel--app-buffer app t)) 338 | 339 | (defun navigel-async-mapcar (mapfn list callback) 340 | "Apply MAPFN to each element of LIST and pass result to CALLBACK. 341 | 342 | MAPFN is a function taking 2 arguments: the element to map and a 343 | callback to call when the mapping is done." 344 | (if (not list) 345 | (funcall callback nil) 346 | (let ((result (make-vector (length list) nil)) 347 | (count 0)) 348 | (cl-loop for index below (length list) 349 | for item in list 350 | do (let ((index index) (item item)) 351 | (funcall 352 | mapfn 353 | item 354 | (lambda (item-result) 355 | (setf (seq-elt result index) item-result) 356 | (cl-incf count) 357 | (when (eq count (length list)) 358 | ;; use `run-at-time' to ensure that CALLBACK is 359 | ;; consistently called asynchronously even if MAPFN is 360 | ;; synchronous: 361 | (run-at-time 362 | 0 nil 363 | callback 364 | (seq-concatenate 'list result)))))))))) 365 | 366 | (defun navigel-async-mapc (mapfn list callback) 367 | "Same as `navigel-async-mapcar' but for side-effects only. 368 | 369 | MAPFN is a function taking 2 arguments: an element of LIST and a 370 | callback. MAPFN should call the callback with no argument when 371 | done computing. 372 | 373 | CALLBACK is a function of no argument that is called when done 374 | computing for the all elements of LIST." 375 | (navigel-async-mapcar 376 | (lambda (item callback) (funcall mapfn item (lambda () (funcall callback nil)))) 377 | list 378 | (lambda (_result) (funcall callback)))) 379 | 380 | (defun navigel-open-parent (&optional entity) 381 | "Open in a new buffer the parent of ENTITY, entity at point if nil." 382 | (interactive (list (navigel-entity-at-point))) 383 | (when entity 384 | (pcase (navigel-parent-to-open entity) 385 | (`(,parent . ,entity) (navigel-open parent entity)) 386 | (_ (message "No parent to go to"))))) 387 | 388 | (defun navigel-refresh (&optional target callback) 389 | "Compute `navigel-entity' children and list those in the current buffer. 390 | 391 | If TARGET is non-nil and is in buffer, move point to it. 392 | 393 | If CALLBACK is non nil, execute it when the buffer has been 394 | refreshed." 395 | (let ((entity navigel-entity) 396 | ;; save navigel-app so we can rebind below 397 | (app navigel-app)) 398 | (navigel--message (if (equal (point-min) (point-max)) 399 | "Populating…" 400 | "Refreshing…")) 401 | (navigel-children 402 | entity 403 | (lambda (children) 404 | ;; restore navigel-app 405 | (let ((navigel-app app) state) 406 | (with-current-buffer (navigel--entity-buffer app entity) 407 | (let ((fmt (navigel-tablist-format-children entity children))) 408 | (when fmt 409 | (setq-local tabulated-list-format fmt) 410 | (tabulated-list-init-header))) 411 | (setq state (navigel--save-state)) 412 | (setq-local tabulated-list-entries 413 | (mapcar (lambda (child) 414 | (list child (navigel-entity-to-columns child))) 415 | children)) 416 | (tabulated-list-print) 417 | (when (not (navigel-single-buffer-app-p app)) 418 | (navigel--restore-state state)) 419 | (when target 420 | (navigel-go-to-entity target)) 421 | (run-hooks 'navigel-changed-hook) 422 | (when callback 423 | (funcall callback)) 424 | (navigel--message "Ready!"))))))) 425 | 426 | (defmacro navigel-method (app name args &rest body) 427 | "Define a method NAME with ARGS and BODY. 428 | This method will only be active if `navigel-app' equals APP." 429 | (declare (indent 3)) 430 | `(cl-defmethod ,name ,(navigel--insert-context-in-args app args) 431 | ,@body)) 432 | 433 | 434 | ;;; Private functions 435 | 436 | (defvar bookmark-make-record-function) 437 | 438 | (defun navigel--list-children (entity &optional target) 439 | "Open a new buffer showing ENTITY's children. 440 | 441 | If TARGET is non-nil and is in buffer, move point to it. 442 | 443 | Interactively, ENTITY is either the element at point or the user 444 | is asked for a top level ENTITY." 445 | ;; save navigel-app because (navigel-tablist-mode) will reset it 446 | (let ((app navigel-app) 447 | (prev-entity navigel-entity) 448 | (single (navigel-single-buffer-app-p navigel-app)) 449 | (buffer (navigel--entity-buffer navigel-app entity)) 450 | cache) 451 | (with-current-buffer buffer 452 | ;; set navigel-app first because it is used on the line below to 453 | ;; select the appropriate mode: 454 | (setq-local navigel-app app) 455 | (when single 456 | (when prev-entity (navigel--cache-state prev-entity)) 457 | (setq cache navigel--state-cache)) 458 | (navigel-entity-tablist-mode entity) 459 | ;; restore navigel-app because is got erased by activating the major mode: 460 | (setq-local navigel-app app) 461 | (setq-local tabulated-list-padding 2) ; for `tablist' 462 | (setq-local navigel-entity entity) 463 | (when single 464 | (setq-local navigel--state-cache cache) 465 | (rename-buffer (navigel-single-buffer-name app entity) t)) 466 | (setq-local tablist-operations-function #'navigel--tablist-operation-function) 467 | (setq-local revert-buffer-function #'navigel--revert-buffer) 468 | (setq-local imenu-prev-index-position-function 469 | #'navigel--imenu-prev-index-position) 470 | (setq-local imenu-extract-index-name-function 471 | #'navigel--imenu-extract-index-name) 472 | (setq-local tabulated-list-format (navigel-tablist-format entity)) 473 | (setq-local bookmark-make-record-function #'navigel-make-bookmark) 474 | (tabulated-list-init-header) 475 | (navigel-refresh 476 | nil 477 | (lambda () 478 | (with-current-buffer buffer 479 | (when (and single entity) 480 | (navigel--restore-state (navigel--cached-state entity))) 481 | (if target (navigel-go-to-entity target) (goto-char (point-min))) 482 | (run-hooks 'navigel-init-done-hook))))) 483 | (switch-to-buffer buffer))) 484 | 485 | (defun navigel--save-state () 486 | "Return an object representing the state of the current buffer. 487 | This should be restored with `navigel--restore-state'. 488 | 489 | The state contains the entity at point, the column of point, and 490 | the marked entities." 491 | `( 492 | (entity-at-point . ,(navigel-entity-at-point)) 493 | (column . ,(current-column)) 494 | (marked-entities . ,(navigel-marked-entities)))) 495 | 496 | (defun navigel--restore-state (state) 497 | "Restore STATE. This was saved with `navigel--save-state'." 498 | (let-alist state 499 | (if .entity-at-point 500 | (navigel-go-to-entity .entity-at-point) 501 | (goto-char (point-min))) 502 | (when .column 503 | (goto-char (line-beginning-position)) 504 | (forward-char .column)) 505 | (when .marked-entities 506 | (save-excursion 507 | (dolist (entity .marked-entities) 508 | (when (navigel-go-to-entity entity) 509 | (tablist-put-mark))))))) 510 | 511 | (defun navigel--forget-single-buffer () 512 | "Remove the entry for the current buffer in `navigel-single-buffers." 513 | (map-delete navigel-single-buffers navigel-app)) 514 | 515 | (defun navigel--single-app-buffer-create (app) 516 | "Create and return a buffer for the given APP, setting it up for single mode." 517 | (let ((buffer (get-buffer-create (navigel-single-buffer-name app nil)))) 518 | (setf (alist-get app navigel-single-buffers) buffer) 519 | (with-current-buffer buffer 520 | (add-hook 'kill-buffer-hook #'navigel--forget-single-buffer nil t) 521 | (setq-local navigel-app app)) 522 | buffer)) 523 | 524 | (defun navigel--app-buffer (app &optional no-create) 525 | "If APP is a single-buffer application, find or create its buffer. 526 | 527 | If NO-CREATE is not nil, do not create a fresh buffer if one does 528 | not already exist." 529 | (when (navigel-single-buffer-app-p app) 530 | (let ((buffer (alist-get app navigel-single-buffers))) 531 | (when (and (not (buffer-live-p buffer)) (not no-create)) 532 | (setq buffer (navigel--single-app-buffer-create app))) 533 | buffer))) 534 | 535 | (defun navigel--entity-buffer (app entity) 536 | "Return the buffer that APP should use for the given ENTITY." 537 | (or (navigel--app-buffer app) 538 | (get-buffer-create (navigel-entity-buffer entity)))) 539 | 540 | (defun navigel--cache-state (entity) 541 | "Save in the local cache the state of ENTITY, as displayed in the current buffer." 542 | (let ((id (when entity (navigel-entity-id entity)))) 543 | (when id 544 | (when (not navigel--state-cache) 545 | (setq-local navigel--state-cache ())) 546 | (setf (alist-get id navigel--state-cache nil nil #'equal) 547 | (navigel--save-state))))) 548 | 549 | (defun navigel--cached-state (&optional entity app) 550 | "Return the cached state of the given ENTITY, in application APP. 551 | 552 | ENTITY and APP default to the local values of `navigel-entity' and 553 | `navigel-app'." 554 | (let ((entity (or entity navigel-entity))) 555 | (when entity 556 | (let ((app-buffer (navigel--app-buffer (or app navigel-app)))) 557 | (when app-buffer 558 | (cdr (assoc (navigel-entity-id entity) 559 | (buffer-local-value 'navigel--state-cache app-buffer)))))))) 560 | 561 | (defun navigel--revert-buffer (&rest _args) 562 | "Compute `navigel-entity' children and list those in the current buffer." 563 | (navigel-refresh)) 564 | 565 | (defun navigel--insert-context-in-args (app args) 566 | "Return an argument list with a &context specializer for APP within ARGS." 567 | (let ((result (list)) 568 | (rest-args args)) 569 | (catch 'found-special-arg 570 | (while rest-args 571 | (let ((arg (car rest-args))) 572 | (when (symbolp arg) 573 | (when (eq arg '&context) 574 | (throw 'found-special-arg 575 | (append (nreverse result) 576 | `(&context (navigel-app ,app)) 577 | (cdr rest-args)))) 578 | (when (string= "&" (substring-no-properties (symbol-name arg) 0 1)) 579 | (throw 'found-special-arg 580 | (append (nreverse result) 581 | `(&context (navigel-app ,app)) 582 | rest-args)))) 583 | (setq result (cons arg result)) 584 | (setq rest-args (cdr rest-args)))) 585 | (append (nreverse result) `(&context (navigel-app ,app)))))) 586 | 587 | 588 | ;;; Major mode 589 | 590 | (defvar navigel-tablist-mode-map 591 | (let ((map (make-sparse-keymap))) 592 | (define-key map (kbd "^") #'navigel-open-parent) 593 | map) 594 | "Keymap for `navigel-tablist-mode'.") 595 | 596 | (define-derived-mode navigel-tablist-mode tablist-mode "navigel-tablist" 597 | "Major mode for all elcouch listing modes.") 598 | 599 | (provide 'navigel) 600 | ;;; navigel.el ends here 601 | 602 | ;;; LocalWords: navigel tablist tablists keymap 603 | -------------------------------------------------------------------------------- /test/navigel-test.el: -------------------------------------------------------------------------------- 1 | ;;; navigel-test.el --- Tests for navigel.el -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019-2023 Damien Cassou 4 | 5 | ;; Author: Damien Cassou 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; Tests for navigel.el. 23 | 24 | ;;; Code: 25 | 26 | (require 'navigel) 27 | 28 | (require 'ert) 29 | 30 | (require 'cl-lib) 31 | 32 | (ert-deftest navigel-insert-context-in-args () 33 | (progn 34 | ;; no arguments: 35 | (should (equal 36 | (navigel--insert-context-in-args 'foo '()) 37 | '(&context (navigel-app foo)))) 38 | ;; only mandatory arguments: 39 | (should (equal 40 | (navigel--insert-context-in-args 'foo '(a)) 41 | '(a &context (navigel-app foo)))) 42 | ;; special argument: 43 | (should (equal 44 | (navigel--insert-context-in-args 'foo '(a &optional b)) 45 | '(a &context (navigel-app foo) &optional b))) 46 | ;; context argument: 47 | (should (equal 48 | (navigel--insert-context-in-args 'foo '(a &context (a b))) 49 | '(a &context (navigel-app foo) (a b)))) 50 | ;; special + context argument: 51 | (should (equal 52 | (navigel--insert-context-in-args 'foo '(a &context (a b) &optional b)) 53 | '(a &context (navigel-app foo) (a b) &optional b))))) 54 | 55 | (provide 'navigel-test) 56 | ;;; navigel-test.el ends here 57 | --------------------------------------------------------------------------------