AmiWest Lesson 8 - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:07:32Z

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

← Older revision		Revision as of 19:07, 26 January 2025
Line 40:		Line 40:
	The following simple code example uses these tags where an application only expects to send ARexx messages:		The following simple code example uses these tags where an application only expects to send ARexx messages:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	Object *arexx_obj;		Object *arexx_obj;
	STATIC struct Hook reply_hook;		STATIC struct Hook reply_hook;
Line 71:		Line 71:
	To do so, most applications will also define a pointer to an AmigaOS '''Hook''' structure ("reply_hook") to receive incoming messages and responses to sent messages. This standard structure allows us to define a function in our application that will be run when our application receives messages or responses. Once we've successfully obtained an ARexx object giving us an ARexx port, we would set up the hook function like this:		To do so, most applications will also define a pointer to an AmigaOS '''Hook''' structure ("reply_hook") to receive incoming messages and responses to sent messages. This standard structure allows us to define a function in our application that will be run when our application receives messages or responses. Once we've successfully obtained an ARexx object giving us an ARexx port, we would set up the hook function like this:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	STATIC struct Hook reply_hook;		STATIC struct Hook reply_hook;
	[...]		[...]
Line 85:		Line 85:
	While the function we create to be called by the "reply hook" will be passed a number of arguments, we are only concerned with the ARexx message passed to our function. This "RexxMessage" structure has the following basic structure:		While the function we create to be called by the "reply hook" will be passed a number of arguments, we are only concerned with the ARexx message passed to our function. This "RexxMessage" structure has the following basic structure:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct RexxMsg		struct RexxMsg
	{		{
Line 104:		Line 104:
	The following is an example of a simple implementation of a reply function that just prints out the contents of received messages:		The following is an example of a simple implementation of a reply function that just prints out the contents of received messages:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	STATIC VOID reply_callback(struct Hook hook UNUSED, Object o UNUSED, struct RexxMsg *rxm)		STATIC VOID reply_callback(struct Hook hook UNUSED, Object o UNUSED, struct RexxMsg *rxm)
	{		{
Line 128:		Line 128:
	The following code excerpt would search for the Workbench ARexx port:		The following code excerpt would search for the Workbench ARexx port:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	CONST_STRPTR port_name = "WORKBENCH";		CONST_STRPTR port_name = "WORKBENCH";
	IExec->Forbid();		IExec->Forbid();
Line 175:		Line 175:
	To send a message, we only need to add the target port name and our message string, as follows:		To send a message, we only need to add the target port name and our message string, as follows:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	CONST_STRPTR cmd = "HELP";		CONST_STRPTR cmd = "HELP";
	int32 RC,RC2;		int32 RC,RC2;
Line 192:		Line 192:
	Here is some example code of waiting for handling an incoming ARexx message:		Here is some example code of waiting for handling an incoming ARexx message:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	uint32 rxsig = 0, signal;		uint32 rxsig = 0, signal;
	IIntuition->GetAttr(AREXX_SigMask, arexx_obj, &rxsig);		IIntuition->GetAttr(AREXX_SigMask, arexx_obj, &rxsig);
Line 210:		Line 210:
	To start with, if we are create an application meant to receive ARexx commands then we will have to adjust our '''NewObject''' request for a new ARexx Object. In this case, that code might look like:		To start with, if we are create an application meant to receive ARexx commands then we will have to adjust our '''NewObject''' request for a new ARexx Object. In this case, that code might look like:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	arexx_obj = IIntuition->NewObject(NULL, "arexx.class",		arexx_obj = IIntuition->NewObject(NULL, "arexx.class",
	AREXX_HostName, "AREXX-RECEIVER",		AREXX_HostName, "AREXX-RECEIVER",
Line 252:		Line 252:
	In the follow code sample, you can see where we define just such an array of "ARexxCmd" structures.		In the follow code sample, you can see where we define just such an array of "ARexxCmd" structures.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	STATIC struct ARexxCmd Commands[] =		STATIC struct ARexxCmd Commands[] =
	{		{
Line 297:		Line 297:
	An example of a simple function for the "SEND" command entry above could look like this:		An example of a simple function for the "SEND" command entry above could look like this:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	STATIC VOID rexx_Send(struct ARexxCmd ac, struct RexxMsg rxm UNUSED)		STATIC VOID rexx_Send(struct ARexxCmd ac, struct RexxMsg rxm UNUSED)
	{		{
Line 319:		Line 319:
	To call an ARexx script from within your program, we go through the same initialization as for sending ARexx messages - create an ARexx object, define a reply hook, and then call a simple variation of the '''IDoMethod''' function. When calling '''IDoMethod''', instead of providing a command name and target message port name, we provide the name of the ARexx script and allow the port name field to default to the ARexx host. When the '''IDoMethod''' is called, the ARexx host finds and runs the designated script. Here is an example of such a call:		To call an ARexx script from within your program, we go through the same initialization as for sending ARexx messages - create an ARexx object, define a reply hook, and then call a simple variation of the '''IDoMethod''' function. When calling '''IDoMethod''', instead of providing a command name and target message port name, we provide the name of the ARexx script and allow the port name field to default to the ARexx host. When the '''IDoMethod''' is called, the ARexx host finds and runs the designated script. Here is an example of such a call:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	IIntuition->IDoMethod(arexx_obj, AM_EXECUTE, "rx_me_demo.rexx", NULL, NULL, NULL, NULL, NULL);		IIntuition->IDoMethod(arexx_obj, AM_EXECUTE, "rx_me_demo.rexx", NULL, NULL, NULL, NULL, NULL);
	</syntaxhighlight>		</syntaxhighlight>
Line 370:		Line 370:
	This example opens an ARexx port called "AREXX-SENDER", asks the user for the name of a port and a text to send to that port. It is most easily tested by addressing the "WORKBENCH" port (it's almost always there and waiting) and sending it a "HELP" message.		This example opens an ARexx port called "AREXX-SENDER", asks the user for the name of a port and a text to send to that port. It is most easily tested by addressing the "WORKBENCH" port (it's almost always there and waiting) and sending it a "HELP" message.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	************************************************************		************************************************************
Line 581:		Line 581:
	The program from Example One can be used to send commands to this program.		The program from Example One can be used to send commands to this program.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	************************************************************		************************************************************
Line 937:		Line 937:
	This program follows the pattern of Example One above except that it causes an ARexx script to be run instead of sending an ARexx message. Like Example one, it waits for a response and ARexx results are handled by a reply function.		This program follows the pattern of Example One above except that it causes an ARexx script to be run instead of sending an ARexx message. Like Example one, it waits for a response and ARexx results are handled by a reply function.

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

Steven Solie: /* The Application */

2013-05-13T21:14:20Z

The Application

← Older revision		Revision as of 21:14, 13 May 2013
Line 949:		Line 949:
	**		**
	** An exmple of how to call an ARexx macro script from an		** An exmple of how to call an ARexx macro script from an
	** AmigaOS4 C program using ~~OS4~~'s arexx.class.		** AmigaOS4 C program using AmigaOS 4's arexx.class.
	**		**
	** Date: 27-11-2011		** Date: 27-11-2011

Steven Solie: /* EXAMPLE TWO: Receiving ARexx Command Messages */

2013-05-13T21:13:41Z

EXAMPLE TWO: Receiving ARexx Command Messages

← Older revision		Revision as of 21:13, 13 May 2013
Line 593:		Line 593:
	**		**
	** An example of how to receive ARexx messages with an AmigaOS4		** An example of how to receive ARexx messages with an AmigaOS4
	** C program using ~~OS4~~'s arexx.class.		** C program using AmigaOS 4's arexx.class.
	**		**
	** Date: 27-11-2011		** Date: 27-11-2011

Steven Solie: /* EXAMPLE ONE: Sending ARexx Messages */

2013-05-13T21:12:08Z

EXAMPLE ONE: Sending ARexx Messages

← Older revision		Revision as of 21:12, 13 May 2013
Line 382:		Line 382:
	**		**
	** An exmple of how to send AN ARexx message from an AmigaOS4		** An exmple of how to send AN ARexx message from an AmigaOS4
	** C program using ~~OS4~~'s arexx.class.		** C program using AmigaOS 4's arexx.class.
	**		**
	** Date: 02-01-2012 09:19:17		** Date: 02-01-2012 09:19:17

Steven Solie: /* Initialization */

2013-05-13T21:11:47Z

Initialization

← Older revision		Revision as of 21:11, 13 May 2013
Line 7:		Line 7:
	==Initialization==		==Initialization==

	Like much of the current AmigaOS, the support of ARexx operations within C programs has been modernized and simplified using the BOOPSI style of object oriented methods. Under ~~AmigaOS4~~, the requirements to open specific libraries has been further automated with the ~~OS4~~ SDK. To use ARexx messaging within an application, we need to initialize a few things:		Like much of the current AmigaOS, the support of ARexx operations within C programs has been modernized and simplified using the BOOPSI style of object oriented methods. Under AmigaOS 4, the requirements to open specific libraries has been further automated with the AmigaOS SDK. To use ARexx messaging within an application, we need to initialize a few things:
	:* Create a BOOPSI "ARexx Object".		:* Create a BOOPSI "ARexx Object".
	:* Create an hook to a function to receive responses.		:* Create an hook to a function to receive responses.

Steven Solie at 21:09, 13 May 2013

2013-05-13T21:09:09Z

← Older revision		Revision as of 21:09, 13 May 2013
Line 50:		Line 50:
	AREXX_ErrorCode, &errorCode,		AREXX_ErrorCode, &errorCode,
	AREXX_ReplyHook, &reply_hook,		AREXX_ReplyHook, &reply_hook,
	~~TAG_DONE~~);		TAG_END);
	</syntaxhighlight>		</syntaxhighlight>

Line 217:		Line 217:
	AREXX_Commands, Commands,		AREXX_Commands, Commands,
	AREXX_NoSlot, TRUE,		AREXX_NoSlot, TRUE,
	~~TAG_DONE~~);		TAG_END);
	</syntaxhighlight>		</syntaxhighlight>

Line 443:		Line 443:
	AREXX_ErrorCode, &errorCode, // set variable to receive error code, if any		AREXX_ErrorCode, &errorCode, // set variable to receive error code, if any
	AREXX_ReplyHook, &reply_hook, // the hook structure defines how replies will be handled		AREXX_ReplyHook, &reply_hook, // the hook structure defines how replies will be handled
	~~TAG_DONE~~);		TAG_END);

	// if ARexx class was successfuly opened, continue		// if ARexx class was successfuly opened, continue
Line 677:		Line 677:
	AREXX_Commands, Commands, // provide structure of commands recognized by app		AREXX_Commands, Commands, // provide structure of commands recognized by app
	AREXX_NoSlot, TRUE, // set to not number port name (there can only be one)		AREXX_NoSlot, TRUE, // set to not number port name (there can only be one)
	~~TAG_DONE~~);		TAG_END);

	// if ARexx class was successfuly opened, continue		// if ARexx class was successfuly opened, continue
Line 998:		Line 998:
	AREXX_NoSlot, TRUE, // set it so the port name is not enumerated		AREXX_NoSlot, TRUE, // set it so the port name is not enumerated
	AREXX_ReplyHook, &reply_hook, // the hook structure defines how replies will be handled		AREXX_ReplyHook, &reply_hook, // the hook structure defines how replies will be handled
	~~TAG_DONE~~);		TAG_END);

	// if ARexx class was successfuly opened, continue		// if ARexx class was successfuly opened, continue

James Jacobs: Fixed typo

2013-02-27T06:43:23Z

Fixed typo

← Older revision		Revision as of 06:43, 27 February 2013
Line 1,093:		Line 1,093:
	===The Script===		===The Script===

	This is a simple ARexx script that addresses the AmigaOS command line ("COMMAND"), it uses "RequestString" to get a string from the user and then it sends that ~~inpuyt~~ back to the calling application with the "Return" function.		This is a simple ARexx script that addresses the AmigaOS command line ("COMMAND"), it uses "RequestString" to get a string from the user and then it sends that input back to the calling application with the "Return" function.

	<pre>		<pre>

Steven Solie at 00:33, 19 October 2012

2012-10-19T00:33:04Z

← Older revision		Revision as of 00:33, 19 October 2012
Line 360:		Line 360:


			= Examples =
⚫	=EXAMPLE ONE: Sending ARexx Messages=

			To download example code click [[Media:ARexxExamples.lha\|on this link]].

		⚫	==EXAMPLE ONE: Sending ARexx Messages==

	The followig is a demonstration program for sending ARexx messages from an application.		The followig is a demonstration program for sending ARexx messages from an application.
Line 569:		Line 573:
	</syntaxhighlight>		</syntaxhighlight>

	=EXAMPLE TWO: Receiving ARexx Command Messages=		==EXAMPLE TWO: Receiving ARexx Command Messages==

	The following is a demonstration of an application that can receive a number of ARexx command messages.		The following is a demonstration of an application that can receive a number of ARexx command messages.
Line 925:		Line 929:
	</syntaxhighlight>		</syntaxhighlight>

	=EXAMPLE THREE: Calling ARexx Scripts=		==EXAMPLE THREE: Calling ARexx Scripts==

	This application and ARexx script demonstrate a simple case where an application can run an ARexx script and receive results from it.		This application and ARexx script demonstrate a simple case where an application can run an ARexx script and receive results from it.

Steven Solie: /* The Script */

2012-10-16T23:21:25Z

The Script

← Older revision		Revision as of 23:21, 16 October 2012
Line 1,091:		Line 1,091:
	This is a simple ARexx script that addresses the AmigaOS command line ("COMMAND"), it uses "RequestString" to get a string from the user and then it sends that inpuyt back to the calling application with the "Return" function.		This is a simple ARexx script that addresses the AmigaOS command line ("COMMAND"), it uses "RequestString" to get a string from the user and then it sends that inpuyt back to the calling application with the "Return" function.

	~~<code>~~<pre>		<pre>
	/* Small macro script for the small arexxclass demo */		/* Small macro script for the small arexxclass demo */

Line 1,111:		Line 1,111:

	exit		exit
	</pre~~></code~~>		</pre>

Steven Solie: /* The Application */

2012-10-16T23:20:34Z

The Application

← Older revision		Revision as of 23:20, 16 October 2012
Line 933:		Line 933:
	This program follows the pattern of Example One above except that it causes an ARexx script to be run instead of sending an ARexx message. Like Example one, it waits for a response and ARexx results are handled by a reply function.		This program follows the pattern of Example One above except that it causes an ARexx script to be run instead of sending an ARexx message. Like Example one, it waits for a response and ARexx results are handled by a reply function.

			<syntaxhighlight>
	<code><pre>
	/*		/*
	************************************************************		************************************************************
Line 1,085:		Line 1,085:

	}		}
			</syntaxhighlight>
	</pre></code>

	===The Script===		===The Script===