/simpletypesystem/trunk

/*

    (C) Gustav Hartvigsson, 2013.

    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU Lesser General Public License as

    published by the Free Software Foundation, either version 3 of the

    License.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef __H_FUNC__

#define __H_FUNC__

#include <stdbool.h>

/** @file

 * Generic function pointer definitions and data stuctures to do with

 * functions.

 * 

 * @todo create an object type that can hold functions and be able to run them.

 */

/*

 * This data structure holds a pointer to a function.

 *

 * A Func object must hold a pointer to a function and can hold a string,

 * representing its name.

 */

/*

 * Common types of function pointers:

 */

/**

 * Generic function.

 * 

 * @param 1 a void pointer to some data

 * @param 2...n a list of other parameters

 */

typedef void * (* SFuncPointer)(void *, ...);

typedef void (* VoidFunc)();

typedef void (* MethodFunc)(void *);

/**

 * A CompFunc represents a standard comparison function.

 * 

 * @param 1 object to compare

 * @param 2 object to compare

 * 

 * compare parameter 1 with parameter 2.

 */

typedef bool (* CompFunc)(void*, void*);

typedef char * (* CharFunc)();

#endif