pigpio/command.h

/*
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>
*/

/*
This version is for pigpio version 13+
*/

#ifndef COMMAND_H
#define COMMAND_H

#include <stdio.h>
#include <string.h>

#include "pigpio.h"

#define MAX_PARAM 512

#define PARSE_FLAGS_PARAMS 1
#define PARSE_FLAGS_VARS   2

#define CMD_NUMERIC 1
#define CMD_PARAM   2
#define CMD_VAR     3

typedef struct
{
   int     flags;
   int     eaten;
   uint8_t opt[8];
} gpioCtlParse_t;

typedef struct
{
   int   cmd;  /* command number            */
   char *name; /* command name              */
   int   vt;   /* command verification type */
   int   rv;   /* command return value type */
} cmdInfo_t;

extern cmdInfo_t cmdInfo[];

extern char *cmdUsage;

int cmdParse(char *buf, uint32_t *p, void **v, gpioCtlParse_t *ctlParse);

char *cmdErrStr(int error);

char *cmdStr(void);

#endif