-
Notifications
You must be signed in to change notification settings - Fork 28
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
Open
rabail-aamir
wants to merge
2
commits into
thoth-tech:main
Choose a base branch
from
rabail-aamir:cxx-doc-overview
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # C++ Implementation Overview in SplashKit Online | ||
|
|
||
| ## Introduction | ||
|
|
||
| This document gives overview of how in Splashkit Online, code is compiled and execuded. It describes how user-written C++ code flows from the browser editor to WebAssembly compilation and execution. | ||
|
|
||
| Main purpse is to help new contributors understand that how the system integrates C++ capability without requiring in-depth compiler knowledge. | ||
rabail-aamir marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 | ||
|
|
||
| CXXCompiler class is responsible for managing the C++ complition process. Its responsibilities include: | ||
|
|
||
| - Writing source files to virtual filesystem | ||
| - Compile each file of C++ into object files | ||
| - Link object files into final WebAssembly output | ||
| - Provide syntax checking and error reporting | ||
| - Warn users about unsupported API usage | ||
|
|
||
| It communicates with Web Worker to make sure that main interface doesn't freeze during compilation. | ||
|
|
||
rabail-aamir marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 WASM executable | ||
rabail-aamir marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| In order to maintain UI responsiveness, this occurs asynchronously. | ||
rabail-aamir marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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++. | ||
| This method offers: | ||
|
|
||
| - Sandboxing for security | ||
| - Compatibility between platforms | ||
| - Execution in real time in a web setting | ||
rabail-aamir marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 | ||
|
|
||
| Prior to being displayed to the user, compiler messages undergo processing and formatting. In order to emphasise certain lines and offer insightful terminal feedback, errors are analysed. | ||
rabail-aamir marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.