command_list.h

MANTIS是由科罗拉多大学开发的传感器网络嵌入式操作系统。 这是mantis的0.9.5版本的源码。

//  This file is part of MANTIS OS, Operating System
//  See http://mantis.cs.colorado.edu/
//
//  Copyright (C) 2003,2004,2005 University of Colorado, Boulder
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the mos license (see file LICENSE)


/** @file command_list.h
 * @brief This is an application which will allow interfacing with a nymph from
 * a computer over the serial line, it provides arbitrary functions
 * @author Charles Gruenwald III 
 * @author Modified: Jeff Rose
 * @date Created: 02/12/2004
 * @date Modified 03/10/2004
 */

#ifndef _command_list_h_
#define _command_list_h_

#include <stdbool.h>
#include "com.h"

typedef struct command_list_s {
  char * input;
  void (*func_pointer)(void);
} command_list_t;

char prompt_char(char * string);

/** @brief Register a command.
 * @param in_list Command list data structure
 * @param name Name of function
 * @param func_pointer Location of function
 * @param max_command_count Maximum number of commands
 * @return TRUE if success, else return FALSE
 */
bool register_function(command_list_t in_list [],
		       char * name, void (*func_pointer)(void),
		       uint16_t max_command_count);

/** @brief Command parse function. 
 * @param in_list Command list data structure
 * @param command_string String for command
 * @param max_command_count Maximum number of commands
 * @return TRUE if the command string exists, else return FALSE
 */
bool command_parse(command_list_t in_list [],
		   char *command_string,
		   uint16_t max_command_count);
/** @brief Print the list
 * @param in_list Command list data structure
 * @param max_command_count Maximum number of commands
 */
int16_t help_list(command_list_t in_list [],
		  uint16_t max_command_count);

#endif