├── .gitignore ├── .travis.yml ├── CONTRIBUTING.md ├── COPYING ├── Makefile ├── README.org ├── examples ├── hierarchy-examples-faces.el ├── hierarchy-examples-fs.el └── hierarchy-examples-major-modes.el ├── hierarchy.el ├── media ├── animals-tabulated-anime.gif ├── animals-tree-anime.gif ├── faces-tree.png ├── files-tabulated-anime.gif ├── files-tree-anime.gif ├── json-tree-anime.gif ├── klassified-tabulated-anime.gif ├── major-modes-tabulated.png └── media-src │ ├── animals-tabulated-01.gif │ ├── animals-tabulated-02.gif │ ├── animals-tabulated-03.gif │ ├── animals-tabulated-04.gif │ ├── animals-tabulated-05.gif │ ├── animals-tree-01.gif │ ├── animals-tree-02.gif │ ├── animals-tree-03.gif │ ├── animals-tree-04.gif │ ├── animals-tree-05.gif │ ├── animals-tree-06.gif │ ├── files-tabulated-01.gif │ ├── files-tabulated-02.gif │ ├── files-tabulated-03.gif │ ├── files-tabulated-04.gif │ ├── files-tabulated-05.gif │ ├── files-tabulated-06.gif │ ├── files-tabulated-07.gif │ ├── files-tabulated-08.gif │ ├── files-tabulated-09.gif │ ├── files-tabulated-10-1.gif │ ├── files-tabulated-10-2.gif │ ├── files-tabulated-11-1.gif │ ├── files-tabulated-11-2.gif │ ├── files-tabulated-11-3.gif │ ├── files-tabulated-11-4.gif │ ├── files-tree-01.gif │ ├── files-tree-02.gif │ ├── files-tree-03.gif │ ├── files-tree-04.gif │ ├── files-tree-05.gif │ ├── files-tree-06.gif │ ├── files-tree-07.gif │ ├── files-tree-08.gif │ ├── files-tree-09.gif │ ├── files-tree-10.gif │ ├── files-tree-11.gif │ ├── files-tree-12.gif │ ├── files-tree-13.gif │ ├── files-tree-14.gif │ ├── files-tree-15.gif │ ├── files-tree-16.gif │ ├── files-tree-17-1.gif │ ├── files-tree-17-2.gif │ ├── files-tree-17-3.gif │ ├── files-tree-17-4.gif │ ├── json-tree-00-1.gif │ ├── json-tree-00-2.gif │ ├── json-tree-01-1.gif │ ├── json-tree-01-2.gif │ ├── json-tree-02.gif │ ├── json-tree-03.gif │ ├── json-tree-04.gif │ ├── json-tree-05.gif │ ├── json-tree-06.gif │ ├── json-tree-07.gif │ ├── json-tree-08.gif │ ├── json-tree-09.gif │ ├── json-tree-10.gif │ ├── json-tree-11.gif │ ├── json-tree-12.gif │ ├── json-tree-13.gif │ ├── json-tree-14.gif │ ├── json-tree-15.gif │ ├── json-tree-16.gif │ ├── json-tree-17.gif │ ├── json-tree-18.gif │ ├── klassified-tabulated-01.gif │ ├── klassified-tabulated-02.gif │ ├── klassified-tabulated-03.gif │ ├── klassified-tabulated-04.gif │ ├── klassified-tabulated-05.gif │ ├── klassified-tabulated-06.gif │ ├── klassified-tabulated-07.gif │ ├── klassified-tabulated-08.gif │ ├── klassified-tabulated-09.gif │ ├── klassified-tabulated-10.gif │ ├── klassified-tabulated-11.gif │ ├── klassified-tabulated-12.gif │ ├── klassified-tabulated-13.gif │ ├── klassified-tabulated-15.gif │ ├── klassified-tabulated-16.gif │ ├── klassified-tabulated-17.gif │ ├── klassified-tabulated-18.gif │ ├── klassified-tabulated-19.gif │ ├── klassified-tabulated-20.gif │ └── klassified-tabulated-21.gif └── test ├── hierarchy-test.el └── test-helper.el /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated files 2 | *~ 3 | *.elc 4 | *-pkg.el 5 | *.tar 6 | TAGS 7 | doc/hierarchy.texi 8 | doc/hierarchy.info 9 | 10 | # Packages 11 | elpa 12 | dist 13 | 14 | # Ecukes 15 | /features/project/test/*.el 16 | .ecukes-failing-scenarios 17 | /makel.mk 18 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: nix 2 | 3 | install: 4 | - bash <(curl https://raw.githubusercontent.com/purcell/nix-emacs-ci/master/travis-install) 5 | 6 | env: 7 | - EMACS_CI=emacs-25-3 8 | - EMACS_CI=emacs-26-3 9 | 10 | script: 11 | - emacs --version 12 | - make ci-dependencies 13 | - make check 14 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Contributions are welcome. If you discover bugs or issues, or have ideas for 4 | improvements or new features, please file a report on the issue tracker for this 5 | repository. Follow the guidelines below to make sure everything goes smoothly. 6 | 7 | ## Issue reporting 8 | 9 | - Check that the issue has not already been reported 10 | - Check that the issue has not already been fixed in the latest code 11 | - Open an issue with a clear title 12 | - Write as grammatically correct as you can in the description. 13 | 14 | ## Pull requests 15 | 16 | - Perform all changes on a topic branch for easier merging 17 | - Follow the coding conventions already in use 18 | - Verify Emacs Lisp code with `checkdoc` 19 | - Add unit tests whenever possible 20 | - Open a [pull request](https://help.github.com/articles/using-pull-requests) 21 | relating to a single issue. 22 | 23 | ## Coding Conventions 24 | 25 | ### Naming 26 | 27 | - Use a `hierarchy-` prefix for all public names. 28 | - Use a `hierarchy--` prefix for all internal names. 29 | 30 | ### Docstrings 31 | 32 | Write meaningful docstrings for all functions and vars. 33 | 34 | - Document all functions and variables as directed by `checkdoc`. 35 | - Consider using [Flycheck](https://github.com/flycheck/flycheck) to automate 36 | `checkdoc` while you're editing. 37 | 38 | ### Common Lisp functions 39 | 40 | Use `cl-lib` instead of `cl`. The `cl` library pollutes the global namespace and 41 | its usage is therefore discouraged. 42 | 43 | - Use `cl-lib`, which adds prefixes to all cl function names 44 | - Use [noflet](https://github.com/nicferrier/emacs-noflet) instead of `flet` 45 | when you need to dynamically rebind functions. 46 | -------------------------------------------------------------------------------- /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 let-alist 2 | ELPA_ARCHIVES = melpa-stable gnu 3 | TEST_ERT_FILES = $(wildcard test/*.el) 4 | LINT_PACKAGE_LINT_FILES = $(wildcard *.el) 5 | LINT_CHECKDOC_FILES = ${LINT_PACKAGE_LINT_FILES} ${TEST_ERT_FILES} 6 | LINT_COMPILE_FILES = ${LINT_CHECKDOC_FILES} 7 | 8 | makel.mk: 9 | # Download makel 10 | @if [ -f ../makel/makel.mk ]; then \ 11 | ln -s ../makel/makel.mk .; \ 12 | else \ 13 | curl \ 14 | --fail --silent --show-error --insecure --location \ 15 | --retry 9 --retry-delay 9 \ 16 | -O https://gitea.petton.fr/DamienCassou/makel/raw/v0.5.3/makel.mk; \ 17 | fi 18 | 19 | # Include makel.mk if present 20 | -include makel.mk 21 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * ⚠ Integration into Emas core 2 | 3 | This project got integrated into Emacs core in release [[https://www.gnu.org/savannah-checkouts/gnu/emacs/news/NEWS.28.1][28.1]]. 4 | Please contribute patches to Emacs core directly instead of here. 5 | 6 | * Hierarchy 7 | #+BEGIN_HTML 8 |

9 | 10 | Build Status 11 | 12 | 13 | Coverage Status 14 | 15 |

16 | #+END_HTML 17 | 18 | ** Summary 19 | 20 | Library to create, query, navigate and display hierarchy structures. You might want to read the [[https://emacs.cafe/emacs/guest-post/2017/06/26/hierarchy.html][introductory blog post]]. 21 | 22 | ** Installing 23 | 24 | Use [[http://melpa.org/][melpa]]. 25 | 26 | ** Using 27 | 28 | After having created a hierarchy with ~hierarchy-new~, populate it by 29 | calling ~hierarchy-add-tree~ or ~hierarchy-add-trees~. You can 30 | then optionally sort its element with ~hierarchy-sort~. For example, 31 | you can create an animal hierarchy by passing a child-to-parent 32 | function to ~hierarchy-add-tree~: 33 | 34 | #+BEGIN_SRC emacs-lisp :session animals 35 | (require 'hierarchy) 36 | 37 | (setq animals (hierarchy-new)) 38 | 39 | (let ((parentfn 40 | ;; Given an item, return its parent 41 | (lambda (item) 42 | (cl-case item 43 | (dove 'bird) 44 | (pigeon 'bird) 45 | (bird 'animal) 46 | (dolphin 'animal) 47 | (cow 'animal))))) 48 | (hierarchy-add-tree animals 'dove parentfn) 49 | (hierarchy-add-tree animals 'pigeon parentfn) 50 | (hierarchy-add-tree animals 'dolphin parentfn) 51 | (hierarchy-add-tree animals 'cow parentfn)) 52 | 53 | (hierarchy-sort animals) 54 | #+END_SRC 55 | 56 | #+RESULTS: 57 | | bird | animal | 58 | 59 | You can learn more about your hierarchy by using functions such as 60 | ~hierarchy-roots~, ~hierarchy-length~, ~hierarchy-children~, 61 | ~hierarchy-descendant-p~. For example, ~hierarchy-roots~ returns any 62 | item without a parent in a hierarchy: 63 | 64 | #+BEGIN_SRC emacs-lisp :session animals :exports both 65 | (hierarchy-roots animals) 66 | #+END_SRC 67 | 68 | #+RESULTS: 69 | | animal | 70 | 71 | ~animal~ is the only item of the ~animals~ hierarchy with no 72 | parent. To get all items with no child, use ~hierarchy-leafs~: 73 | 74 | #+BEGIN_SRC emacs-lisp :session animals :exports both 75 | (hierarchy-leafs animals) 76 | #+END_SRC 77 | 78 | #+RESULTS: 79 | | dove | pigeon | dolphin | cow | 80 | 81 | It is possible to get the children of an item by using 82 | ~hierarchy-children~: 83 | 84 | #+BEGIN_SRC emacs-lisp :session animals :exports both 85 | (hierarchy-children animals 'animal) 86 | #+END_SRC 87 | 88 | #+RESULTS: 89 | | bird | cow | dolphin | 90 | 91 | We see here that ~animal~ has three children. 92 | 93 | You can navigate a hierarchy using ~hierarchy-map-item~, 94 | ~hierarchy-map~ and ~hierarchy-map-tree~. For example, this code 95 | inserts a text view of a hierarchy in a buffer: 96 | 97 | #+BEGIN_SRC emacs-lisp :session animals :exports both 98 | (with-temp-buffer 99 | (hierarchy-map 100 | (hierarchy-labelfn-indent 101 | (lambda (animal _) (insert (symbol-name animal) "\n"))) 102 | animals) 103 | (buffer-substring (point-min) (point-max))) 104 | #+END_SRC 105 | 106 | #+RESULTS: 107 | : animal 108 | : bird 109 | : dove 110 | : pigeon 111 | : cow 112 | : dolphin 113 | 114 | The indentation between a parent and its child can be configured by 115 | passing one more parameter to ~hierarchy-labelfn-indent~. You can also 116 | display clickable buttons instead of just plain text using either 117 | ~hierarchy-labelfn-button~ or ~hierarchy-labelfn-button-if~. 118 | 119 | If you want a buffer containing only a hierarchy while being able to 120 | navigate it with standard key-bindings use either 121 | ~hierarchy-tabulated-display~ or ~hierarchy-tree-display~ as 122 | shown in below animated pictures. 123 | 124 | #+BEGIN_SRC emacs-lisp :session animals :exports code 125 | (switch-to-buffer 126 | (hierarchy-tabulated-display 127 | animals 128 | (hierarchy-labelfn-indent 129 | (hierarchy-labelfn-button 130 | (lambda (item _) (insert (symbol-name item))) 131 | (lambda (item _) (message "You clicked on: %s" item)))))) 132 | #+END_SRC 133 | 134 | #+RESULTS: 135 | : #> 136 | 137 | [[file:media/animals-tabulated-anime.gif]] 138 | 139 | #+BEGIN_SRC emacs-lisp :session animals :exports code 140 | (switch-to-buffer 141 | (hierarchy-tree-display 142 | animals 143 | (lambda (item _) (insert (symbol-name item))))) 144 | #+END_SRC 145 | 146 | #+RESULTS: 147 | : t 148 | 149 | [[file:media/animals-tree-anime.gif]] 150 | 151 | ** Examples 152 | *** File-system example 153 | The hierarchy library can be used to display any kind of hierarchy you 154 | need. For example, a [[file:examples/hierarchy-examples-fs.el][file-system navigator]] is provided as an example. 155 | 156 | #+BEGIN_SRC emacs-lisp :session animals :exports code 157 | (load "./examples/hierarchy-examples-fs.el") 158 | 159 | ;; Execute one of the following lines to show the `.emacd.d' hierarchy 160 | ;; in either a tabulated list or a tree widget. This takes around 3 161 | ;; seconds on my computer. 162 | 163 | (hierarchy-examples-fs-display-filesystem "~/.emacs.d") 164 | 165 | (hierarchy-examples-fs-display-filesystem-tree "~/.emacs.d") 166 | #+END_SRC 167 | 168 | #+RESULTS: 169 | : # 170 | 171 | [[file:media/files-tabulated-anime.gif]] 172 | 173 | [[file:media/files-tree-anime.gif]] 174 | *** Faces hierarchy example 175 | Emacs and packages define quite a lot of faces. Because a face may 176 | inherit from another one, we can get [[file:examples/hierarchy-examples-faces.el][a hierarchy of them]]: 177 | 178 | [[file:media/faces-tree.png]] 179 | 180 | This is based on an [[https://github.com/DamienCassou/hierarchy/issues/74][idea and code from Yuan Fu]]. 181 | *** Major modes hierarchy example 182 | Emacs and packages define quite a lot of major modes. A major mode 183 | usually derives from another one which means we can get a [[file:examples/hierarchy-examples-major-modes.el][hierarchy of 184 | major modes]]: 185 | 186 | [[file:media/major-modes-tabulated.png]] 187 | *** Class hierarchy example 188 | With a bit more work, the hierarchy library can also be used to 189 | display class hierarchies (as I am currently experimenting in [[https://github.com/DamienCassou/klassified.el][this 190 | project]]). 191 | 192 | [[file:media/klassified-tabulated-anime.gif]] 193 | *** JSON navigator example 194 | A [[https://github.com/DamienCassou/json-navigator][JSON navigator]] is also implemented as yet another example. 195 | 196 | [[file:media/json-tree-anime.gif]] 197 | ** Contributing 198 | 199 | Yes, please do! See [[file:CONTRIBUTING.md][CONTRIBUTING]] for guidelines. 200 | 201 | ** License 202 | 203 | See [[file:COPYING][COPYING]]. Copyright (c) 2017 Damien Cassou. 204 | -------------------------------------------------------------------------------- /examples/hierarchy-examples-faces.el: -------------------------------------------------------------------------------- 1 | ;;; hierarchy-examples-faces.el --- Represent how faces inherit from each other -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2017 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 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'hierarchy) 27 | 28 | (defun hierarchy-examples-faces--parent (face) 29 | "Return parent face of FACE. 30 | If FACE doesn't inherit from any other face or inherit from an 31 | invalid face, return 'root-face." 32 | (let ((parent-face (if (eq face 'root-face) 33 | nil ;; the root has no parent 34 | (or (face-attribute face :inherit nil 'default) 35 | 'root-face)))) 36 | (cond ((facep parent-face) parent-face) 37 | ((null parent-face) nil) ;; the root has no parent 38 | (t 'root-face)))) 39 | 40 | (defun hierarchy-examples-faces--build-hierarchy () 41 | "Return a hierarchy of all faces Emacs knows about." 42 | (let ((hierarchy (hierarchy-new))) 43 | (hierarchy-add-trees hierarchy (face-list) #'hierarchy-examples-faces--parent) 44 | hierarchy)) 45 | 46 | (defun hierarchy-examples-faces-display-faces () 47 | "Display hierarchy of all faces Emacs knows about in a tree widget." 48 | (interactive) 49 | (require 'tree-widget) 50 | (let* ((hierarchy (hierarchy-examples-faces--build-hierarchy))) 51 | (switch-to-buffer 52 | (hierarchy-tree-display 53 | hierarchy 54 | (lambda (face _) (insert (format "%s" face))))))) 55 | 56 | ;; (hierarchy-examples-faces-display-faces) 57 | 58 | (provide 'hierarchy-examples-faces) 59 | ;;; hierarchy-examples-faces.el ends here 60 | -------------------------------------------------------------------------------- /examples/hierarchy-examples-fs.el: -------------------------------------------------------------------------------- 1 | ;;; hierarchy-examples-fs.el --- Represent the filesystem as a hierarchy -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2017 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 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'hierarchy) 27 | 28 | (defun hierarchy-examples-fs-directory-p (file) 29 | "Return non-nil if FILE is a directory and not . or ..." 30 | (and (not (string-suffix-p "/." file)) 31 | (not (string-suffix-p "/.." file)) 32 | (file-directory-p file))) 33 | 34 | (defun hierarchy-examples-fs-children (folder) 35 | "Return sub-directories of FOLDER as absolute paths." 36 | (when (file-directory-p folder) 37 | (seq-filter #'hierarchy-examples-fs-directory-p (directory-files folder t)))) 38 | 39 | (defun hierarchy-examples-fs-parent (folder) 40 | "Return parent of FOLDER." 41 | (when (not (string= folder "/")) 42 | (directory-file-name (file-name-directory folder)))) 43 | 44 | (defun hierarchy-examples-fs-build-fs-hierarchy (folder) 45 | "Return hierarchy of FOLDER." 46 | (let* ((folder (expand-file-name folder)) 47 | (parentfn #'hierarchy-examples-fs-parent) 48 | (childrenfn (lambda (file) (when (string-prefix-p folder file) 49 | (hierarchy-examples-fs-children file)))) 50 | (hierarchy (hierarchy-new))) 51 | (hierarchy-add-tree hierarchy folder parentfn childrenfn) 52 | (hierarchy-sort hierarchy) 53 | hierarchy)) 54 | 55 | (defun hierarchy-examples-fs-labelfn (folder _) 56 | "Insert name of FOLDER at current position. 57 | 58 | _ is ignored." 59 | (insert (if (string= folder "/") 60 | "/" 61 | (file-name-nondirectory folder)))) 62 | 63 | (defun hierarchy-examples-fs-display-filesystem (&optional folder) 64 | "Display hierarchy of FOLDER in a tabulated list." 65 | (let* ((hierarchy (hierarchy-examples-fs-build-fs-hierarchy folder)) 66 | (buffer (hierarchy-tabulated-display 67 | hierarchy 68 | (hierarchy-labelfn-indent 69 | (hierarchy-labelfn-button 70 | #'hierarchy-examples-fs-labelfn (lambda (item _) (dired item))))))) 71 | (switch-to-buffer buffer))) 72 | 73 | (defun hierarchy-examples-fs-display-filesystem-tree (&optional folder) 74 | "Display hierarchy of FOLDER in a tree widget." 75 | (require 'tree-widget) 76 | (let* ((hierarchy (hierarchy-examples-fs-build-fs-hierarchy folder))) 77 | (switch-to-buffer (hierarchy-tree-display hierarchy #'hierarchy-examples-fs-labelfn)))) 78 | 79 | ;; Execute one of the following lines to show the .emacd.d hierarchy 80 | ;; in either a tabulated list or a tree widget. This takes around 4 81 | ;; seconds on my computer. 82 | ;; 83 | ;; (hierarchy-examples-fs-display-filesystem "~/.emacs.d") 84 | ;; 85 | ;; (hierarchy-examples-fs-display-filesystem-tree "~/.emacs.d") 86 | 87 | (provide 'hierarchy-examples-fs) 88 | ;;; hierarchy-examples-fs.el ends here 89 | -------------------------------------------------------------------------------- /examples/hierarchy-examples-major-modes.el: -------------------------------------------------------------------------------- 1 | ;;; hierarchy-examples-major-modes.el --- Represent how major-modes inherit from each other -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019 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 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'hierarchy) 27 | 28 | (defun hierarchy-examples-major-modes--major-mode-p (f) 29 | "Return non-nil if F is a major-mode function." 30 | ;; copy-edited from counsel.el (in the swiper/ivy repository) 31 | (and (commandp f) (string-match "-mode$" (symbol-name f)) 32 | (null (help-function-arglist f)))) 33 | 34 | (defun hierarchy-examples-major-modes--all-major-modes () 35 | "Return a list of all major modes." 36 | (let ((major-modes (list))) 37 | (mapatoms 38 | (lambda (symbol) 39 | (when (hierarchy-examples-major-modes--major-mode-p symbol) 40 | (setq major-modes (cons symbol major-modes))))) 41 | major-modes)) 42 | 43 | (defun hierarchy-examples-major-modes--major-mode-parent (f) 44 | "Return the major mode F derive from. 45 | If F doesn't derive from any major-mode, return `root-mode'." 46 | (let ((parent-mode (or (get f 'derived-mode-parent)))) 47 | (cond 48 | ((eq f 'root-mode) nil) 49 | ((null parent-mode) 'root-mode) 50 | (t parent-mode)))) 51 | 52 | (defun hierarchy-examples-major-modes--major-mode-build-hierarchy () 53 | "Return a hierarchy of all major modes." 54 | (let ((hierarchy (hierarchy-new))) 55 | (hierarchy-add-trees hierarchy (hierarchy-examples-major-modes--all-major-modes) #'hierarchy-examples-major-modes--major-mode-parent) 56 | (hierarchy-sort hierarchy) 57 | hierarchy)) 58 | 59 | (defun hierarchy-examples-major-modes-display-major-modes () 60 | "Display all major modes and their inheritance relationship." 61 | (interactive) 62 | (let* ((hierarchy (hierarchy-examples-major-modes--major-mode-build-hierarchy)) 63 | (buffer (hierarchy-tabulated-display 64 | hierarchy 65 | (hierarchy-labelfn-indent 66 | (hierarchy-labelfn-button 67 | (lambda (item _) (insert (format "%s" item))) 68 | (lambda (item _) (find-function item))))))) 69 | (switch-to-buffer buffer))) 70 | 71 | ;; (hierarchy-examples-major-modes-display-major-modes) 72 | 73 | (provide 'hierarchy-examples-major-modes) 74 | ;;; hierarchy-examples-major-modes.el ends here 75 | -------------------------------------------------------------------------------- /hierarchy.el: -------------------------------------------------------------------------------- 1 | ;;; hierarchy.el --- Library to create and display hierarchy structures -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2017 Damien Cassou 4 | 5 | ;; Author: Damien Cassou 6 | ;; Maintainer: Damien Cassou 7 | ;; Version: 0.7.0 8 | ;; Package-Requires: ((emacs "25.1")) 9 | ;; GIT: https://github.com/DamienCassou/hierarchy 10 | ;; URL: https://github.com/DamienCassou/hierarchy 11 | ;; 12 | ;; This file is not part of GNU Emacs. 13 | 14 | ;; This program is free software: you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | 29 | ;; Library to create, query, navigate and display hierarchy structures. 30 | 31 | ;; Creation: After having created a hierarchy with `hierarchy-new', populate it by 32 | ;; calling `hierarchy-add-tree' or `hierarchy-add-trees'. You can then optionally sort its 33 | ;; element with `hierarchy-sort'. 34 | 35 | ;; Querying: You can learn more about your hierarchy by using functions such as 36 | ;; `hierarchy-roots', `hierarchy-has-item', `hierarchy-length', `hierarchy-parent', `hierarchy-descendant-p'. 37 | 38 | ;; Navigation: When your hierarchy is ready, you can use `hierarchy-map-item', `hierarchy-map', 39 | ;; and `map-tree' to apply functions to elements of the hierarchy. 40 | 41 | ;; Display: You can display a hierarchy as a tabulated list using 42 | ;; `hierarchy-tabulated-display' and as an expandable/foldable tree 43 | ;; using `hierarchy-convert-to-tree-widget'. The 44 | ;; `hierarchy-labelfn-*' functions will help you display each item of 45 | ;; the hierarchy the way you want it. 46 | 47 | ;;; Limitation: 48 | 49 | ;; Current implementation uses #'equal to find and distinguish elements. Support 50 | ;; for user-provided equality definition is desired but not yet implemented. 51 | 52 | ;;; Code: 53 | 54 | (require 'seq) 55 | (require 'map) 56 | (require 'subr-x) 57 | 58 | 59 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 60 | ;; Helpers 61 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 62 | 63 | (cl-defstruct (hierarchy 64 | (:constructor hierarchy--make) 65 | (:conc-name hierarchy--)) 66 | (roots (list)) ; list of the hierarchy roots (no parent) 67 | (parents (make-hash-table :test 'equal)) ; map an item to its parent 68 | (children (make-hash-table :test 'equal)) ; map an item to its childre 69 | ;; cache containing the set of all items in the hierarchy 70 | (seen-items (make-hash-table :test 'equal))) ; map an item to t 71 | 72 | (defun hierarchy--seen-items-add (hierarchy item) 73 | "In HIERARCHY, add ITEM to seen items." 74 | (map-put (hierarchy--seen-items hierarchy) item t)) 75 | 76 | (defun hierarchy--compute-roots (hierarchy) 77 | "Search roots of HIERARCHY and return them." 78 | (cl-set-difference 79 | (map-keys (hierarchy--seen-items hierarchy)) 80 | (map-keys (hierarchy--parents hierarchy)) 81 | :test #'equal)) 82 | 83 | (defun hierarchy--sort-roots (hierarchy sortfn) 84 | "Compute, sort and store the roots of HIERARCHY. 85 | 86 | SORTFN is a function taking two items of the hierarchy as parameter and 87 | returning non-nil if the first parameter is lower than the second." 88 | (setf (hierarchy--roots hierarchy) 89 | (sort (hierarchy--compute-roots hierarchy) 90 | sortfn))) 91 | 92 | (defun hierarchy--add-relation (hierarchy item parent acceptfn) 93 | "In HIERARCHY, add ITEM as child of PARENT. 94 | 95 | ACCEPTFN is a function returning non-nil if its parameter (any object) 96 | should be an item of the hierarchy." 97 | (let* ((existing-parent (hierarchy-parent hierarchy item)) 98 | (has-parent-p (funcall acceptfn existing-parent))) 99 | (cond 100 | ((and has-parent-p (not (equal existing-parent parent))) 101 | (error "An item (%s) can only have one parent: '%s' vs '%s'" 102 | item existing-parent parent)) 103 | ((not has-parent-p) 104 | (let ((existing-children (map-elt (hierarchy--children hierarchy) parent (list)))) 105 | (map-put (hierarchy--children hierarchy) parent (append existing-children (list item)))) 106 | (map-put (hierarchy--parents hierarchy) item parent))))) 107 | 108 | (defun hierarchy--set-equal (list1 list2 &rest cl-keys) 109 | "Return non-nil if LIST1 and LIST2 have same elements. 110 | 111 | I.e., if every element of LIST1 also appears in LIST2 and if 112 | every element of LIST2 also appears in LIST1. 113 | 114 | CL-KEYS are key-value pairs just like in `cl-subsetp'. Supported 115 | keys are :key and :test." 116 | (and (apply 'cl-subsetp list1 list2 cl-keys) 117 | (apply 'cl-subsetp list2 list1 cl-keys))) 118 | 119 | 120 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 121 | ;; Creation 122 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 123 | 124 | (defun hierarchy-new () 125 | "Create a hierarchy and return it." 126 | (hierarchy--make)) 127 | 128 | (defun hierarchy-add-tree (hierarchy item parentfn &optional childrenfn acceptfn) 129 | "In HIERARCHY, add ITEM. 130 | 131 | PARENTFN is either nil or a function defining the child-to-parent 132 | relationship: this function takes an item as parameter and should return 133 | the parent of this item in the hierarchy. If the item has no parent in the 134 | hierarchy (i.e., it should be a root), the function should return an object 135 | not accepted by acceptfn (i.e., nil for the default value of acceptfn). 136 | 137 | CHILDRENFN is either nil or a function defining the parent-to-children 138 | relationship: this function takes an item as parameter and should return a 139 | list of children of this item in the hierarchy. 140 | 141 | If both PARENTFN and CHILDRENFN are non-nil, the results of PARENTFN and 142 | CHILDRENFN are expected to be coherent with each other. 143 | 144 | ACCEPTFN is a function returning non-nil if its parameter (any object) 145 | should be an item of the hierarchy. By default, ACCEPTFN returns non-nil 146 | if its parameter is non-nil." 147 | (unless (hierarchy-has-item hierarchy item) 148 | (let ((acceptfn (or acceptfn #'identity))) 149 | (hierarchy--seen-items-add hierarchy item) 150 | (let ((parent (and parentfn (funcall parentfn item)))) 151 | (when (funcall acceptfn parent) 152 | (hierarchy--add-relation hierarchy item parent acceptfn) 153 | (hierarchy-add-tree hierarchy parent parentfn childrenfn))) 154 | (let ((children (and childrenfn (funcall childrenfn item)))) 155 | (mapc (lambda (child) 156 | (when (funcall acceptfn child) 157 | (hierarchy--add-relation hierarchy child item acceptfn) 158 | (hierarchy-add-tree hierarchy child parentfn childrenfn))) 159 | children))))) 160 | 161 | (defun hierarchy-add-trees (hierarchy items parentfn &optional childrenfn acceptfn) 162 | "Call `hierarchy-add-tree' on HIERARCHY and each element of ITEMS. 163 | 164 | PARENTFN, CHILDRENFN and ACCEPTFN have the same meaning as in `hierarchy-add'." 165 | (seq-map (lambda (item) 166 | (hierarchy-add-tree hierarchy item parentfn childrenfn acceptfn)) 167 | items)) 168 | 169 | (defun hierarchy-add-list (hierarchy list &optional wrap childrenfn) 170 | "Add to HIERARCHY the sub-lists in LIST. 171 | 172 | If WRAP is non-nil, allow duplicate items in LIST by wraping each 173 | item in a cons (id . item). The root's id is 1. 174 | 175 | CHILDRENFN is a function (defaults to `cdr') taking LIST as a 176 | parameter which should return LIST's children (a list). Each 177 | child is (recursively) passed as a parameter to CHILDRENFN to get 178 | its own children. Because of this parameter, LIST can be 179 | anything, not necessarily a list." 180 | (let* ((childrenfn (or childrenfn #'cdr)) 181 | (id 0) 182 | (wrapfn (lambda (item) 183 | (if wrap 184 | (cons (setq id (1+ id)) item) 185 | item))) 186 | (unwrapfn (if wrap #'cdr #'identity))) 187 | (hierarchy-add-tree 188 | hierarchy (funcall wrapfn list) nil 189 | (lambda (item) 190 | (mapcar wrapfn (funcall childrenfn 191 | (funcall unwrapfn item))))) 192 | hierarchy)) 193 | 194 | (defun hierarchy-from-list (list &optional wrap childrenfn) 195 | "Create and return a hierarchy built from LIST. 196 | 197 | This function passes LIST, WRAP and CHILDRENFN unchanged to 198 | `hierarchy-add-list'." 199 | (hierarchy-add-list (hierarchy-new) list wrap childrenfn)) 200 | 201 | (defun hierarchy-sort (hierarchy &optional sortfn) 202 | "Modify HIERARCHY so that its roots and item's children are sorted. 203 | 204 | SORTFN is a function taking two items of the hierarchy as parameter and 205 | returning non-nil if the first parameter is lower than the second. By 206 | default, SORTFN is `string-lessp'." 207 | (let ((sortfn (or sortfn #'string-lessp))) 208 | (hierarchy--sort-roots hierarchy sortfn) 209 | (mapc (lambda (parent) 210 | (setf 211 | (map-elt (hierarchy--children hierarchy) parent) 212 | (sort (map-elt (hierarchy--children hierarchy) parent) sortfn))) 213 | (map-keys (hierarchy--children hierarchy))))) 214 | 215 | (defun hierarchy-extract-tree (hierarchy item) 216 | "Return a copy of HIERARCHY with ITEM's descendants and parents." 217 | (if (not (hierarchy-has-item hierarchy item)) 218 | nil 219 | (let ((tree (hierarchy-new))) 220 | (hierarchy-add-tree tree item 221 | (lambda (each) (hierarchy-parent hierarchy each)) 222 | (lambda (each) 223 | (when (or (equal each item) 224 | (hierarchy-descendant-p hierarchy each item)) 225 | (hierarchy-children hierarchy each)))) 226 | tree))) 227 | 228 | (defun hierarchy-copy (hierarchy) 229 | "Return a copy of HIERARCHY. 230 | 231 | Items in HIERARCHY are shared, but structure is not." 232 | (hierarchy-map-hierarchy (lambda (item _) (identity item)) hierarchy)) 233 | 234 | 235 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 236 | ;; Querying 237 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 238 | 239 | (defun hierarchy-items (hierarchy) 240 | "Return a list of all items of HIERARCHY." 241 | (map-keys (hierarchy--seen-items hierarchy))) 242 | 243 | (defun hierarchy-has-item (hierarchy item) 244 | "Return t if HIERARCHY includes ITEM." 245 | (map-contains-key (hierarchy--seen-items hierarchy) item)) 246 | 247 | (defun hierarchy-empty-p (hierarchy) 248 | "Return t if HIERARCHY is empty." 249 | (= 0 (hierarchy-length hierarchy))) 250 | 251 | (defun hierarchy-length (hierarchy) 252 | "Return the number of items in HIERARCHY." 253 | (hash-table-count (hierarchy--seen-items hierarchy))) 254 | 255 | (defun hierarchy-has-root (hierarchy item) 256 | "Return t if one of HIERARCHY's roots is ITEM. 257 | 258 | A root is an item with no parent." 259 | (seq-contains (hierarchy-roots hierarchy) item)) 260 | 261 | (defun hierarchy-roots (hierarchy) 262 | "Return all roots of HIERARCHY. 263 | 264 | A root is an item with no parent." 265 | (let ((roots (hierarchy--roots hierarchy))) 266 | (or roots 267 | (hierarchy--compute-roots hierarchy)))) 268 | 269 | (defun hierarchy-leafs (hierarchy &optional node) 270 | "Return all leafs of HIERARCHY. 271 | 272 | A leaf is an item with no child. 273 | 274 | If NODE is an item of HIERARCHY, only return leafs under NODE." 275 | (let ((leafs (cl-set-difference 276 | (map-keys (hierarchy--seen-items hierarchy)) 277 | (map-keys (hierarchy--children hierarchy))))) 278 | (if (hierarchy-has-item hierarchy node) 279 | (seq-filter (lambda (item) (hierarchy-descendant-p hierarchy item node)) leafs) 280 | leafs))) 281 | 282 | (defun hierarchy-parent (hierarchy item) 283 | "In HIERARCHY, return parent of ITEM." 284 | (map-elt (hierarchy--parents hierarchy) item)) 285 | 286 | (defun hierarchy-children (hierarchy parent) 287 | "In HIERARCHY, return children of PARENT." 288 | (map-elt (hierarchy--children hierarchy) parent (list))) 289 | 290 | (defun hierarchy-child-p (hierarchy item1 item2) 291 | "In HIERARCHY, return non-nil if and only if ITEM1 is a child of ITEM2." 292 | (equal (hierarchy-parent hierarchy item1) item2)) 293 | 294 | (defun hierarchy-descendant-p (hierarchy item1 item2) 295 | "In HIERARCHY, return non-nil if and only if ITEM1 is a descendant of ITEM2. 296 | 297 | ITEM1 is a descendant of ITEM2 if and only if both are items of HIERARCHY 298 | and either: 299 | 300 | - ITEM1 is child of ITEM2, or 301 | - ITEM1's parent is a descendant of ITEM2." 302 | (and 303 | (hierarchy-has-item hierarchy item1) 304 | (hierarchy-has-item hierarchy item2) 305 | (or 306 | (hierarchy-child-p hierarchy item1 item2) 307 | (hierarchy-descendant-p hierarchy (hierarchy-parent hierarchy item1) item2)))) 308 | 309 | (defun hierarchy-equal (hierarchy1 hierarchy2) 310 | "Return t if HIERARCHY1 and HIERARCHY2 are equal. 311 | 312 | Two equal hierarchies share the same items and the same 313 | relationships among them." 314 | (and (hierarchy-p hierarchy1) 315 | (hierarchy-p hierarchy2) 316 | (= (hierarchy-length hierarchy1) (hierarchy-length hierarchy2)) 317 | ;; parents are the same 318 | (seq-every-p (lambda (child) 319 | (equal (hierarchy-parent hierarchy1 child) 320 | (hierarchy-parent hierarchy2 child))) 321 | (map-keys (hierarchy--parents hierarchy1))) 322 | ;; children are the same 323 | (seq-every-p (lambda (parent) 324 | (hierarchy--set-equal 325 | (hierarchy-children hierarchy1 parent) 326 | (hierarchy-children hierarchy2 parent) 327 | :test #'equal)) 328 | (map-keys (hierarchy--children hierarchy1))))) 329 | 330 | 331 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 332 | ;; Navigation 333 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 334 | 335 | (defun hierarchy-map-item (func item hierarchy &optional indent) 336 | "Return the result of applying FUNC to ITEM and its descendants in HIERARCHY. 337 | 338 | This function navigates the tree top-down: FUNCTION is first called on item 339 | and then on each of its children. Results are concatenated in a list. 340 | 341 | INDENT is a number (default 0) representing the indentation of ITEM in 342 | HIERARCHY. FUNC should take 2 argument: the item and its indentation 343 | level." 344 | (let ((indent (or indent 0))) 345 | (cons 346 | (funcall func item indent) 347 | (seq-mapcat (lambda (child) (hierarchy-map-item func child hierarchy (1+ indent))) 348 | (hierarchy-children hierarchy item))))) 349 | 350 | (defun hierarchy-map (func hierarchy &optional indent) 351 | "Return the result of applying FUNC to each element of HIERARCHY. 352 | 353 | This function navigates the tree top-down: FUNCTION is first called on each 354 | root. To do so, it calls `hierarchy-map-item' on each root 355 | sequentially. Results are concatenated in a list. 356 | 357 | FUNC should take 2 arguments: the item and its indentation level. 358 | 359 | INDENT is a number (default 0) representing the indentation of HIERARCHY's 360 | roots." 361 | (let ((indent (or indent 0))) 362 | (seq-mapcat (lambda (root) (hierarchy-map-item func root hierarchy indent)) 363 | (hierarchy-roots hierarchy)))) 364 | 365 | (defun hierarchy-map-tree (function hierarchy &optional item indent) 366 | "Apply FUNCTION on each item of HIERARCHY under ITEM. 367 | 368 | This function navigates the tree bottom-up: FUNCTION is first called on 369 | leafs and the result is passed as parameter when calling FUNCTION on 370 | parents. 371 | 372 | FUNCTION should take 3 parameters: the current item, its indentation 373 | level (a number), and a list representing the result of applying 374 | `hierarchy-map-tree' to each child of the item. 375 | 376 | INDENT is 0 by default and is passed as second parameter to FUNCTION. 377 | INDENT is incremented by 1 at each level of the tree. 378 | 379 | This function returns the result of applying FUNCTION to ITEM (the first 380 | root if nil)." 381 | (let ((item (or item (car (hierarchy-roots hierarchy)))) 382 | (indent (or indent 0))) 383 | (funcall function item indent 384 | (mapcar (lambda (child) 385 | (hierarchy-map-tree function hierarchy child (1+ indent))) 386 | (hierarchy-children hierarchy item))))) 387 | 388 | (defun hierarchy-map-hierarchy (function hierarchy) 389 | "Apply FUNCTION to each item of HIERARCHY in a new hierarchy. 390 | 391 | FUNCTION should take 2 parameters, the current item and its 392 | indentation level (a number), and should return an item to be 393 | added to the new hierarchy." 394 | (let* ((items (make-hash-table :test #'equal)) 395 | (transform (lambda (item) (map-elt items item)))) 396 | ;; Make 'items', a table mapping original items to their 397 | ;; transformation 398 | (hierarchy-map (lambda (item indent) 399 | (map-put items item (funcall function item indent))) 400 | hierarchy) 401 | (hierarchy--make 402 | :roots (mapcar transform (hierarchy-roots hierarchy)) 403 | :parents (let ((result (make-hash-table :test #'equal))) 404 | (map-apply (lambda (child parent) 405 | (map-put result 406 | (funcall transform child) 407 | (funcall transform parent))) 408 | (hierarchy--parents hierarchy)) 409 | result) 410 | :children (let ((result (make-hash-table :test #'equal))) 411 | (map-apply (lambda (parent children) 412 | (map-put result 413 | (funcall transform parent) 414 | (seq-map transform children))) 415 | (hierarchy--children hierarchy)) 416 | result) 417 | :seen-items (let ((result (make-hash-table :test #'equal))) 418 | (map-apply (lambda (item v) 419 | (map-put result 420 | (funcall transform item) 421 | v)) 422 | (hierarchy--seen-items hierarchy)) 423 | result)))) 424 | 425 | 426 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 427 | ;; Display 428 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 429 | 430 | (defun hierarchy-labelfn-indent (labelfn &optional indent-string) 431 | "Return a function rendering LABELFN indented with INDENT-STRING. 432 | 433 | INDENT-STRING defaults to a 2-space string. Indentation is 434 | multiplied by the depth of the displayed item." 435 | (let ((indent-string (or indent-string " "))) 436 | (lambda (item indent) 437 | (dotimes (_ indent) (insert indent-string)) 438 | (funcall labelfn item indent)))) 439 | 440 | (defun hierarchy-labelfn-button (labelfn actionfn) 441 | "Return a function rendering LABELFN in a button. 442 | 443 | Clicking the button triggers ACTIONFN. ACTIONFN is a function 444 | taking an item of HIERARCHY and an indentation value (a number) 445 | as input. This function is called when an item is clicked. The 446 | return value of ACTIONFN is ignored." 447 | (lambda (item indent) 448 | (let ((start (point))) 449 | (funcall labelfn item indent) 450 | (make-text-button start (point) 451 | 'action (lambda (_) (funcall actionfn item indent)))))) 452 | 453 | (defun hierarchy-labelfn-button-if (labelfn buttonp actionfn) 454 | "Return a function rendering LABELFN as a button if BUTTONP. 455 | 456 | Pass LABELFN and ACTIONFN to `hierarchy-labelfn-button' if 457 | BUTTONP is non-nil. Otherwise, render LABELFN without making it 458 | a button. 459 | 460 | BUTTONP is a function taking an item of HIERARCHY and an 461 | indentation value (a number) as input." 462 | (lambda (item indent) 463 | (if (funcall buttonp item indent) 464 | (funcall (hierarchy-labelfn-button labelfn actionfn) item indent) 465 | (funcall labelfn item indent)))) 466 | 467 | (defun hierarchy-labelfn-to-string (labelfn item indent) 468 | "Execute LABELFN on ITEM and INDENT. Return result as a string." 469 | (with-temp-buffer 470 | (funcall labelfn item indent) 471 | (buffer-substring (point-min) (point-max)))) 472 | 473 | (defun hierarchy-print (hierarchy &optional to-string) 474 | "Insert HIERARCHY in current buffer as plain text. 475 | 476 | Use TO-STRING to convert each element to a string. TO-STRING is 477 | a function taking an item of HIERARCHY as input and returning a 478 | string. If nil, TO-STRING defaults to a call to `format' with \"%s\"." 479 | (let ((to-string (or to-string (lambda (item) (format "%s" item))))) 480 | (hierarchy-map 481 | (hierarchy-labelfn-indent (lambda (item _) (insert (funcall to-string item) "\n"))) 482 | hierarchy))) 483 | 484 | (defun hierarchy-to-string (hierarchy &optional to-string) 485 | "Return a string representing HIERARCHY. 486 | 487 | TO-STRING is passed unchanged to `hierarchy-print'." 488 | (with-temp-buffer 489 | (hierarchy-print hierarchy to-string) 490 | (buffer-substring (point-min) (point-max)))) 491 | 492 | (defun hierarchy-tabulated-imenu-action (_item-name position) 493 | "Move to ITEM-NAME at POSITION in current buffer." 494 | (goto-char position) 495 | (back-to-indentation)) 496 | 497 | (define-derived-mode hierarchy-tabulated-mode tabulated-list-mode "Hierarchy tabulated" 498 | "Major mode to display a hierarchy as a tabulated list." 499 | (setq-local imenu-generic-expression 500 | ;; debbugs: 26457 - Cannot pass a function to 501 | ;; imenu-generic-expression. Add 502 | ;; `hierarchy-tabulated-imenu-action' to the end of the 503 | ;; list when bug is fixed 504 | '(("Item" "^[[:space:]]+\\(?1:.+\\)$" 1)))) 505 | 506 | (defun hierarchy-tabulated-display (hierarchy labelfn &optional buffer) 507 | "Display HIERARCHY as a tabulated list in `hierarchy-tabulated-mode'. 508 | 509 | LABELFN is a function taking an item of HIERARCHY and an indentation 510 | level (a number) as input and inserting a string to be displayed in the 511 | table. 512 | 513 | The tabulated list is displayed in BUFFER, or a newly created buffer if 514 | nil. The buffer is returned." 515 | (let ((buffer (or buffer (generate-new-buffer "hierarchy-tabulated")))) 516 | (with-current-buffer buffer 517 | (hierarchy-tabulated-mode) 518 | (setq tabulated-list-format 519 | (vector '("Item name" 0 nil))) 520 | (setq tabulated-list-entries 521 | (hierarchy-map (lambda (item indent) 522 | (list item (vector (hierarchy-labelfn-to-string labelfn item indent)))) 523 | hierarchy)) 524 | (tabulated-list-init-header) 525 | (tabulated-list-print)) 526 | buffer)) 527 | 528 | (declare-function widget-convert "wid-edit") 529 | (defun hierarchy-convert-to-tree-widget (hierarchy labelfn) 530 | "Return a tree-widget for HIERARCHY. 531 | 532 | LABELFN is a function taking an item of HIERARCHY and an indentation 533 | value (a number) as parameter and inserting a string to be displayed as a 534 | node label." 535 | (require 'wid-edit) 536 | (require 'tree-widget) 537 | (hierarchy-map-tree (lambda (item indent children) 538 | (widget-convert 539 | 'tree-widget 540 | :tag (hierarchy-labelfn-to-string labelfn item indent) 541 | :args children)) 542 | hierarchy)) 543 | 544 | (defun hierarchy-tree-display (hierarchy labelfn &optional buffer) 545 | "Display HIERARCHY as a tree widget in a new buffer. 546 | 547 | HIERARCHY and LABELFN are passed unchanged to 548 | `hierarchy-convert-to-tree-widget'. 549 | 550 | The tree widget is displayed in BUFFER, or a newly created buffer if 551 | nil. The buffer is returned." 552 | (let ((buffer (or buffer (generate-new-buffer "*hierarchy-tree*"))) 553 | (tree-widget (hierarchy-convert-to-tree-widget hierarchy labelfn))) 554 | (with-current-buffer buffer 555 | (setq-local buffer-read-only t) 556 | (let ((inhibit-read-only t)) 557 | (erase-buffer) 558 | (widget-create tree-widget) 559 | (goto-char (point-min)) 560 | (special-mode))) 561 | buffer)) 562 | 563 | (provide 'hierarchy) 564 | 565 | ;;; hierarchy.el ends here 566 | -------------------------------------------------------------------------------- /media/animals-tabulated-anime.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/animals-tabulated-anime.gif -------------------------------------------------------------------------------- /media/animals-tree-anime.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/animals-tree-anime.gif -------------------------------------------------------------------------------- /media/faces-tree.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/faces-tree.png -------------------------------------------------------------------------------- /media/files-tabulated-anime.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/files-tabulated-anime.gif -------------------------------------------------------------------------------- /media/files-tree-anime.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/files-tree-anime.gif -------------------------------------------------------------------------------- /media/json-tree-anime.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/json-tree-anime.gif -------------------------------------------------------------------------------- /media/klassified-tabulated-anime.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/klassified-tabulated-anime.gif -------------------------------------------------------------------------------- /media/major-modes-tabulated.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/major-modes-tabulated.png -------------------------------------------------------------------------------- /media/media-src/animals-tabulated-01.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tabulated-01.gif -------------------------------------------------------------------------------- /media/media-src/animals-tabulated-02.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tabulated-02.gif -------------------------------------------------------------------------------- /media/media-src/animals-tabulated-03.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tabulated-03.gif -------------------------------------------------------------------------------- /media/media-src/animals-tabulated-04.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tabulated-04.gif -------------------------------------------------------------------------------- /media/media-src/animals-tabulated-05.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tabulated-05.gif -------------------------------------------------------------------------------- /media/media-src/animals-tree-01.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tree-01.gif -------------------------------------------------------------------------------- /media/media-src/animals-tree-02.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tree-02.gif -------------------------------------------------------------------------------- /media/media-src/animals-tree-03.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tree-03.gif -------------------------------------------------------------------------------- /media/media-src/animals-tree-04.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tree-04.gif -------------------------------------------------------------------------------- /media/media-src/animals-tree-05.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tree-05.gif -------------------------------------------------------------------------------- /media/media-src/animals-tree-06.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/animals-tree-06.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-01.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-01.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-02.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-02.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-03.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-03.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-04.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-04.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-05.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-05.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-06.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-06.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-07.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-07.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-08.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-08.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-09.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-09.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-10-1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-10-1.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-10-2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-10-2.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-11-1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-11-1.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-11-2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-11-2.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-11-3.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-11-3.gif -------------------------------------------------------------------------------- /media/media-src/files-tabulated-11-4.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tabulated-11-4.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-01.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-01.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-02.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-02.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-03.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-03.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-04.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-04.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-05.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-05.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-06.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-06.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-07.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-07.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-08.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-08.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-09.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-09.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-10.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-10.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-11.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-11.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-12.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-12.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-13.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-13.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-14.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-14.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-15.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-15.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-16.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-16.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-17-1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-17-1.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-17-2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-17-2.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-17-3.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-17-3.gif -------------------------------------------------------------------------------- /media/media-src/files-tree-17-4.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/files-tree-17-4.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-00-1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-00-1.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-00-2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-00-2.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-01-1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-01-1.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-01-2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-01-2.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-02.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-02.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-03.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-03.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-04.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-04.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-05.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-05.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-06.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-06.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-07.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-07.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-08.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-08.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-09.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-09.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-10.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-10.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-11.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-11.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-12.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-12.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-13.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-13.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-14.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-14.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-15.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-15.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-16.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-16.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-17.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-17.gif -------------------------------------------------------------------------------- /media/media-src/json-tree-18.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/json-tree-18.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-01.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-01.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-02.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-02.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-03.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-03.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-04.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-04.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-05.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-05.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-06.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-06.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-07.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-07.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-08.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-08.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-09.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-09.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-10.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-10.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-11.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-11.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-12.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-12.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-13.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-13.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-15.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-15.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-16.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-16.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-17.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-17.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-18.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-18.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-19.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-19.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-20.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-20.gif -------------------------------------------------------------------------------- /media/media-src/klassified-tabulated-21.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/DamienCassou/hierarchy/d8373b376642e9297595468dbe72ec63a6e4b571/media/media-src/klassified-tabulated-21.gif -------------------------------------------------------------------------------- /test/hierarchy-test.el: -------------------------------------------------------------------------------- 1 | ;;; hierarchy-test.el --- Tests for hierarchy.el 2 | 3 | ;; Copyright (C) 2013 Damien Cassou 4 | 5 | ;; Author: Damien Cassou 6 | ;; Maintainer: Damien Cassou 7 | 8 | ;; This file is not part of GNU Emacs. 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 | ;; Tests for hierarchy.el 26 | 27 | ;;; Code: 28 | 29 | (require 'ert) 30 | (require 'hierarchy) 31 | 32 | (declare-function test-helper-animals "test-helper") 33 | 34 | (ert-deftest hierarchy-add-one-root () 35 | (let ((parentfn (lambda (_) nil)) 36 | (hierarchy (hierarchy-new))) 37 | (hierarchy-add-tree hierarchy 'animal parentfn) 38 | (should (equal (hierarchy-roots hierarchy) '(animal))))) 39 | 40 | (ert-deftest hierarchy-add-one-item-with-parent () 41 | (let ((parentfn (lambda (item) 42 | (cl-case item 43 | (bird 'animal)))) 44 | (hierarchy (hierarchy-new))) 45 | (hierarchy-add-tree hierarchy 'bird parentfn) 46 | (should (equal (hierarchy-roots hierarchy) '(animal))) 47 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))))) 48 | 49 | (ert-deftest hierarchy-add-one-item-with-parent-and-grand-parent () 50 | (let ((parentfn (lambda (item) 51 | (cl-case item 52 | (dove 'bird) 53 | (bird 'animal)))) 54 | (hierarchy (hierarchy-new))) 55 | (hierarchy-add-tree hierarchy 'dove parentfn) 56 | (should (equal (hierarchy-roots hierarchy) '(animal))) 57 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))) 58 | (should (equal (hierarchy-children hierarchy 'bird) '(dove))))) 59 | 60 | (ert-deftest hierarchy-add-same-root-twice () 61 | (let ((parentfn (lambda (_) nil)) 62 | (hierarchy (hierarchy-new))) 63 | (hierarchy-add-tree hierarchy 'animal parentfn) 64 | (hierarchy-add-tree hierarchy 'animal parentfn) 65 | (should (equal (hierarchy-roots hierarchy) '(animal))))) 66 | 67 | (ert-deftest hierarchy-add-same-child-twice () 68 | (let ((parentfn (lambda (item) 69 | (cl-case item 70 | (bird 'animal)))) 71 | (hierarchy (hierarchy-new))) 72 | (hierarchy-add-tree hierarchy 'bird parentfn) 73 | (hierarchy-add-tree hierarchy 'bird parentfn) 74 | (should (equal (hierarchy-roots hierarchy) '(animal))) 75 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))))) 76 | 77 | (ert-deftest hierarchy-add-item-and-its-parent () 78 | (let ((parentfn (lambda (item) 79 | (cl-case item 80 | (bird 'animal)))) 81 | (hierarchy (hierarchy-new))) 82 | (hierarchy-add-tree hierarchy 'bird parentfn) 83 | (hierarchy-add-tree hierarchy 'animal parentfn) 84 | (should (equal (hierarchy-roots hierarchy) '(animal))) 85 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))))) 86 | 87 | (ert-deftest hierarchy-add-item-and-its-child () 88 | (let ((parentfn (lambda (item) 89 | (cl-case item 90 | (bird 'animal)))) 91 | (hierarchy (hierarchy-new))) 92 | (hierarchy-add-tree hierarchy 'animal parentfn) 93 | (hierarchy-add-tree hierarchy 'bird parentfn) 94 | (should (equal (hierarchy-roots hierarchy) '(animal))) 95 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))))) 96 | 97 | (ert-deftest hierarchy-add-two-items-sharing-parent () 98 | (let ((parentfn (lambda (item) 99 | (cl-case item 100 | (dove 'bird) 101 | (pigeon 'bird)))) 102 | (hierarchy (hierarchy-new))) 103 | (hierarchy-add-tree hierarchy 'dove parentfn) 104 | (hierarchy-add-tree hierarchy 'pigeon parentfn) 105 | (should (equal (hierarchy-roots hierarchy) '(bird))) 106 | (should (equal (hierarchy-children hierarchy 'bird) '(dove pigeon))))) 107 | 108 | (ert-deftest hierarchy-add-two-hierarchies () 109 | (let ((parentfn (lambda (item) 110 | (cl-case item 111 | (dove 'bird) 112 | (circle 'shape)))) 113 | (hierarchy (hierarchy-new))) 114 | (hierarchy-add-tree hierarchy 'dove parentfn) 115 | (hierarchy-add-tree hierarchy 'circle parentfn) 116 | (should (equal (hierarchy-roots hierarchy) '(bird shape))) 117 | (should (equal (hierarchy-children hierarchy 'bird) '(dove))) 118 | (should (equal (hierarchy-children hierarchy 'shape) '(circle))))) 119 | 120 | (ert-deftest hierarchy-add-with-childrenfn () 121 | (let ((childrenfn (lambda (item) 122 | (cl-case item 123 | (animal '(bird)) 124 | (bird '(dove pigeon))))) 125 | (hierarchy (hierarchy-new))) 126 | (hierarchy-add-tree hierarchy 'animal nil childrenfn) 127 | (should (equal (hierarchy-roots hierarchy) '(animal))) 128 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))) 129 | (should (equal (hierarchy-children hierarchy 'bird) '(dove pigeon))))) 130 | 131 | (ert-deftest hierarchy-add-with-parentfn-and-childrenfn () 132 | (let ((parentfn (lambda (item) 133 | (cl-case item 134 | (bird 'animal) 135 | (animal 'life-form)))) 136 | (childrenfn (lambda (item) 137 | (cl-case item 138 | (bird '(dove pigeon)) 139 | (pigeon '(ashy-wood-pigeon))))) 140 | (hierarchy (hierarchy-new))) 141 | (hierarchy-add-tree hierarchy 'bird parentfn childrenfn) 142 | (should (equal (hierarchy-roots hierarchy) '(life-form))) 143 | (should (equal (hierarchy-children hierarchy 'life-form) '(animal))) 144 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))) 145 | (should (equal (hierarchy-children hierarchy 'bird) '(dove pigeon))) 146 | (should (equal (hierarchy-children hierarchy 'pigeon) '(ashy-wood-pigeon))))) 147 | 148 | (ert-deftest hierarchy-add-twice-with-parentfn-and-childrenfn () 149 | (let* ((parentfn (lambda (item) 150 | (cl-case item 151 | (dove 'bird) 152 | (bird 'animal)))) 153 | (childrenfn (lambda (item) 154 | (cl-case item 155 | (animal '(bird)) 156 | (bird '(dove))))) 157 | (hierarchy (hierarchy-new))) 158 | (hierarchy-add-tree hierarchy 'bird parentfn childrenfn) 159 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))) 160 | (should (equal (hierarchy-children hierarchy 'bird) '(dove))))) 161 | 162 | (ert-deftest hierarchy-add-trees () 163 | (let ((parentfn (lambda (item) 164 | (cl-case item 165 | (dove 'bird) 166 | (pigeon 'bird) 167 | (bird 'animal)))) 168 | (hierarchy (hierarchy-new))) 169 | (hierarchy-add-trees hierarchy '(dove pigeon) parentfn) 170 | (should (equal (hierarchy-roots hierarchy) '(animal))) 171 | (should (equal (hierarchy-children hierarchy 'animal) '(bird))) 172 | (should (equal (hierarchy-children hierarchy 'bird) '(dove pigeon))))) 173 | 174 | (ert-deftest hierarchy-from-list () 175 | (let ((hierarchy (hierarchy-from-list 176 | '(animal (bird (dove) 177 | (pigeon)) 178 | (cow) 179 | (dolphin))))) 180 | (hierarchy-sort hierarchy (lambda (item1 item2) 181 | (string< (car item1) 182 | (car item2)))) 183 | (should (equal (hierarchy-to-string hierarchy (lambda (item) (symbol-name (car item)))) 184 | "animal\n bird\n dove\n pigeon\n cow\n dolphin\n")))) 185 | 186 | (ert-deftest hierarchy-from-list-with-duplicates () 187 | (let ((hierarchy (hierarchy-from-list 188 | '(a (b) (b)) 189 | t))) 190 | (hierarchy-sort hierarchy (lambda (item1 item2) 191 | ;; sort by ID 192 | (< (car item1) (car item2)))) 193 | (should (equal (hierarchy-length hierarchy) 3)) 194 | (should (equal (hierarchy-to-string 195 | hierarchy 196 | (lambda (item) 197 | (format "%s(%s)" 198 | (cadr item) 199 | (car item)))) 200 | "a(1)\n b(2)\n b(3)\n")))) 201 | 202 | (ert-deftest hierarchy-from-list-with-childrenfn () 203 | (let ((hierarchy (hierarchy-from-list 204 | "abc" 205 | nil 206 | (lambda (item) 207 | (when (string= item "abc") 208 | (split-string item "" t)))))) 209 | (hierarchy-sort hierarchy (lambda (item1 item2) (string< item1 item2))) 210 | (should (equal (hierarchy-length hierarchy) 4)) 211 | (should (equal (hierarchy-to-string hierarchy) 212 | "abc\n a\n b\n c\n")))) 213 | 214 | (ert-deftest hierarchy-add-relation-check-error-when-different-parent () 215 | (let ((parentfn (lambda (item) 216 | (cl-case item 217 | (bird 'animal)))) 218 | (hierarchy (hierarchy-new))) 219 | (hierarchy-add-tree hierarchy 'bird parentfn) 220 | (should-error 221 | (hierarchy--add-relation hierarchy 'bird 'cow #'identity)))) 222 | 223 | (ert-deftest hierarchy-empty-p-return-non-nil-for-empty () 224 | (should (hierarchy-empty-p (hierarchy-new)))) 225 | 226 | (ert-deftest hierarchy-empty-p-return-nil-for-non-empty () 227 | (should-not (hierarchy-empty-p (test-helper-animals)))) 228 | 229 | (ert-deftest hierarchy-length-of-empty-is-0 () 230 | (should (equal (hierarchy-length (hierarchy-new)) 0))) 231 | 232 | (ert-deftest hierarchy-length-of-non-empty-counts-items () 233 | (let ((parentfn (lambda (item) 234 | (cl-case item 235 | (bird 'animal) 236 | (dove 'bird) 237 | (pigeon 'bird)))) 238 | (hierarchy (hierarchy-new))) 239 | (hierarchy-add-tree hierarchy 'dove parentfn) 240 | (hierarchy-add-tree hierarchy 'pigeon parentfn) 241 | (should (equal (hierarchy-length hierarchy) 4)))) 242 | 243 | (ert-deftest hierarchy-has-root () 244 | (let ((parentfn (lambda (item) 245 | (cl-case item 246 | (bird 'animal) 247 | (dove 'bird) 248 | (pigeon 'bird)))) 249 | (hierarchy (hierarchy-new))) 250 | (should-not (hierarchy-has-root hierarchy 'animal)) 251 | (should-not (hierarchy-has-root hierarchy 'bird)) 252 | (hierarchy-add-tree hierarchy 'dove parentfn) 253 | (hierarchy-add-tree hierarchy 'pigeon parentfn) 254 | (should (hierarchy-has-root hierarchy 'animal)) 255 | (should-not (hierarchy-has-root hierarchy 'bird)))) 256 | 257 | (ert-deftest hierarchy-leafs () 258 | (let ((animals (test-helper-animals))) 259 | (should (equal (hierarchy-leafs animals) 260 | '(dove pigeon dolphin cow))))) 261 | 262 | (ert-deftest hierarchy-leafs-includes-lonely-roots () 263 | (let ((parentfn (lambda (item) nil)) 264 | (hierarchy (hierarchy-new))) 265 | (hierarchy-add-tree hierarchy 'foo parentfn) 266 | (should (equal (hierarchy-leafs hierarchy) 267 | '(foo))))) 268 | 269 | (ert-deftest hierarchy-leafs-of-node () 270 | (let ((animals (test-helper-animals))) 271 | (should (equal (hierarchy-leafs animals 'cow) '())) 272 | (should (equal (hierarchy-leafs animals 'animal) '(dove pigeon dolphin cow))) 273 | (should (equal (hierarchy-leafs animals 'bird) '(dove pigeon))) 274 | (should (equal (hierarchy-leafs animals 'dove) '())))) 275 | 276 | (ert-deftest hierarchy-child-p () 277 | (let ((animals (test-helper-animals))) 278 | (should (hierarchy-child-p animals 'dove 'bird)) 279 | (should (hierarchy-child-p animals 'bird 'animal)) 280 | (should (hierarchy-child-p animals 'cow 'animal)) 281 | (should-not (hierarchy-child-p animals 'cow 'bird)) 282 | (should-not (hierarchy-child-p animals 'bird 'cow)) 283 | (should-not (hierarchy-child-p animals 'animal 'dove)) 284 | (should-not (hierarchy-child-p animals 'animal 'bird)))) 285 | 286 | (ert-deftest hierarchy-descendant () 287 | (let ((animals (test-helper-animals))) 288 | (should (hierarchy-descendant-p animals 'dove 'animal)) 289 | (should (hierarchy-descendant-p animals 'dove 'bird)) 290 | (should (hierarchy-descendant-p animals 'bird 'animal)) 291 | (should (hierarchy-descendant-p animals 'cow 'animal)) 292 | (should-not (hierarchy-descendant-p animals 'cow 'bird)) 293 | (should-not (hierarchy-descendant-p animals 'bird 'cow)) 294 | (should-not (hierarchy-descendant-p animals 'animal 'dove)) 295 | (should-not (hierarchy-descendant-p animals 'animal 'bird)))) 296 | 297 | (ert-deftest hierarchy-descendant-if-not-same () 298 | (let ((animals (test-helper-animals))) 299 | (should-not (hierarchy-descendant-p animals 'cow 'cow)) 300 | (should-not (hierarchy-descendant-p animals 'dove 'dove)) 301 | (should-not (hierarchy-descendant-p animals 'bird 'bird)) 302 | (should-not (hierarchy-descendant-p animals 'animal 'animal)))) 303 | 304 | ;; keywords supported: :test :key 305 | (ert-deftest hierarchy--set-equal () 306 | (should (hierarchy--set-equal '(1 2 3) '(1 2 3))) 307 | (should (hierarchy--set-equal '(1 2 3) '(3 2 1))) 308 | (should (hierarchy--set-equal '(3 2 1) '(1 2 3))) 309 | (should-not (hierarchy--set-equal '(2 3) '(3 2 1))) 310 | (should-not (hierarchy--set-equal '(1 2 3) '(2 3))) 311 | (should-not (hierarchy--set-equal '("1" "2") '("2" "1") :test #'eq)) 312 | (should (hierarchy--set-equal '("1" "2") '("2" "1") :test #'equal)) 313 | (should-not (hierarchy--set-equal '(1 2) '(-1 -2))) 314 | (should (hierarchy--set-equal '(1 2) '(-1 -2) :key #'abs)) 315 | (should-not (hierarchy--set-equal '(("1" 1) ("2" 1)) '(("1" 2) ("2" 2)))) 316 | (should-not (hierarchy--set-equal '(("1" 1) ("2" 1)) '(("1" 2) ("2" 2)) :key #'car)) 317 | (should-not (hierarchy--set-equal '(("1" 1) ("2" 1)) '(("1" 2) ("2" 2)) :test #'equal)) 318 | (should (hierarchy--set-equal '(("1" 1) ("2" 1)) '(("1" 2) ("2" 2)) :key #'car :test #'equal))) 319 | 320 | (ert-deftest hierarchy-equal-returns-true-for-same-hierarchy () 321 | (let ((animals (test-helper-animals))) 322 | (should (hierarchy-equal animals animals)) 323 | (should (hierarchy-equal (test-helper-animals) animals)))) 324 | 325 | (ert-deftest hierarchy-equal-returns-true-for-hierarchy-copies () 326 | (let ((animals (test-helper-animals))) 327 | (should (hierarchy-equal animals (hierarchy-copy animals))))) 328 | 329 | (ert-deftest hierarchy-map-item-on-leaf () 330 | (let* ((animals (test-helper-animals)) 331 | (result (hierarchy-map-item (lambda (item indent) (cons item indent)) 332 | 'cow 333 | animals))) 334 | (should (equal result '((cow . 0)))))) 335 | 336 | (ert-deftest hierarchy-map-item-on-leaf-with-indent () 337 | (let* ((animals (test-helper-animals)) 338 | (result (hierarchy-map-item (lambda (item indent) (cons item indent)) 339 | 'cow 340 | animals 341 | 2))) 342 | (should (equal result '((cow . 2)))))) 343 | 344 | (ert-deftest hierarchy-map-item-on-parent () 345 | (let* ((animals (test-helper-animals)) 346 | (result (hierarchy-map-item (lambda (item indent) (cons item indent)) 347 | 'bird 348 | animals))) 349 | (should (equal result '((bird . 0) (dove . 1) (pigeon . 1)))))) 350 | 351 | (ert-deftest hierarchy-map-item-on-grand-parent () 352 | (let* ((animals (test-helper-animals)) 353 | (result (hierarchy-map-item (lambda (item indent) (cons item indent)) 354 | 'animal 355 | animals))) 356 | (should (equal result '((animal . 0) (bird . 1) (dove . 2) (pigeon . 2) 357 | (cow . 1) (dolphin . 1)))))) 358 | 359 | (ert-deftest hierarchy-map-conses () 360 | (let* ((animals (test-helper-animals)) 361 | (result (hierarchy-map (lambda (item indent) 362 | (cons item indent)) 363 | animals))) 364 | (should (equal result '((animal . 0) 365 | (bird . 1) 366 | (dove . 2) 367 | (pigeon . 2) 368 | (cow . 1) 369 | (dolphin . 1)))))) 370 | 371 | (ert-deftest hierarchy-map-tree () 372 | (let ((animals (test-helper-animals))) 373 | (should (equal (hierarchy-map-tree (lambda (item indent children) 374 | (list item indent children)) 375 | animals) 376 | '(animal 377 | 0 378 | ((bird 1 ((dove 2 nil) (pigeon 2 nil))) 379 | (cow 1 nil) 380 | (dolphin 1 nil))))))) 381 | 382 | (ert-deftest hierarchy-map-hierarchy-keeps-hierarchy () 383 | (let* ((animals (test-helper-animals)) 384 | (result (hierarchy-map-hierarchy (lambda (item _) (identity item)) 385 | animals))) 386 | (should (hierarchy-equal animals result)))) 387 | 388 | (ert-deftest hierarchy-map-applies-function () 389 | (let* ((animals (test-helper-animals)) 390 | (parentfn (lambda (item) 391 | (cond 392 | ((equal item "bird") "animal") 393 | ((equal item "dove") "bird") 394 | ((equal item "pigeon") "bird") 395 | ((equal item "cow") "animal") 396 | ((equal item "dolphin") "animal")))) 397 | (expected (hierarchy-new))) 398 | (hierarchy-add-tree expected "dove" parentfn) 399 | (hierarchy-add-tree expected "pigeon" parentfn) 400 | (hierarchy-add-tree expected "cow" parentfn) 401 | (hierarchy-add-tree expected "dolphin" parentfn) 402 | (should (hierarchy-equal 403 | (hierarchy-map-hierarchy (lambda (item _) (symbol-name item)) animals) 404 | expected)))) 405 | 406 | (ert-deftest hierarchy-extract-tree () 407 | (let* ((animals (test-helper-animals)) 408 | (birds (hierarchy-extract-tree animals 'bird))) 409 | (hierarchy-sort birds) 410 | (should (equal (hierarchy-roots birds) '(animal))) 411 | (should (equal (hierarchy-children birds 'animal) '(bird))) 412 | (should (equal (hierarchy-children birds 'bird) '(dove pigeon))))) 413 | 414 | (ert-deftest hierarchy-extract-tree-nil-if-not-in-hierarchy () 415 | (let* ((animals (test-helper-animals))) 416 | (should-not (hierarchy-extract-tree animals 'foobar)))) 417 | 418 | (ert-deftest hierarchy-items-of-empty-hierarchy-is-empty () 419 | (should (seq-empty-p (hierarchy-items (hierarchy-new))))) 420 | 421 | (ert-deftest hierarchy-items-returns-sequence-of-same-length () 422 | (let* ((animals (test-helper-animals)) 423 | (result (hierarchy-items animals))) 424 | (should (= (seq-length result) (hierarchy-length animals))))) 425 | 426 | (ert-deftest hierarchy-items-return-all-elements-of-hierarchy () 427 | (let* ((animals (test-helper-animals)) 428 | (result (hierarchy-items animals))) 429 | (should (equal (seq-sort #'string< result) '(animal bird cow dolphin dove pigeon))))) 430 | 431 | (ert-deftest hierarchy-labelfn-indent-no-indent-if-0 () 432 | (let* ((labelfn-base (lambda (_item _indent) (insert "foo"))) 433 | (labelfn (hierarchy-labelfn-indent labelfn-base))) 434 | (should (equal 435 | (with-temp-buffer 436 | (funcall labelfn "bar" 0) 437 | (buffer-substring (point-min) (point-max))) 438 | "foo")))) 439 | 440 | (ert-deftest hierarchy-labelfn-indent-three-times-if-3 () 441 | (let* ((labelfn-base (lambda (_item _indent) (insert "foo"))) 442 | (labelfn (hierarchy-labelfn-indent labelfn-base))) 443 | (should (equal 444 | (with-temp-buffer 445 | (funcall labelfn "bar" 3) 446 | (buffer-substring (point-min) (point-max))) 447 | " foo")))) 448 | 449 | (ert-deftest hierarchy-labelfn-indent-default-indent-string () 450 | (let* ((labelfn-base (lambda (_item _indent) (insert "foo"))) 451 | (labelfn (hierarchy-labelfn-indent labelfn-base))) 452 | (should (equal 453 | (with-temp-buffer 454 | (funcall labelfn "bar" 1) 455 | (buffer-substring (point-min) (point-max))) 456 | " foo")))) 457 | 458 | (ert-deftest hierarchy-labelfn-indent-custom-indent-string () 459 | (let* ((labelfn-base (lambda (_item _indent) (insert "foo"))) 460 | (labelfn (hierarchy-labelfn-indent labelfn-base "###")) 461 | (content (with-temp-buffer 462 | (funcall labelfn "bar" 1) 463 | (buffer-substring (point-min) (point-max))))) 464 | (should (equal content "###foo")))) 465 | 466 | (ert-deftest hierarchy-labelfn-button-propertize () 467 | (let* ((labelfn-base (lambda (_item _indent) (insert "foo"))) 468 | (actionfn #'identity) 469 | (labelfn (hierarchy-labelfn-button labelfn-base actionfn)) 470 | (properties (with-temp-buffer 471 | (funcall labelfn "bar" 1) 472 | (text-properties-at 1)))) 473 | (should (equal (car properties) 'action)))) 474 | 475 | (ert-deftest hierarchy-labelfn-button-execute-labelfn () 476 | (let* ((labelfn-base (lambda (_item _indent) (insert "foo"))) 477 | (actionfn #'identity) 478 | (labelfn (hierarchy-labelfn-button labelfn-base actionfn)) 479 | (content (with-temp-buffer 480 | (funcall labelfn "bar" 1) 481 | (buffer-substring-no-properties (point-min) (point-max))))) 482 | (should (equal content "foo")))) 483 | 484 | (ert-deftest hierarchy-labelfn-button-if-does-not-button-unless-condition () 485 | (let ((labelfn-base (lambda (_item _indent) (insert "foo"))) 486 | (spy-count 0) 487 | (condition (lambda (_item _indent) nil))) 488 | (cl-letf (((symbol-function 'hierarchy-labelfn-button) (lambda (_labelfn _actionfn) (lambda (_item _indent) (cl-incf spy-count))))) 489 | (funcall (hierarchy-labelfn-button-if labelfn-base condition #'identity) nil nil) 490 | (should (equal spy-count 0))))) 491 | 492 | (ert-deftest hierarchy-labelfn-button-if-does-button-when-condition () 493 | (let ((labelfn-base (lambda (_item _indent) (insert "foo"))) 494 | (spy-count 0) 495 | (condition (lambda (_item _indent) t))) 496 | (cl-letf (((symbol-function 'hierarchy-labelfn-button) (lambda (_labelfn _actionfn) (lambda (_item _indent) (cl-incf spy-count))))) 497 | (funcall (hierarchy-labelfn-button-if labelfn-base condition #'identity) nil nil) 498 | (should (equal spy-count 1))))) 499 | 500 | (ert-deftest hierarchy-labelfn-to-string () 501 | (let ((labelfn (lambda (item _indent) (insert item)))) 502 | (should (equal (hierarchy-labelfn-to-string labelfn "foo" 1) "foo")))) 503 | 504 | (ert-deftest hierarchy-print () 505 | (let* ((animals (test-helper-animals)) 506 | (result (with-temp-buffer 507 | (hierarchy-print animals) 508 | (buffer-substring-no-properties (point-min) (point-max))))) 509 | (should (equal result "animal\n bird\n dove\n pigeon\n cow\n dolphin\n")))) 510 | 511 | (ert-deftest hierarchy-to-string () 512 | (let* ((animals (test-helper-animals)) 513 | (result (hierarchy-to-string animals))) 514 | (should (equal result "animal\n bird\n dove\n pigeon\n cow\n dolphin\n")))) 515 | 516 | (ert-deftest hierarchy-tabulated-display () 517 | (let* ((animals (test-helper-animals)) 518 | (labelfn (lambda (item _indent) (insert (symbol-name item)))) 519 | (contents (with-temp-buffer 520 | (hierarchy-tabulated-display animals labelfn (current-buffer)) 521 | (buffer-substring-no-properties (point-min) (point-max))))) 522 | (should (equal contents "animal\nbird\ndove\npigeon\ncow\ndolphin\n")))) 523 | 524 | (ert-deftest hierarchy-sort-non-root-nodes () 525 | (let* ((animals (test-helper-animals))) 526 | (should (equal (hierarchy-roots animals) '(animal))) 527 | (should (equal (hierarchy-children animals 'animal) '(bird cow dolphin))) 528 | (should (equal (hierarchy-children animals 'bird) '(dove pigeon))))) 529 | 530 | (ert-deftest hierarchy-sort-roots () 531 | (let* ((organisms (hierarchy-new)) 532 | (parentfn (lambda (item) 533 | (cl-case item 534 | (oak 'plant) 535 | (bird 'animal))))) 536 | (hierarchy-add-tree organisms 'oak parentfn) 537 | (hierarchy-add-tree organisms 'bird parentfn) 538 | (hierarchy-sort organisms) 539 | (should (equal (hierarchy-roots organisms) '(animal plant))))) 540 | 541 | (provide 'hierarchy-test) 542 | ;;; hierarchy-test.el ends here 543 | -------------------------------------------------------------------------------- /test/test-helper.el: -------------------------------------------------------------------------------- 1 | ;;; test-helper.el --- Helper functions to test hierarchies -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2017 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 | ;; 23 | 24 | ;;; Code: 25 | 26 | (declare-function undercover "undercover") 27 | 28 | (when (require 'undercover nil t) 29 | (undercover "hierarchy.el")) 30 | 31 | (require 'hierarchy) 32 | 33 | (defun test-helper-animals () 34 | "Create a sorted animal hierarchy." 35 | (let ((parentfn (lambda (item) (cl-case item 36 | (dove 'bird) 37 | (pigeon 'bird) 38 | (bird 'animal) 39 | (dolphin 'animal) 40 | (cow 'animal)))) 41 | (hierarchy (hierarchy-new))) 42 | (hierarchy-add-tree hierarchy 'dove parentfn) 43 | (hierarchy-add-tree hierarchy 'pigeon parentfn) 44 | (hierarchy-add-tree hierarchy 'dolphin parentfn) 45 | (hierarchy-add-tree hierarchy 'cow parentfn) 46 | (hierarchy-sort hierarchy) 47 | hierarchy)) 48 | 49 | ;;; test-helper.el ends here 50 | --------------------------------------------------------------------------------