Making DLLs - Revision history

Sandman at 22:32, 28 July 2008

2008-07-28T22:32:45Z

←Older revision		Revision as of 22:32, 28 July 2008
Line 122:		Line 122:
	<pre>		<pre>
	#include <fxdll.h>		#include <fxdll.h>
		+	#include <math.h>

	static int dll_log(INSTANCE * my, int * params)		static int dll_log(INSTANCE * my, int * params)
	{		{
	// Store the result in a variable first, for the pointer typecasting		// Store the result in a variable first, for the pointer typecasting
-	float f = ~~log~~((float)&params[0]);	+	float f = logf((float)&params[0]);
	return (int)&f;		return (int)&f;
	}		}

Sandman: added example

2008-07-28T17:10:50Z

added example

←Older revision		Revision as of 17:10, 28 July 2008
Line 119:		Line 119:
	</pre>		</pre>

		+	=== Example ===
		+	<pre>
		+	#include <fxdll.h>
		+
		+	static int dll_log(INSTANCE * my, int * params)
		+	{
		+	// Store the result in a variable first, for the pointer typecasting
		+	float f = log((float)&params[0]);
		+	return (int)&f;
		+	}
		+
		+	FENIX_MainDLL RegisterFunctions (COMMON_PARAMS)
		+	{
		+	FENIX_DLLImport
		+
		+	// float log( float f)
		+	FENIX_export ( "log" , "F" , TYPE_FLOAT , dll_log) ;
		+
		+	}
		+	</pre>
	== Tips & Tricks ==		== Tips & Tricks ==
	There are a few tips and tricks, but most of them come from experience. Some from a lot of experience.		There are a few tips and tricks, but most of them come from experience. Some from a lot of experience.
Line 167:		Line 187:

	----		----
-	--[[User:Sandman\|Sandman]] 22:27, ~~19 November 2007~~ (~~CET~~)	+	--[[User:Sandman\|Sandman]] 19:10, 28 July 2008 (CEST)

Sandman: added pointer typecasting

2008-07-28T16:32:52Z

added pointer typecasting

←Older revision		Revision as of 16:32, 28 July 2008
Line 110:		Line 110:
	}		}
	</pre>		</pre>
-	The first parameter is like a [[processID]]: it is the [[process]] calling this function. The second parameter is a list of parameters. For some parameters you may wish to typecast them and put them into a proper variable before using them, for example:	+	The first parameter is like a [[processID]]: it is the [[process]] calling this function. The second parameter is a list of parameters. For some parameters you may wish to typecast them via a 'pointer tyoecast' and put them into a proper variable before using them, for example:
	<pre>		<pre>
-	float my_float = (float)params[0];	+	float my_float = (float)&params[0];
	</pre>		</pre>
-	The return type of this function is always '''static int''' and you should always return an int. Of course you can return other datatypes, but it needs to be typecasted to an int, like:	+	The return type of this function is always '''static int''' and you should always return an int. Of course you can return other datatypes, but it needs to be 'pointer typecasted' to an int, like:
	<pre>		<pre>
-	return (int)my_float;	+	return (int)&my_float;
	</pre>		</pre>

Sandman at 01:28, 28 July 2008

2008-07-28T01:28:09Z

←Older revision		Revision as of 01:28, 28 July 2008
Line 23:		Line 23:
	* '''Project -> Properties...'''. Select TAB '''Build targets'''. For each target you want to use (on the left), select '''Dynamic library''' at the Type (on the right). You don't need to create an import library.		* '''Project -> Properties...'''. Select TAB '''Build targets'''. For each target you want to use (on the left), select '''Dynamic library''' at the Type (on the right). You don't need to create an import library.

-	* '''Project -> Build options...'''. Select the top item in the list on the left. Go to TAB '''Linker settings''' and add the following line to the right textfield: <code>-def fenixdll.def</code>. Now go to TAB '''Search directories'''~~, in that the~~ TAB '''Compiler''' and add the directory you created earlier, the '''Fenix\Fenix 0.92a Includes'''.	+	* '''Project -> Build options...'''. Select the top item in the list on the left. Go to TAB '''Linker settings''' and add the following line to the right textfield: <code>-def fenixdll.def</code>. Now go to TAB '''Search directories''' -> TAB '''Compiler''' and add the directory you created earlier, the '''Fenix\Fenix 0.92a Includes'''.

	* Copy '''fenixdll.def''' to your project folder.		* Copy '''fenixdll.def''' to your project folder.

	== Coding a DLL ==		== Coding a DLL ==
-	Now you have a setup for making a DLL for Fenix, but if you use libraries, you'll have to set them up yourself. Fenix uses SDL by default, so you will need to [http://lazyfoo.net/SDL_tutorials/lesson01/index.php set this up] too. If the compiler complains it cannot find <code>SDL.h</code>, go ~~into~~ the file ~~<code>fxdll.h</code>~~ and change the inclusion of <code>SDL.h</code> to <code>SDL/SDL.h</code>. It also uses [http://www.zlib.net/ zlib].	+	Now you have a setup for making a DLL for Fenix, but if you use libraries, you'll have to set them up yourself. Fenix uses SDL by default, so you will need to [http://lazyfoo.net/SDL_tutorials/lesson01/index.php set this up] too. If the compiler complains it cannot find <code>SDL.h</code>, go to where the file is included and change the inclusion of <code>SDL.h</code> to <code>SDL/SDL*.h</code>. It also uses [http://www.zlib.net/ zlib].

	The most basic code will be something like this:		The most basic code will be something like this:

Sandman: added Code::Blocks

2008-07-28T01:24:46Z

added Code::Blocks

←Older revision		Revision as of 01:24, 28 July 2008
Line 2:		Line 2:
	=== Source ===		=== Source ===
	Before we start coding, download the latest Fenix Source [[Latest_Fenix_version\|here]] and the file [[Media:Fenixdll.def\|fenixdll.def]]. Put the source somewhere appropriate, like '''Fenix\Fenix 0.92a Source\'''. Search for all .c and .h in that folder and put it into a new folder like '''Fenix\Fenix 0.92a Includes\''', together with fenixdll.def.		Before we start coding, download the latest Fenix Source [[Latest_Fenix_version\|here]] and the file [[Media:Fenixdll.def\|fenixdll.def]]. Put the source somewhere appropriate, like '''Fenix\Fenix 0.92a Source\'''. Search for all .c and .h in that folder and put it into a new folder like '''Fenix\Fenix 0.92a Includes\''', together with fenixdll.def.
-
-	=== Compiler ===
-	First step to coding a DLL is getting a C compiler. As I use '''MVC++''', I'll tell you how to set it up to code a DLL for Fenix/Bennu.

	=== MVC++ ===		=== MVC++ ===
Line 16:		Line 13:

	* '''Project -> Add To Project -> Files...''' and add fenixdll.def to your project.		* '''Project -> Add To Project -> Files...''' and add fenixdll.def to your project.
		+
		+	=== Code::Blocks ===
		+	Ah, so you're a cool kid on the block. Let's get cracking.
		+
		+	* '''File -> New -> Project'''. Select Empty project. Specify a name and project folder. Keep GNU GCC Compiler and just hit Finish.
		+
		+	* '''File -> New -> Empty file'''. Select yes. Name the file anything you want, but for the sake of this tutorial, have it the extension '''.c'''; you can go rogue later.
		+
		+	* '''Project -> Properties...'''. Select TAB '''Build targets'''. For each target you want to use (on the left), select '''Dynamic library''' at the Type (on the right). You don't need to create an import library.
		+
		+	* '''Project -> Build options...'''. Select the top item in the list on the left. Go to TAB '''Linker settings''' and add the following line to the right textfield: <code>-def fenixdll.def</code>. Now go to TAB '''Search directories''', in that the TAB '''Compiler''' and add the directory you created earlier, the '''Fenix\Fenix 0.92a Includes'''.
		+
		+	* Copy '''fenixdll.def''' to your project folder.

	== Coding a DLL ==		== Coding a DLL ==
		+	Now you have a setup for making a DLL for Fenix, but if you use libraries, you'll have to set them up yourself. Fenix uses SDL by default, so you will need to [http://lazyfoo.net/SDL_tutorials/lesson01/index.php set this up] too. If the compiler complains it cannot find <code>SDL.h</code>, go into the file <code>fxdll.h</code> and change the inclusion of <code>SDL.h</code> to <code>SDL/SDL.h</code>. It also uses [http://www.zlib.net/ zlib].
		+
	The most basic code will be something like this:		The most basic code will be something like this:
	<pre>		<pre>
Line 38:		Line 50:

	=== RegisterFunctions ===		=== RegisterFunctions ===
-	This is where you tell Fenix~~/Bennu~~ which functions to make available for use in Fenix~~/Bennu~~. To do this, add a line like this:	+	This is where you tell Fenix which functions to make available for use in Fenix. To do this, add a line like this:

	FENIX_export ( <'''CHAR ''' functionname> , <'''CHAR ''' parameters> , <'''BASETYPE''' returntype> , <'''VOID *''' function> ) ;		FENIX_export ( <'''CHAR ''' functionname> , <'''CHAR ''' parameters> , <'''BASETYPE''' returntype> , <'''VOID *''' function> ) ;

-	* '''CHAR *''' functionname: This is how the function will be called in Fenix~~/Bennu~~.	+	* '''CHAR *''' functionname: This is how the function will be called in Fenix.

	* '''CHAR *''' parameters: The list of parameters, possible characters are:		* '''CHAR *''' parameters: The list of parameters, possible characters are:
Line 88:		Line 100:
	\|}		\|}

-	* '''VOID *''' function: This is the function you wish Fenix~~/bennu~~ to call when the function is called. This is the name of the function, without "" and can differ from the functionname used in Fenix~~/Bennu~~.	+	* '''VOID *''' function: This is the function you wish Fenix to call when the function is called. This is the name of the function, without "" and can differ from the functionname used in Fenix.

	=== Functions ===		=== Functions ===

Sandman: /* Some handy functions */

2007-11-19T23:22:24Z

Some handy functions

←Older revision		Revision as of 23:22, 19 November 2007
Line 147:		Line 147:

	:Returns the contents of a string. This pointer is only valid as long as no other string function is called (so duplicate the string if needed).		:Returns the contents of a string. This pointer is only valid as long as no other string function is called (so duplicate the string if needed).
-
-	For the rest, see [[Media:Fxdll.h\|fxdll.h]] in the Fenix source. If you'd like more documentation about a function or something else, let [[User:Sandman\|me]] know (IRC/discussion page).

	<big>'''void''' string_discard ('''int''' stringID)</big>		<big>'''void''' string_discard ('''int''' stringID)</big>

	:Decrease the usage counter of a string. Use this when you retrieve the identifier of the string and discard it.		:Decrease the usage counter of a string. Use this when you retrieve the identifier of the string and discard it.
		+
		+	For the rest, see [[Media:Fxdll.h\|fxdll.h]] in the Fenix source. If you'd like more documentation about a function or something else, let [[User:Sandman\|me]] know (IRC/discussion page).

	----		----
	--[[User:Sandman\|Sandman]] 22:27, 19 November 2007 (CET)		--[[User:Sandman\|Sandman]] 22:27, 19 November 2007 (CET)

Sandman: /* Some handy functions */

2007-11-19T23:21:56Z

Some handy functions

←Older revision		Revision as of 23:21, 19 November 2007
Line 142:		Line 142:
	<big>'''void''' string_use ('''int''' stringID)</big>		<big>'''void''' string_use ('''int''' stringID)</big>

-	:Increase the usage counter of an string. Use this when you store the identifier of the string somewhere. So in practice this should always be called after string_new().	+	:Increase the usage counter of a string. Use this when you store the identifier of the string somewhere. So in practice this should always be called after string_new().

	<big>'''const char*''' string_get ('''int''' stringID)</big>		<big>'''const char*''' string_get ('''int''' stringID)</big>
Line 149:		Line 149:

	For the rest, see [[Media:Fxdll.h\|fxdll.h]] in the Fenix source. If you'd like more documentation about a function or something else, let [[User:Sandman\|me]] know (IRC/discussion page).		For the rest, see [[Media:Fxdll.h\|fxdll.h]] in the Fenix source. If you'd like more documentation about a function or something else, let [[User:Sandman\|me]] know (IRC/discussion page).
		+
		+	<big>'''void''' string_discard ('''int''' stringID)</big>
		+
		+	:Decrease the usage counter of a string. Use this when you retrieve the identifier of the string and discard it.

	----		----
	--[[User:Sandman\|Sandman]] 22:27, 19 November 2007 (CET)		--[[User:Sandman\|Sandman]] 22:27, 19 November 2007 (CET)

Sandman: /* Tips & Tricks */

2007-11-19T21:32:49Z

Tips & Tricks

←Older revision		Revision as of 21:32, 19 November 2007
Line 129:		Line 129:
	Definition: <code>ProcessID call( <ProcessTypeID> )</code><br>		Definition: <code>ProcessID call( <ProcessTypeID> )</code><br>
	Example: <code>proc_id = call(type MyProcName);</code>		Example: <code>proc_id = call(type MyProcName);</code>
-
-	* I'll leave the rest up to you to find out. Feel free to ask me on [http://www.booleansoup.com Booleansoup] or on IRC (irc.blitzed.org #bilge) for example.
-

	== Some handy functions ==		== Some handy functions ==

Sandman at 21:27, 19 November 2007

2007-11-19T21:27:34Z

←Older revision		Revision as of 21:27, 19 November 2007
Line 132:		Line 132:
	* I'll leave the rest up to you to find out. Feel free to ask me on [http://www.booleansoup.com Booleansoup] or on IRC (irc.blitzed.org #bilge) for example.		* I'll leave the rest up to you to find out. Feel free to ask me on [http://www.booleansoup.com Booleansoup] or on IRC (irc.blitzed.org #bilge) for example.

		+
		+	== Some handy functions ==
		+
		+	<big>'''void''' gr_con_printf ('''const char*''' fmt, ...)</big>
		+
		+	:Outputs the message pointed to by ''fmt'' in the Fenix console.
		+
		+	<big>'''int''' string_new ('''const char*''' ptr)</big>
		+
		+	:Creates a new string for Fenix, a copy of the string pointed to by ''ptr'' (so you can free the passed string). Returns the stringID of the created string.
		+
		+	<big>'''void''' string_use ('''int''' stringID)</big>
		+
		+	:Increase the usage counter of an string. Use this when you store the identifier of the string somewhere. So in practice this should always be called after string_new().
		+
		+	<big>'''const char*''' string_get ('''int''' stringID)</big>
		+
		+	:Returns the contents of a string. This pointer is only valid as long as no other string function is called (so duplicate the string if needed).
		+
		+	For the rest, see [[Media:Fxdll.h\|fxdll.h]] in the Fenix source. If you'd like more documentation about a function or something else, let [[User:Sandman\|me]] know (IRC/discussion page).

	----		----
-	--[[User:Sandman\|Sandman]] 14:14, ~~23 July~~ 2007 (~~CEST~~)	+	--[[User:Sandman\|Sandman]] 22:27, 19 November 2007 (CET)

Sandman: /* Source */

2007-11-19T20:35:03Z

Source

←Older revision		Revision as of 20:35, 19 November 2007
Line 1:		Line 1:
	== Setting up ==		== Setting up ==
	=== Source ===		=== Source ===
-	Before we start coding, download the latest Fenix Source [~~http://sourceforge.net/project/showfiles.php?group_id=2714&package_id=2687~~ here] and the file [~~http~~:~~//wwwhome.cs.utwente.nl/~bergfi/fenix/wiki/fenixdll~~.def fenixdll.def]. Put the source somewhere appropriate, like '''Fenix\Fenix 0.92a Source\'''. Search for all .c and .h in that folder and put it into a new folder like '''Fenix\Fenix 0.92a Includes\''', together with fenixdll.def.	+	Before we start coding, download the latest Fenix Source [[Latest_Fenix_version\|here]] and the file [[Media:Fenixdll.def\|fenixdll.def]]. Put the source somewhere appropriate, like '''Fenix\Fenix 0.92a Source\'''. Search for all .c and .h in that folder and put it into a new folder like '''Fenix\Fenix 0.92a Includes\''', together with fenixdll.def.

	=== Compiler ===		=== Compiler ===