This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Contents 1 Setting up 1.1 Source 1.2 MVC++ 1.3 Code::Blocks 2 Coding a DLL 2.1 RegisterFunctions 2.2 Functions 2.3 Example 3 Tips & Tricks 4 Some handy functions

[edit] Setting up

[edit] Source

Before we start coding, download the latest Fenix Source here and the file 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.

[edit] MVC++

So we got MVC++ eh, let's do this then.

• Tools -> Options -> TAB: Directories. Show directories for: Include files. Add the directory you created earlier, Fenix\Fenix 0.92a Includes, to the list. Yes the includes folder.

• File -> New will bring up the New dialog box. Select Win32 Dynamic-Link Library and name your project. Click OK. A new dialog box pops up! Select An empty DLL project. and click Finish. Click OK. I myself like to have the list on the left to display the files; to do this select FileView under it.

• File -> New again, select C++ Source File and name your file. Click OK.

• Project -> Add To Project -> Files... and add fenixdll.def to your project.

[edit] 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: -def fenixdll.def. 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.

[edit] 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 set this up too. If the compiler complains it cannot find SDL*.h, go to where the file is included and change the inclusion of SDL*.h to SDL/SDL*.h. It also uses zlib.

The most basic code will be something like this:

#include <fxdll.h>

static int DLL_MYFUNC(INSTANCE * my, int * params)
{
    return 0;
}

FENIX_MainDLL RegisterFunctions (COMMON_PARAMS)
{
    FENIX_DLLImport

    FENIX_export ( "DLL_MYFUNC" , "" , TYPE_DWORD , DLL_MYFUNC ) ;

}

If this doesn't compile then something went wrong during setup. Let's assume it compiles, so I can explain the code.

[edit] RegisterFunctions

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> ) ;

• CHAR * functionname: This is how the function will be called in Fenix.

• CHAR * parameters: The list of parameters, possible characters are:

I	- TYPE_DWORD
B	- TYPE_BYTE
W	- TYPE_WORD
S	- TYPE_STRING
P	- TYPE_POINTER
F	- TYPE_FLOAT

• BASETYPE returntype: The datatype of the returnvalue. Possible are:

TYPE_UNDEFINED	- 0
TYPE_INT	- 1
TYPE_DWORD	- 2
TYPE_SHORT	- 3
TYPE_WORD	- 4
TYPE_SBYTE	- 5
TYPE_BYTE	- 6
TYPE_CHAR	- 8
TYPE_FLOAT	- 9
TYPE_STRING	- 16
TYPE_ARRAY	- 17
TYPE_STRUCT	- 18
TYPE_POINTER	- 19

• 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.

[edit] Functions

Like stated, the most basic function is of the form:

static int DLL_MYFUNC(INSTANCE * my, int * params)
{
    return 0;
}

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:

float my_float = *(float*)&params[0];

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:

return *(int*)&my_float;

[edit] Example

#include <fxdll.h>
#include <math.h>

static int dll_log(INSTANCE * my, int * params)
{
    // Store the result in a variable first, for the pointer typecasting
    float f = logf(*(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) ;

}

[edit] Tips & Tricks

There are a few tips and tricks, but most of them come from experience. Some from a lot of experience.

• It is possible to use the same functionname multiple times, even with different properties. The only condition is that the number of parameters needs to be different:

FENIX_export ( "DLL_MYFUNC" , "I"  , TYPE_DWORD , DLL_MYFUNC ) ;
FENIX_export ( "DLL_MYFUNC" , "II" , TYPE_DWORD , DLL_MYFUNC2 ) ;

• Some functions are handy to use, for example gr_con_printf(). Look in the sourcecode of for example Network.dll to see how it works. Keep in mind that flooding the console isn't very nice, so leave the option open for the user of the DLL to turn it off.

• Calling a Fenix function/process from a DLL can be handy sometimes, especially when used as a callback function. Initiating a process of a variable processtype in Fenix is also possible:

static int CALL(INSTANCE * my, int * params)
{
    INSTANCE * proc = instance_new (procdef_get(params[0]), first_instance);
    return instance_go (proc);
}

With this method the parameters of the called process won't be initialized. Definition: ProcessID call( <ProcessTypeID> )
Example: proc_id = call(type MyProcName);

[edit] Some handy functions

void gr_con_printf (const char* fmt, ...)

Outputs the message pointed to by fmt in the Fenix console.

int string_new (const char* ptr)

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.

void string_use (int stringID)

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().

const char* string_get (int stringID)

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).

void string_discard (int stringID)

Decrease the usage counter of a string. Use this when you retrieve the identifier of the string and discard it.

For the rest, see fxdll.h in the Fenix source. If you'd like more documentation about a function or something else, let me know (IRC/discussion page).

---

--Sandman 19:10, 28 July 2008 (CEST)