shell.h

/*
 * shell.h
 */
#ifndef _clish_shell_h
#define _clish_shell_h

#include <stdio.h>
#include <pthread.h>

#include "lub/c_decl.h"
#include "lub/types.h"
#include "lub/argv.h"

#include "tinyrl/tinyrl.h"

#include "view.h"

_BEGIN_C_DECL

typedef struct clish_shell_s clish_shell_t;

/*=====================================
 * SHELL INTERFACE
 *===================================== */
typedef bool_t 
    clish_shell_init_fn_t(
        const clish_shell_t *shell
    );

typedef void 
    clish_shell_fini_fn_t(
        const clish_shell_t *shell
    );

typedef void 
    clish_shell_cmd_line_fn_t(
        const clish_shell_t *instance,
        const char *cmd_line
    );

typedef bool_t
    clish_shell_script_fn_t(
        const clish_shell_t *instance,
        const char          *script
    );

typedef bool_t 
    clish_shell_access_fn_t(
        const clish_shell_t *instance,
        const char *access
    );
typedef bool_t 
    clish_shell_builtin_fn_t(
        const clish_shell_t *instance,
        const lub_argv_t *argv
    );

typedef struct
{
    const char               *name;     
    clish_shell_builtin_fn_t *callback; 
} clish_shell_builtin_t; 
 
typedef struct
{
    clish_shell_init_fn_t        *init_fn;     
    clish_shell_access_fn_t      *access_fn;   
    clish_shell_cmd_line_fn_t    *cmd_line_fn; 
    clish_shell_script_fn_t      *script_fn;   
    clish_shell_fini_fn_t        *fini_fn;     
    const clish_shell_builtin_t *cmd_list;    
} clish_shell_hooks_t;
/*-----------------
 * meta functions
 *----------------- */
int
    clish_shell_spawn_and_wait(const clish_shell_hooks_t *hooks,
                               void                      *cookie);
bool_t
    clish_shell_spawn(
        pthread_t *pthread,
        const pthread_attr_t *attr,
        const clish_shell_hooks_t *hooks,
        void *cookie
    );
bool_t
    clish_shell_spawn_from_file(const clish_shell_hooks_t *hooks,
                                void                      *cookie,
                                const                char *filename);
        
clish_shell_t *
    clish_shell_new(const clish_shell_hooks_t *hooks,
                    void                      *cookie,
                    FILE                      *istream);
/*-----------------
 * methods
 *----------------- */
/*
 * Called to invoke the startup command for this shell
 */
bool_t
    clish_shell_startup(clish_shell_t *instance);
void
    clish_shell_delete(clish_shell_t *instance);
clish_view_t *
    clish_shell_find_create_view(clish_shell_t *instance,
                                 const char    *name,
                                 const char    *prompt);
clish_ptype_t *
    clish_shell_find_create_ptype(clish_shell_t           *instance,
                                  const char              *name,
                                  const char              *text,
                                  const char              *pattern,
                                  clish_ptype_method_e     method,
                                  clish_ptype_preprocess_e preprocess);
int
    clish_shell_xml_read(clish_shell_t *instance,
                         const char      *filename);
void
    clish_shell_help(clish_shell_t *instance,
                     const char    *line);
bool_t
    clish_shell_execute(clish_shell_t         *instance,
                        const clish_command_t *cmd,
                        clish_pargv_t        **pargv);
bool_t 
    clish_shell_readline(clish_shell_t          *shell,
                         const char             *prompt,
                         const clish_command_t **cmd,
                         clish_pargv_t         **pargv);
void
    clish_shell_set_context(clish_shell_t *instance,
                            const char    *viewname);
void
    clish_shell_dump(clish_shell_t *instance);
void
    clish_shell_close(clish_shell_t *instance);
/*-----------------
 * attributes 
 *----------------- */
const clish_view_t *
    clish_shell__get_view(const clish_shell_t *instance);
const char *
    clish_shell__get_viewid(const clish_shell_t *instance);
const char *
    clish_shell__get_overview(const clish_shell_t *instance);
tinyrl_t *
    clish_shell__get_tinyrl(const clish_shell_t *instance);
void *
    clish_shell__get_client_cookie(const clish_shell_t *instance);

_END_C_DECL
#endif /* _clish_shell_h */

---