Wasm csharp biding generator #117

daosgava · 2025-04-04T07:34:56Z

Description

This is the first part of the bindings generation functionality. This initial PR covers generating bindings on the C# side. Additionally, this PR is a follow up of the C# WebAssembly support pull request.

Type of change

Breaking change (fix or feature that would cause existing functionality to not work as
expected)

Note:

To generate bindings go to CSharpWasm/BindingsGenerator and execute dotnet run.
Folders were restructure, so the CSharpWasm project was moved to CSharpCodeRunner.

Next Steps:

Modify the buildAndCopy.sh script to run the BindingsGenerator project, create a new version of the bindings, copy them to CSharpCodeRunner, build the project, and copy and paste the output to the IDE folder.
Generate types on the JavaScript Side.

Question:
Do we need to generate types on the C# side?

Images:

After running dotnet run, it should generate a the bindinds in the same directory. SplashKit.Generated.cs

…sed workerEventProcessor

…de, update event handling for compile and run

…eation

github-actions · 2025-04-04T07:36:13Z

🐋 PR Preview!
Preview at https://thoth-tech.github.io/SplashkitOnline/pr-previews/117
for commit `a29dd05`

Oliver-Quail

Hi Daniel,
While I have been somewhat harsh, I think this work is amazing, it just needs some comments in the meantime to help with other people being able to work on it later down the line. I get this is a work in progress as well, so I don't think you need to improve your documentation immediately as I can see you've started writing it but in your next pull request please add more.
Finally I was unable to run your code on my system due to a syntax error in buildAndCopy.sh. I've included the details in a comment.
I will be happy to approve once these changes are made :)

Oliver-Quail · 2025-04-10T00:18:32Z

Browser_IDE/compilers/csharp/csharpCompiler.js

+
+        let hasErrors = false;
+
+        // If all good, then output the 'compiled' result


Hi Daniel,
While I can see what is going on here. (Using the compiled binaries to compile a program), adding a comment here clarifying that the program is being complied not the binaries would help with clarity

Oliver-Quail · 2025-04-10T00:19:42Z

Browser_IDE/compilers/csharp/csharpCompiler.js

+            }
+        }
+
+        return compiled;


Just wondering if there is any documentation present on what data the compiled variable holds? If so please could you add it. I understand the priority right now is getting the program working, so please add a comment if you don't have time to document

Oliver-Quail · 2025-04-10T00:22:32Z

Browser_IDE/executionEnvironment.js

        iframe.id="iframetest"; // this code is primordial...
        if (language.needsSandbox)
-            iframe.sandbox = 'allow-scripts allow-modals';
+            iframe.sandbox = 'allow-scripts allow-modals allow-same-origin';


Hi Daniel,
While I can understand what is going on here with CORS, I think a comment clarifying what these three attributes do would be valuable, particularly for those working on this project in the future

Oliver-Quail · 2025-04-10T00:25:42Z

Browser_IDE/CSharpWasm/main.js

+const loadDotNet = async () => {
+    const { setModuleImports, getAssemblyExports, getConfig } = await dotnet
+        .withDiagnosticTracing(false)
+        .withApplicationArgumentsFromQuery()
+        .create();
+
+    setModuleImports("main.js", {
+        window: {
+            location: {
+                href: () => globalThis.window.location.href,
+            },
+        },
+        SplashKitBackendWASM: {
+            // TODO: Pass the rest of the SplashKit functions
+            write_line,
+            refresh_screen,
+            open_window,
+            fill_ellipse: () => {
+                // Research how to pass a JS object in WASM
+                fill_ellipse(color_black(), 260, 260, 200, 200);
+            },
+        },
+    });
+
+    const config = getConfig();
+    const exports = await getAssemblyExports(config.mainAssemblyName);
+    return exports;
+};
+
+const CompileAndRun = async (code, reportError) => {
+    try {
+        const exports = await loadDotNet();
+        const result = await exports.CSharpCodeRunner.CompileAndRun(code);
+        if (result.includes("Compilation failed")) {
+            const errors = result.split(":");
+            const errorLine = errors[1].split("Line");
+
+            const indexCorrector = 1;
+            const filePath = "__USERCODE__/code/main.cs";
+            reportError(
+                filePath,
+                result,
+                Number(errorLine[1]) + indexCorrector,
+                null,
+                true,
+            );
+        }
+    } catch (error) {
+        console.error("Error during code execution:", error);
+    }
+};
+
+// This event will be trigger by the csharp compiler
+document.addEventListener("compileAndRun", (ev) => {
+    CompileAndRun(ev.detail.program[0].source, ev.detail.reportError);
+});


Hi Daniel,
Don't fix it for this commit as I get that this is a work in progress but in your next pull request please can you add some documentation or comments to this code. That is if no documentation exists

Oliver-Quail · 2025-04-10T00:27:07Z

Browser_IDE/languageDefinitions.js

+    {
+        name: "CSharp",
+        userVisibleName: "C#",
+        aliases: ['C#', 'CSharp'],
+        sourceExtensions: ['cs'],
+        compilableExtensions: ['cs'],
+        defaultSourceExtension: "cs",
+        setups: [{
+            name: "C#",
+            runtimeFiles: [
+                { src: "moduleEventTarget.js", type: "text/javascript" },
+                { src: "loadsplashkit.js", type: "text/javascript" },
+                { src: "fsevents.js", type: "text/javascript" },
+                { src: "CSharpWasm/main.js", type: "module" },
+                { src: "runtimes/ExecutionEnvironmentInternal.js", type: "text/javascript" },
+                { src: "runtimes/csharp/csharpRuntime.js", type: "text/javascript" },
+            ],
+            runtimeDependencies: [
+                "runtimes/javascript/bin/SplashKitBackendWASM.js",
+                "runtimes/javascript/bin/SplashKitBackendWASM.wasm",
+            ],
+            compilerFiles: [
+                "compilers/csharp/csharpCompiler.js",
+            ],
+            runtimeSizeAprox: 20,
+            compilerSizeAprox: 150,
+            compilerName: "csharpCompiler",
+            supportHotReloading: false,
+            getDefaultProject: ()=>{return makeNewProject_CSharp;},
+            persistentFilesystem: false,
+            compiled: true,
+            needsSandbox: false,
+            needsServiceWorker: false,
+        }]
+    },


Just curios, is this process documented somewhere?

Oliver-Quail · 2025-04-10T00:30:16Z

CSharpWasm/BindingsGenerator/BindingsGenerator.cs

+        var sb = new StringBuilder();
+        sb.AppendLine("using System.Runtime.InteropServices.JavaScript;");
+        sb.AppendLine();
+        sb.AppendLine("namespace SplashKitSDK");
+        sb.AppendLine("{");
+        sb.AppendLine("    public partial class SplashKit");
+        sb.AppendLine("    {");
+
+        if (jsonData != null)
+        {
+            foreach (var module in jsonData.Values)
+            {
+                if (module.Functions == null) continue;
+
+                foreach (var function in module.Functions)
+                {
+                    if (function.Signatures != null &&
+                        function.Signatures.TryGetValue("csharp", out var csharpSigs))
+                    {
+                        foreach (var sig in csharpSigs)
+                        {
+                            if (sig.Contains(" SplashKit."))
+                            {
+                                sb.AppendLine($"        [JSImport(\"SplashKitBackendWASM.{function.Name}\", \"main.js\")]");
+                                sb.AppendLine($"        {CleanSignature(sig)}");
+                                sb.AppendLine();
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        else
+        {


Please can you add a comment that specifies that you are binding C# to JavaScript just to make this clearer?

Oliver-Quail · 2025-04-10T00:31:23Z

CSharpWasm/CSharpCodeRunner/.gitignore

+# Build results
+bin/
+obj/
+.DS_Store


Again please add these to the global .gitignore

Oliver-Quail · 2025-04-10T00:35:11Z

CSharpWasm/CSharpCodeRunner/README.md

+# CSharpWasm
+
+This project enables building and running C# code in the browser using WebAssembly (Wasm).
+
+## Project Structure
+
+- **SplashKitInterop.cs**: This file contains the logic for binding C# code with JavaScript functions, enabling the use of SplashKit functions within the C# environment.
+
+- **CSharpCodeRunner.cs**: A class responsible for compiling C# code, providing the necessary functionality to run the code dynamically.
+
+- **buildAndCopy.sh**: A shell script that builds the project and copies the necessary files into the `Browser_IDE/CSharpWasm` directory. This script helps automate the build process for easy integration with the browser.
+
+### Running the Build and Copy Script
+
+To build the project and copy the necessary files into the `Browser_IDE/CSharpWasm` directory, run the following shell script:
+
+```bash
+./buildAndCopy.sh


I get this is a work in progress but in your next pull request or when you get this to a working state please can you move this file in the documentation folder?

Oliver-Quail · 2025-04-10T00:36:23Z

CSharpWasm/CSharpCodeRunner/runtimeconfig.template.json

+                "name": "browser",
+                "host": "browser"


Just checking that this tells C# to run the wasm in the browser. If so please can you leave a comment noting this. It will mean that others in the future will be more easily able to work on this section of the project

Oliver-Quail · 2025-04-10T00:47:14Z

CSharpWasm/buildAndCopy.sh

+FRAMEWORK_DEST="../Browser_IDE/CSharpWasm/wwwroot/_framework"
+
+# List of files to copy
+FILES=(


Just noting when I tried to run this, I got an error on this line for unexpected character "(". My system is Linux, I'm not sure if this helps but please can you look into this

daosgava added 20 commits December 14, 2024 19:01

Add initial C# WebAssembly project structure and setup

45c3674

Refine .gitignore to streamline ignored files and directories

2b8ae27

Add C# support with compiler and runtime integration

da18768

Refactor C# runtime integration: update event handling and remove unu…

0f58d42

…sed workerEventProcessor

Remove redundant console log for IDE initialization

606ac85

Merge branch 'main' into wasm-csharp-interop

8b9ff86

Update comment for clarity in CSharpCompiler registration

4b302ed

Refactor C# WebAssembly integration: remove run button and related co…

d7f6529

…de, update event handling for compile and run

Remove redundant console log in project initializer for C# project cr…

144c5e5

…eation

CSharpWasm.dll update

2d6035c

Overload write_line function

cff1e1c

add error handling and namespace

f4b75ae

fix indentation, use sample from splash kit website

92583f0

Add comments with future work

4358d72

Improve comments and remove unnecessary methods

de6d8e5

Initial Setup

86654f6

Minor change

d7c7494

add generated file to gitignore

7aaa8c3

improve format, parameters and return type

84116eb

Folder restructuring

f8ecba6

daosgava temporarily deployed to static-site April 4, 2025 07:35 — with GitHub Actions Inactive

cleaning folder structure

a29dd05

daosgava temporarily deployed to static-site April 6, 2025 11:56 — with GitHub Actions Inactive

Oliver-Quail reviewed Apr 10, 2025

View reviewed changes


		let hasErrors = false;

		// If all good, then output the 'compiled' result

Wasm csharp biding generator #117

Are you sure you want to change the base?

Wasm csharp biding generator #117

Uh oh!

Conversation

daosgava commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Uh oh!

github-actions bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Oliver-Quail left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

daosgava commented Apr 4, 2025 •

edited

Loading

github-actions bot commented Apr 4, 2025 •

edited

Loading