Cupcake is a compiler for Jonathan Blows new programming language JAI. The compiler is built from the ideas and temporary specification that Blow has given in his Youtube and Twitch videos. Cupcake has almost everything implemented that Jonathan Blow has shown in his videos so far (2016-06-12).
Both Cupcake and me has no association with Jonathan Blow or JAI's development. The experience you have with Cupcake should not be reflected towards JAI and your opinion of it, Cupcake is not JAI. Cupcake is my hobby project, created for me to learn how a compiler works and how programs goes from source code to machine code.
UPDATE: The original 0.1-alpha release had the compiler removed (only the "source code" is left and that's basically useless) so there is no point to download that; 0.2-alpha also originally got it's compiler removed, but it was preserved by this fork.
| Status | |
|---|---|
| Windows 32bit | v0.1-alpha |
| Windows 32bit | v0.2-alpha |
| Windows 32bit/Mac OSX | v0.2-alpha-with-mac |
The executable is by nature 32-bit, but runs on 64-bit systems with the built-in WoW64. More platforms will be supported later. There is a lot of Windows-specific code in this release and it will take a while to port everything over natively.
Here is the latest release: Cupcake v0.2-alpha with Mac support.
| Version | Date | Link |
|---|---|---|
| v0.1-alpha | 2016-06-12 | Download |
| v0.2-alpha | 2017-01-21 | Download |
| v0.2-alpha-with-mac | 2020-05-08 (Raw source still 2017 version) | Download |
- Download the latest release.
- Unpack in a seperate folder.
- Run the compiler through the console.
- Ideal location of install:
%userprofile% - Ideal to add "cupcake-v0.2-alpha\v0.2-alpha\Windows-32-bit" to the system environment variable
$PATH - Another path to take is to rename the executable to
jai.exeif comfortable (to save like half a second when typing) - Make sure to run
cupcakein the same directory as the exe to not get module and output errors - If ran in another directory, make sure to supply the
modulesfolder in the-largument when running - Ideal to make a symlink with
mklink /d <modules and target source> <endpath>formodulesandtargetas well as a folder calledoutputin your working directory to call from there without any arguments - Arguments like
-v/--version, --nologo, -h/--helpcurrently cannot be called withcupcakeand will be fixed later - Compilation of the C++ output is currently under many errors and will be revised soon, for now, always make
sure to include
#run main()or#run any_func()at the end of the file or with the-rargument
cupcake main.jai
Usage: cupcake <source>... [options]
Options:
-v --version Show version
-h --help Show this screen
--nologo Disable Cupcake logo
-r --run <code> Executes the code
-l --modules <path> Include modules from folder [include already: ./modules/]
-m --module <file> Include module
Cupcake, as JAI, does not generate machine code (yet). There are two ways to execute your code, run the code in the compiler itself through bytecode (#run) or compile/convert your JAI code to C++ code. Currently a C++ file will always be generated and there is no way to turn it off. The output location for the C++ file is %EXECUTABLE_PATH%/output/output.cpp, the location can be changed by using the compiler workspace feature.
ORIGINAL CREATOR DOCUMENTATION OF JUGODLIS
The release includes a few examples, but there is no other documentation available to Cupcake. The game example is the invaders game Jonathan Blow showed in the first few demos. To test the examples just type this in to the console.
cupcake examples/EXAMPLE_NAME/main.jai
Because the specification for actual JAI is not complete, writing a documentation is not worth [Julgodis'] time. Though some nice people have written stuff about the language that could be used as documentation.
Jai Primer by Jorge Rodríguez.
Jai Programming Language – Resources and Information by Inductive.
The Joy of Programming in Jai by Nuno Afonso.
After using Cupcake, if you have any nice code examples, please send them to [email protected] and I added them to the examples folder.
The progress of JAI features that Cupcake has:
| Video | Implemented Status | Tested Status |
|---|---|---|
| Base language, compile-time execution | Everything implemented | Good enough |
| Iteration and arrays, uninitialized values, enums | Everything but inlining | Good enough |
| SOA, composition | Everything implemented | Good enough |
| Run-Time (and Compile-Time) Type Information | Everything but check calls and embedded systems | Good enough |
| Arguments and Return Values | Everything but double multi-return and #must | Good enough |
| Polymorphic Procedures Part 1 & Part 2 | Everything implemented | Good enough |
| Implicit Context | Everything implemented | Good enough |
| Bounds check, here strings, overloading | Everything implemented | Good enough |
| Self-browsing code, compiler message loop, workspaces | Everything but self-browsing code | Good enough |
| Code Modification | Can not be implemented without self-browsing code | Not tested |
| Structs with Parameters | Everything implemented | Good enough |
| First-Class (-Ish?) Types | Everything implemented | Good enough |
| Iterators, (Overloading x Polymorphism) | Everything implemented | Good enough |
Some out-of-the-box syntax highlighting is included in:
Visual Studio Code (or just add .jai to C++ file associations (similar syntax))
Microsoft Visual Studio (only 2013 and 2015, deprecated and not recommended)
Sublime Text
Eclipse...sort of (for CDT, add .jai to C++ file associations (similar syntax))
ORIGINAL CREATOR ISSUES OF JUGODLIS
The goal is to make Cupcake as great as possible and to do that i need your help. If you find any problems/bugs, please report them and don't forget to send example code that demonstrates the problem. You can use the Github issue section or send me an email at [email protected] (use the email if you don't want the demonstration source code to be public).
For now I have decided to not release the source code. Why, because I don't know if it would be fair to Jonathan Blow and I am not very proud of the quality of the code. There is a huge amount of unnecessary code that could and should be removed, Cupcake v0.1-alpha is around 45k LOC. [Decomps are just a proof of concept through Snowman decompiler (just rough structure, not full source)]
ORIGINAL CREATOR LICENSE OF JULGODIS
MIT License
Copyright (c) 2016 Jonathan Wase
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.