├── LICENSE ├── README.md └── c3-ts-mode.el /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # c3-ts-mode 2 | This tree-sitter powered Emacs 29+ major mode provides syntax highlighting, indentation, imenu and which-function support for C3. 3 | It's built against the tree-sitter grammar located at . 4 | 5 | > [!WARNING] 6 | > If you're updating, please do `M-x treesit-install-language-grammar RET c3 RET` to update the tree-sitter grammar too. 7 | 8 | ## Installing 9 | 10 | This mode requires Emacs 29 or greater for the built-in tree-sitter support. 11 | 12 | ### Install the tree-sitter grammar 13 | Add the source url to your `treesit-language-source-alist`. 14 | ```elisp 15 | (setq treesit-language-source-alist 16 | '((c3 "https://github.com/c3lang/tree-sitter-c3"))) 17 | ``` 18 | 19 | If you already have a `treesit-language-source-alist`, you can also append to it using: 20 | ```elisp 21 | (add-to-list 'treesit-language-source-alist 22 | '(c3 "https://github.com/c3lang/tree-sitter-c3")) 23 | ``` 24 | 25 | Next, run `M-x treesit-install-language-grammar RET c3 RET`. (This requires `cc` to be available on your system.) 26 | 27 | A `libtree-sitter-c3.so` should now be built and installed in your emacs directory. 28 | 29 | ### Install the mode 30 | 31 | Clone this repository and add: 32 | ```elisp 33 | (add-to-list 'load-path "path/to/c3-ts-mode") 34 | (require 'c3-ts-mode) 35 | ``` 36 | 37 | ## Configuration 38 | 39 | Set the indent offset using the `c3-ts-mode-indent-offset` variable: 40 | ```elisp 41 | (setq c3-ts-mode-indent-offset 2) 42 | ``` 43 | 44 | To enable all highlighting features, you might want to set `treesit-font-lock-level` to 4 (the default is 3): 45 | ```elisp 46 | (setq treesit-font-lock-level 4) 47 | ``` 48 | 49 | The default face for module paths is `font-lock-constant-face`. Override it by setting `c3-ts-mode-module-path-face`. The face name must be prefixed with `@`: 50 | ```elisp 51 | (setq c3-ts-mode-module-path-face '@font-lock-some-face-here) 52 | ``` 53 | 54 | The default face for assignments (see [Notes](#notes)) is `font-lock-variable-name-face`. Override it by setting `c3-ts-mode-assignment-face`. The face name must be prefixed with `@`: 55 | ```elisp 56 | (setq c3-ts-mode-assignment-face '@font-lock-some-face-here) 57 | ``` 58 | 59 | Further options: 60 | ```elisp 61 | ;; Disable highlighting of variables 62 | (setq c3-ts-mode-highlight-variable nil) 63 | ;; Disable highlighting of members 64 | (setq c3-ts-mode-highlight-property nil) 65 | ;; Disable highlighting of punctuation 66 | (setq c3-ts-mode-highlight-punctuation nil) 67 | ;; Disable highlighting of assignments 68 | (setq c3-ts-mode-highlight-assignment nil) 69 | ``` 70 | 71 | ## Adding custom highlighting patterns 72 | 73 | Here is an example how to override highlighting of the "assert" keyword and argument names: 74 | ```elisp 75 | (defun add-custom-c3-ts-rules () 76 | (add-to-list 'treesit-font-lock-settings 77 | (car (treesit-font-lock-rules 78 | :language 'c3 79 | ;; Choose a feature name here (see docs for 'treesit-font-lock-rules') 80 | :feature 'custom 81 | ;; Use 't' to override the face, 'append'/'prepend' to append/prepend to existing ones 82 | :override t 83 | ;; This will highlight the "assert" keyword and argument names with custom faces 84 | ;; See "37.5 Pattern Matching Tree-sitter Nodes" in the Emacs manual 85 | '((assert_stmt "assert" @assert-face) 86 | (call_arg_list (call_arg name: (_) @named-arg-face))) 87 | )) t) 88 | 89 | ;; Add feature 'custom' to feature level 4 90 | (push 'custom (nth 3 treesit-font-lock-feature-list))) 91 | 92 | (add-hook 'c3-ts-mode-hook #'add-custom-c3-ts-rules) 93 | ``` 94 | 95 | ## Notes 96 | - A special feature is that assignments (and updates via `++`/`--`) are highlighted accurately. 97 | - If a variable or field is assigned, the variable name is highlighted. 98 | - If a pointer dereference is assigned, the asterisk is highlighted. 99 | - If an array element is assigned, the subscript brackets are highlighted. 100 | - You can configure this feature using `c3-ts-mode-highlight-assignment` and `c3-ts-mode-assignment-face`. 101 | - If punctuation is enabled (`treesit-font-lock-level` is `4` and `c3-ts-mode-highlight-punctuation` is `t`), make sure both `font-lock-punctuation-face` and `font-lock-brackets-face` is defined in your theme. 102 | - Indentation is tricky and has a bunch of edge cases - please submit an issue if you find a case where it doesn't work as expected. 103 | -------------------------------------------------------------------------------- /c3-ts-mode.el: -------------------------------------------------------------------------------- 1 | ;;; c3-ts-mode.el --- Major mode for C3 using tree-sitter -*- lexical-binding: t -*- 2 | 3 | ;; Author: Christian Buttner 4 | ;; URL: https://github.com/c3lang/c3-ts-mode 5 | ;; Keywords: c3 languages tree-sitter 6 | ;; Version: 0.9.0 7 | ;; Package-Requires : ((emacs "29.1")) 8 | 9 | ;;; License: 10 | 11 | ;; This program is free software; you can redistribute it and/or 12 | ;; modify it under the terms of the GNU General Public License as 13 | ;; published by the Free Software Foundation; either version 3, or 14 | ;; (at your option) any later version. 15 | ;; 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 19 | ;; General Public License for more details. 20 | ;; 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program; if not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; This tree-sitter powered Emacs 29+ major mode provides syntax highlighting, indentation, imenu and which-function support for C3. 27 | ;; It's built against the tree-sitter grammar located at . 28 | 29 | ;;; Code: 30 | 31 | (require 'treesit) 32 | (require 'c-ts-common) 33 | (require 'compile) 34 | 35 | (eval-when-compile (require 'rx)) 36 | 37 | (declare-function treesit-node-child-by-field-name "treesit.c") 38 | (declare-function treesit-node-type "treesit.c") 39 | (declare-function treesit-node-text "treesit.c") 40 | (declare-function treesit-parser-create "treesit.c") 41 | 42 | (defgroup c3-ts nil 43 | "Major mode for editing C3 files." 44 | :prefix "c3-ts-" 45 | :group 'languages) 46 | 47 | (defcustom c3-ts-mode-indent-offset 2 48 | "Number of spaces for each indentation step in `c3-ts-mode'." 49 | :version "29.1" 50 | :type 'integer 51 | :safe 'integerp 52 | :group 'c3-ts) 53 | 54 | (defcustom c3-ts-mode-highlight-variable 't 55 | "Enable highlighting of variables in `c3-ts-mode'." 56 | :version "29.1" 57 | :type 'boolean 58 | :safe 'booleanp 59 | :group 'c3-ts) 60 | 61 | (defcustom c3-ts-mode-highlight-property 't 62 | "Enable highlighting of members in `c3-ts-mode'." 63 | :version "29.1" 64 | :type 'boolean 65 | :safe 'booleanp 66 | :group 'c3-ts) 67 | 68 | (defcustom c3-ts-mode-highlight-assignment 't 69 | "Enable highlighting of assignments in `c3-ts-mode'." 70 | :version "29.1" 71 | :type 'boolean 72 | :safe 'booleanp 73 | :group 'c3-ts) 74 | 75 | (defcustom c3-ts-mode-highlight-punctuation 't 76 | "Enable highlighting of punctuation in `c3-ts-mode'." 77 | :version "29.1" 78 | :type 'boolean 79 | :safe 'booleanp 80 | :group 'c3-ts) 81 | 82 | (defcustom c3-ts-mode-module-path-face '@font-lock-constant-face 83 | "The face to use for highlighting module paths in `c3-ts-mode'." 84 | :version "29.1" 85 | :type 'symbol 86 | :group 'c3-ts) 87 | 88 | (defcustom c3-ts-mode-assignment-face '@font-lock-variable-name-face 89 | "The face to use for highlighting assignments in `c3-ts-mode'." 90 | :version "29.1" 91 | :type 'symbol 92 | :group 'c3-ts) 93 | 94 | (defcustom c3-ts-mode-hook nil 95 | "Hook run after entering `c3-ts-mode'." 96 | :version "29.1" 97 | :type 'hook 98 | :group 'c3-ts) 99 | 100 | (defvar c3-ts-mode--syntax-table 101 | (let ((table (make-syntax-table))) 102 | ;; Adapted from c-ts-mode.el 103 | (modify-syntax-entry ?_ "_" table) 104 | (modify-syntax-entry ?\\ "\\" table) 105 | (modify-syntax-entry ?+ "." table) 106 | (modify-syntax-entry ?- "." table) 107 | (modify-syntax-entry ?= "." table) 108 | (modify-syntax-entry ?% "." table) 109 | (modify-syntax-entry ?< ". 1" table) ; C3: the first character of a comment-start sequence 110 | (modify-syntax-entry ?> ". 4" table) ; C3: the second character of a comment-end sequence 111 | (modify-syntax-entry ?& "." table) 112 | (modify-syntax-entry ?| "." table) 113 | (modify-syntax-entry ?\' "\"" table) 114 | (modify-syntax-entry ?` "\"" table) 115 | (modify-syntax-entry ?\240 "." table) 116 | (modify-syntax-entry ?/ ". 124b" table) 117 | (modify-syntax-entry ?* ". 23" table) 118 | (modify-syntax-entry ?\n "> b" table) 119 | (modify-syntax-entry ?\^m "> b" table) 120 | table) 121 | "Syntax table for `c3-ts-mode'.") 122 | 123 | (defvar c3-ts-mode--keywords 124 | ;; From "c3c --list-keywords", without base types 125 | '("alias" 126 | "assert" 127 | "asm" 128 | "attrdef" 129 | "bitstruct" 130 | "break" 131 | "case" 132 | "catch" 133 | "const" 134 | "continue" 135 | "default" 136 | "defer" 137 | "do" 138 | "else" 139 | "enum" 140 | "extern" 141 | ;; "false" ;; NOTE Treated as constant 142 | "faultdef" 143 | "for" 144 | "foreach" 145 | "foreach_r" 146 | "fn" 147 | "tlocal" 148 | "if" 149 | "inline" 150 | "import" 151 | "macro" 152 | "module" 153 | "nextcase" 154 | ;; "null" ;; NOTE Treated as constant 155 | "interface" 156 | "return" 157 | "static" 158 | "struct" 159 | "switch" 160 | ;; "true" ;; NOTE Treated as constant 161 | "try" 162 | "typedef" 163 | "union" 164 | "var" 165 | "while" 166 | 167 | "$alignof" 168 | "$assert" 169 | "$assignable" 170 | "$case" 171 | "$default" 172 | "$defined" 173 | "$echo" 174 | "$else" 175 | "$embed" 176 | "$endfor" 177 | "$endforeach" 178 | "$endif" 179 | "$endswitch" 180 | "$eval" 181 | "$evaltype" 182 | "$error" 183 | "$exec" 184 | "$extnameof" 185 | "$feature" 186 | "$for" 187 | "$foreach" 188 | "$if" 189 | "$include" 190 | "$is_const" 191 | "$nameof" 192 | "$offsetof" 193 | "$qnameof" 194 | "$sizeof" 195 | "$stringify" 196 | "$switch" 197 | "$typefrom" 198 | "$typeof" 199 | "$vacount" 200 | "$vatype" 201 | "$vaconst" 202 | "$vaarg" 203 | "$vaexpr" 204 | "$vasplat")) 205 | 206 | (defvar c3-ts-mode--type-properties 207 | ;; From "c3c --list-type-properties" 208 | '("alignof" 209 | "associated" 210 | "elements" 211 | "extnameof" 212 | "from_ordinal" 213 | "get" 214 | "inf" 215 | "is_eq" 216 | "is_ordered" 217 | "is_substruct" 218 | "len" 219 | "lookup" 220 | "lookup_field" 221 | "max" 222 | "membersof" 223 | "methodsof" 224 | "min" 225 | "nan" 226 | "inner" 227 | "kindof" 228 | "names" 229 | "nameof" 230 | "params" 231 | "paramsof" 232 | "parentof" 233 | "qnameof" 234 | "returns" 235 | "sizeof" 236 | "tagof" 237 | "has_tagof" 238 | "values" 239 | ;; Separate token in c3c 240 | "typeid")) 241 | 242 | 243 | (defvar c3-ts-mode--operators 244 | ;; From "c3c --list-operators" 245 | '("&" 246 | "!" 247 | "~" 248 | "|" 249 | "^" 250 | ":" 251 | ;; "," 252 | ;; ";" 253 | "=" 254 | ">" 255 | "/" 256 | "." 257 | ;; "#" 258 | "<" 259 | ;; "{" 260 | ;; "[" 261 | ;; "(" 262 | "-" 263 | "%" 264 | "+" 265 | "?" 266 | ;; "}" 267 | ;; "]" 268 | ;; ")" 269 | "*" 270 | ;; "_" 271 | "&&" 272 | ;; "->" 273 | "!!" 274 | "&=" 275 | "|=" 276 | "^=" 277 | "/=" 278 | ".." 279 | "?:" 280 | "==" 281 | ">=" 282 | "=>" 283 | "<=" 284 | ;; "[<" 285 | "-=" 286 | "--" 287 | "%=" 288 | "*=" 289 | "!=" 290 | "||" 291 | "+=" 292 | "++" 293 | ;; ">]" 294 | "??" 295 | ;; "::" 296 | "<<" 297 | ">>" 298 | "..." 299 | "<<=" 300 | ">>=")) 301 | 302 | (defvar c3-ts-mode--feature-list 303 | `((comment definition) 304 | (keyword string type) 305 | ;; TODO Not clear if assignment should go in level 4 or not (3 is the default level). 306 | ,(append 307 | '(builtin attribute escape-sequence literal constant assembly module function doc-comment) 308 | (when c3-ts-mode-highlight-assignment '(assignment))) 309 | ,(append 310 | '(type-property operator bracket) 311 | (when c3-ts-mode-highlight-punctuation '(punctuation)) 312 | (when c3-ts-mode-highlight-variable '(variable)) 313 | (when c3-ts-mode-highlight-property '(property))) 314 | ;; (error) ;; Disabled by default 315 | ) 316 | "`treesit-font-lock-feature-list' for `c3-ts-mode'.") 317 | 318 | (defvar c3-ts-mode--font-lock-settings 319 | ;; NOTE Earlier rules have precedence over later rules 320 | (treesit-font-lock-rules 321 | :language 'c3 322 | :feature 'comment 323 | '((line_comment) @font-lock-comment-face 324 | (block_comment) @font-lock-comment-face 325 | (doc_comment) @font-lock-doc-face) 326 | 327 | :language 'c3 328 | :feature 'doc-comment 329 | :override 'append 330 | `((doc_comment_contract name: (at_ident) @bold 331 | (:match ,(rx 332 | bos 333 | "@" 334 | (or 335 | "param" 336 | "return" 337 | "deprecated" 338 | "require" 339 | "ensure" 340 | "pure") 341 | eos) @bold))) 342 | 343 | :language 'c3 344 | :feature 'literal 345 | '((integer_literal) @font-lock-number-face 346 | (real_literal) @font-lock-number-face 347 | (char_literal) @font-lock-constant-face 348 | (bytes_literal) @font-lock-constant-face) 349 | 350 | :language 'c3 351 | :feature 'string 352 | '((string_literal) @font-lock-string-face 353 | (raw_string_literal) @font-lock-string-face) 354 | 355 | :language 'c3 356 | :feature 'escape-sequence 357 | :override t 358 | '((escape_sequence) @font-lock-escape-face) 359 | 360 | :language 'c3 361 | :feature 'keyword 362 | `([,@c3-ts-mode--keywords] @font-lock-keyword-face) 363 | 364 | :language 'c3 365 | :feature 'builtin 366 | '([(builtin) (builtin_const)] @font-lock-builtin-face) 367 | 368 | :language 'c3 369 | :feature 'type-property 370 | `((type_access_expr (access_ident (ident) @font-lock-constant-face (:match ,(rx-to-string `(: bos (or ,@c3-ts-mode--type-properties) eos)) @font-lock-constant-face)))) 371 | 372 | :language 'c3 373 | :feature 'constant 374 | '((const_ident) @font-lock-constant-face 375 | ["true" "false" "null"] @font-lock-constant-face) 376 | 377 | :language 'c3 378 | :feature 'assembly 379 | '((asm_instr [(ident) "int"] @font-lock-function-call-face) 380 | (asm_expr [(ct_ident) (ct_const_ident)] @font-lock-variable-use-face)) 381 | 382 | :language 'c3 383 | :feature 'module 384 | `((module_resolution (ident) ,c3-ts-mode-module-path-face) 385 | (module_declaration (path_ident (ident) ,c3-ts-mode-module-path-face)) 386 | (import_declaration (path_ident (ident) ,c3-ts-mode-module-path-face))) 387 | 388 | :language 'c3 389 | :feature 'attribute 390 | '((attribute name: (at_ident) @font-lock-builtin-face) 391 | (at_type_ident) @font-lock-builtin-face 392 | (call_inline_attributes (at_ident) @font-lock-builtin-face)) 393 | 394 | :language 'c3 395 | :feature 'type 396 | '((type_ident) @font-lock-type-face 397 | (ct_type_ident) @font-lock-type-face 398 | (base_type_name) @font-lock-type-face 399 | 400 | ;; TODO Probably don't want these 401 | ;; (type_suffix ["[" "[<" ">]" "]"] @font-lock-type-face) 402 | ;; (type "!" @font-lock-type-face :anchor) 403 | ) 404 | 405 | :language 'c3 406 | :feature 'definition 407 | '((func_header name: (_) @font-lock-function-name-face) 408 | (macro_header name: (_) @font-lock-function-name-face)) 409 | 410 | :language 'c3 411 | :feature 'function 412 | '((call_expr function: (ident_expr [(ident) (at_ident)] @font-lock-function-call-face)) 413 | (call_expr function: (trailing_generic_expr argument: (ident_expr [(ident) (at_ident)] @font-lock-function-call-face))) 414 | ;; Method call 415 | (call_expr function: (field_expr field: (access_ident [(ident) (at_ident)] @font-lock-function-call-face))) ; NOTE Ambiguous, could be calling a method or function pointer 416 | ;; Method on type 417 | (call_expr function: (type_access_expr field: (access_ident [(ident) (at_ident)] @font-lock-function-call-face)))) 418 | 419 | :language 'c3 420 | :feature 'assignment 421 | `((assignment_expr left: (ident_expr (ident) ,c3-ts-mode-assignment-face)) 422 | (assignment_expr left: (field_expr field: (_) ,c3-ts-mode-assignment-face)) 423 | (assignment_expr left: (unary_expr operator: "*" ,c3-ts-mode-assignment-face)) 424 | (assignment_expr left: (subscript_expr ["[" "]"] ,c3-ts-mode-assignment-face)) 425 | 426 | (update_expr argument: (ident_expr (ident) ,c3-ts-mode-assignment-face)) 427 | (update_expr argument: (field_expr field: (_) ,c3-ts-mode-assignment-face)) 428 | (update_expr argument: (unary_expr operator: "*" ,c3-ts-mode-assignment-face)) 429 | (update_expr argument: (subscript_expr ["[" "]"] ,c3-ts-mode-assignment-face)) 430 | 431 | (unary_expr operator: ["--" "++"] argument: (ident_expr (ident) ,c3-ts-mode-assignment-face)) 432 | (unary_expr operator: ["--" "++"] argument: (field_expr field: (access_ident (ident)) ,c3-ts-mode-assignment-face)) 433 | (unary_expr operator: ["--" "++"] argument: (subscript_expr ["[" "]"] ,c3-ts-mode-assignment-face))) 434 | 435 | :language 'c3 436 | :feature 'operator 437 | `(([,@c3-ts-mode--operators]) @font-lock-operator-face) 438 | 439 | :language 'c3 440 | :feature 'property 441 | '(;; Member 442 | (field_expr field: (access_ident (ident) @font-lock-property-use-face)) 443 | (struct_member_declaration (ident) @font-lock-property-name-face) 444 | (struct_member_declaration (identifier_list (ident) @font-lock-property-name-face)) 445 | (bitstruct_member_declaration (ident) @font-lock-property-name-face) 446 | (initializer_list (initializer_element (param_path (param_path_element (access_ident (ident) @font-lock-property-name-face)))))) 447 | 448 | :language 'c3 449 | :feature 'variable 450 | '([(ident) (ct_ident)] @font-lock-variable-use-face 451 | ;; Parameter 452 | (param name: (_) @font-lock-variable-name-face) 453 | (trailing_block_param (at_ident) @font-lock-variable-name-face) 454 | (call_arg_list (call_arg name: (_) @font-lock-variable-name-face)) 455 | (enum_param (ident) @font-lock-variable-name-face) 456 | ;; Declaration 457 | (declaration (identifier_list [(ident) (ct_ident)] @font-lock-variable-name-face)) 458 | (declaration name: [(ident) (ct_ident)] @font-lock-variable-name-face) 459 | (var_declaration name: [(ident) (ct_ident)] @font-lock-variable-name-face) 460 | (try_unwrap (ident) @font-lock-variable-name-face) 461 | (catch_unwrap (ident) @font-lock-variable-name-face)) 462 | 463 | :language 'c3 464 | :feature 'bracket 465 | '((["(" ")" "[" "]" "{" "}" "[<" ">]"]) @font-lock-bracket-face) 466 | 467 | :language 'c3 468 | :feature 'punctuation 469 | '(([";" "," "::"]) @font-lock-punctuation-face) 470 | 471 | :language 'c3 472 | :feature 'error 473 | :override t 474 | '((ERROR) @font-lock-warning-face)) 475 | "Tree-sitter font-lock settings for `c3-ts-mode'.") 476 | 477 | (defvar c3-ts-mode--simple-indent-rules 478 | `((c3 479 | ((parent-is "source_file") column-0 0) 480 | 481 | ((node-is "else") parent-bol 0) ;; Also matches $else 482 | ((node-is "^\\(case\\|ct_case\\|default\\|ct_default\\)_stmt$") parent-bol c3-ts-mode-indent-offset) 483 | ((node-is "ct_stmt_body") parent-bol c3-ts-mode-indent-offset) 484 | ((parent-is "ct_stmt_body") standalone-parent 0) 485 | ((node-is "$endif") parent-bol 0) 486 | ((node-is "$endfor") parent-bol 0) 487 | ((node-is "$endswitch") parent-bol 0) 488 | 489 | ((and (parent-is "block_comment_text") c-ts-common-looking-at-star) 490 | c-ts-common-comment-start-after-first-star -1) 491 | 492 | ;; NOTE This only indents the first line of a doc comment text. This way we preserve identation on subsequent lines, such as list item indentation. TODO Indent to a minimum of 1? Can still ruin formatting 493 | ((node-is "doc_comment_text") parent-bol 1) 494 | ((node-is "doc_comment_contract") parent-bol 1) 495 | ((node-is "*>") parent-bol 0) 496 | 497 | ((node-is "}") standalone-parent 0) 498 | ((node-is ")") standalone-parent 0) 499 | 500 | ((match "while" "do_stmt" nil nil nil) standalone-parent 0) 501 | ((match "compound_stmt" "else_part" nil nil nil) standalone-parent 0) 502 | 503 | ;; Attributes 504 | ((node-is "attributes") standalone-parent c3-ts-mode-indent-offset) 505 | ((parent-is "attributes") parent 0) ;; Align attributes on same column 506 | 507 | ;; Body/block children 508 | ((parent-is "enum_body") standalone-parent c3-ts-mode-indent-offset) 509 | ((parent-is "struct_body") standalone-parent c3-ts-mode-indent-offset) 510 | ((parent-is "bitstruct_body") standalone-parent c3-ts-mode-indent-offset) 511 | ((parent-is "interface_body") standalone-parent c3-ts-mode-indent-offset) 512 | ((parent-is "macro_func_body") standalone-parent c3-ts-mode-indent-offset) 513 | ((parent-is "implies_body") standalone-parent c3-ts-mode-indent-offset) 514 | 515 | ((parent-is "compound_stmt") standalone-parent c3-ts-mode-indent-offset) 516 | ((parent-is "initializer_list") standalone-parent c3-ts-mode-indent-offset) 517 | ((parent-is "case_stmt") standalone-parent c3-ts-mode-indent-offset) 518 | ((parent-is "default_stmt") standalone-parent c3-ts-mode-indent-offset) 519 | 520 | ;; if/switch/for/while/defer with block 521 | ((match "compound_stmt" "\\(if\\|switch\\|for\\|foreach\\|while\\|do\\|defer\\)_stmt" nil nil nil) standalone-parent 0) 522 | 523 | ;; for/while/defer without block 524 | ((parent-is "\\(for\\|foreach\\|while\\|defer\\)_stmt") standalone-parent c3-ts-mode-indent-offset) 525 | 526 | ;; Body not handled so far 527 | ((field-is "body") standalone-parent 0) 528 | ((field-is "lambda_body") standalone-parent 0) 529 | 530 | ;; Trailing macro block 531 | ((match "compound_stmt" nil "trailing" nil nil) parent 0) 532 | 533 | ((match nil "field_expr" "field" nil nil) parent-bol c3-ts-mode-indent-offset) 534 | ((n-p-gp "." "field_expr" nil) parent-bol c3-ts-mode-indent-offset) ;; Field access beginning with "." 535 | ((match nil "type_access_expr" "field" nil nil) parent-bol c3-ts-mode-indent-offset) 536 | ((match nil "assignment_expr" "right" nil nil) parent-bol c3-ts-mode-indent-offset) 537 | ((match nil "const_declaration" "right" nil nil) parent-bol c3-ts-mode-indent-offset) 538 | ((match nil "declaration" "right" nil nil) parent-bol c3-ts-mode-indent-offset) 539 | 540 | ;; Multi line declarations 541 | ((parent-is "identifier_list") parent 0) 542 | ((parent-is "^for_cond") parent 1) 543 | ((parent-is "^foreach_cond") parent 1) 544 | ((parent-is "ct_for_cond") parent 0) 545 | ((parent-is "ct_foreach_cond") parent 0) 546 | ((parent-is "paren_cond") parent 1) 547 | ((parent-is "catch_unwrap_list") parent 0) 548 | ((parent-is "comma_decl_or_expr") parent 0) 549 | 550 | ;; First parameter/argument 551 | ((match "^\\(call_\\|attribute_\\)?arg\\|param\\|enum_param_declaration\\|trailing_block_param$" nil nil 1 1) parent-bol c3-ts-mode-indent-offset) 552 | ;; Subsequent params/arguments 553 | ((match "^\\(call_\\|attribute_\\)?arg\\|param\\|enum_param_declaration\\|trailing_block_param$" nil nil 2 nil) (nth-sibling 1) 0) 554 | 555 | ;; String/bytes literals 556 | ((node-is "raw_string_literal") no-indent) 557 | ((match "string_literal" "string_expr" nil 0 0) parent 0) 558 | ((match "string_literal" "string_expr" nil 1 nil) (nth-sibling 0) 0) 559 | ((match "bytes_literal" "bytes_expr" nil 0 0) parent 0) 560 | ((match "bytes_literal" "bytes_expr" nil 1 nil) (nth-sibling 0) 0) 561 | 562 | ((parent-is "paren") parent 1) 563 | ((parent-is "binary") parent 0) 564 | ((parent-is "range") parent 0) 565 | ((parent-is "elvis_orelse") parent 0) 566 | ((parent-is "ternary") parent c3-ts-mode-indent-offset) 567 | ((parent-is "subscript") parent c3-ts-mode-indent-offset) 568 | ((parent-is "update") parent c3-ts-mode-indent-offset) 569 | ((parent-is "call") parent c3-ts-mode-indent-offset) 570 | ((parent-is "cast") parent c3-ts-mode-indent-offset) 571 | 572 | ((parent-is "func_declaration") standalone-parent 0) 573 | ((parent-is "func_header") standalone-parent 0) 574 | ((parent-is "macro_declaration") standalone-parent 0) 575 | ((parent-is "macro_header") standalone-parent 0) 576 | 577 | ((node-is "initializer_list") parent 0) 578 | 579 | ;; ((parent-is "ERROR") no-indent 0) 580 | ))) 581 | 582 | (defun c3-ts-mode--defun-name (node) 583 | "Return the name of the defun NODE." 584 | (let () 585 | (treesit-node-text 586 | (treesit-node-child-by-field-name 587 | (pcase (treesit-node-type node) 588 | ("func_definition" (treesit-node-child node 1)) 589 | ("macro_declaration" (treesit-node-child node 1)) 590 | (_ node)) 591 | "name") 592 | t))) 593 | 594 | 595 | ;;;###autoload 596 | (define-derived-mode c3-ts-mode prog-mode "C3" 597 | "Major mode for editing C3 files, powered by tree-sitter." 598 | :group 'c3-ts 599 | :syntax-table c3-ts-mode--syntax-table 600 | 601 | ;; Comment 602 | (c-ts-common-comment-setup) 603 | 604 | ;; Electric 605 | (setq-local electric-indent-chars 606 | (append "{}():;," electric-indent-chars)) 607 | 608 | (when (treesit-ready-p 'c3) 609 | (treesit-parser-create 'c3) 610 | 611 | ;; Font-lock 612 | (setq-local treesit-font-lock-settings c3-ts-mode--font-lock-settings) 613 | (setq-local treesit-font-lock-feature-list c3-ts-mode--feature-list) 614 | 615 | ;; Indent 616 | (setq-local treesit-simple-indent-rules c3-ts-mode--simple-indent-rules) 617 | 618 | ;; Navigation 619 | (setq-local treesit-defun-name-function #'c3-ts-mode--defun-name) 620 | (setq-local treesit-defun-type-regexp 621 | (rx bos 622 | (or "struct_declaration" 623 | "bitstruct_declaration" 624 | "enum_declaration" 625 | "interface_declaration" 626 | "func_definition" 627 | "macro_declaration" 628 | "const_declaration" 629 | "alias_declaration" 630 | "typedef_declaration" 631 | "faultdef_declaration" 632 | "attrdef_declaration") 633 | eos)) 634 | 635 | ;; Imenu 636 | (setq-local treesit-simple-imenu-settings 637 | `(("Struct" "\\`struct_declaration\\'" nil nil) 638 | ("Bitstruct" "\\`bitstruct_declaration\\'" nil nil) 639 | ("Enum" "\\`enum_declaration\\'" nil nil) 640 | ("Interface" "\\`interface_declaration\\'" nil nil) 641 | ("Function" "\\`func_definition\\'" nil nil) 642 | ("Macro" "\\`macro_declaration\\'" nil nil) 643 | ("Const" "\\`const_declaration\\'" nil nil) 644 | ("Alias" "\\`alias_declaration\\'" nil nil) 645 | ("Type" "\\`typedef_declaration\\'" nil nil) 646 | ("Fault" "\\`faultdef_declaration\\'" nil nil) 647 | ("Attribute" "\\`attrdef_declaration\\'" nil nil))) 648 | 649 | ;; Which-function 650 | (setq-local which-func-functions (treesit-defun-at-point)) 651 | 652 | (treesit-major-mode-setup))) 653 | 654 | (when (treesit-ready-p 'c3) 655 | (add-to-list 'auto-mode-alist '("\\.c3\\'" . c3-ts-mode)) 656 | (add-to-list 'auto-mode-alist '("\\.c3i\\'" . c3-ts-mode)) 657 | (add-to-list 'auto-mode-alist '("\\.c3t\\'" . c3-ts-mode))) 658 | 659 | (eval-after-load 'compile 660 | (lambda() 661 | (add-to-list 'compilation-error-regexp-alist-alist 662 | '(c3 663 | "^(\\([^:]*\\):\\([0-9]+\\):\\([0-9]+\\)) \\(Warning\\)?.*$" 664 | 1 2 3 (4))) 665 | (add-to-list 'compilation-error-regexp-alist 'c3))) 666 | 667 | (provide 'c3-ts-mode) 668 | 669 | 670 | ;;; c3-ts-mode.el ends here 671 | --------------------------------------------------------------------------------