-
Notifications
You must be signed in to change notification settings - Fork 29
Add C++ implementation overview documentation #139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # C++ Implementation Overview in SplashKit Online | ||
|
|
||
| ## Introduction | ||
|
|
||
| This document gives an overview of how Splashkit Online compiles and executes code. It describes how user-written C++ code flows from the browser editor to WebAssembly compilation and execution. | ||
|
|
||
| The main purpose is to help new contributors understand how the system integrates C++ capabilities without requiring in-depth compiler knowledge. | ||
|
|
||
| ## Where C++ Lives in Repository | ||
|
|
||
| - **compilers/cxx:** | ||
| Includes the primary logic for applying Clang to compile C++ code to WebAssembly. | ||
| - **runtimes/cxx:** | ||
| Manages the browser's runtime execution of C++ programmes that have been compiled. | ||
| - **SplashKitWasm:** | ||
| Contains the WebAssembly build of the SplashKit library used by compiled programs. | ||
| - **javascript/compilers/cxxCompiler.js:** | ||
| Manages the front-end compilation process. | ||
|
|
||
| ## Role of CXXCompiler | ||
|
|
||
| The **CXXCompiler** class manages the C++ compilation process. Its responsibilities include: | ||
|
|
||
| - Writing source files to the virtual filesystem | ||
| - Compiling each C++ file into object files | ||
| - Linking object files into final WebAssembly output | ||
| - Providing syntax checking and error reporting | ||
| - Warning users about unsupported API usage | ||
|
|
||
| It communicates with a Web Worker to ensure the main interface doesn't freeze during compilation. | ||
|
|
||
|
|
||
| ## Web Workers and Clang Backend | ||
|
|
||
| In a Web Worker, the actual compilation process is carried out using: | ||
|
|
||
| - **clang++.wasm**: Compiles C++ source into object files | ||
| - **wasm-ld.wasm**: Links object files into a final | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This sentence seems incomplete. It looks like it was intended to describe the final WebAssembly output. Consider completing the sentence for clarity. |
||
|
|
||
| This occurs asynchronously to maintain UI responsiveness. | ||
|
|
||
| ## Relationship with WebAssembly (WASM) | ||
|
|
||
| SplashKit Online can securely run C++ code within the browser thanks to WebAssembly. | ||
| The browser's runtime interprets WASM, which is created by the compiler from C++. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This sentence is understandable, but the term “interprets” may be slightly misleading. Browsers typically execute or compile WebAssembly rather than interpret it. Consider rephrasing to something like “The browser executes the compiled WebAssembly (WASM) generated from C++ code” for better technical accuracy. |
||
| This method offers: | ||
|
|
||
| - Sandboxing for security | ||
| - Compatibility between platforms | ||
| - Real-time execution in web environments | ||
|
|
||
| ## Execution Environment | ||
|
|
||
| Runtime environment handles: | ||
|
|
||
| - Program start / stop / pause | ||
| - File system interactions | ||
| - Canvas rendering | ||
| - Audio output | ||
| - Keyboard and user input | ||
|
|
||
| The ExecutionEnvironmentInternalCXX class is in charge of this, coordinating communication between the browser user interface and the compiled programme. | ||
|
|
||
| ## Error Handling and Output | ||
|
|
||
| During error handling, compiler messages are processed and formatted before being displayed to the user. | ||
| This is done to ensure key lines are emphasised and clear terminal feedback is provided through error analysis. | ||
Uh oh!
There was an error while loading. Please reload this page.