shell.h

Go to the documentation of this file.

#ifndef _SHELL_H
#define _SHELL_H

#include "shell_types.h"

#define MAX_LINE_LEN      1024
#define MAX_ARGS           256

/*------------------------------------------------------------------
 *                    Internal error codes.
 *-----------------------------------------------------------------*/

#define SHELL_SUCCESS 0
#define SHELL_ERROR  -1
#define SHELL_NOT_FOUND -2
#define SHELL_SYNTAX_ERROR -22

/*------------------------------------------------------------------
 *                    Main shell routines.
 *-----------------------------------------------------------------*/

int shell_Init(int verbose, char *input_file, char *prompt, int shell_index);

int shell_Launch();

int shell_BarrierInit(int nb_threads);

/*------------------------------------------------------------------
 *                Parsing and execution routines.
 *-----------------------------------------------------------------*/

int shell_ParseLine(char *in_out_line, char **out_arglist, int *p_argcount);

void shell_CleanArgs(int argc, char **in_out_argv, int *in_allocated);

int shell_SolveArgs(int argc, char **in_out_argv, int *out_allocated);

int shell_Execute(int argc, char **argv, FILE * output);

/*------------------------------------------------------------------
 *                 Shell ouput routines.
 *-----------------------------------------------------------------*/

void shell_PrintError(shell_state_t * context, char *error_msg);

void shell_PrintTrace(shell_state_t * context, char *msg);

/*------------------------------------------------------------------
 *                 Shell state management routines.
 *-----------------------------------------------------------------*/

extern char *shell_special_vars[];

int shell_SetLayer(shell_state_t * context, char *layer_name);

layer_def_t *shell_GetLayer(shell_state_t * context);

int shell_SetStatus(shell_state_t * context, int returned_status);

int shell_GetStatus(shell_state_t * context);

int shell_SetVerbose(shell_state_t * context, char *str_verbose);

int shell_GetVerbose(shell_state_t * context);

int shell_SetDbgLvl(shell_state_t * context, char *str_debug_level);

int shell_GetDbgLvl(shell_state_t * context);

FILE *shell_GetInputStream(shell_state_t * context);

int shell_SetInput(shell_state_t * context, char *file_name);

int shell_SetPrompt(shell_state_t * context, char *str_prompt);

char *shell_GetPrompt(shell_state_t * context);

int shell_SetShellId(shell_state_t * context, int shell_index);

int shell_SetLine(shell_state_t * context, int lineno);

int shell_GetLine(shell_state_t * context);

/*------------------------------------------------------------------
 *                      Shell commands.
 *-----------------------------------------------------------------*/

int shellcmd_help(int argc,     /* IN : number of args in argv */
                  char **argv,  /* IN : arg list               */
                  FILE * output /* IN : output stream          */
    );

int shellcmd_if(int argc,       /* IN : number of args in argv */
                char **argv,    /* IN : arg list               */
                FILE * output   /* IN : output stream          */
    );

int shellcmd_interactive(int argc,      /* IN : number of args in argv */
                         char **argv,   /* IN : arg list               */
                         FILE * output  /* IN : output stream          */
    );

int shellcmd_set(int argc,      /* IN : number of args in argv */
                 char **argv,   /* IN : arg list               */
                 FILE * output  /* IN : output stream          */
    );

int shellcmd_unset(int argc,    /* IN : number of args in argv */
                   char **argv, /* IN : arg list               */
                   FILE * output        /* IN : output stream          */
    );

int shellcmd_print(int argc,    /* IN : number of args in argv */
                   char **argv, /* IN : arg list               */
                   FILE * output        /* IN : output stream          */
    );

int shellcmd_varlist(int argc,  /* IN : number of args in argv */
                     char **argv,       /* IN : arg list               */
                     FILE * output      /* IN : output stream          */
    );

int shellcmd_time(int argc,     /* IN : number of args in argv */
                  char **argv,  /* IN : arg list               */
                  FILE * output /* IN : output stream          */
    );

int shellcmd_quit(int argc,     /* IN : number of args in argv */
                  char **argv,  /* IN : arg list               */
                  FILE * output /* IN : output stream          */
    );

int shellcmd_barrier(int argc,  /* IN : number of args in argv */
                     char **argv,       /* IN : arg list               */
                     FILE * output      /* IN : output stream          */
    );

static command_def_t __attribute__ ((__unused__)) shell_commands[] =
{

  {
  "barrier", shellcmd_barrier, "synchronization in a multi-thread shell"},
  {
  "echo", shellcmd_print, "print one or more arguments"},
  {
  "exit", shellcmd_quit, "exit this shell"},
  {
  "help", shellcmd_help, "print this help"},
  {
  "if", shellcmd_if, "conditionnal execution"},
  {
  "interactive", shellcmd_interactive, "close script file and start interactive mode"},
  {
  "print", shellcmd_print, "print one or more arguments"},
  {
  "quit", shellcmd_quit, "exit this shell"},
  {
  "set", shellcmd_set, "set the value of a shell variable"},
  {
  "time", shellcmd_time, "measures the time for executing a command"},
  {
  "unset", shellcmd_unset, "free a shell variable"},
  {
  "varlist", shellcmd_varlist, "print the list of shell variables"},
  {
  NULL, NULL, NULL}             /* End of command list */
};

/* @todo: if, source */

#endif