Clipboard Device - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:09:37Z

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

← Older revision		Revision as of 19:09, 26 January 2025
Line 31:		Line 31:
	The clipboard device operates like the other Amiga devices. To use it, you must first open the clipboard device, then send I/O requests to it, and then close it when finished. See [[Exec_Device_I/O\|Exec Device I/O]] for general information on device usage.		The clipboard device operates like the other Amiga devices. To use it, you must first open the clipboard device, then send I/O requests to it, and then close it when finished. See [[Exec_Device_I/O\|Exec Device I/O]] for general information on device usage.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOClipReq		struct IOClipReq
	{		{
Line 60:		Line 60:
	* Open the clipboard device. Call OpenDevice(), passing the IOClipReq.		* Open the clipboard device. Call OpenDevice(), passing the IOClipReq.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct MsgPort *ClipMP = IExec->AllocSysObjectTags(ASOT_PORT, TAG_END);		struct MsgPort *ClipMP = IExec->AllocSysObjectTags(ASOT_PORT, TAG_END);

Line 106:		Line 106:
	The multiple clips are implemented as different units in the clipboard device. The unit is specified at OpenDevice() time.		The multiple clips are implemented as different units in the clipboard device. The unit is specified at OpenDevice() time.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOClipReq *ClipIO;		struct IOClipReq *ClipIO;
	int32 unit;		int32 unit;
Line 128:		Line 128:
	You write to the clipboard device by passing an IOClipReq to the device with CMD_WRITE set in io_Command, the number of bytes to be written set in io_Length and the address of the write buffer set in io_Data.		You write to the clipboard device by passing an IOClipReq to the device with CMD_WRITE set in io_Command, the number of bytes to be written set in io_Length and the address of the write buffer set in io_Data.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	ClipIO->io_Data = (char *) data;		ClipIO->io_Data = (char *) data;
	ClipIO->io_Length = 4;		ClipIO->io_Length = 4;
Line 194:		Line 194:
	A code fragment for doing this:		A code fragment for doing this:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	LONG slen = strlen ("Enterprise");		LONG slen = strlen ("Enterprise");
	BOOL odd = (slen & 1); /* pad byte flag */		BOOL odd = (slen & 1); /* pad byte flag */
Line 236:		Line 236:
	When the final write is done, an update command must be sent to the device to indicate that the writing is complete and the data is available. You update the clipboard device by passing an IOClipReq to the device with CMD_UPDATE set in io_Command.		When the final write is done, an update command must be sent to the device to indicate that the writing is complete and the data is available. You update the clipboard device by passing an IOClipReq to the device with CMD_UPDATE set in io_Command.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	ClipIO->io_Command = CMD_UPDATE;		ClipIO->io_Command = CMD_UPDATE;
	IEXec->DoIO(ClipIO);		IEXec->DoIO(ClipIO);
Line 245:		Line 245:
	When an application performs a post, it must specify a message port for the clipboard to send a message to if it needs the application to satisfy the post with a write called the SatisfyMsg.		When an application performs a post, it must specify a message port for the clipboard to send a message to if it needs the application to satisfy the post with a write called the SatisfyMsg.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct SatisfyMsg		struct SatisfyMsg
	{		{
Line 270:		Line 270:
	You read from the clipboard device by passing an IOClipReq to the device with CMD_READ set in io_Command, the number of bytes to be read set in io_Length and the address of the read buffer set in io_Data.		You read from the clipboard device by passing an IOClipReq to the device with CMD_READ set in io_Command, the number of bytes to be read set in io_Length and the address of the read buffer set in io_Data.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	ClipIO->io_Command = CMD_READ;		ClipIO->io_Command = CMD_READ;
	ClipIO->io_Data = (char *) read_data;		ClipIO->io_Data = (char *) read_data;
Line 288:		Line 288:
	Each OpenDevice() must eventually be matched by a call to CloseDevice().		Each OpenDevice() must eventually be matched by a call to CloseDevice().

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	IExec->CloseDevice(ClipIO);		IExec->CloseDevice(ClipIO);
	</syntaxhighlight>		</syntaxhighlight>
Line 302:		Line 302:
	You specify a hook for the clipboard device by initializing a Hook structure and then passing an IOClipReq to the device with CBD_CHANGEHOOK set in io_Command, 1 set in io_Length, and the address of the Hook structure set in io_Data.		You specify a hook for the clipboard device by initializing a Hook structure and then passing an IOClipReq to the device with CBD_CHANGEHOOK set in io_Command, 1 set in io_Length, and the address of the Hook structure set in io_Data.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOClipReq ClipIO; / Declare the IOClipReq */		struct IOClipReq ClipIO; / Declare the IOClipReq */
	struct Hook ClipHook; / Declare the Hook */		struct Hook ClipHook; / Declare the Hook */
Line 320:		Line 320:
	You remove a hook by passing an IOClipReq to the device with the address of the Hook structure set in io_Data, 0 set in io_Length and CBD_CHANGEHOOK set in io_Command.		You remove a hook by passing an IOClipReq to the device with the address of the Hook structure set in io_Data, 0 set in io_Length and CBD_CHANGEHOOK set in io_Command.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	ClipIO->io_Data = (char ) ClipHook; / point to hook struct */		ClipIO->io_Data = (char ) ClipHook; / point to hook struct */
	ClipIO->io_Length = 0; /* Remove hook from clipboard */		ClipIO->io_Length = 0; /* Remove hook from clipboard */
Line 338:		Line 338:
	=== Clipdemo.c ===		=== Clipdemo.c ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	* Clipdemo.c		* Clipdemo.c
Line 668:		Line 668:
	=== Changehook_Test.c ===		=== Changehook_Test.c ===

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	* Changehook_Test.c		* Changehook_Test.c
Line 799:		Line 799:
	== Support Functions Called from Example Programs ==		== Support Functions Called from Example Programs ==

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/* Cbio.c		/* Cbio.c
	*		*
Line 1,276:		Line 1,276:
	== Include File for the Example Programs ==		== Include File for the Example Programs ==

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/***********************************************************************		/***********************************************************************
	*		*

Steven Solie at 21:25, 6 November 2015

2015-11-06T21:25:23Z

← Older revision		Revision as of 21:25, 6 November 2015
Line 228:		Line 228:
	</syntaxhighlight>		</syntaxhighlight>

	The fragment above does no error checking because it’s a fragment. You should always error check. See the example programs at the end of this ~~chapter~~ for the proper method of error checking.		The fragment above does no error checking because it’s a fragment. You should always error check. See the example programs at the end of this article for the proper method of error checking.

	{{Note\|title=IFFParse That Data!\|text=Keep in mind that the functions in the iffparse.library can be used to write data to the clipboard. See the [[IFFParse_Library\|IFFParse Library]] for more information.}}		{{Note\|title=IFFParse That Data!\|text=Keep in mind that the functions in the iffparse.library can be used to write data to the clipboard. See the [[IFFParse_Library\|IFFParse Library]] for more information.}}
Line 316:		Line 316:
	</syntaxhighlight>		</syntaxhighlight>

	It also assumes that the function HookFunc() has been coded. One of the example programs at the end of this ~~chapter~~ has hook processing in it. See the include file utility/hooks.h and [[Utility_Library\|Utility Library]] for further information on hooks.		It also assumes that the function HookFunc() has been coded. One of the example programs at the end of this article has hook processing in it. See the include file utility/hooks.h and [[Utility_Library\|Utility Library]] for further information on hooks.

	You remove a hook by passing an IOClipReq to the device with the address of the Hook structure set in io_Data, 0 set in io_Length and CBD_CHANGEHOOK set in io_Command.		You remove a hook by passing an IOClipReq to the device with the address of the Hook structure set in io_Data, 0 set in io_Length and CBD_CHANGEHOOK set in io_Command.

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

2013-05-23T20:05:13Z

Writing to the Clipboard Device

← Older revision		Revision as of 20:05, 23 May 2013
Line 194:		Line 194:
	A code fragment for doing this:		A code fragment for doing this:

			<syntaxhighlight>
	<pre>
	LONG slen = strlen (~~"~~Enterprise~~"~~);		LONG slen = strlen ("Enterprise");
	BOOL odd = (slen &~~amp;~~ 1); /* pad byte flag */		BOOL odd = (slen & 1); /* pad byte flag */

	/* set length depending on whether string is odd or even length */		/* set length depending on whether string is odd or even length */
Line 202:		Line 202:

	/* Reset the clip id */		/* Reset the clip id */
	ClipIO-~~>~~io_ClipID = 0;		ClipIO->io_ClipID = 0;
	ClipIO-~~>~~io_Offset = 0;		ClipIO->io_Offset = 0;

	error = writeLong ((LONG ) ~~"~~FORM~~"~~);/ ~~"~~FORM~~"~~ */		error = writeLong ((LONG ) "FORM");/ "FORM" */

	length += 12; /* add 12 bytes for FTXT, CHRS &~~amp;~~ length byte to string length */		length += 12; /* add 12 bytes for FTXT, CHRS & length byte to string length */
	error = writeLong (&~~amp;~~length);		error = writeLong (&length);
	error = writeLong ((LONG ) ~~"~~FTXT~~"~~);/ ~~"~~FTXT~~"~~ for example */		error = writeLong ((LONG ) "FTXT");/ "FTXT" for example */
	error = writeLong ((LONG ) ~~"~~CHRS~~"~~);/ ~~"~~CHRS~~"~~ for example */		error = writeLong ((LONG ) "CHRS");/ "CHRS" for example */
	error = writeLong (&~~amp;~~slen); /* # (length of string) */		error = writeLong (&slen); /* # (length of string) */

	ClipIO-~~>~~io_Command = CMD_WRITE;		ClipIO->io_Command = CMD_WRITE;
	ClipIO-~~>~~io_Data = (char *) string;		ClipIO->io_Data = (char *) string;
	ClipIO-~~>~~io_Length = slen; /* length of string */		ClipIO->io_Length = slen; /* length of string */
	error = (LONG) DoIO (clipIO); /* text string */		error = (LONG) IExec->DoIO (clipIO); /* text string */


	LONG writeLong (LONG * ldata)		LONG writeLong (LONG * ldata)
	{		{
	ClipIO-~~>~~io_Command = CMD_WRITE;		ClipIO->io_Command = CMD_WRITE;
	ClipIO-~~>~~io_Data = (char *) ldata;		ClipIO->io_Data = (char *) ldata;
	ClipIO-~~>~~io_Length = 4L;		ClipIO->io_Length = 4L;
	return ( (LONG) DoIO (clipIO) );		return ( (LONG) IExec->DoIO (clipIO) );
	}		}
			</syntaxhighlight>
	</pre>

	The fragment above does no error checking because it’s a fragment. You should always error check. See the example programs at the end of this chapter for the proper method of error checking.		The fragment above does no error checking because it’s a fragment. You should always error check. See the example programs at the end of this chapter for the proper method of error checking.

Steven Solie: /* Opening the Clipboard Device */

2013-04-04T15:15:40Z

Opening the Clipboard Device

← Older revision		Revision as of 15:15, 4 April 2013
Line 56:		Line 56:
	Three primary steps are required to open the clipboard device:		Three primary steps are required to open the clipboard device:

	* Create a message port using ~~CreatePort~~(). Reply messages from the device must be directed to a message port.		* Create a message port using AllocSysObject() and ASOT_PORT type. Reply messages from the device must be directed to a message port.
	* Create an extended I/O request structure of type IOClipReq using ~~CreateExtIO~~().		* Create an extended I/O request structure of type IOClipReq using AllocSysObject() and ASOT_IOREQUEST type.
	* Open the clipboard device. Call OpenDevice(), passing the IOClipReq.		* Open the clipboard device. Call OpenDevice(), passing the IOClipReq.

Steven Solie at 20:03, 3 April 2013

2013-04-03T20:03:29Z

← Older revision		Revision as of 20:03, 3 April 2013
Line 1:		Line 1:
	[[Category:Devices\|Clipboard]]~~{{WIP}}~~		[[Category:Devices\|Clipboard]]

	== Clipboard Device ==		== Clipboard Device ==

Steven Solie: /* Clipdemo.c */

2013-04-03T20:03:05Z

Clipdemo.c

Show changes

Steven Solie: /* Support Functions Called from Example Programs */

2013-04-03T19:42:55Z

Support Functions Called from Example Programs

Show changes

Steven Solie: /* Example Clipboard Programs */

2013-03-28T18:57:12Z

Example Clipboard Programs

Show changes

Steven Solie: /* Include File for the Example Programs */

2013-03-28T18:52:34Z

Include File for the Example Programs

← Older revision		Revision as of 18:52, 28 March 2013
Line 1,337:		Line 1,337:
	};		};

	#define MAKE_ID(a,b,c,d) ((a>>24L) \| (b>>16L) \| (c>>8L) \| d)		#define MAKE_ID(a,b,c,d) ((a<<24L) \| (b<<16L) \| (c<<8L) \| d)

	#define ID_FORM MAKE_ID('F','O','R','M')		#define ID_FORM MAKE_ID('F','O','R','M')

Steven Solie: /* Example Clipboard Programs */

2013-03-28T18:52:08Z

Example Clipboard Programs

← Older revision		Revision as of 18:52, 28 March 2013
Line 679:		Line 679:

	return(0);		return(0);
			}
	}</pre>
	<pre>/*		</pre>

			<syntaxhighlight>
			/*
	* Changehook_Test.c		* Changehook_Test.c
	*		*
Line 818:		Line 821:
	CloseCB(clipIO);		CloseCB(clipIO);
	}		}
			}
	}</pre>
			</syntaxhighlight>

	== Support Functions Called from Example Programs ==		== Support Functions Called from Example Programs ==