├── .gitignore ├── LICENSE ├── README.org ├── ob-scad.el └── scad-mode.el /.gitignore: -------------------------------------------------------------------------------- 1 | *-autoloads.el 2 | *-pkg.el 3 | *.elc 4 | *.info 5 | *.texi 6 | *~ 7 | \#*\# 8 | /README-elpa 9 | -------------------------------------------------------------------------------- /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.org: -------------------------------------------------------------------------------- 1 | #+title: scad-mode - Emacs mode to edit OpenSCAD files 2 | #+language: en 3 | #+export_file_name: scad-mode.texi 4 | #+texinfo_dir_category: Emacs misc features 5 | #+texinfo_dir_title: Scad-Mode: (scad-mode). 6 | #+texinfo_dir_desc: Edit OpenSCAD files 7 | 8 | #+html: GNU Emacs 9 | #+html: NonGNU ELPA 10 | #+html: NonGNU-devel ELPA 11 | #+html: MELPA 12 | #+html: MELPA Stable 13 | 14 | * Features 15 | 16 | - Syntax highlighting 17 | - Basic completion function (press =M-TAB=) 18 | - Preview rendered model in separate window (press =C-c C-c=) 19 | - Open buffer in OpenSCAD (press =C-c C-o=) 20 | - Export buffer with OpenSCAD (press =C-c C-e=) 21 | - Flymake support (enable =flymake-mode= in =scad-mode= buffers) 22 | - Org Babel support (=scad= source blocks) 23 | 24 | * Org Babel support 25 | 26 | #+begin_src scad :file example.png :colorscheme Tomorrow :size 200,200 27 | for (y=[0:2:20]) { 28 | translate([0,0,y+1]) 29 | cube([30-2*y,30-2*y,2], true); 30 | } 31 | #+end_src 32 | 33 | * Installation 34 | 35 | Install via =M-x package-install RET scad-mode RET= from NonGNU ELPA or MELPA. 36 | After the installation =*.scad= files will be opened with =scad-mode=. 37 | 38 | * Related packages 39 | 40 | - [[https://github.com/lenbok/scad-dbus][scad-dbus]]: Interact with a running OpenSCAD instance from Emacs via DBUS 41 | - =lsp-mode=, =eglot= or =lsp-bridge=: The =openscad-lsp= server can be used with =scad-mode= 42 | -------------------------------------------------------------------------------- /ob-scad.el: -------------------------------------------------------------------------------- 1 | ;;; ob-scad.el --- Babel Functions for OpenSCAD -*- lexical-binding: t -*- 2 | 3 | ;; This file is not part of GNU Emacs. 4 | 5 | ;; This program is free software: you can redistribute it and/or modify 6 | ;; it under the terms of the GNU General Public License as published by 7 | ;; the Free Software Foundation, either version 3 of the License, or 8 | ;; (at your option) any later version. 9 | 10 | ;; This program is distributed in the hope that it will be useful, 11 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | ;; GNU General Public License for more details. 14 | 15 | ;; You should have received a copy of the GNU General Public License 16 | ;; along with this program. If not, see . 17 | 18 | ;;; Commentary: 19 | 20 | ;; Org Babel support for OpenSCAD 21 | 22 | ;;; Code: 23 | 24 | (require 'ob) 25 | 26 | (defvar scad-command) 27 | (declare-function scad--preview-colorscheme "ext:scad-mode") 28 | (defvar scad-preview-projection) 29 | (defvar scad-preview-view) 30 | 31 | (defvar org-babel-default-header-args:scad 32 | '((:results . "file") 33 | (:exports . "results")) 34 | "Default arguments for evaluating a scad source block.") 35 | 36 | (defvar org-babel-header-args:scad 37 | '((colorscheme . :any) 38 | (size . :any) 39 | (projection . :any) 40 | (camera . :any) 41 | (view . :any)) 42 | "Scad specific header args.") 43 | 44 | (defun org-babel-execute:scad (body params) 45 | "Evaluate BODY with `scad-command' given PARAMS." 46 | (require 'scad-mode) 47 | (let* ((outfile (or (alist-get :file params) 48 | (error "Scad code block requires :file header argument"))) 49 | (infile (org-babel-temp-file "scad-"))) 50 | (with-temp-file infile (insert body)) 51 | (apply #'call-process scad-command nil 0 nil 52 | (delq nil 53 | (list "-o" outfile 54 | "--preview" 55 | "--viewall" 56 | (format "--projection=%s" 57 | (alist-get :projection params scad-preview-projection)) 58 | (format "--colorscheme=%s" 59 | (alist-get :colorscheme params (scad--preview-colorscheme))) 60 | (format "--view=%s" (or (alist-get :view params) 61 | (mapconcat #'identity scad-preview-view ","))) 62 | (when-let (camera (alist-get :camera params)) 63 | (format "--camera=%s" camera)) 64 | (when-let (size (alist-get :size params)) 65 | (format "--imgsize=%s" size)) 66 | infile))) 67 | nil)) 68 | 69 | (provide 'ob-scad) 70 | ;;; ob-scad.el ends here 71 | -------------------------------------------------------------------------------- /scad-mode.el: -------------------------------------------------------------------------------- 1 | ;;; scad-mode.el --- A major mode for editing OpenSCAD code -*- lexical-binding: t -*- 2 | 3 | ;; Author: Len Trigg, Łukasz Stelmach, zk_phi, Daniel Mendler 4 | ;; Maintainer: Len Trigg , Daniel Mendler 5 | ;; Created: 2010 6 | ;; Keywords: languages 7 | ;; URL: https://github.com/openscad/emacs-scad-mode 8 | ;; Package-Requires: ((emacs "28.1") (compat "30")) 9 | ;; Version: 96.0 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;; This program is free software: you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | ;;; Commentary: 27 | ;; 28 | ;; This is a major-mode to implement the SCAD constructs and 29 | ;; font-locking for OpenSCAD. Install the package from NonGNU ELPA or 30 | ;; MELPA: 31 | ;; 32 | ;; M-x install-package RET scad-mode RET 33 | 34 | ;;; Code: 35 | 36 | (require 'compat) 37 | (require 'cc-mode) 38 | (eval-when-compile 39 | (require 'cc-langs) 40 | (require 'cc-fonts) 41 | (require 'cl-lib)) 42 | 43 | (defgroup scad nil 44 | "A major mode for editing OpenSCAD code." 45 | :link '(url-link :tag "Website" "https://github.com/openscad/emacs-scad-mode") 46 | :link '(emacs-library-link :tag "Library Source" "scad-mode.el") 47 | :group 'languages 48 | :prefix "scad-") 49 | 50 | (defcustom scad-command 51 | "openscad" 52 | "Path to openscad executable." 53 | :type 'string) 54 | 55 | (defcustom scad-extra-args 56 | nil 57 | "Additional command line arguments to pass to openscad. 58 | For example '--enable=manifold'." 59 | :type '(repeat string)) 60 | 61 | (defcustom scad-keywords 62 | '("return" "undef" "true" "false" "for" "each" "if" "else" "let" "intersection_for" 63 | "function" "use" "include" "module") 64 | "SCAD keywords." 65 | :type '(repeat string)) 66 | 67 | (defcustom scad-functions 68 | '("cos" "acos" "sin" "asin" "tan" "atan" "atan2" ;;func.cc 69 | "abs" "sign" "rands" "min" "max" 70 | "round" "ceil" "floor" 71 | "pow" "sqrt" "exp" "log" "ln" 72 | "str" 73 | "lookup" "version" "version_num" "len" "search" 74 | "dxf_dim" "dxf_cross" ;;dxfdim.cc 75 | "norm" "cross" ;;2014.03 76 | "concat" "chr" ;;2015.03 77 | "assert" "ord" ;;2019.05 78 | "is_undef" "is_list" "is_num" "is_bool" "is_string" "is_function") ;;2019.05 type test 79 | "SCAD functions." 80 | :type '(repeat string)) 81 | 82 | (defcustom scad-modules 83 | '("children" "echo" ;;control.cc 84 | "cube" "sphere" "cylinder" "polyhedron" "square" "circle" "polygon" ;;primitives.cc 85 | "scale" "rotate" "translate" "mirror" "multmatrix" ;;transform.cc 86 | "union" "difference" "intersection" ;;csgops.cc 87 | "render" ;;render.cc 88 | "color" ;;color.cc 89 | "surface" ;;surface.cc 90 | "linear_extrude" ;;linearextrude.cc 91 | "rotate_extrude" ;;rotateextrude.cc 92 | "import" ;;import.cc 93 | "group" ;;builtin.cc 94 | "projection" ;;projection.cc 95 | "minkowski" "hull" "resize" ;;cgaladv.cc 96 | "parent_module" ;;2014.03 97 | "offset" "text") ;;2015.03 98 | "SCAD modules." 99 | :type '(repeat string)) 100 | 101 | (defcustom scad-deprecated 102 | '("child" "assign" "dxf_linear_extrude" "dxf_rotate_extrude" 103 | "import_stl" "import_off" "import_dxf") 104 | "SCAD deprecated modules and functions." 105 | :type '(repeat string)) 106 | 107 | (defcustom scad-operators 108 | '("+" "-" "*" "/" "%" 109 | "&&" "||" "!" 110 | "<" "<=" "==" "!=" ">" ">=" 111 | "?" ":" "=") 112 | "SCAD operators." 113 | :type '(repeat string)) 114 | 115 | (defcustom scad-preview-projection 'perspective 116 | "Preview projection." 117 | :type '(choice (const ortho) (const perspective))) 118 | 119 | (defcustom scad-preview-camera '(0 0 0 50 0 20 500) 120 | "Default parameters for the Gimbal camera." 121 | :type '(repeat integer)) 122 | 123 | (defcustom scad-preview-refresh 1.0 124 | "Delay in seconds until updating preview." 125 | :type '(choice (const nil) number)) 126 | 127 | (defcustom scad-preview-colorscheme '("Tomorrow" . "Tomorrow Night") 128 | "Color scheme for rendering preview. 129 | Can be pair of light and dark scheme, used depending on the current 130 | Emacs theme." 131 | :type '(choice string (cons string string))) 132 | 133 | (defcustom scad-preview-view '("axes" "scales") 134 | "List of views to be rendered. 135 | Options are axes, crosshairs, edges, scales, wireframe." 136 | :type '(repeat string)) 137 | 138 | (defcustom scad-export-extension ".stl" 139 | "Extension (file type) for output data file via `scad-export'. 140 | Options are .stl, .off, .amf, .3mf, .csg, .dxf, .svg, .pdf, .png, 141 | .echo, .ast, .term, .nef3, .nefdbg." 142 | :type 'string) 143 | 144 | (defvar-keymap scad-mode-map 145 | :doc "Keymap for `scad-mode'." 146 | :parent c-mode-base-map 147 | "C-c C-c" #'scad-preview 148 | "C-c C-o" #'scad-open 149 | "C-c C-e" #'scad-export 150 | "TAB" #'indent-for-tab-command 151 | "M-TAB" #'completion-at-point) 152 | 153 | (defvar scad-mode-syntax-table 154 | (let ((st (make-syntax-table))) 155 | (c-populate-syntax-table st) 156 | st) 157 | "Syntax table for `scad-mode'.") 158 | 159 | (defvar scad-font-lock-keywords 160 | `(("\\(module\\|function\\)[ \t]+\\(\\sw+\\)" (1 'font-lock-keyword-face nil) (2 'font-lock-function-name-face nil t)) 161 | ("\\(use\\|include\\)[ \t]*<\\([^>]+\\)>" (1 'font-lock-preprocessor-face nil) (2 'font-lock-type-face nil t)) 162 | ("<\\(\\sw+\\)>\\|$\\(\\sw+\\)" . font-lock-builtin-face) 163 | (,(regexp-opt scad-keywords 'words) . font-lock-keyword-face) 164 | (,(regexp-opt scad-modules 'words) . font-lock-builtin-face) 165 | (,(regexp-opt scad-functions 'words) . font-lock-function-name-face) 166 | (,(regexp-opt scad-deprecated 'words) . font-lock-warning-face) 167 | ;(,(regexp-opt scad-operators) . font-lock-operator-face) ;; This actually looks pretty ugly 168 | ;("\\(\\<\\S +\\>\\)\\s *(" 1 font-lock-function-name-face t) ;; Seems to override other stuff (e.g. in comments and builtins) 169 | ) 170 | "Keyword highlighting specification for `scad-mode'.") 171 | (defconst scad-font-lock-keywords-1 scad-font-lock-keywords) 172 | (defconst scad-font-lock-keywords-2 scad-font-lock-keywords) 173 | (defconst scad-font-lock-keywords-3 scad-font-lock-keywords) 174 | 175 | (defvar scad-completions 176 | (append scad-keywords scad-functions scad-modules) 177 | "List of known words for completion.") 178 | 179 | (put 'scad-mode 'c-mode-prefix "scad-") 180 | 181 | ;;;###autoload 182 | (add-to-list 'auto-mode-alist '("\\.scad\\'" . scad-mode)) 183 | 184 | ;;;###autoload 185 | (define-derived-mode scad-mode prog-mode "SCAD" 186 | "Major mode for editing OpenSCAD code." 187 | :group 'scad 188 | :after-hook (c-update-modeline) 189 | (add-hook 'flymake-diagnostic-functions #'scad-flymake nil 'local) 190 | (add-hook 'completion-at-point-functions 191 | #'scad-completion-at-point nil 'local) 192 | (c-initialize-cc-mode t) 193 | (c-init-language-vars scad-mode) 194 | (c-common-init 'scad-mode) 195 | (c-set-offset 'cpp-macro 0 nil) 196 | (c-run-mode-hooks 'c-mode-common-hook)) 197 | 198 | (defun scad-completion-at-point () 199 | "Completion at point function." 200 | (when-let (bounds (bounds-of-thing-at-point 'word)) 201 | (list (car bounds) (cdr bounds) 202 | scad-completions 203 | :exclusive 'no))) 204 | 205 | (defun scad-open () 206 | "Open current buffer with `scad-command'." 207 | (interactive nil scad-mode) 208 | (save-buffer) 209 | (call-process scad-command nil 0 nil (buffer-file-name))) 210 | 211 | (defun scad-export (file) 212 | "Render and export current SCAD model to FILE." 213 | (interactive 214 | (list (read-file-name 215 | "Export to: " 216 | nil nil nil 217 | (concat (file-name-base (buffer-file-name)) 218 | scad-export-extension))) 219 | scad-mode) 220 | (save-buffer) 221 | (compile (string-join (append (list scad-command) 222 | (list "-o" 223 | (shell-quote-argument (expand-file-name file)) 224 | (shell-quote-argument (buffer-file-name))) 225 | scad-extra-args) " "))) 226 | 227 | (defvar-local scad--preview-buffer nil) 228 | (defvar-local scad--preview-proc nil) 229 | (defvar-local scad--preview-image nil) 230 | (defvar-local scad--preview-mode-status nil) 231 | (defvar-local scad--preview-mode-camera nil) 232 | (defvar-local scad--preview-timer nil) 233 | 234 | (defvar-keymap scad-preview-mode-map 235 | :doc "Keymap for SCAD preview buffers." 236 | "p" #'scad-preview-projection 237 | "-" #'scad-preview-distance- 238 | "+" #'scad-preview-distance+ 239 | "" #'scad-preview-rotate-z- 240 | "" #'scad-preview-rotate-z+ 241 | "" #'scad-preview-rotate-x+ 242 | "" #'scad-preview-rotate-x- 243 | "M-" #'scad-preview-translate-x+ 244 | "M-" #'scad-preview-translate-x- 245 | "M-" #'scad-preview-translate-z- 246 | "M-" #'scad-preview-translate-z+) 247 | 248 | (defun scad--preview-status (status) 249 | "Update mode line of preview buffer with STATUS." 250 | (setq scad--preview-mode-camera (apply #'format "[%d %d %d] [%d %d %d] %d" 251 | scad-preview-camera) 252 | scad--preview-mode-status status) 253 | (force-mode-line-update)) 254 | 255 | (defun scad-preview () 256 | "Preview SCAD models in real-time within Emacs." 257 | (interactive nil scad-mode) 258 | (unless (buffer-live-p scad--preview-buffer) 259 | (setq scad--preview-buffer 260 | (with-current-buffer (get-buffer-create (format "*scad preview: %s*" (buffer-name))) 261 | (scad-preview-mode) 262 | (current-buffer)))) 263 | (when scad-preview-refresh 264 | (add-hook 'after-change-functions #'scad--preview-change nil 'local)) 265 | (let ((orig-buffer (current-buffer))) 266 | (with-current-buffer scad--preview-buffer 267 | (setq scad--preview-buffer orig-buffer) 268 | (scad--preview-reset)))) 269 | 270 | (defun scad--preview-change (&rest _) 271 | "Buffer changed, trigger rerendering." 272 | (if (not (buffer-live-p scad--preview-buffer)) 273 | (remove-hook 'after-change-functions #'scad--preview-change 'local) 274 | (let ((buffer scad--preview-buffer)) 275 | (with-current-buffer buffer 276 | (scad--preview-kill) 277 | (scad--preview-status "Stale") 278 | (setq scad--preview-timer 279 | (run-with-timer 280 | scad-preview-refresh nil 281 | (lambda () 282 | (when (buffer-live-p buffer) 283 | (with-current-buffer buffer 284 | (setq scad--preview-timer nil) 285 | (scad--preview-render)))))))))) 286 | 287 | (defun scad--preview-colorscheme () 288 | "Color scheme depending on Emacs theme." 289 | (cond 290 | ((stringp scad-preview-colorscheme) 291 | scad-preview-colorscheme) 292 | ((color-dark-p (color-name-to-rgb (face-background 'default))) 293 | (cdr scad-preview-colorscheme)) 294 | (t (car scad-preview-colorscheme)))) 295 | 296 | (defun scad--preview-reset (&rest _) 297 | "Reset camera settings and render." 298 | (setq-local scad-preview-camera (copy-sequence (default-value 'scad-preview-camera)) 299 | scad-preview-projection (default-value 'scad-preview-projection)) 300 | (scad--preview-render)) 301 | 302 | ;; Based on https://github.com/zk-phi/scad-preview 303 | (defun scad--preview-render (&rest _) 304 | "Render image from current buffer." 305 | (if (not (buffer-live-p scad--preview-buffer)) 306 | (scad--preview-status "Dead") 307 | (scad--preview-kill) 308 | (scad--preview-status "Render") 309 | (let* ((infile (make-temp-file "scad-preview-" nil ".scad")) 310 | (basefile (file-name-sans-extension infile)) 311 | (outfile (concat basefile ".tmp.png")) 312 | (buffer (current-buffer)) 313 | (win (or (get-buffer-window buffer) 314 | (display-buffer 315 | buffer '(nil (inhibit-same-window . t)))))) 316 | (with-current-buffer scad--preview-buffer 317 | (save-restriction 318 | (widen) 319 | (write-region (point-min) (point-max) infile nil 'nomsg))) 320 | (with-environment-variables 321 | ;; Setting the OPENSCADPATH to the current directory allows openscad to pick 322 | ;; up other local files with `include '. 323 | (("OPENSCADPATH" 324 | (if-let ((path (getenv "OPENSCADPATH"))) 325 | (concat default-directory path-separator path) 326 | default-directory))) 327 | (setq scad--preview-proc 328 | (make-process 329 | :noquery t 330 | :connection-type 'pipe 331 | :name "scad-preview" 332 | :buffer "*scad preview output*" 333 | :sentinel 334 | (lambda (proc _event) 335 | (unwind-protect 336 | (when (and (buffer-live-p buffer) 337 | (memq (process-status proc) '(exit signal))) 338 | (with-current-buffer buffer 339 | (setq scad--preview-proc nil) 340 | (if (not (ignore-errors 341 | (and (file-exists-p outfile) 342 | (> (file-attribute-size (file-attributes outfile)) 0)))) 343 | (scad--preview-status "Error") 344 | (with-silent-modifications 345 | (scad--preview-delete) 346 | (setq scad--preview-image (concat basefile ".png")) 347 | (rename-file outfile scad--preview-image) 348 | (erase-buffer) 349 | (insert (propertize "#" 'display `(image :type png :file ,scad--preview-image)))) 350 | (scad--preview-status "Done")))) 351 | (delete-file infile) 352 | (delete-file outfile))) 353 | :command 354 | (append 355 | (list scad-command 356 | "-o" outfile 357 | "--preview" 358 | (format "--projection=%s" scad-preview-projection) 359 | (format "--imgsize=%d,%d" 360 | (window-pixel-width win) 361 | (window-pixel-height win)) 362 | (format "--view=%s" 363 | (mapconcat #'identity scad-preview-view ",")) 364 | (format "--camera=%s" 365 | (mapconcat #'number-to-string scad-preview-camera ",")) 366 | (format "--colorscheme=%s" (scad--preview-colorscheme)) 367 | infile) 368 | scad-extra-args))))))) 369 | 370 | (defun scad--preview-kill () 371 | "Kill current rendering." 372 | (when (process-live-p scad--preview-proc) 373 | (delete-process scad--preview-proc) 374 | (setq scad--preview-proc nil)) 375 | (when scad--preview-timer 376 | (cancel-timer scad--preview-timer) 377 | (setq scad--preview-timer nil))) 378 | 379 | (defun scad--preview-delete () 380 | "Delete current image." 381 | (when scad--preview-image 382 | (delete-file scad--preview-image) 383 | (setq scad--preview-image nil))) 384 | 385 | (define-derived-mode scad-preview-mode special-mode "SCAD/Preview" 386 | "Major mode for SCAD preview buffers." 387 | :interactive nil :abbrev-table nil :syntax-table nil 388 | (setq-local buffer-read-only t 389 | line-spacing nil 390 | cursor-type nil 391 | cursor-in-non-selected-windows nil 392 | left-fringe-width 1 393 | right-fringe-width 1 394 | left-margin-width 0 395 | right-margin-width 0 396 | truncate-lines nil 397 | show-trailing-whitespace nil 398 | display-line-numbers nil 399 | fringe-indicator-alist '((truncation . nil)) 400 | revert-buffer-function #'scad--preview-reset 401 | mode-line-position '(" " scad--preview-mode-camera) 402 | mode-line-process '(" " scad--preview-mode-status) 403 | mode-line-modified nil 404 | mode-line-mule-info nil 405 | mode-line-remote nil) 406 | (add-hook 'kill-buffer-hook #'scad--preview-kill nil 'local) 407 | (add-hook 'kill-buffer-hook #'scad--preview-delete nil 'local) 408 | (add-hook 'window-size-change-functions 409 | (let ((buf (current-buffer))) 410 | (lambda (_) 411 | (with-current-buffer buf 412 | (scad--preview-render)))) 413 | nil 'local)) 414 | 415 | (defun scad-preview-projection () 416 | "Toggle projection." 417 | (interactive nil scad-preview-mode) 418 | (setq-local scad-preview-projection 419 | (if (eq scad-preview-projection 'ortho) 420 | 'perspective 421 | 'ortho)) 422 | (scad--preview-render)) 423 | 424 | (defmacro scad--define-preview-move (name idx off) 425 | "Define camera move function NAME which increments IDX by OFF." 426 | `(defun ,(intern (format "scad-preview-%s" name)) (&optional offset) 427 | "Move camera by OFFSET." 428 | (interactive "P" scad-preview-mode) 429 | (cl-incf (nth ,idx scad-preview-camera) 430 | (* (cl-signum ,off) 431 | (if offset (prefix-numeric-value offset) ,(abs off)))) 432 | (scad--preview-render))) 433 | 434 | (scad--define-preview-move translate-x+ 0 10) 435 | (scad--define-preview-move translate-x- 0 -10) 436 | (scad--define-preview-move translate-y+ 1 10) 437 | (scad--define-preview-move translate-y- 1 -10) 438 | (scad--define-preview-move translate-z+ 2 10) 439 | (scad--define-preview-move translate-z- 2 -10) 440 | (scad--define-preview-move rotate-x+ 3 20) 441 | (scad--define-preview-move rotate-x- 3 -20) 442 | (scad--define-preview-move rotate-y+ 4 20) 443 | (scad--define-preview-move rotate-y- 4 -20) 444 | (scad--define-preview-move rotate-z+ 5 20) 445 | (scad--define-preview-move rotate-z- 5 -20) 446 | (scad--define-preview-move distance- 6 100) 447 | (scad--define-preview-move distance+ 6 -100) 448 | 449 | (defvar-local scad--flymake-proc nil) 450 | 451 | (defun scad-flymake (report-fn &rest _args) 452 | "Flymake backend, diagnostics are passed to REPORT-FN." 453 | (unless (executable-find scad-command) 454 | (error "Cannot find `%s'" scad-command)) 455 | (when (process-live-p scad--flymake-proc) 456 | (delete-process scad--flymake-proc)) 457 | (let* ((buffer (current-buffer)) 458 | (infile (make-temp-file "scad-flymake-" nil ".scad")) 459 | (outfile (concat (file-name-sans-extension infile) ".ast"))) 460 | (save-restriction 461 | (widen) 462 | (write-region (point-min) (point-max) infile nil 'nomsg)) 463 | (with-environment-variables 464 | ;; Setting the OPENSCADPATH to the current directory allows openscad to pick 465 | ;; up other local files with `include '. 466 | (("OPENSCADPATH" 467 | (if-let ((path (getenv "OPENSCADPATH"))) 468 | (concat default-directory path-separator path) 469 | default-directory))) 470 | (setq 471 | scad--flymake-proc 472 | (make-process 473 | :name "scad-flymake" 474 | :noquery t 475 | :connection-type 'pipe 476 | :buffer (generate-new-buffer " *scad-flymake*") 477 | :command (append (list scad-command "-o" outfile infile) scad-extra-args) 478 | :sentinel 479 | (lambda (proc _event) 480 | (when (memq (process-status proc) '(exit signal)) 481 | (unwind-protect 482 | (when (and (buffer-live-p buffer) 483 | (eq proc (buffer-local-value 'scad--flymake-proc buffer))) 484 | (with-current-buffer (process-buffer proc) 485 | (goto-char (point-min)) 486 | (let (diags) 487 | (while (search-forward-regexp "^\\(ERROR\\|WARNING\\): \\(.*?\\),? in file [^,]+, line \\([0-9]+\\)" nil t) 488 | (let ((msg (match-string 2)) 489 | (type (if (equal (match-string 1) "ERROR") :error :warning)) 490 | (region (flymake-diag-region buffer (string-to-number (match-string 3))))) 491 | (push (flymake-make-diagnostic buffer (car region) (cdr region) type msg) diags))) 492 | (funcall report-fn (nreverse diags))))) 493 | (delete-file outfile) 494 | (delete-file infile) 495 | (kill-buffer (process-buffer proc)))))))))) 496 | 497 | (provide 'scad-mode) 498 | ;;; scad-mode.el ends here 499 | --------------------------------------------------------------------------------