fish-shell/function.cpp

/** \file function.c

    Prototypes for functions for storing and retrieving function
	information. These functions also take care of autoloading
	functions in the $fish_function_path. Actual function evaluation
	is taken care of by the parser and to some degree the builtin
	handling library.
*/

#include "config.h"

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <wchar.h>
#include <unistd.h>
#include <termios.h>
#include <signal.h>
#include <pthread.h>
#include <errno.h>
#include <map>
#include <set>

#include "wutil.h"
#include "fallback.h"
#include "util.h"

#include "function.h"
#include "proc.h"
#include "parser.h"
#include "common.h"
#include "intern.h"
#include "event.h"
#include "reader.h"
#include "parse_util.h"
#include "parser_keywords.h"
#include "env.h"
#include "expand.h"
#include "halloc.h"
#include "halloc_util.h"

class function_internal_info_t
{
public:
    /** Function definition */
    wcstring definition;
    
    /** Function description */
    wcstring description;
    
	/**
	   File where this function was defined
	*/
    const wchar_t *definition_file;
    
	/**
	   Line where definition started
	*/
	int definition_offset;
    
	/**
	   List of all named arguments for this function
	 */
    wcstring_list_t named_arguments;
    
	/**
	   Flag for specifying that this function was automatically loaded
	*/
    bool is_autoload;
    
	/**
	   Set to non-zero if invoking this function shadows the variables
	   of the underlying function.
	 */
	bool shadows;
};

/**
   Table containing all functions
*/
typedef std::map<wcstring, function_internal_info_t> function_map_t;
static function_map_t loaded_functions;

/* Lock for functions */
static pthread_mutex_t functions_lock;

/* Helper macro for vomiting */
#define VOMIT_ON_FAILURE(a) do { if (0 != (a)) { int err = errno; fprintf(stderr, "%s failed on line %d in file %s: %d (%s)\n", #a, __LINE__, __FILE__, err, strerror(err)); abort(); }} while (0)

static int kLockDepth = 0;
static char kLockFunction[1024];

/**
   Lock and unlock the functions hash
*/
static void lock_functions(const char *func) {
    VOMIT_ON_FAILURE(pthread_mutex_lock(&functions_lock));
    if (! kLockDepth++) {
        strcat(kLockFunction, func);
    }
}

static void unlock_functions(void) {
    if (! --kLockDepth) {
        memset(kLockFunction, 0, sizeof kLockFunction);
    }
    VOMIT_ON_FAILURE(pthread_mutex_unlock(&functions_lock));
}

#define LOCK_FUNCTIONS() lock_functions(__FUNCTION__)
#define UNLOCK_FUNCTIONS() unlock_functions()


/**
   Kludgy flag set by the load function in order to tell function_add
   that the function being defined is autoloaded. There should be a
   better way to do this...
*/
static int is_autoload = 0;

/**
   Make sure that if the specified function is a dynamically loaded
   function, it has been fully loaded.
*/
static int load( const wchar_t *name )
{
    ASSERT_IS_MAIN_THREAD();
	int was_autoload = is_autoload;
	int res;
    LOCK_FUNCTIONS();
    function_map_t::iterator iter = loaded_functions.find(name);
	if( iter !=  loaded_functions.end() && !iter->second.is_autoload ) {
        UNLOCK_FUNCTIONS();
		return 0;
    }
    UNLOCK_FUNCTIONS();
	
	is_autoload = 1;	
	res = parse_util_load( name,
						   L"fish_function_path",
						   &function_remove,
						   1 );
	is_autoload = was_autoload;
	return res;
}

/**
   Insert a list of all dynamically loaded functions into the
   specified list.
*/
static void autoload_names( std::set<wcstring> &names, int get_hidden )
{
	size_t i;
	
	const env_var_t path_var_wstr =  env_get_string( L"fish_function_path" );
    if (path_var_wstr.missing())
        return;
	const wchar_t *path_var = path_var_wstr.c_str(); 
	
    wcstring_list_t path_list;

	tokenize_variable_array2( path_var, path_list );
	for( i=0; i<path_list.size(); i++ )
	{
        const wcstring &ndir_str = path_list.at(i);
		const wchar_t *ndir = (wchar_t *)ndir_str.c_str();
		DIR *dir = wopendir( ndir );
		if( !dir )
			continue;
		
		wcstring name;
		while (wreaddir(dir, name))
		{
			const wchar_t *fn = name.c_str();
			const wchar_t *suffix;
			if( !get_hidden && fn[0] == L'_' )
				continue;
			
            suffix = wcsrchr( fn, L'.' );
			if( suffix && (wcscmp( suffix, L".fish" ) == 0 ) )
			{
                wcstring name(fn, suffix - fn);
                names.insert(name);
			}
		}				
		closedir(dir);
	}
}

void function_init()
{
    pthread_mutexattr_t a;
    VOMIT_ON_FAILURE(pthread_mutexattr_init(&a));
    VOMIT_ON_FAILURE(pthread_mutexattr_settype(&a,PTHREAD_MUTEX_RECURSIVE));
    VOMIT_ON_FAILURE(pthread_mutex_init(&functions_lock, &a));
    VOMIT_ON_FAILURE(pthread_mutexattr_destroy(&a));
}

void function_destroy()
{
    LOCK_FUNCTIONS();
    loaded_functions.clear();
    UNLOCK_FUNCTIONS();
}


void function_add( function_data_t *data )
{
	int i;
	
	CHECK( data->name, );
	CHECK( data->definition, );
	LOCK_FUNCTIONS();
	function_remove( data->name );
	    
    function_internal_info_t &info = loaded_functions[data->name];
    
	info.definition_offset = parse_util_lineno( parser_get_buffer(), current_block->tok_pos )-1;
	info.definition = data->definition;

	if( data->named_arguments )
	{
		for( i=0; i<al_get_count( data->named_arguments ); i++ )
		{
            info.named_arguments.push_back((wchar_t *)al_get( data->named_arguments, i ));
		}
	}
	
	
	if (data->description)
        info.description = data->description;
	info.definition_file = intern(reader_current_filename());
	info.is_autoload = is_autoload;
	info.shadows = data->shadows;
	
	
	for( i=0; i<al_get_count( data->events ); i++ )
	{
		event_add_handler( (event_t *)al_get( data->events, i ) );
	}
	UNLOCK_FUNCTIONS();
}

static int function_exists_internal( const wchar_t *cmd, bool autoload )
{
	int res;
	CHECK( cmd, 0 );
	
	if( parser_keywords_is_reserved(cmd) )
		return 0;
	
    LOCK_FUNCTIONS();
	if ( autoload ) load( cmd );
    res = loaded_functions.find(cmd) != loaded_functions.end();
	UNLOCK_FUNCTIONS();
    return res;
}

int function_exists( const wchar_t *cmd )
{
    return function_exists_internal( cmd, true );
}

int function_exists_no_autoload( const wchar_t *cmd )
{
    return function_exists_internal( cmd, false );    
}

void function_remove( const wchar_t *name )
{
	event_t ev;
	
	CHECK( name, );

    LOCK_FUNCTIONS();
    bool erased = (loaded_functions.erase(name) > 0);
	
	if( !erased ) {
        UNLOCK_FUNCTIONS();
		return;
    }

	ev.type=EVENT_ANY;
	ev.function_name=name;	
	event_remove( &ev );

	/*
	  Notify the autoloader that the specified function is erased, but
	  only if this call to fish_remove is not made by the autoloader
	  itself.
	*/
	if( !is_autoload )
	{
		parse_util_unload( name, L"fish_function_path", 0 );
	}
    UNLOCK_FUNCTIONS();
}
	
const wchar_t *function_get_definition( const wchar_t *name )
{
    const wchar_t *result = NULL;
	CHECK( name, 0 );
	LOCK_FUNCTIONS();
	load( name );
    function_map_t::iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        result = iter->second.definition.c_str();
    UNLOCK_FUNCTIONS();
    return result;
}

wcstring_list_t function_get_named_arguments( const wchar_t *name )
{
    wcstring_list_t result;
	CHECK( name, result );
    LOCK_FUNCTIONS();
	load( name );
    function_map_t::iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        result = iter->second.named_arguments;
    UNLOCK_FUNCTIONS();
    return result;
}

int function_get_shadows( const wchar_t *name )
{
	bool result = false;
	CHECK( name, 0 );
	LOCK_FUNCTIONS();
	load( name );
    function_map_t::const_iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        result = iter->second.shadows;
    UNLOCK_FUNCTIONS();
    return result;
}

	
const wchar_t *function_get_desc( const wchar_t *name )
{
    const wchar_t *result = NULL;
	CHECK( name, 0 );
	load( name );
    LOCK_FUNCTIONS();
    function_map_t::const_iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        result = iter->second.description.c_str();
    UNLOCK_FUNCTIONS();
    
    /* Empty length string goes to NULL */
    if (result && ! result[0])
        result = NULL;
            
    return result ? _(result) : NULL;
}

void function_set_desc( const wchar_t *name, const wchar_t *desc )
{
	CHECK( name, );
	CHECK( desc, );
	
	load( name );
    LOCK_FUNCTIONS();
    function_map_t::iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        iter->second.description = desc;
    UNLOCK_FUNCTIONS();
}

int function_copy( const wchar_t *name, const wchar_t *new_name )
{
    int result = 0;
    LOCK_FUNCTIONS();
    function_map_t::const_iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end()) {
        function_internal_info_t &new_info = loaded_functions[new_name];
        new_info = iter->second;
        
		// This new instance of the function shouldn't be tied to the def 
		// file of the original. 
		new_info.definition_file = 0;
		new_info.is_autoload = 0;
        
        result = 1;
    }
    UNLOCK_FUNCTIONS();
	return result;
}

wcstring_list_t function_get_names( int get_hidden )
{
    std::set<wcstring> names;
    LOCK_FUNCTIONS();
	autoload_names( names, get_hidden );
	
    function_map_t::const_iterator iter;
    for (iter = loaded_functions.begin(); iter != loaded_functions.end(); iter++) {
        const wcstring &name = iter->first;
        
        /* Maybe skip hidden */
        if (! get_hidden) {
            if (name.size() == 0 || name.at(0) == L'_') continue;
        }
        
        names.insert(name);
    }
    UNLOCK_FUNCTIONS();
    
    return wcstring_list_t(names.begin(), names.end());
}

const wchar_t *function_get_definition_file( const wchar_t *name )
{
    const wchar_t *result = NULL;

	CHECK( name, 0 );
    LOCK_FUNCTIONS();
    function_map_t::const_iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        result = iter->second.definition_file;
    UNLOCK_FUNCTIONS();
    return result;
}


int function_get_definition_offset( const wchar_t *name )
{
    int result = -1;

	CHECK( name, -1 );
    LOCK_FUNCTIONS();
    function_map_t::const_iterator iter = loaded_functions.find(name);
    if (iter != loaded_functions.end())
        result = iter->second.definition_offset;
    UNLOCK_FUNCTIONS();
    return result;
}