Input output guide #144

AtibQur · 2024-10-14T10:15:07Z

No description provided.

alexp-sssup · 2024-10-14T10:40:35Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

@@ -0,0 +1,49 @@
+---
+title: input and output CheerpX


Suggested change

title: input and output CheerpX

title: Input and output

alexp-sssup · 2024-10-14T10:41:06Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

@@ -0,0 +1,49 @@
+---
+title: input and output CheerpX
+description: Summarization on how to get data in and out of CheerpX VM


Suggested change

description: Summarization on how to get data in and out of CheerpX VM

description: Techniques for getting data in and out of CheerpX virtual machine

alexp-sssup · 2024-10-14T10:42:13Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+## CheerpX console input and output
+
+CheerpX provides two options for handling console input and output: the `built-in` console and a `custom` console. The purpose of these consoles are to interact with the running application, execute commands and, view output. The custom console allows you to create an interface that fits the specific needs of your application.


Prefer italics to code for built-in and custom. We should only use the code markers for names which corresponds to APIs

alexp-sssup · 2024-10-14T10:44:11Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+## CheerpX console input and output
+
+CheerpX provides two options for handling console input and output: the `built-in` console and a `custom` console. The purpose of these consoles are to interact with the running application, execute commands and, view output. The custom console allows you to create an interface that fits the specific needs of your application.


Suggested change

CheerpX provides two options for handling console input and output: the `built-in` console and a `custom` console. The purpose of these consoles are to interact with the running application, execute commands and, view output. The custom console allows you to create an interface that fits the specific needs of your application.

CheerpX provides two options for handling console input and output: the `built-in` console and a `custom` console. The purpose of the console is to interact with the running application via standard input and output..

alexp-sssup · 2024-10-14T10:45:02Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+**Built-in console**
+
+The CheerpX VM comes with a `built-in` console that mimics traditional console behavior. The `built-in` console in CheerpX allows for standard input and output operations, similar to typical command-line environments. You can use standard I/O functions like printf and scanf within your C/C++ programs.


Suggested change

The CheerpX VM comes with a `built-in` console that mimics traditional console behavior. The `built-in` console in CheerpX allows for standard input and output operations, similar to typical command-line environments. You can use standard I/O functions like printf and scanf within your C/C++ programs.

CheerpX comes with a _built-in_ console that mimics traditional console behavior. The _built-in_ console in CheerpX allows for standard input and output operations, similar to typical command-line environments. You can use standard I/O functions like printf and scanf within your C/C++ programs.

alexp-sssup · 2024-10-14T10:46:02Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+For more information, visit the [CheerpX console].
+
+**Custom console**


Should this be ### titles?

alexp-sssup · 2024-10-14T10:49:11Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+**Custom console**
+
+CheerpX also supports a `custom` console that allows developers to capture output programmatically. This feature enables you to accumulate program output into a JavaScript string. You can implement your `custom` logging mechanism to redirect the output to a variable, which can be manipulated or displayed as needed.


Suggested change

CheerpX also supports a `custom` console that allows developers to capture output programmatically. This feature enables you to accumulate program output into a JavaScript string. You can implement your `custom` logging mechanism to redirect the output to a variable, which can be manipulated or displayed as needed.

CheerpX also supports a `custom` console that allows developers to capture output, and provide input, programmatically. This feature is useful to integrate with a more complete terminal implementation such as xterm.js [TODO ADD LINK TO LIB]. We use xterm.js ourselves for our public WebVM environment.

Another possible use for the custom console it accumulating program output into a JavaScript string. You can achieve this with the following snippet [ADD CODE, this is not documented elsewhere]

alexp-sssup · 2024-10-14T10:51:41Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+`IDBDevice` provides a persistent, read-write filesystem using the browser’s IndexedDB. It’s ideal for storing data that should persist between sessions. You can use the `readFileAsBlob` method to read files from an IDBDevice as Blob objects.
+
+You can copy files from various filesystems into the `IDBDevice`. This allows you to make these files accesible.


Suggested change

You can copy files from various filesystems into the `IDBDevice`. This allows you to make these files accesible.

If the file you want to read is not yet in an `IDBDevice`, you can copy files by running commands inside the virtual machine to make them accessible. [ADD AN EXAMPLE, e.g. using `cp` via `cx.run`]

alexp-sssup · 2024-10-14T10:53:05Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+## Accessing JS Data in the Filesystem via DataDevice
+
+The `DataDevice` in CheerpX allows access to JavaScript data in the filesystem. This device can interact with data stored in memory or other JavaScript objects. It is particularly useful for transferring data between JavaScript and the compiled C/C++ code.


Suggested change

The `DataDevice` in CheerpX allows access to JavaScript data in the filesystem. This device can interact with data stored in memory or other JavaScript objects. It is particularly useful for transferring data between JavaScript and the compiled C/C++ code.

The `DataDevice` in CheerpX allows access to JavaScript data from the filesystem. This device can read-only access to `Uint8Array`s and JavaScript `Strings`s. It is particularly useful for transferring data from JavaScript to processes running in CheerpX.

alexp-sssup · 2024-10-14T10:53:50Z

sites/cheerpx/src/content/docs/11-guides/input-output.md

+
+Currently, CheerpX doesn't directly support capturing stdout from running programs. Therefore, The IDBDevice allows you to use `.readFileAsBlob()` for capturing stdout after redirecting stdout to a file in `bash`. You can then read this file as a Blob.
+
+For more information on capturing stdout, see [Frequently Asked Questions].


Move the whole answer outside of the FAQ, this document is a much better place for it. Also integrated it with the previously mentioned solution of using a custom console.

AtibQur added 3 commits October 14, 2024 11:33

Add input-output guide

b6f7d58

Add clarity

b9471e5

Removed excessive information

879403b

AtibQur requested a review from GabrielaReyna as a code owner October 14, 2024 10:15

alexp-sssup reviewed Oct 14, 2024

View reviewed changes

Text changes to input-output, added content to faq

7b81e2a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Input output guide #144

Input output guide #144

AtibQur commented Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

alexp-sssup Oct 14, 2024

	description: Summarization on how to get data in and out of CheerpX VM
	description: Techniques for getting data in and out of CheerpX virtual machine


		## CheerpX console input and output

		CheerpX provides two options for handling console input and output: the `built-in` console and a `custom` console. The purpose of these consoles are to interact with the running application, execute commands and, view output. The custom console allows you to create an interface that fits the specific needs of your application.


		Built-in console

		The CheerpX VM comes with a `built-in` console that mimics traditional console behavior. The `built-in` console in CheerpX allows for standard input and output operations, similar to typical command-line environments. You can use standard I/O functions like printf and scanf within your C/C++ programs.

	The CheerpX VM comes with a `built-in` console that mimics traditional console behavior. The `built-in` console in CheerpX allows for standard input and output operations, similar to typical command-line environments. You can use standard I/O functions like printf and scanf within your C/C++ programs.
	CheerpX comes with a _built-in_ console that mimics traditional console behavior. The _built-in_ console in CheerpX allows for standard input and output operations, similar to typical command-line environments. You can use standard I/O functions like printf and scanf within your C/C++ programs.


		For more information, visit the [CheerpX console].

		Custom console


		Custom console

		CheerpX also supports a `custom` console that allows developers to capture output programmatically. This feature enables you to accumulate program output into a JavaScript string. You can implement your `custom` logging mechanism to redirect the output to a variable, which can be manipulated or displayed as needed.

-CheerpX also supports a `custom` console that allows developers to capture output programmatically. This feature enables you to accumulate program output into a JavaScript string. You can implement your `custom` logging mechanism to redirect the output to a variable, which can be manipulated or displayed as needed.
+CheerpX also supports a `custom` console that allows developers to capture output, and provide input, programmatically. This feature is useful to integrate with a more complete terminal implementation such as xterm.js [TODO ADD LINK TO LIB]. We use xterm.js ourselves for our public WebVM environment.
+Another possible use for the custom console it accumulating program output into a JavaScript string. You can achieve this with the following snippet [ADD CODE, this is not documented elsewhere]


		`IDBDevice` provides a persistent, read-write filesystem using the browser’s IndexedDB. It’s ideal for storing data that should persist between sessions. You can use the `readFileAsBlob` method to read files from an IDBDevice as Blob objects.

		You can copy files from various filesystems into the `IDBDevice`. This allows you to make these files accesible.

	You can copy files from various filesystems into the `IDBDevice`. This allows you to make these files accesible.
	If the file you want to read is not yet in an `IDBDevice`, you can copy files by running commands inside the virtual machine to make them accessible. [ADD AN EXAMPLE, e.g. using `cp` via `cx.run`]


		## Accessing JS Data in the Filesystem via DataDevice

		The `DataDevice` in CheerpX allows access to JavaScript data in the filesystem. This device can interact with data stored in memory or other JavaScript objects. It is particularly useful for transferring data between JavaScript and the compiled C/C++ code.


		Currently, CheerpX doesn't directly support capturing stdout from running programs. Therefore, The IDBDevice allows you to use `.readFileAsBlob()` for capturing stdout after redirecting stdout to a file in `bash`. You can then read this file as a Blob.

		For more information on capturing stdout, see [Frequently Asked Questions].

Input output guide #144

Are you sure you want to change the base?

Input output guide #144

Conversation

AtibQur commented Oct 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment