fish: function.h Source File

00001 
00010 #ifndef FISH_FUNCTION_H
00011 #define FISH_FUNCTION_H
00012 
00013 #include <wchar.h>
00014 
00015 #include "util.h"
00016 
00024 typedef struct function_data
00025 {
00029         wchar_t *name;
00033         wchar_t *description;
00037         wchar_t *definition;
00041         array_list_t *events;
00045         array_list_t *named_arguments;
00050         int shadows;
00051 }
00052         function_data_t;
00053 
00054 
00058 void function_init();
00059 
00063 void function_destroy();
00064 
00069 void function_add( function_data_t *data );
00070 
00074 void function_remove( const wchar_t *name );
00075 
00079 const wchar_t *function_get_definition( const wchar_t *name );
00080 
00084 const wchar_t *function_get_desc( const wchar_t *name );
00085 
00089 void function_set_desc( const wchar_t *name, const wchar_t *desc );
00090 
00094 int function_exists( const wchar_t *name );
00095 
00103 void function_get_names( array_list_t *list, 
00104                                                  int get_hidden );
00105 
00113 const wchar_t *function_get_definition_file( const wchar_t *name );
00114 
00122 int function_get_definition_offset( const wchar_t *name );
00123 
00127 array_list_t *function_get_named_arguments( const wchar_t *name );
00128 
00132 int function_get_shadows( const wchar_t *name );
00133 
00134 #endif