Console Device - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:36:02Z

Text replacement - "<syntaxhighlight>" to "<syntaxhighlight lang="C" line>"

← Older revision		Revision as of 19:36, 26 January 2025
Line 47:		Line 47:
	The I/O request used by the console device is called IOStdReq.		The I/O request used by the console device is called IOStdReq.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOStdReq		struct IOStdReq
	{		{
Line 129:		Line 129:
	See the include file devices/conunit.h for the flag definitions and the SDK for an explanation of the flags.		See the include file devices/conunit.h for the flag definitions and the SDK for an explanation of the flags.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct NewWindow nw =		struct NewWindow nw =
	{		{
Line 184:		Line 184:
	All I/O requests must be complete before CloseDevice(). If any requests are still pending, abort them with AbortIO().		All I/O requests must be complete before CloseDevice(). If any requests are still pending, abort them with AbortIO().

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	if (!(IExec->CheckIO(ConsIO)))		if (!(IExec->CheckIO(ConsIO)))
	IExec->AbortIO(ConsIO); /* Ask device to abort any pending requests */		IExec->AbortIO(ConsIO); /* Ask device to abort any pending requests */
Line 220:		Line 220:
	You write to the console device by passing an I/O request to the device with a pointer to the write buffer set in io_Data, the number of bytes in the buffer set in io_Length and CMD_WRITE set in io_Command.		You write to the console device by passing an I/O request to the device with a pointer to the write buffer set in io_Data, the number of bytes in the buffer set in io_Length and CMD_WRITE set in io_Command.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	CONST_STRPTR outstring= "Make it so";		CONST_STRPTR outstring= "Make it so";

Line 231:		Line 231:
	You may also send NULL-terminated strings to the console device in the same manner except that io_Length must be set to -1.		You may also send NULL-terminated strings to the console device in the same manner except that io_Length must be set to -1.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	ConsIO->io_Data = "\033[3mOh boy.";		ConsIO->io_Data = "\033[3mOh boy.";
	ConsIO->io_Length = -1;		ConsIO->io_Length = -1;
Line 475:		Line 475:
	You read from the console device by passing an I/O request to the device with a pointer to the read buffer set in io_Data, the number of bytes in the buffer set in io_Length and CMD_READ set in io_Command.		You read from the console device by passing an I/O request to the device with a pointer to the read buffer set in io_Data, the number of bytes in the buffer set in io_Length and CMD_READ set in io_Command.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	#define READ_BUFFER_SIZE 25		#define READ_BUFFER_SIZE 25
	char ConsoleReadBuffer[READ_BUFFER_SIZE];		char ConsoleReadBuffer[READ_BUFFER_SIZE];
Line 489:		Line 489:
	After sending the read request, your program can wait on a combination of signal bits including that of the reply port you created. The following fragment demonstrates waiting on both a queued console read request, and Window IDCMP messages:		After sending the read request, your program can wait on a combination of signal bits including that of the reply port you created. The following fragment demonstrates waiting on both a queued console read request, and Window IDCMP messages:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	uint32 conreadsig = 1 << ConsoleMP->mp_SigBit;		uint32 conreadsig = 1 << ConsoleMP->mp_SigBit;
	uint32 windowsig = 1 << win->UserPort->mp_SigBit;		uint32 windowsig = 1 << win->UserPort->mp_SigBit;
Line 804:		Line 804:
	* Close the console device when you are finished.		* Close the console device when you are finished.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	#include <devices/conunit.h>		#include <devices/conunit.h>

Line 833:		Line 833:
	To use the commands with the CONU_LIBRARY console unit, you follow the same steps that were outlined in [[#Opening the Console Device\|Opening the Console Device]].		To use the commands with the CONU_LIBRARY console unit, you follow the same steps that were outlined in [[#Opening the Console Device\|Opening the Console Device]].

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct KeyMap keymap; / pointer to keymap */		struct KeyMap keymap; / pointer to keymap */

Line 885:		Line 885:
	The following is a console device demonstration program with supporting routines:		The following is a console device demonstration program with supporting routines:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	* Console.c		* Console.c

Steven Solie: /* Where Is All the Keymap Information? */

2015-11-06T19:27:35Z

Where Is All the Keymap Information?

← Older revision		Revision as of 19:27, 6 November 2015
Line 871:		Line 871:

	Again, as in the previous code fragment, this is not complete and you should only use it as a guide.		Again, as in the previous code fragment, this is not complete and you should only use it as a guide.

	== Where Is All the Keymap Information? ==

	Unlike previous editions of this chapter, this one has a very small amount of keymap information. Keymap information is now contained, appropriately enough, in the [[Keymap_Library\|Keymap Library]].

	== Console Device Caveats ==		== Console Device Caveats ==

Steven Solie: /* Using the Console Device Without a Window */

2015-11-06T19:26:57Z

Using the Console Device Without a Window

← Older revision		Revision as of 19:26, 6 November 2015
Line 831:		Line 831:
	The code fragment shows only the steps outlined above, it is not complete in any sense of the word. For a complete example of using a console device function, see the ''rawkey.c'' code example in the [[Intuition_Keyboard\|Intuition Keyboard]]. The example uses the RawKeyConvert() function.		The code fragment shows only the steps outlined above, it is not complete in any sense of the word. For a complete example of using a console device function, see the ''rawkey.c'' code example in the [[Intuition_Keyboard\|Intuition Keyboard]]. The example uses the RawKeyConvert() function.

	To use the commands with the CONU_LIBRARY console unit, you follow the same steps that were outlined in ~~the “Opening~~ the Console ~~Device”~~ ~~section~~ ~~of this~~ ~~chapter~~.		To use the commands with the CONU_LIBRARY console unit, you follow the same steps that were outlined in [[#Opening the Console Device\|Opening the Console Device]].

	<syntaxhighlight>		<syntaxhighlight>

Steven Solie: /* About Console I/O */

2015-11-06T19:25:54Z

About Console I/O

← Older revision		Revision as of 19:25, 6 November 2015
Line 198:		Line 198:
	Console I/O is closely associated with the Amiga Intuition interface; a console must be tied to a window that is already opened. From the Window data structure, the console device determines how many characters it can display on a line and how many lines of text it can display in a window without clipping at any edge.		Console I/O is closely associated with the Amiga Intuition interface; a console must be tied to a window that is already opened. From the Window data structure, the console device determines how many characters it can display on a line and how many lines of text it can display in a window without clipping at any edge.

	You can open the console device many times, if you wish. The result of each open call is a new console unit. AmigaDOS and Intuition see to it that only one window is currently active and its console, if any, is the only one (with a few exceptions) that receives notification of input events, such as keystrokes. Later in this ~~chapter~~ you will see that other Intuition events can be sensed by the console device as well.		You can open the console device many times, if you wish. The result of each open call is a new console unit. AmigaDOS and Intuition see to it that only one window is currently active and its console, if any, is the only one (with a few exceptions) that receives notification of input events, such as keystrokes. Later in this article you will see that other Intuition events can be sensed by the console device as well.

	{{Note\|title=Introducing...\|text=For this entire ~~chapter~~ the characters <CSI> represent the ''control sequence introducer''. For output you may use either the two-character sequence <Esc>[ (0x1B 0x5B) or the one-byte value 0x9B. For input you will receive 0x9B unless the sequence has been typed by the user.}}		{{Note\|title=Introducing...\|text=For this entire article the characters <CSI> represent the ''control sequence introducer''. For output you may use either the two-character sequence <Esc>[ (0x1B 0x5B) or the one-byte value 0x9B. For input you will receive 0x9B unless the sequence has been typed by the user.}}

	=== Exec Functions and the Console Device ===		=== Exec Functions and the Console Device ===

Steven Solie: /* Hints for Writing Text */

2015-09-30T02:25:48Z

Hints for Writing Text

← Older revision		Revision as of 02:25, 30 September 2015
Line 249:		Line 249:

	If you do not want to wait for all Write requests, you can set the IOF_WAIT_WRITE bit in the io_Flags byte before calling CMD_WRITE. This flag bit has the same effect as opening the console with the CONFLAG_SYNC_WRITES set, but its scope is limited to the current IORequest.		If you do not want to wait for all Write requests, you can set the IOF_WAIT_WRITE bit in the io_Flags byte before calling CMD_WRITE. This flag bit has the same effect as opening the console with the CONFLAG_SYNC_WRITES set, but its scope is limited to the current IORequest.

	=== Hints for Writing Text ===

	You must keep in mind that the console device locks all layers while writing text. To avoid, problems with this, it is best to send smaller rather larger numbers of character to be written. We recommend no more than 256 bytes per write as the optimum size.

	=== Control Sequences for Window Output ===		=== Control Sequences for Window Output ===

Steven Solie: /* Using the Console Device Without a Window */

2015-09-29T17:10:11Z

Using the Console Device Without a Window

← Older revision		Revision as of 17:10, 29 September 2015
Line 813:		Line 813:
	int main()		int main()
	{		{
	struct IOStdReq ConsIO = {0};		struct IOStdReq ConsIO = {0};

	/* Open the device with CONU_LIBRARY for function use */		/* Open the device with CONU_LIBRARY for function use */
	if (0 == IExec->OpenDevice("console.device", CONU_LIBRARY, (struct IORequest *)&ConsIO, 0))		if (0 == IExec->OpenDevice("console.device", CONU_LIBRARY, (struct IORequest *)&ConsIO, 0))
	{		{
	/* Set the base address variable to the device library vector */		/* Set the base address variable to the device library vector */
	struct ConsoleDevice ConsoleDevice = (struct ConsoleDevice )ConsIO.io_Device;		struct ConsoleDevice ConsoleDevice = (struct ConsoleDevice )ConsIO.io_Device;
	struct ConsoleIFace IConsole = (struct ConsoleIFace)		struct ConsoleIFace IConsole = (struct ConsoleIFace)
	IExec->GetInterface((struct Library*)ConsoleDevice, "main", 1, NULL);		IExec->GetInterface((struct Library*)ConsoleDevice, "main", 1, NULL);

	.		.
Line 829:		Line 829:
	IExec->DropInterface((struct Interface *)IConsole);		IExec->DropInterface((struct Interface *)IConsole);
	IExec->CloseDevice(ConsIO);		IExec->CloseDevice(ConsIO);
	}		}
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	The code fragment shows only the steps outlined above, it is not complete in any sense of the word. For a complete example of using a console device function, see the ''rawkey.c'' code example in the [[~~Intuition_Mouse_and_Keyboard~~\|Intuition ~~Mouse and~~ Keyboard]]. The example uses the RawKeyConvert() function.		The code fragment shows only the steps outlined above, it is not complete in any sense of the word. For a complete example of using a console device function, see the ''rawkey.c'' code example in the [[Intuition_Keyboard\|Intuition Keyboard]]. The example uses the RawKeyConvert() function.

	To use the commands with the CONU_LIBRARY console unit, you follow the same steps that were outlined in the “Opening the Console Device” section of this chapter.		To use the commands with the CONU_LIBRARY console unit, you follow the same steps that were outlined in the “Opening the Console Device” section of this chapter.

Steven Solie: /* Writing to the Console Device */

2015-09-29T16:30:27Z

Writing to the Console Device

← Older revision		Revision as of 16:30, 29 September 2015
Line 239:		Line 239:

	The fragment above will output the string “Oh boy.” in italics. Keep in mind that setting the text rendition to italics will remain in effect until you specifically instruct the console device to change it to another text style.		The fragment above will output the string “Oh boy.” in italics. Keep in mind that setting the text rendition to italics will remain in effect until you specifically instruct the console device to change it to another text style.

			=== Synchronized Writes ===

			Synchronized writes were the only option for Console Device before version 53.38. Returning from the Write call means that the data has been transferred from the caller's buffer and the IORequest structure contents are no longer required. The data may not yet have been written to the display and any effects caused by the data (e.g. change of cursor position) may not yet have started or been completed.

			If the Console was opened in legacy mode (no TABBED or HISTORY options), then the SYNCWRITES option is forced for greater compatibility with older applications. Otherwise, the Console is opened with synchronized writes disabled. This enables the application to continue to do work while the Console works in parallel.

			You can still force the Write operation to block until completed by opening the Console with the CONFLAG_SYNC_WRITES set or (for a Shell) including the option SYNCWRITES in the command line.

			If you do not want to wait for all Write requests, you can set the IOF_WAIT_WRITE bit in the io_Flags byte before calling CMD_WRITE. This flag bit has the same effect as opening the console with the CONFLAG_SYNC_WRITES set, but its scope is limited to the current IORequest.

	=== Hints for Writing Text ===		=== Hints for Writing Text ===

Steven Solie: /* Control Sequences for Window Output */

2015-09-29T16:13:54Z

Control Sequences for Window Output

@@ Line 345: / Line 345: @@
 |-
 | 4 || Underscore
 |-
 | 7 || Reversed character/cell colors
@@ Line 355: / Line 359: @@
 |-
 | 24 || Underscore off (V36)
 |-
 | 27 || Reversed off (V36)
 |-
 | 28 || Concealed off (V36)
 |}
@@ Line 392: / Line 402: @@
 ==== Set Graphic Rendition Implementation Notes ====
 The sequences in the next table are not ANSI standard sequences, they are private Amiga sequences. In these command descriptions, length, width, and offset are comprised of one or more ASCII digits, defining a decimal value.

Steven Solie: /* Hints for Writing Text */

2015-09-29T15:53:45Z

Hints for Writing Text

← Older revision		Revision as of 15:53, 29 September 2015
Line 242:		Line 242:
	=== Hints for Writing Text ===		=== Hints for Writing Text ===

	You must keep in mind that the console device locks all layers while writing text. To avoid, problems with this, it is best to send smaller rather larger numbers of character to be written. We recommend no more than 256 bytes per write as the optimum size		You must keep in mind that the console device locks all layers while writing text. To avoid, problems with this, it is best to send smaller rather larger numbers of character to be written. We recommend no more than 256 bytes per write as the optimum size.

	If your console is attached to a V1.2/1.3 SuperBitmap window, you will not see a cursor rendered. For output speed and compatibility with future OS versions which may visibly render the cursor, you should send the cursor-off sequence (ESC[0 p) whenever you open or reset (ESCc) a SuperBitmap window’s console.

	=== Control Sequences for Window Output ===		=== Control Sequences for Window Output ===

Steven Solie: /* Writing to the Console Device */

2015-09-29T15:48:47Z

Writing to the Console Device

← Older revision		Revision as of 15:48, 29 September 2015
Line 224:		Line 224:

	ConsIO->io_Data = outstring;		ConsIO->io_Data = outstring;
	ConsIO->io_Length = ~~strlen~~(outstring);		ConsIO->io_Length = IUtility->Strlen(outstring);
	ConsIO->io_Command = CMD_WRITE;		ConsIO->io_Command = CMD_WRITE;
	IExec->DoIO(ConsIO);		IExec->DoIO(ConsIO);