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 16+
*/

#ifndef COMMAND_H
#define COMMAND_H

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

#include "pigpio.h"

#define CMD_MAX_PARAM 512
#define CMD_MAX_EXTENSION 8192

#define CMD_UNKNOWN_CMD   -1
#define CMD_BAD_PARAMETER -2
#define CMD_EXT_TOO_SMALL -3

#define CMD_P_ARR 10
#define CMD_V_ARR 10

#define CMD_NUMERIC 1
#define CMD_VAR     2
#define CMD_PAR     3

typedef struct
{
   uint32_t cmd;
   uint32_t p1;
   uint32_t p2;
   union
   {
      uint32_t p3;
      uint32_t ext_len;
      uint32_t res;
   };
} cmdCmd_t;

typedef struct
{
   int    eaten;
   int8_t opt[4];
} cmdCtlParse_t;

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

typedef struct
{
   uint32_t tag;
   int      step;
} cmdTagStep_t;

typedef struct
{
   uint32_t p[5];
   int8_t opt[4];
} cmdInstr_t;

typedef struct
{
   /*
     +-----------+---------+---------+----------------+
     | PARAMS... | VARS... | CMDS... | STRING AREA... |
     +-----------+---------+---------+----------------+
   */
   int *par;
   int *var;
   cmdInstr_t *instr;
   int instrs;
   char *str_area;
   int str_area_len;
   int str_area_pos;
} cmdScript_t;

extern cmdInfo_t cmdInfo[];

extern char *cmdUsage;

int cmdParse(char *buf, uint32_t *p, unsigned ext_len, char *ext, cmdCtlParse_t *ctl);

int cmdParseScript(char *script, cmdScript_t *s, int diags);

char *cmdErrStr(int error);

char *cmdStr(void);

#endif