├── .gitattributes ├── .gitignore ├── CHANGELOG.md ├── LICENSE.txt ├── README.md ├── examples ├── errors │ ├── both.op │ ├── errors.op │ └── warnings.op ├── factorial.op ├── hello-world.bf ├── lost-kingdom.bf ├── stack.op └── triangle.bf ├── oplang.cabal └── src ├── Language └── OpLang │ ├── Codegen.hs │ ├── Optimizer.hs │ ├── Parser.hs │ ├── Syntax.hs │ └── Validation.hs ├── Main.hs └── Opts.hs /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Tell GitHub's Linguist to ignore files in this folder when detecting repo language 5 | # More info at https://github.com/github/linguist#vendored-code 6 | examples/* linguist-vendored 7 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | dist-newstyle 2 | 3 | *.c 4 | *.exe 5 | *.out 6 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## v0.5.0.0 \[2024-04-28\] 4 | 5 | * Use `putchar`/`getchar` instead of `printf`/`scanf` for I/O 6 | * Optimizer improvements 7 | * Can now optimize more complex loops into constant-time arithmetic 8 | * Performs better constant propagation 9 | 10 | ## v0.4.0.1 \[2023-12-28\] 11 | 12 | * Improve error messages, warnings, and `--help` text 13 | * Fix warnings not being shown if there were also compilation errors 14 | * Update dependencies to allow compiling with GHC 9.8 15 | 16 | ## v0.4.0.0 \[2023-05-06\] 17 | 18 | * Add command-line options for printing the AST and IR, ignoring warnings, and skipping C compilation 19 | * Require GHC 9.2 or newer 20 | 21 | ## v0.3.0.1 \[2022-08-12\] 22 | 23 | * Update [`base`](https://hackage.haskell.org/package/base) version bound to require GHC 9.0 (`base` 4.15) or newer 24 | 25 | ## v0.3.0.0 \[2022-08-12\] 26 | 27 | * Upgrade to [`text`](https://hackage.haskell.org/package/text) v2 and use [`text-builder-linear`](https://hackage.haskell.org/package/text-builder-linear), improving compilation performance 28 | * Optimizer overhaul 29 | * Now uses a separate IR 30 | * Performs more optimizations, runs in a single pass 31 | * Generates smaller and slightly faster C code 32 | 33 | ## v0.2.0.0 \[2022-03-19\] 34 | 35 | * Parser error message improvements 36 | * Codegen improvements 37 | * **\[Breaking\]** Tailcalls are no longer optimized 38 | 39 | ## v0.1.0.0 \[2020-10-10\] 40 | 41 | * Initial release 42 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 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 | # oplang 2 | 3 | [![Hackage](https://img.shields.io/hackage/v/oplang?style=for-the-badge)](https://hackage.haskell.org/package/oplang) 4 | 5 | OpLang is a stack-based esoteric programming language based on [Brainfuck](https://en.wikipedia.org/wiki/Brainfuck). 6 | 7 | ## Installing 8 | 9 | The compiler is available on [Hackage](https://hackage.haskell.org/package/oplang), and can be installed via [cabal](https://www.haskell.org/cabal/) (which can itself be installed via [ghcup](https://www.haskell.org/ghcup/)). 10 | 11 | ```sh 12 | cabal install oplang 13 | ``` 14 | 15 | ## Usage 16 | 17 | To compile and run an OpLang program, use: 18 | 19 | ```sh 20 | oplang code.op 21 | ./code.out 22 | ``` 23 | 24 | For a list of available command-line options, use `oplang --help`. 25 | 26 | ## Building from source 27 | 28 | Prerequisites: 29 | 30 | * `GHC` >=9.2 31 | * `cabal` >=3.6 32 | 33 | (Both can be installed via [ghcup](https://www.haskell.org/ghcup/)) 34 | 35 | To build the project, use `cabal build`. 36 | 37 | To run the project locally (without installing), use `cabal run . -- `. 38 | 39 | ## Language features 40 | 41 | OpLang is a strict superset of Brainfuck. 42 | 43 | Its main improvement is the addition of user-defined operators, which are analogous to user-defined functions in languages like C or Python. 44 | 45 | The "memory tape" in OpLang is specific to each operator invocation (akin to the stack frames of functions in C), and there is a separate "stack" which persists across operator invocations. 46 | 47 | Each cell in the tape(s) and stack is 1 byte, and overflow/underflow is allowed. 48 | 49 | The default sizes of the stack and of memory tapes is 4KB. These defaults can be individually modified via command-line arguments. 50 | 51 | ### Syntax 52 | 53 | OpLang has 10 built-in operators, 8 of which are the Brainfuck operators, with the same semantics: 54 | 55 | * `+`: Increment the current cell 56 | * `-`: Decrement the current cell 57 | * `<`: Move the current cell pointer to the left 58 | * `>`: Move the current cell pointer to the right 59 | * `,`: Read a character from stdin and store its ASCII value in the current cell 60 | * `.`: Interpret the current cell as an ASCII character and print it to stdout 61 | * `[`: Begin a loop (i.e. if the value at the current cell is zero, jump to the next `]`) 62 | * `]`: End a loop (i.e. if the value at the current cell is non-zero, jump to the previous `[`) 63 | 64 | And 2 of them are new operators that modify the stack: 65 | 66 | * `;`: Pop a value from the stack and store it into the current cell 67 | * `:`: Push the value of the current cell onto the stack 68 | 69 | An OpLang program consists of a series of custom operator definitions, followed by the "toplevel" (similar to a `main()` function in other languages). 70 | 71 | An operator definition consists of the operator's name, followed by the operator's body, enclosed in `{`/`}`. 72 | 73 | Single-line comments are supported, and are introduced by the `#` character. 74 | 75 | Here's a simple program that reads a character from stdin, adds 3 to it, and prints it back: 76 | 77 | ```oplang 78 | a { ; +++ : } 79 | ,: a ;. 80 | ``` 81 | 82 | For more example programs, see the [examples](examples/) directory. 83 | 84 | ## Compiler architecture 85 | 86 | The compiler works by translating the input OpLang source into C, and then compiling that using the system's C compiler. To use a different C compiler, set the `CC` environment variable. 87 | 88 | The compiler uses an intermediate representation (which can be shown with the `--dump-ir` option) on which it performs a number of optimizations, generating C code that is much smaller and faster than a direct translation would yield. 89 | 90 | ## License 91 | 92 | This repository is licensed under the terms of the GNU General Public License v3. 93 | 94 | For more details, see [the license file](LICENSE.txt). 95 | -------------------------------------------------------------------------------- /examples/errors/both.op: -------------------------------------------------------------------------------- 1 | # Should fail to compile, producing the following warnings and errors: 2 | # Warning: Unused operator 'f'. 3 | # Warning: Unused operator 'g'. 4 | # Error: In definition of 'f': Call to undefined operator 'a'. 5 | # Error: In definition of 'g': Call to undefined operator 'b'. 6 | f { a } 7 | g { b } 8 | -------------------------------------------------------------------------------- /examples/errors/errors.op: -------------------------------------------------------------------------------- 1 | # Should fail to compile with the following errors: 2 | # Error: In top level: Call to undefined operator 'b'. 3 | # Error: In definition of 'f': Call to undefined operator 'a'. 4 | f { a } 5 | f b 6 | -------------------------------------------------------------------------------- /examples/errors/warnings.op: -------------------------------------------------------------------------------- 1 | # Should produce the following warnings (unless compiled with --no-warn): 2 | # Warning: Unused operator 'f'. 3 | # Warning: Unused operator 'g'. 4 | f { } 5 | g { } 6 | -------------------------------------------------------------------------------- /examples/factorial.op: -------------------------------------------------------------------------------- 1 | # Reads a single-digit number n, then prints factorial(n) '*' chars. 2 | # To easily check the value, you can pipe the output into `wc -c`, like so: 3 | # `echo 5 | ./factorial.out | wc -c` 4 | # ^ Should print 120 5 | 6 | 0 { +++ +++ [> ++++ ++++ < -] > : } 7 | s { ; > ; [- < - >] < : } 8 | r { 0 , : s } 9 | 10 | m { ; > ; < [->[->+>+<<]>[-<+>]<<]>[-]>>[-<<<+>>>]<<< : } 11 | f { ; > + < [: > : m ; < -] > : } 12 | 13 | * { +++ +++ + [> +++ +++ < -] > : } 14 | 15 | *; > rf ; [ < . > - ] 16 | -------------------------------------------------------------------------------- /examples/hello-world.bf: -------------------------------------------------------------------------------- 1 | # Prints 'hello world'. 2 | # Relies on cells overflowing in order to work. 3 | 4 | +[-[<<[+[--->]-[<<<]]]>>>-]>-.---.>..>.<<<<-.<+.>>>>>.>.<<.<-. 5 | -------------------------------------------------------------------------------- /examples/stack.op: -------------------------------------------------------------------------------- 1 | # Prints 'cba'. 2 | 3 | f { ++++ ++++ [> ++++ ++++ ++++ < -] > + : + : + : } 4 | m { f ;. ;. ;. } 5 | m 6 | -------------------------------------------------------------------------------- /examples/triangle.bf: -------------------------------------------------------------------------------- 1 | # Downloaded from http://www.hevanet.com/cristofd/brainfuck/sierpinski.b 2 | # Prints the Sierpinski triangle 3 | 4 | ++++++++[>+>++++<<-]>++>>+<[-[>>+<<-]+>>]>+[ 5 | -<<<[ 6 | ->[+[-]+>++>>>-<<]<[<]>>++++++[<<+++++>>-]+<<++.[-]<< 7 | ]>.>+[>>]>+ 8 | ] 9 | -------------------------------------------------------------------------------- /oplang.cabal: -------------------------------------------------------------------------------- 1 | cabal-version: 3.0 2 | 3 | name: oplang 4 | version: 0.5.0.0 5 | synopsis: Stack-based esoteric programming language 6 | description: Please see the README on GitHub at 7 | homepage: https://github.com/aionescu/oplang#readme 8 | bug-reports: https://github.com/aionescu/oplang/issues 9 | license: GPL-3.0-only 10 | license-file: LICENSE.txt 11 | author: Alex Ionescu 12 | maintainer: aaionescu@pm.me 13 | copyright: Copyright (C) 2019-2024 Alex Ionescu 14 | category: Compilers/Interpreters, Language 15 | build-type: Simple 16 | 17 | tested-with: GHC == { 9.2.8, 9.4.8, 9.6.3, 9.8.2 } 18 | 19 | extra-doc-files: 20 | CHANGELOG.md 21 | README.md 22 | examples/**/*.bf 23 | examples/**/*.op 24 | 25 | source-repository head 26 | type: git 27 | location: https://github.com/aionescu/oplang 28 | 29 | executable oplang 30 | default-language: GHC2021 31 | default-extensions: 32 | BlockArguments 33 | DerivingStrategies 34 | LambdaCase 35 | LexicalNegation 36 | NegativeLiterals 37 | NoFieldSelectors 38 | OverloadedRecordDot 39 | OverloadedStrings 40 | RecordWildCards 41 | ViewPatterns 42 | 43 | other-extensions: 44 | StrictData 45 | 46 | ghc-options: 47 | -Wall 48 | -Wcompat 49 | -Widentities 50 | -Wmissing-deriving-strategies 51 | -Wno-name-shadowing 52 | -Wpartial-fields 53 | -Wprepositive-qualified-module 54 | -Wredundant-constraints 55 | -Wunused-packages 56 | 57 | hs-source-dirs: src 58 | main-is: Main.hs 59 | autogen-modules: Paths_oplang 60 | 61 | other-modules: 62 | Language.OpLang.Codegen 63 | Language.OpLang.Optimizer 64 | Language.OpLang.Parser 65 | Language.OpLang.Syntax 66 | Language.OpLang.Validation 67 | Opts 68 | Paths_oplang 69 | 70 | build-depends: 71 | base >=4.16 && <5 72 | , containers ^>= 0.7 73 | , directory ^>= 1.3.8 74 | , filepath ^>= 1.4.100 75 | , megaparsec ^>= 9.6.1 76 | , monad-chronicle ^>= 1.0.1 77 | , mtl ^>= 2.3 78 | , optparse-applicative ^>= 0.17 79 | , process ^>= 1.6.17 80 | , text >=2 && <2.2 81 | , text-builder-linear ^>= 0.1 82 | -------------------------------------------------------------------------------- /src/Language/OpLang/Codegen.hs: -------------------------------------------------------------------------------- 1 | module Language.OpLang.Codegen(codegen) where 2 | 3 | import Data.Char(ord) 4 | import Data.Foldable(foldMap') 5 | import Data.Map.Strict qualified as M 6 | import Data.Text(Text) 7 | import Data.Text.Builder.Linear(Builder, fromDec, runBuilder) 8 | 9 | import Language.OpLang.Syntax 10 | 11 | type CCode = Builder 12 | 13 | cName :: Name -> CCode 14 | cName name = "_" <> fromDec (ord name) 15 | 16 | programHeader :: Word -> Word -> CCode 17 | programHeader stackSize tapeSize = 18 | "#include\n#define T " <> fromDec tapeSize 19 | <> "\nchar q[" <> fromDec stackSize <> "],*s=q;" 20 | 21 | forwardDecl :: Name -> CCode 22 | forwardDecl name = "void " <> cName name <> "();" 23 | 24 | codegenDef :: Name -> [Instr] -> CCode 25 | codegenDef name body = "void " <> cName name <> "(){char u[T]={0},*t=u;" <> codegenOps body <> "}" 26 | 27 | codegenMain :: [Instr] -> CCode 28 | codegenMain body = "int main(){char u[T]={0},*t=u;" <> codegenOps body <> "return 0;}" 29 | 30 | codegenOps :: [Instr] -> CCode 31 | codegenOps = foldMap' codegenOp 32 | 33 | tape :: Offset -> CCode 34 | tape 0 = "*t" 35 | tape offset = "t[" <> fromDec offset <> "]" 36 | 37 | plusEq :: (Ord a, Num a) => a -> CCode 38 | plusEq val 39 | | val < 0 = "-=" 40 | | otherwise = "+=" 41 | 42 | times :: Val -> CCode 43 | times 1 = "" 44 | times n = "*" <> fromDec n 45 | 46 | codegenOp :: Instr -> CCode 47 | codegenOp = \case 48 | Add offset val -> tape offset <> plusEq val <> fromDec (abs val) <> ";" 49 | Set offset val -> tape offset <> "=" <> fromDec val <> ";" 50 | Pop offset -> tape offset <> "=*(--s);" 51 | Push offset -> "*(s++)=" <> tape offset <> ";" 52 | PushKnown val -> "*(s++)=" <> fromDec val <> ";" 53 | Read offset -> tape offset <> "=getchar();" 54 | Write offset -> "putchar(" <> tape offset <> ");" 55 | WriteKnown val -> "putchar(" <> fromDec val <> ");" 56 | Move offset -> "t" <> plusEq offset <> fromDec (abs offset) <> ";" 57 | AddMul offset initialOffset val -> tape offset <> plusEq val <> tape initialOffset <> times (abs val) <> ";" 58 | Loop ops -> "while(*t){" <> codegenOps ops <> "}" 59 | Call name -> cName name <> "();" 60 | 61 | codegen :: Word -> Word -> Program Instr -> Text 62 | codegen stackSize tapeSize Program{..} = 63 | runBuilder 64 | $ programHeader stackSize tapeSize 65 | <> foldMap' forwardDecl (M.keys opDefs) 66 | <> M.foldMapWithKey codegenDef opDefs 67 | <> codegenMain topLevel 68 | -------------------------------------------------------------------------------- /src/Language/OpLang/Optimizer.hs: -------------------------------------------------------------------------------- 1 | module Language.OpLang.Optimizer(optimize) where 2 | 3 | import Data.IntMap.Strict(IntMap) 4 | import Data.IntMap.Strict qualified as I 5 | import Data.IntSet qualified as S 6 | 7 | import Language.OpLang.Syntax 8 | 9 | -- Models partial information about a memory cell, used during partial evaluation. 10 | data Cell 11 | = UnknownPlus Val -- Unknown starting value + a known constant. 12 | | Known Bool Val -- Fully-known constant value. The 'Bool' tracks whether it should be committed unconditionally. 13 | deriving stock Eq 14 | 15 | isKnown :: Cell -> Bool 16 | isKnown UnknownPlus{} = False 17 | isKnown _ = True 18 | 19 | getVal :: Cell -> Val 20 | getVal (UnknownPlus val) = val 21 | getVal (Known _ val) = val 22 | 23 | -- 'isKnown' and 'getVal' could be made into lenses, which would make this definition redundant, 24 | -- but adding a dependency on 'lens' just for this would be overkill. 25 | mapVal :: (Val -> Val) -> Cell -> Cell 26 | mapVal f (UnknownPlus val) = UnknownPlus $ f val 27 | mapVal f (Known c val) = Known c $ f val 28 | 29 | instance Semigroup Cell where 30 | (<>) :: Cell -> Cell -> Cell 31 | UnknownPlus a <> UnknownPlus b = UnknownPlus (a + b) 32 | UnknownPlus a <> Known c b = Known c (a + b) 33 | Known c a <> _ = Known c a 34 | 35 | instance Monoid Cell where 36 | mempty :: Cell 37 | mempty = UnknownPlus 0 38 | 39 | -- Models partial information about a segment of the memory tape. 40 | -- Represented as a mapping from memory offsets to Cells. 41 | type Tape = IntMap Cell 42 | 43 | -- Commit a cell update instruction. 44 | commitCell :: Offset -> Cell -> [Instr] -> [Instr] 45 | commitCell offset cell acc = 46 | case cell of 47 | UnknownPlus 0 -> acc 48 | UnknownPlus val -> Add offset val : acc 49 | 50 | Known False 0 -> acc 51 | Known _ val -> Set offset val : acc 52 | 53 | -- Commit a Move instruction. 54 | commitMove :: Offset -> [Instr] -> [Instr] 55 | commitMove 0 acc = acc 56 | commitMove offset acc = Move offset : acc 57 | 58 | -- Commit cell update instructions for all the cells in the specified tape segment. 59 | commitCells :: Tape -> [Instr] -> [Instr] 60 | commitCells tape acc = I.foldrWithKey' commitCell acc tape 61 | 62 | -- Commit a set of AddMul instructions, resulting from a for-like loop. 63 | commitAddMuls :: Offset -> Val -> IntMap Val -> [Instr] -> [Instr] 64 | commitAddMuls offset diff vals acc = I.foldrWithKey' (commitAddMul offset diff) acc vals 65 | where 66 | commitAddMul :: Offset -> Val -> Offset -> Val -> [Instr] -> [Instr] 67 | commitAddMul _ _ _ 0 acc = acc 68 | commitAddMul initialOffset diff offset val acc = AddMul offset initialOffset (val * -diff) : acc 69 | 70 | -- Partially evaluate a program, producing an optimized sequence of instructions. 71 | pEval :: Offset -> Tape -> [Instr] -> [Op] -> (Offset, Tape, [Instr]) 72 | pEval offset tape acc [] = (offset, tape, acc) 73 | pEval offset tape acc (op : ops) = 74 | case op of 75 | Incr -> pEval offset (I.insertWith (<>) offset (UnknownPlus 1) tape) acc ops 76 | Decr -> pEval offset (I.insertWith (<>) offset (UnknownPlus -1) tape) acc ops 77 | 78 | Read' -> pEval offset (I.delete offset tape) (Read offset : acc) ops 79 | Pop' -> pEval offset (I.delete offset tape) (Pop offset : acc) ops 80 | 81 | MoveL -> pEval (offset - 1) tape acc ops 82 | MoveR -> pEval (offset + 1) tape acc ops 83 | 84 | Write' -> 85 | case I.findWithDefault mempty offset tape of 86 | Known _ val -> pEval offset tape (WriteKnown val : acc) ops 87 | cell -> pEval offset (I.delete offset tape) (Write offset : commitCell offset cell acc) ops 88 | 89 | Push' -> 90 | case I.findWithDefault mempty offset tape of 91 | Known _ val -> pEval offset tape (PushKnown val : acc) ops 92 | cell -> pEval offset (I.delete offset tape) (Push offset : commitCell offset cell acc) ops 93 | 94 | Call' c -> pEval offset tape (Call c : acc) ops 95 | 96 | Loop' l -> 97 | case I.findWithDefault mempty offset tape of 98 | Known _ 0 -> pEval offset tape acc ops 99 | 100 | cell -> 101 | case pEval 0 I.empty [] l of 102 | (0, I.mapKeys (offset +) -> tape', []) | Just (UnknownPlus diff) <- tape' I.!? offset, abs diff == 1, not $ any isKnown tape' -> 103 | case cell of 104 | Known _ val -> pEval offset (I.insert offset (Known True 0) $ I.unionWith (<>) (mapVal ((val * -diff) *) <$> tape') tape) acc ops 105 | _ -> 106 | let 107 | modified = I.intersection tape tape' 108 | addMuls = getVal <$> I.delete offset tape' 109 | remaining = tape I.\\ modified 110 | in 111 | pEval offset (I.insert offset (Known True 0) remaining) (commitAddMuls offset diff addMuls $ commitCells modified acc) ops 112 | 113 | (offset', tape', acc') -> 114 | let l' = Loop $ reverse $ commitMove offset' $ commitCells tape' acc' 115 | in pEval 0 (I.singleton 0 $ Known False 0) (l' : commitMove offset (commitCells tape acc)) ops 116 | 117 | optimizeOps :: Word -> [Op] -> [Instr] 118 | optimizeOps tapeSize ops = reverse acc 119 | where 120 | initialTape = I.fromSet (const $ Known False 0) $ S.fromRange (0, fromEnum tapeSize - 1) 121 | (_, _, acc) = pEval 0 initialTape [] ops 122 | 123 | optimize :: Word -> Program Op -> Program Instr 124 | optimize tapeSize Program{..} = 125 | Program 126 | { opDefs = optimizeOps tapeSize <$> opDefs 127 | , topLevel = optimizeOps tapeSize topLevel 128 | } 129 | -------------------------------------------------------------------------------- /src/Language/OpLang/Parser.hs: -------------------------------------------------------------------------------- 1 | module Language.OpLang.Parser(parse) where 2 | 3 | import Control.Monad.Chronicle(MonadChronicle(..)) 4 | import Data.Functor(($>)) 5 | import Data.List(intercalate) 6 | import Data.Map.Strict(Map) 7 | import Data.Map.Strict qualified as M 8 | import Data.Set qualified as S 9 | import Data.Text(Text) 10 | import Data.Text qualified as T 11 | import Data.Void(Void) 12 | import Text.Megaparsec hiding (parse) 13 | import Text.Megaparsec.Char(space1) 14 | import Text.Megaparsec.Char.Lexer qualified as L 15 | 16 | import Language.OpLang.Syntax 17 | 18 | type Parser = Parsec Void Text 19 | 20 | ws :: Parser () 21 | ws = L.space space1 (L.skipLineComment "#") empty 22 | 23 | lexeme :: Parser a -> Parser a 24 | lexeme = L.lexeme ws 25 | 26 | symbol :: Text -> Parser Text 27 | symbol = L.symbol ws 28 | 29 | reserved :: Text 30 | reserved = "+-<>,.;:[]{}" 31 | 32 | builtIn :: Parser Op 33 | builtIn = 34 | choice 35 | [ symbol "+" $> Incr 36 | , symbol "-" $> Decr 37 | , symbol "<" $> MoveL 38 | , symbol ">" $> MoveR 39 | , symbol "," $> Read' 40 | , symbol "." $> Write' 41 | , symbol ";" $> Pop' 42 | , symbol ":" $> Push' 43 | ] "built-in operator" 44 | 45 | block :: Text -> Text -> Parser [Op] 46 | block b e = between (symbol b) (symbol e) $ many op 47 | 48 | loop :: Parser Op 49 | loop = Loop' <$> block "[" "]" "loop" 50 | 51 | custom :: Parser Char 52 | custom = lexeme (satisfy $ not . (`T.elem` reserved)) "custom operator" 53 | 54 | op :: Parser Op 55 | op = 56 | choice 57 | [ loop 58 | , builtIn 59 | , Call' <$> custom 60 | ] "operator" 61 | 62 | def :: Parser (Name, [Op]) 63 | def = (,) <$> custom <*> block "{" "}" "definition" 64 | 65 | defs :: Parser (Map Name [Op]) 66 | defs = many (try def) >>= toMap 67 | where 68 | toMap ds 69 | | unique = pure $ M.fromList ds 70 | | otherwise = fail $ "Duplicate definition of operators: " <> intercalate ", " (show <$> S.toList set) 71 | where 72 | ids = fst <$> ds 73 | set = S.fromList ids 74 | unique = S.size set == length ids 75 | 76 | program :: Parser (Program Op) 77 | program = Program <$> defs <*> (many op "toplevel") 78 | 79 | parse :: MonadChronicle [Text] m => FilePath -> Text -> m (Program Op) 80 | parse path code = 81 | case runParser (ws *> program <* eof) path code of 82 | Left e -> confess ["Parse error at " <> T.pack (errorBundlePretty e)] 83 | Right p -> pure p 84 | -------------------------------------------------------------------------------- /src/Language/OpLang/Syntax.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE StrictData #-} 2 | module Language.OpLang.Syntax where 3 | 4 | import Data.Int(Int8) 5 | import Data.Map.Strict(Map) 6 | 7 | type Name = Char 8 | type Val = Int8 9 | type Offset = Int 10 | 11 | -- Surface-level AST, produced by the parser 12 | data Op 13 | = Incr 14 | | Decr 15 | | MoveL 16 | | MoveR 17 | | Read' 18 | | Write' 19 | | Pop' 20 | | Push' 21 | | Loop' [Op] 22 | | Call' Name 23 | deriving stock Show 24 | 25 | -- Internal IR, used for optimizations and codegen 26 | data Instr 27 | = Add Offset Val 28 | | Set Offset Val 29 | | Read Offset 30 | | Write Offset 31 | | WriteKnown Val 32 | | Pop Offset 33 | | Push Offset 34 | | PushKnown Val 35 | | Move Offset 36 | | Loop [Instr] 37 | | Call Name 38 | | AddMul Offset Offset Val 39 | deriving stock Show 40 | 41 | data Program op 42 | = Program 43 | { opDefs :: Map Name [op] 44 | , topLevel :: [op] 45 | } 46 | deriving stock Show 47 | -------------------------------------------------------------------------------- /src/Language/OpLang/Validation.hs: -------------------------------------------------------------------------------- 1 | module Language.OpLang.Validation(validate) where 2 | 3 | import Control.Monad(unless) 4 | import Control.Monad.Chronicle(MonadChronicle(..)) 5 | import Data.Bifunctor(bimap) 6 | import Data.Foldable(foldMap') 7 | import Data.Functor((<&>)) 8 | import Data.Map.Strict(Map) 9 | import Data.Map.Strict qualified as M 10 | import Data.Maybe(fromMaybe) 11 | import Data.Set(Set) 12 | import Data.Set qualified as S 13 | import Data.Text(Text) 14 | import Data.Text qualified as T 15 | 16 | import Language.OpLang.Syntax 17 | 18 | calledOps :: [Op] -> Set Name 19 | calledOps = foldMap' \case 20 | Call' op -> S.singleton op 21 | Loop' ops -> calledOps ops 22 | _ -> S.empty 23 | 24 | undefinedCalls :: Program Op -> [Text] 25 | undefinedCalls Program{..} = 26 | toMsgs =<< filter (not . S.null . snd) (undefinedInTopLevel : undefinedInDefs) 27 | where 28 | defined = M.keysSet opDefs 29 | 30 | undefinedInTopLevel = (Nothing, calledOps topLevel S.\\ defined) 31 | undefinedInDefs = bimap Just ((S.\\ defined) . calledOps) <$> M.toList opDefs 32 | 33 | fmt = maybe "top level" $ ("definition of " <>) . T.pack . show 34 | toMsgs (name, ops) = S.toList ops <&> \op -> 35 | "Error: In " <> fmt name <> ": Call to undefined operator " <> T.pack (show op) <> "." 36 | 37 | allUsedOps :: Map Name [Op] -> Set Name -> [Op] -> Set Name 38 | allUsedOps defs seen ops 39 | | S.null used = seen 40 | | otherwise = foldMap' ((allUsedOps defs (seen <> used)) . fromMaybe [] . (defs M.!?)) used 41 | where 42 | used = calledOps ops S.\\ seen 43 | 44 | removeUnusedOps :: Program Op -> ([Text], Program Op) 45 | removeUnusedOps p@Program{..} = (warnings, p{opDefs = usedDefs}) 46 | where 47 | usedOps = allUsedOps opDefs S.empty topLevel 48 | unusedDefs = M.withoutKeys opDefs usedOps 49 | usedDefs = M.restrictKeys opDefs usedOps 50 | 51 | warnings = M.keys unusedDefs <&> \op -> 52 | "Warning: Unused operator " <> T.pack (show op) <> "." 53 | 54 | validate :: MonadChronicle [Text] m => Bool -> Program Op -> m (Program Op) 55 | validate noWarn p = do 56 | let (warnings, p') = removeUnusedOps p 57 | unless noWarn $ dictate warnings 58 | 59 | case undefinedCalls p of 60 | [] -> pure p' 61 | errs -> confess errs 62 | -------------------------------------------------------------------------------- /src/Main.hs: -------------------------------------------------------------------------------- 1 | module Main(main) where 2 | 3 | import Control.Monad(when) 4 | import Control.Monad.Chronicle(ChronicleT(..)) 5 | import Control.Monad.Trans(lift) 6 | import Data.Bifoldable(bitraverse_) 7 | import Data.Foldable(traverse_) 8 | import Data.Maybe(fromMaybe) 9 | import Data.Text(Text) 10 | import Data.Text.IO qualified as T 11 | import System.Directory(createDirectoryIfMissing, removeFile) 12 | import System.Environment(lookupEnv) 13 | import System.Exit(exitFailure, exitSuccess) 14 | import System.FilePath(dropExtension, takeDirectory) 15 | import System.Info(os) 16 | import System.Process(callProcess) 17 | 18 | import Language.OpLang.Codegen(codegen) 19 | import Language.OpLang.Optimizer(optimize) 20 | import Language.OpLang.Parser(parse) 21 | import Language.OpLang.Validation(validate) 22 | import Opts(Opts(..), getOpts) 23 | 24 | exePath :: FilePath -> FilePath 25 | exePath path = dropExtension path <> ext os 26 | where 27 | ext "mingw32" = ".exe" 28 | ext _ = ".out" 29 | 30 | compileCCode :: Opts -> Text -> IO () 31 | compileCCode opts cCode = do 32 | let cFile = dropExtension opts.path <> ".c" 33 | 34 | if opts.noCC then do 35 | let outFile = fromMaybe cFile opts.outPath 36 | createDirectoryIfMissing True $ takeDirectory outFile 37 | T.writeFile outFile cCode 38 | else do 39 | T.writeFile cFile cCode 40 | 41 | let outFile = fromMaybe (exePath opts.path) opts.outPath 42 | createDirectoryIfMissing True $ takeDirectory outFile 43 | 44 | cc <- fromMaybe "cc" <$> lookupEnv "CC" 45 | callProcess cc ["-o", outFile, cFile] 46 | removeFile cFile 47 | 48 | runCompiler :: Opts -> Text -> ChronicleT [Text] IO () 49 | runCompiler opts code = do 50 | ast <- parse opts.path code 51 | when opts.dumpAST do 52 | lift $ putStrLn $ "AST:\n" <> show ast <> "\n" 53 | 54 | ast' <- validate opts.noWarn ast 55 | 56 | let ir = optimize opts.tapeSize ast' 57 | when opts.dumpIR do 58 | lift $ putStrLn $ "IR:\n" <> show ir <> "\n" 59 | 60 | let cCode = codegen opts.stackSize opts.tapeSize ir 61 | lift $ compileCCode opts cCode 62 | 63 | main :: IO () 64 | main = do 65 | opts <- getOpts 66 | code <- T.readFile opts.path 67 | 68 | runChronicleT (runCompiler opts code) 69 | >>= bitraverse_ (traverse_ T.putStrLn) (\_ -> exitSuccess) 70 | 71 | exitFailure 72 | -------------------------------------------------------------------------------- /src/Opts.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE StrictData #-} 2 | module Opts(Opts(..), getOpts) where 3 | 4 | import Data.Version(showVersion) 5 | import Options.Applicative 6 | 7 | import Paths_oplang(version) 8 | 9 | data Opts = 10 | Opts 11 | { stackSize :: Word 12 | , tapeSize :: Word 13 | , noWarn :: Bool 14 | , noCC :: Bool 15 | , dumpAST :: Bool 16 | , dumpIR :: Bool 17 | , outPath :: Maybe FilePath 18 | , path :: FilePath 19 | } 20 | 21 | getOpts :: IO Opts 22 | getOpts = execParser optsParser 23 | where 24 | ver = "oplang v" <> showVersion version 25 | verOpt = infoOption ver (short 'v' <> long "version" <> help "Show version information") 26 | 27 | opts :: Parser Opts 28 | opts = 29 | Opts 30 | <$> option auto (long "stack-size" <> value 4096 <> metavar "SIZE" <> help "Size of the stack, in bytes (default 4096)") 31 | <*> option auto (long "tape-size" <> value 4096 <> metavar "SIZE" <> help "Size of the memory tape, in bytes (default 4096)") 32 | <*> switch (long "no-warn" <> help "Don't report warnings") 33 | <*> switch (long "no-cc" <> help "Output a C file without compiling it") 34 | <*> switch (long "dump-ast" <> help "Print the AST after parsing") 35 | <*> switch (long "dump-ir" <> help "Print the IR after optimization") 36 | <*> optional (strOption $ short 'o' <> long "out-path" <> metavar "PATH" <> help "Path of the resulting executable (or C file if --no-cc is passed)") 37 | <*> strArgument (metavar "PATH" <> help "The source file to compile") 38 | 39 | optsParser = info (helper <*> verOpt <*> opts) (fullDesc <> header ver) 40 | --------------------------------------------------------------------------------