fnet_shell.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  Licensed under the Apache License, Version 2.0 (the "License"); you may
*  not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*  http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
*  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***************************************************************************
*
*  FNET Shell service API.
*
***************************************************************************/
#ifndef _FNET_SHELL_H_

#define _FNET_SHELL_H_

/**************************************************************************/ 
#define FNET_SHELL_QUOTE_SYMBOL      '\''

/**************************************************************************/ 
#define FNET_SHELL_ESCAPE_SYMBOL      '\\'

/**************************************************************************/ 
#define FNET_SHELL_COMMAND_SPLITTER          ';'

/**************************************************************************/ 
typedef enum
{
    FNET_SHELL_STATE_DISABLED = 0,      
    FNET_SHELL_STATE_INIT,              
    FNET_SHELL_STATE_GET_USER_INPUT,    
    FNET_SHELL_STATE_EXEC_CMD,          
    FNET_SHELL_STATE_BLOCKED,           
    FNET_SHELL_STATE_END_CMD            
} fnet_shell_state_t;

/**************************************************************************/ 
typedef void *fnet_shell_desc_t;

/**************************************************************************/ 
typedef void(*fnet_shell_cmd_function_t)( fnet_shell_desc_t desc, fnet_index_t argc, fnet_char_t **argv );

/**************************************************************************/ 
typedef struct
{
    const fnet_char_t           *name;          
    fnet_index_t                min_args;       
    fnet_index_t                max_args;       
    fnet_shell_cmd_function_t   cmd_ptr;        
    fnet_char_t                 *description;   
    fnet_char_t                 *syntax;        
} fnet_shell_command_t;

/**************************************************************************/ 
typedef struct
{
    const fnet_shell_command_t      *cmd_table;     
    fnet_char_t                     *prompt_str;    
    void (*shell_init)( fnet_shell_desc_t shell_desc );
} fnet_shell_t;


/**************************************************************************/ 
typedef struct
{
    const fnet_shell_t      *shell;                 
    fnet_char_t             *cmd_line_buffer;       
    fnet_size_t             cmd_line_buffer_size;   
    fnet_serial_stream_t    stream;                 
    fnet_bool_t             echo;                   
} fnet_shell_params_t;

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_shell_desc_t fnet_shell_init( fnet_shell_params_t *params);

/***************************************************************************/ 
void fnet_shell_release(fnet_shell_desc_t desc);

/***************************************************************************/ 
void fnet_shell_help( fnet_shell_desc_t desc);


/***************************************************************************/ 
fnet_return_t fnet_shell_script(fnet_shell_desc_t desc, fnet_char_t *script );

/***************************************************************************/ 
void fnet_shell_script_stop( fnet_shell_desc_t desc);

/***************************************************************************/ 
fnet_return_t fnet_shell_block( fnet_shell_desc_t desc, void (*on_ctrlc)(fnet_shell_desc_t shl_desc, void *cookie), void *cookie);

/***************************************************************************/ 
void fnet_shell_unblock( fnet_shell_desc_t desc);

/***************************************************************************/ 
fnet_size_t fnet_shell_printf(fnet_shell_desc_t desc, const fnet_char_t *format, ... );

/***************************************************************************/ 
fnet_size_t fnet_shell_println(fnet_shell_desc_t desc, const fnet_char_t *format, ... );

/***************************************************************************/ 
void fnet_shell_putchar(fnet_shell_desc_t desc, fnet_char_t character);

/***************************************************************************/ 
fnet_int32_t fnet_shell_getchar(fnet_shell_desc_t desc);

/***************************************************************************/ 
fnet_return_t fnet_shell_switch( fnet_shell_desc_t desc, const fnet_shell_t *switch_shell);

/***************************************************************************/ 
fnet_bool_t fnet_shell_is_ctrlc (fnet_shell_desc_t desc);

/***************************************************************************/ 
const fnet_shell_command_t *fnet_shell_get_command_by_name(fnet_shell_desc_t desc, const fnet_char_t *name);

#if defined(__cplusplus)
}
#endif

#endif