cli.h

/* Copyright Statement:
 *
 * (C) 2005-2016  MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User").  If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __CLI_H__
#define __CLI_H__

#include <stdint.h>

#include "putter.h"

#ifdef __cplusplus
extern "C" {
#endif

/****************************************************************************
 *
 * Constants.
 *
 ****************************************************************************/

#define CLI_MAX_TOKENS      (20)

/****************************************************************************
 *
 * Types.
 *
 ****************************************************************************/

typedef int    (*getchar_fptr_t)(void);


typedef int    (*putchar_fptr_t)(int);


typedef uint8_t (*knock_fptr_t)(char *id, char *pass);


typedef uint8_t (*cli_cmd_handler_t)(uint8_t len, char *param[]);

/*****************************************************************************
* Structures
*****************************************************************************/

typedef struct cmd_s cmd_t;


struct cmd_s {
    char                *cmd;       
    char                *help;      
    cli_cmd_handler_t   fptr;       
    cmd_t               *sub;       
};


#if !defined(CLI_DISABLE_LINE_EDIT) && !defined(CLI_DISABLE_HISTORY)

typedef struct cli_history_s cli_history_t;

struct cli_history_s {
    char            **history;     
    char            *input;        
    char            *parse_token;  
    uint16_t        history_max;   
    uint16_t        line_max;      
    uint16_t        index;         
    uint16_t        position;      
    uint8_t         full;          
};
#endif /* !CLI_DISABLE_LINE_EDIT && !CLI_DISABLE_HISTORY */


typedef struct cli_s cli_t;

struct cli_s {
    uint8_t             state;                 
    cmd_t               *cmd;                  
    char                echo;                  
    getchar_fptr_t      get;                   
    putchar_fptr_t      put;                   
    knock_fptr_t        knock;                 
    char                *tok[CLI_MAX_TOKENS];  
#if !defined(CLI_DISABLE_LINE_EDIT) && !defined(CLI_DISABLE_HISTORY)
    cli_history_t       history;               
#endif /* !CLI_DISABLE_LINE_EDIT && !CLI_DISABLE_HISTORY */
};

/****************************************************************************
 *
 * Function prototypes.
 *
 ****************************************************************************/


void cli_init(cli_t *cli);


void cli_line(char *line);


void cli_tokens(uint8_t argc, char *argv[]);


void cli_task(void);


uint8_t cli_logout(uint8_t len, char *param[]);


uint8_t cli_hardcode_login(char *id, char *password);


#ifdef __cplusplus
}
#endif

#endif /* __CLI_H__ */