Linker Libraries - Revision history

Steven Solie at 20:06, 19 July 2013

2013-07-19T20:06:39Z

← Older revision		Revision as of 20:06, 19 July 2013
Line 41:		Line 41:
	; Intuition		; Intuition
	: Functions which provide support for Intuition's hook and BOOPSI sub-systems.		: Functions which provide support for Intuition's hook and BOOPSI sub-systems.

⚫	== debug.lib ==

⚫	This link library contains standard I/O (stdio) style functions for communicating with a serial terminal connected to the Amiga via its built-in serial port. Typically this terminal will be a 9600-baud, 8 data-bits, one stop-bit connection to an external terminal or an Amiga running a terminal package. The ''debug.lib'' functions allow you to output messages and prompt for input (even from within low level task or interrupt code) without disturbing the Amiga's display and or current state (other than the serial hardware itself).

⚫	No matter how badly the system may have crashed, these functions can usually get a message out. A similar debugging library (currently called ''ddebug.lib)'' is available for sending debugging output to the parallel port. This is useful for debugging serial applications. ''ddebug.lib'' is not documented here. It contains functions similar to ''debug.lib'' but with names starting with 'D' instead of 'K'.

⚫	Please refer to the SDK for a detailed description of the functions.

	== Functions in amiga.lib ==		== Functions in amiga.lib ==
Line 223:		Line 215:
	: Replaced by '''IIntuition->ISetSuperAttrs()''' in V50.		: Replaced by '''IIntuition->ISetSuperAttrs()''' in V50.

	== ~~Functions in~~ debug.lib ==		== debug.lib ==

		⚫	This link library contains standard I/O (stdio) style functions for communicating with a serial terminal connected to the Amiga via its built-in serial port. Typically this terminal will be a 9600-baud, 8 data-bits, one stop-bit connection to an external terminal or an Amiga running a terminal package. The ''debug.lib'' functions allow you to output messages and prompt for input (even from within low level task or interrupt code) without disturbing the Amiga's display and or current state (other than the serial hardware itself).
	''debug.lib''

		⚫	No matter how badly the system may have crashed, these functions can usually get a message out. A similar debugging library (currently called ''ddebug.lib)'' is available for sending debugging output to the parallel port. This is useful for debugging serial applications. ''ddebug.lib'' is not documented here. It contains functions similar to ''debug.lib'' but with names starting with 'D' instead of 'K'.

		⚫	Please refer to the SDK for a detailed description of the functions.

		⚫	== Functions in debug.lib ==

	is a link library that provides useful diagnostic functions that are handy for developing code. It includes the following functions:		''debug.lib'' is a link library that provides useful diagnostic functions that are handy for developing code. It includes the following functions:

			; KCmpStr()
	Compare two null-terminated strings.		: Compare two null-terminated strings.

			; KGetChar()
	Get a character from the console.		: Get a character from the console.

			; KGetNum()
	Get a number from the console.		: Get a number from the console.

			; KMayGetChar()
	Return a character if present, but don't wait.		: Return a character if present, but don't wait.

			; KPrintF()
	Print formatted data to the console.		: Print formatted data to the console.

			; KPutChar()
	Put a character to the console.		: Put a character to the console.

			; KPutStr()
	Put a string to the console.		: Put a string to the console.

Steven Solie: /* Commodities */

2013-07-19T20:00:47Z

Commodities

← Older revision		Revision as of 20:00, 19 July 2013
Line 165:		Line 165:
	=== Commodities ===		=== Commodities ===

			; ArgArrayInit() and ArgArrayDone()
		⚫	: ArgArrayInit() returns an array of strings suitable for sending to icon.library/FindToolType(). This array will be the ToolTypes array of the program's icon, if it was started from Workbench. It will just be "argv" if the program was started from a shell. ArgArrayDone() frees memory and does cleanup required after a call to ArgArrayInit().

			; ArgInt() and ArgString()
		⚫	: These functions look for a particular entry in a ToolType array returned by ArgArrayInit() and return the integer (ArgInt()) or string (ArgString()) associated with that entry. A default value can be passed to each function which will be returned in the event that the requested entry could not be found in the ToolType array.

			; CxCustom()
	ArgArrayInit()
		⚫	: This function creates a custom commodity object. The action of this object on receiving a commodity message is to call a function of the application programmer's choice.

			; CxDebug()
⚫	returns an array of strings suitable for sending to icon.library/FindToolType(). This array will be the ToolTypes array of the ~~program‚Äôs~~ icon, if it was started from Workbench. It will just be ~~‚Äôargv‚Äô~~ if the program was started from a shell. ArgArrayDone() frees memory and does cleanup required after a call to ArgArrayInit().
		⚫	: This function creates a Commodities debug object. The action of this object on receiving a Commodities message is to print out information about the message through the serial port (using the debug.lib/kprintf() routine). A specified "id" will also be displayed.

			; CxFilter()
		⚫	: Creates a Commodities input event filter object that matches a description string. The description string is in the same format as strings expected by commodities.library/SetFilter(). If the description string is NULL, the filter will not match any messages.

			; CxSender()
		⚫	: This function creates a Commodities sender object. The action of this object on receiving a Commodities message is to copy the Commodities message into a standard Exec Message, to put a supplied id in the message as well, and to send the message off to the message port.

			; CxSignal()
⚫	These functions look for a particular entry in a ToolType array returned by ArgArrayInit() and return the integer (ArgInt()) or string (ArgString()) associated with that entry. A default value can be passed to each function which will be returned in the event that the requested entry could not be found in the ToolType array.
		⚫	: This function creates a Commodities signal object. The action of this object on receiving a Commodities message is to send a signal to a task. The caller is responsible for allocating the signal and determining the proper task ID.

			; CxTranslate()
⚫	This function creates a custom commodity object. The action of this object on receiving a commodity message is to call a function of the application ~~programmer‚Äôs~~ choice.
		⚫	: This function creates a Commodities translator object. The action of this object on receiving a Commodities message is to replace that message in the commodities network with a chain of Commodities input messages.

			; HotKey()
⚫	This function creates a Commodities debug object. The action of this object on receiving a Commodities message is to print out information about the message through the serial port (using the debug.lib/kprintf() routine). A specified ~~‚Äôid‚Äô~~ will also be displayed.
		⚫	: This function creates a triad of commodity objects to accomplish a high-level function.
		⚫	: The three objects are a filter, which is created to match by CxFilter(), a sender created by CxSender(), and a translator which is created by CxTranslate(), so that it swallows any commodity input event messages that are passed down by the filter.
		⚫	: This is the simple way to get a message sent to your program when the user performs a particular input action.

			; InvertString()
⚫	Creates a Commodities input event filter object that matches a description string. The description string is in the same format as strings expected by commodities.library/SetFilter(). If the description string is NULL, the filter will not match any messages.
		⚫	: This function returns a linked list of input events which would translate into the string using the supplied keymap (or the system default keymap if the supplied keymap is NULL).
		⚫	: This chain should eventually be freed using FreeIEvents().

			; FreeIEvents()
⚫	This function creates a Commodities sender object. The action of this object on receiving a Commodities message is to copy the Commodities message into a standard Exec Message, to put a supplied id in the message as well, and to send the message off to the message port.
		⚫	: This function frees a linked list of input events as obtained from InvertString().

⚫	This function creates a Commodities signal object. The action of this object on receiving a Commodities message is to send a signal to a task. The caller is responsible for allocating the signal and determining the proper task ID.

⚫	This function creates a Commodities translator object. The action of this object on receiving a Commodities message is to replace that message in the commodities network with a chain of Commodities input messages.

⚫	This function creates a triad of commodity objects to accomplish a high-level function.

⚫	The three objects are a filter, which is created to match by CxFilter(), a sender created by CxSender(), and a translator which is created by CxTranslate(), so that it swallows any commodity input event messages that are passed down by the filter.

⚫	This is the simple way to get a message sent to your program when the user performs a particular input action.

⚫	This function returns a linked list of input events which would translate into the string using the supplied keymap (or the system default keymap if the supplied keymap is NULL).

⚫	This chain should eventually be freed using FreeIEvents().

⚫	This function frees a linked list of input events as obtained from InvertString().

	=== Intuition ===		=== Intuition ===

Steven Solie: /* Timer */

2013-07-19T19:58:01Z

Timer

← Older revision		Revision as of 19:58, 19 July 2013
Line 161:		Line 161:

	; TimeDelay()		; TimeDelay()
	: This function waits for a specified period of time before returning to ~~the~~ the caller.		: This function waits for a specified period of time before returning to the caller.

	=== Commodities ===		=== Commodities ===

Steven Solie: /* Timer */

2013-07-19T19:57:51Z

Timer

← Older revision		Revision as of 19:57, 19 July 2013
Line 160:		Line 160:
	=== Timer ===		=== Timer ===

			; TimeDelay()
	This function waits for a specified period of time before returning to the the caller.		: This function waits for a specified period of time before returning to the the caller.

	=== Commodities ===		=== Commodities ===

Steven Solie: /* ARexx */

2013-07-19T19:57:32Z

ARexx

← Older revision		Revision as of 19:57, 19 July 2013
Line 152:		Line 152:
	=== ARexx ===		=== ARexx ===

			; GetRexxVar() and SetRexxVar()
		⚫	: GetRexxVar() attempts to extract the value of a variable from a running ARexx script/program. SetRexxVar() will attempt to set the value of a particular variable in a running ARexx script.

			; CheckRexxMsg()

		⚫	: This function checks to make sure that a RexxMsg is from ARexx directly. Messages used by the Rexx Variable Interface (RVI) routines are required to be directly from ARexx.
	GetRexxVar()

⚫	attempts to extract the value of a variable from a running ARexx script/program. SetRexxVar() will attempt to set the value of a particular variable in a running ARexx script.

⚫	This function checks to make sure that a RexxMsg is from ARexx directly. Messages used by the Rexx Variable Interface (RVI) routines are required to be directly from ARexx.

	=== Timer ===		=== Timer ===

Steven Solie: /* Graphics */

2013-07-19T19:56:50Z

Graphics

← Older revision		Revision as of 19:56, 19 July 2013
Line 147:		Line 147:
	=== Graphics ===		=== Graphics ===

			; AddTOF() and RemTOF()

		⚫	: AddTOF() adds a task to the vertical-blanking interval interrupt server chain. This frees C programmers from the burden of having to write an assembly language routine to perform this function. The task can be removed with RemTOF().

	AddTOF()

⚫	adds a task to the vertical-blanking interval interrupt server chain. This frees C programmers from the burden of having to write an assembly language routine to perform this function. The task can be removed with RemTOF().

	=== ARexx ===		=== ARexx ===

Steven Solie: /* Math */

2013-07-19T19:56:09Z

Math

← Older revision		Revision as of 19:56, 19 July 2013
Line 130:		Line 130:
	=== Math ===		=== Math ===

			; afp()
	Converts ASCII string variable into fast floating-point.		: Converts ASCII string variable into fast floating-point.
			: Fast floating-point format has been replaced by the '''float32''' and '''float64''' types in V50.

			; arnd()
	ASCII round-off of the provided floating-point string.		: ASCII round-off of the provided floating-point string.

			; dbf()
	Accepts a dual-binary format floating-point number and converts it to FFP format.		: Accepts a dual-binary format floating-point number and converts it to FFP format.
			: Fast floating-point format has been replaced by the '''float32''' and '''float64''' types in V50.

			; fpa()
	Accepts an FFP number and the address of the ASCII string where its converted output is to be stored. The number is converted to a NULL terminated ASCII string and stored at the address provided. Additionally, the base ten (10) exponent in binary form is returned.		: Accepts an FFP number and the address of the ASCII string where its converted output is to be stored. The number is converted to a NULL terminated ASCII string and stored at the address provided. Additionally, the base ten (10) exponent in binary form is returned.
			: Fast floating-point format has been replaced by the '''float32''' and '''float64''' types in V50.

	=== Graphics ===		=== Graphics ===

Steven Solie: /* Linker Libraries */

2013-07-19T19:46:18Z

Linker Libraries

← Older revision		Revision as of 19:46, 19 July 2013
Line 3:		Line 3:

	This section describes the obsolete ''amiga.lib'' and ''debug.lib'' libraries. Unlike the libraries described in other parts of this wiki, these are not shared run-time libraries. Code from the linker libraries is inserted by the linker into your final program. Only the functions you use are pulled into your code. These libraries are typically supplied by your language or compiler vendor.		This section describes the obsolete ''amiga.lib'' and ''debug.lib'' libraries. Unlike the libraries described in other parts of this wiki, these are not shared run-time libraries. Code from the linker libraries is inserted by the linker into your final program. Only the functions you use are pulled into your code. These libraries are typically supplied by your language or compiler vendor.

			If you are porting a program from AmigaOS 3.9 or earlier, you can use the information in this section to find V50 replacement functions.

	== amiga.lib ==		== amiga.lib ==

Steven Solie: /* Linker Libraries */

2013-07-19T19:44:41Z

Linker Libraries

← Older revision		Revision as of 19:44, 19 July 2013
Line 2:		Line 2:
	== Linker Libraries ==		== Linker Libraries ==

	This section describes the ''amiga.lib'' and ''debug.lib'' libraries. Unlike the libraries described in ~~the~~ other ~~chapters~~ of ~~the~~ ~~manual~~, these are not shared run-time libraries. Code from the linker libraries is inserted by the linker into your final program. Only the functions you use are pulled into your code. These libraries are typically supplied by your language or compiler vendor.		This section describes the obsolete ''amiga.lib'' and ''debug.lib'' libraries. Unlike the libraries described in other parts of this wiki, these are not shared run-time libraries. Code from the linker libraries is inserted by the linker into your final program. Only the functions you use are pulled into your code. These libraries are typically supplied by your language or compiler vendor.

	== amiga.lib ==		== amiga.lib ==

Steven Solie: /* clib */

2013-07-19T19:42:32Z

clib

← Older revision		Revision as of 19:42, 19 July 2013
Line 88:		Line 88:
	; fclose()		; fclose()
	: Closes a file.		: Closes a file.
	: Replaced by [[Newlib_Library]]'s '''fclose()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''fclose()''' in V50.

	; fgetc()		; fgetc()
	: Gets a character from a file.		: Gets a character from a file.
	: Replaced by [[Newlib_Library]]'s '''fgetc()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''fgetc()''' in V50.

	; fprintf()		; fprintf()
	: Prints a formatted output line to a file.		: Prints a formatted output line to a file.
	: Replaced by [[Newlib_Library]]'s '''fprintf()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''fprintf()''' in V50.

	; fputc()		; fputc()
	: Puts character to file.		: Puts character to file.
	: Replaced by [[Newlib_Library]]'s '''fputc()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''fputc()''' in V50.

	; fputs()		; fputs()
	: Writes a string to file.		: Writes a string to file.
	: Replaced by [[Newlib_Library]]'s '''fputs()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''fputs()''' in V50.

	; getchar()		; getchar()
	: Gets a character from ''stdin''.		: Gets a character from ''stdin''.
	: Replaced by [[Newlib_Library]]'s '''getchar()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''getchar()''' in V50.

	; printf()		; printf()
	: Puts format data to ''stdout''.		: Puts format data to ''stdout''.
	: Replaced by [[Newlib_Library]]'s '''printf()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''printf()''' in V50.

	; putchar()		; putchar()
	: Puts character to ''stdout''.		: Puts character to ''stdout''.
	: Replaced by [[Newlib_Library]]'s '''putchar()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''putchar()''' in V50.

	; puts()		; puts()
	: Puts a string to ''stdout'', followed by newline.		: Puts a string to ''stdout'', followed by newline.
	: Replaced by [[Newlib_Library]]'s '''puts()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''puts()''' in V50.

	; sprintf()		; sprintf()
	: Formats data into a string (see Exec RawDoFmt() ).		: Formats data into a string (see Exec RawDoFmt() ).
	: Replaced by [[Newlib_Library]]'s '''sprintf()''' in V50.		: Replaced by [[Newlib_Library\|Newlib Library]]'s '''sprintf()''' in V50.

	=== Math ===		=== Math ===