Commodities Exchange Library - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:08:27Z

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

Frédéric Khannouf: Replaced a "stdio" printf by a DOS Printf, as stdio.h is not included in this source example

2020-10-22T08:29:04Z

Replaced a "stdio" printf by a DOS Printf, as stdio.h is not included in this source example

← Older revision		Revision as of 08:29, 22 October 2020
Line 243:		Line 243:
	case CXM_COMMAND:		case CXM_COMMAND:
	/* Commodities has sent a command */		/* Commodities has sent a command */
	~~printf~~("A command: ");		IDOS->Printf("A command: ");
	switch(msgid)		switch(msgid)
	{		{

Daniel Jedlicka: Fixed wrong qualifier strings for the "rawmouse" class string.

2015-12-06T21:09:12Z

Fixed wrong qualifier strings for the "rawmouse" class string.

← Older revision		Revision as of 21:09, 6 December 2015
Line 402:		Line 402:
	\| "repeat" \|\| IEQUALIFIER_REPEAT		\| "repeat" \|\| IEQUALIFIER_REPEAT
	\|-		\|-
	\| "~~midbutton~~" \|\| IEQUALIFIER_MIDBUTTON		\| "mouse_middlepress" \|\| IEQUALIFIER_MIDBUTTON
	\|-		\|-
	\| "~~rbutton~~" \|\| IEQUALIFIER_RBUTTON		\| "mouse_rightpress" \|\| IEQUALIFIER_RBUTTON
	\|-		\|-
	\| "~~leftbutton~~" \|\| IEQUALIFIER_LEFTBUTTON		\| "mouse_leftpress" \|\| IEQUALIFIER_LEFTBUTTON
	\|-		\|-
	\| "relativemouse" \|\| IEQUALIFIER_RELATIVEMOUSE		\| "relativemouse" \|\| IEQUALIFIER_RELATIVEMOUSE
Line 450:		Line 450:

	<pre>		<pre>
	"rawmouse ~~rbutton~~"		"rawmouse mouse_rightpress"
	</pre>		</pre>

Daniel Jedlicka: Replaced BYTE, ULONG and LONG with int8, uint32 and int32, respectively.

2015-12-06T09:06:16Z

Replaced BYTE, ULONG and LONG with int8, uint32 and int32, respectively.

← Older revision		Revision as of 09:06, 6 December 2015
Line 1,238:		Line 1,238:
	CONST_STRPTR newshell = "\rllehswen"; /* "newshell" spelled backwards */		CONST_STRPTR newshell = "\rllehswen"; /* "newshell" spelled backwards */
	struct InputEvent *ie = NULL;		struct InputEvent *ie = NULL;
	~~ULONG~~ cxsigflag;		uint32 cxsigflag;

	#define TEMPLATE "HOTKEY/K,CX_PRIORITY/N"		#define TEMPLATE "HOTKEY/K,CX_PRIORITY/N"
Line 1,255:		Line 1,255:
	struct RDArgs *argsdata = NULL;		struct RDArgs *argsdata = NULL;
	int32 rargs[ARG_MAX] = {0};		int32 rargs[ARG_MAX] = {0};
	~~BYTE~~ priority = 0;		int8 priority = 0;

	signal(SIGINT, SIG_IGN);		signal(SIGINT, SIG_IGN);
Line 1,266:		Line 1,266:
	{		{
	if (rargs[ARG_PRIORITY])		if (rargs[ARG_PRIORITY])
	priority = (~~BYTE~~)(uint32 )rargs[ARG_PRIORITY];		priority = (int8)(uint32 )rargs[ARG_PRIORITY];
	if ((broker_mp = IExec->AllocSysObject(ASOT_PORT, NULL)))		if ((broker_mp = IExec->AllocSysObject(ASOT_PORT, NULL)))
	{		{
Line 1,332:		Line 1,332:
	extern struct MsgPort *broker_mp;		extern struct MsgPort *broker_mp;
	extern CxObj *broker;		extern CxObj *broker;
	extern ~~ULONG~~ cxsigflag;		extern uint32 cxsigflag;
	CxMsg *msg = NULL;		CxMsg *msg = NULL;
	~~ULONG~~ sigrcvd, msgid, msgtype;		uint32 sigrcvd, msgid, msgtype;
	~~LONG~~ returnvalue = 1L;		int32 returnvalue = 1L;

	while (returnvalue)		while (returnvalue)

Daniel Jedlicka: Replaced the popshell.c example source code by a version adapted for OS4 by xenic.

2015-12-06T08:50:06Z

Replaced the popshell.c example source code by a version adapted for OS4 by xenic.

Show changes

Steven Solie at 18:05, 4 November 2015

2015-11-04T18:05:36Z

← Older revision		Revision as of 18:05, 4 November 2015
Line 2:		Line 2:
	== Commodities Exchange Library ==		== Commodities Exchange Library ==

	This ~~chapter~~ describes Commodities Exchange, the library of routines used to add a custom input handler to the Amiga. With Commodities Exchange, any program function can be associated with key combinations or other input events ''globally'' allowing the creation utility programs that run in the background for all tasks.		This article describes Commodities Exchange, the library of routines used to add a custom input handler to the Amiga. With Commodities Exchange, any program function can be associated with key combinations or other input events ''globally'' allowing the creation utility programs that run in the background for all tasks.

	== Custom Input Handlers ==		== Custom Input Handlers ==
Line 94:		Line 94:
	</syntaxhighlight>		</syntaxhighlight>

	Commodities Exchange gets all the information it needs about the broker from this structure. NewBroker's nb_Version field contains the version number of the NewBroker structure. This should be set to NB_VERSION which is defined in <libraries/commodities.h>. The nb_Name, nb_Title, and nb_Descr point to strings which hold the name, title, and description of the broker. The two bit fields, nb_Unique and nb_Flags, toggle certain features of Commodities Exchange based on their values. They are discussed in detail later in this ~~chapter~~.		Commodities Exchange gets all the information it needs about the broker from this structure. NewBroker's nb_Version field contains the version number of the NewBroker structure. This should be set to NB_VERSION which is defined in <libraries/commodities.h>. The nb_Name, nb_Title, and nb_Descr point to strings which hold the name, title, and description of the broker. The two bit fields, nb_Unique and nb_Flags, toggle certain features of Commodities Exchange based on their values. They are discussed in detail later in this article.

	The nb_Pri field contains the broker's priority. Commodities Exchange inserts the broker into the master list based on this number. Higher priority brokers get CxMessages before lower priority brokers.		The nb_Pri field contains the broker's priority. Commodities Exchange inserts the broker into the master list based on this number. Higher priority brokers get CxMessages before lower priority brokers.
Line 305:		Line 305:
	</syntaxhighlight>		</syntaxhighlight>

	If a commodity has a lot of CxObjects, deleting each individually can be a bit tedious. DeleteCxObjAll() will delete a CxObject and any other CxObjects that are attached to it. The HotKey.c example given later in this ~~chapter~~ uses this function to delete all its CxObjects. A commodity that uses DeleteCxObjAll() to delete all its CxObjects should make sure that they are all connected to the main one. (See the "Connecting CxObjects" section below.)		If a commodity has a lot of CxObjects, deleting each individually can be a bit tedious. DeleteCxObjAll() will delete a CxObject and any other CxObjects that are attached to it. The HotKey.c example given later in this article uses this function to delete all its CxObjects. A commodity that uses DeleteCxObjAll() to delete all its CxObjects should make sure that they are all connected to the main one. (See the "Connecting CxObjects" section below.)

	After deleting its CxObjects, a commodity must take care of any CxMessages that might have arrived at the message port just before the commodity deleted its objects.		After deleting its CxObjects, a commodity must take care of any CxMessages that might have arrived at the message port just before the commodity deleted its objects.
Line 804:		Line 804:
	</syntaxhighlight>		</syntaxhighlight>

	CxSignal() sets up a signal CxObject. When a signal CxObject receives a CxMessage, it signals a task. The commodity is responsible for determining the proper task ID and allocating the signal. Normally, a commodity wants to be signaled so it uses FindTask(NULL) to find it's own task address. Note that cx_signal from the above prototype is the signal number as returned by AllocSignal(), not the signal mask made from that number. For more information on signals, see ~~the~~ Exec ~~chapter~~.		CxSignal() sets up a signal CxObject. When a signal CxObject receives a CxMessage, it signals a task. The commodity is responsible for determining the proper task ID and allocating the signal. Normally, a commodity wants to be signaled so it uses FindTask(NULL) to find it's own task address. Note that cx_signal from the above prototype is the signal number as returned by AllocSignal(), not the signal mask made from that number. For more information on signals, see [[Exec_Signals\|Exec Signals]].

	The example "Divert.c" (shown a little later) uses a signal CxObject.		The example "Divert.c" (shown a little later) uses a signal CxObject.
Line 1,379:		Line 1,379:
	== Function Reference ==		== Function Reference ==

	The following are brief descriptions of the Commodities Exchange functions covered in this ~~chapter~~. See the SDK for details on each function call.		The following are brief descriptions of the Commodities Exchange functions covered in this article. See the SDK for details on each function call.

	{\| class="wikitable"		{\| class="wikitable"

Steven Solie: /* Filter Objects and Input Description Strings */

2014-04-26T04:58:37Z

Filter Objects and Input Description Strings

← Older revision		Revision as of 04:58, 26 April 2014
Line 343:		Line 343:
	Because not all commodities are interested in every input event that makes it way down the input chain, Commodities Exchange has a method for filtering them. A filter CxObject compares the CxMessages it receives to a pattern. If a CxMessage matches the pattern, the filter diverts the CxMessage down its personal list of CxObjects.		Because not all commodities are interested in every input event that makes it way down the input chain, Commodities Exchange has a method for filtering them. A filter CxObject compares the CxMessages it receives to a pattern. If a CxMessage matches the pattern, the filter diverts the CxMessage down its personal list of CxObjects.

			<syntaxhighlight>
	<pre>
	CxObj *CxFilter(STRPTR descriptionstring);		CxObj *CxFilter(STRPTR descriptionstring);
			</syntaxhighlight>
	</pre>

	The C macro CxFilter() (defined in <libraries/commodities.h>) returns a pointer to a filter CxObject. The macro has only one argument, a pointer to a string describing which input events to filter. The following regular expression outlines the format of the input event description string (CX_POPKEY uses the same description string format):		The C macro CxFilter() (defined in <libraries/commodities.h>) returns a pointer to a filter CxObject. The macro has only one argument, a pointer to a string describing which input events to filter. The following regular expression outlines the format of the input event description string (CX_POPKEY uses the same description string format):
Line 431:		Line 431:
	"backspace", "del", "down", "enter", "esc", "f1", "f2",		"backspace", "del", "down", "enter", "esc", "f1", "f2",
	"f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10",		"f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10",
	"help", "left", "return", "right", "space", "tab", "up".		"f11, "f12", "help", "left", "return", "right", "space", "tab", "up".

	''ANSICode'' is a single character (for example "a" that Commodities Exchange looks up in the system default keymap.		''ANSICode'' is a single character (for example "a" that Commodities Exchange looks up in the system default keymap.

Steven Solie: /* New Input Events */

2014-04-25T14:29:52Z

New Input Events

← Older revision		Revision as of 14:29, 25 April 2014
Line 1,163:		Line 1,163:
	Commodities Exchange also has functions used to introduce new input events to the input stream.		Commodities Exchange also has functions used to introduce new input events to the input stream.

			<syntaxhighlight>
	<pre>
	struct InputEvent InvertString( UBYTE string, ULONG *keymap );		struct InputEvent InvertString( UBYTE string, ULONG *keymap );
	VOID FreeIEvents( struct InputEvent *ie );		VOID FreeIEvents( struct InputEvent *ie );
	VOID AddIEvents( struct InputEvent *ie );		VOID AddIEvents( struct InputEvent *ie );
			</syntaxhighlight>
	</pre>

	InvertString() is a function that accepts an ASCII string and creates a linked list of input events that translate into the string using the supplied keymap (or the system default if the key map is NULL). The NULL terminated string may contain ANSI character codes, an input description enclosed in angle (<>) brackets, or one of the following backslash escape characters:		InvertString() is a function that accepts an ASCII string and creates a linked list of input events that translate into the string using the supplied keymap (or the system default if the key map is NULL). The NULL terminated string may contain ANSI character codes, an input description enclosed in angle (<>) brackets, or one of the following backslash escape characters:

Steven Solie: /* Controlling CxMessages */

2014-04-25T14:26:38Z

Controlling CxMessages

← Older revision		Revision as of 14:26, 25 April 2014
Line 960:		Line 960:
	A Custom CxObject has the power to directly manipulate the CxMessages that travel around the Commodities network. One way is to directly change values in the corresponding input event. Another way is to redirect (or dispose of) the CxMessages.		A Custom CxObject has the power to directly manipulate the CxMessages that travel around the Commodities network. One way is to directly change values in the corresponding input event. Another way is to redirect (or dispose of) the CxMessages.

			<syntaxhighlight>
	<pre>
	VOID DivertCxMsg ( CxMsg cxm, CxObj headobj, CxObj *retobj );		VOID DivertCxMsg ( CxMsg cxm, CxObj headobj, CxObj *retobj );
	VOID RouteCxMsg ( CxMsg cxm, CxObj co );		VOID RouteCxMsg ( CxMsg cxm, CxObj co );
	VOID DisposeCxMsg( CxMsg *cxm );		VOID DisposeCxMsg( CxMsg *cxm );
			</syntaxhighlight>
	</pre>

	DivertCxMsg() and RouteCxMsg() dictate where the CxMessage will go next. Conceptually, DivertCxMsg() is analogous to a subroutine in a program; the CxMessage will travel down the personal list of a CxObject (headobj in the prototype) until it gets to the end of that list. It then returns and visits the CxObject that follows the return CxObject (the return CxObject in the prototype above is retobj). RouteCxMsg() is analogous to a goto in a program; it has no CxObject to return to.		DivertCxMsg() and RouteCxMsg() dictate where the CxMessage will go next. Conceptually, DivertCxMsg() is analogous to a subroutine in a program; the CxMessage will travel down the personal list of a CxObject (headobj in the prototype) until it gets to the end of that list. It then returns and visits the CxObject that follows the return CxObject (the return CxObject in the prototype above is retobj). RouteCxMsg() is analogous to a goto in a program; it has no CxObject to return to.

Daniel Jedlicka: /* Function Reference */

2013-10-19T20:18:35Z

Function Reference

← Older revision		Revision as of 20:18, 19 October 2013
Line 1,474:		Line 1,474:
	\| AddIEvents()		\| AddIEvents()
	\| Converts a list of input events to CxMessages and puts them into the network.		\| Converts a list of input events to CxMessages and puts them into the network.
			\|-
			\| CopyBrokerList()
			\| Creates a local copy of the current broker list (V53.4).
			\|-
			\| FreeBrokerList()
			\| Frees the local broker list (V53.4).
			\|-
			\| BrokerCommand()
			\| Sends a command to a commodity broker (V53.4).
	\|}		\|}

	Obsolete ~~functions which are no longer~~ ~~used.~~		=== Obsolete Functions ===

			The following functions are obsolete and no longer used:

	{\| class="wikitable"		{\| class="wikitable"