example_config.c File Reference

Example of using the librnr config module. More...

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/config.h"

Go to the source code of this file.

Classes
struct	Cmd_T
	command structure type More...

Macros
#define	CHKARGS(argc, min)
	Check argument count against minimum required. More...
#define	CHKCFG()
	Check that the configuration db exists. More...
#define	CHKNOCFG()
	Check that the configuration db does not exist. More...

Typedefs
typedef void(*	CmdExec_T) (int, char *[])
	command execution function type

Functions
static void	CmdHelp (int argc, char *argv[])
	Print command help. More...
static void	CmdQuit (int argc, char *argv[])
	Quit this example program. More...
static void	CmdLog (int argc, char *argv[])
	Set diagnotics logging level. More...
static void	CmdDbDelete (int argc, char *argv[])
	Delete configuration db. More...
static void	CmdDbNew (int argc, char *argv[])
	Create new, empty configuration db. More...
static void	CmdDbPrint (int argc, char *argv[])
	Print out entire configuration db. More...
static void	CmdDbRead (int argc, char *argv[])
	Create new configuration db from file. More...
static void	CmdDelete (int argc, char *argv[])
	Delete configuration key. More...
static void	CmdFind (int argc, char *argv[])
	Find configuration key=values matching substring. More...
static void	CmdGetd (int argc, char *argv[])
	Get configuration value string converting to double. More...
static void	CmdGeti (int argc, char *argv[])
	Get configuration value string converting to int. More...
static void	CmdGets (int argc, char *argv[])
	Get configuration value string. More...
static void	CmdSectDelete (int argc, char *argv[])
	Delete entier configuration db section. More...
static void	CmdSectNew (int argc, char *argv[])
	Create new, empty configuration db section. More...
static void	CmdSetd (int argc, char *argv[])
	Set or create key=<double> entry in section. More...
static void	CmdSeti (int argc, char *argv[])
	Set or create key=<int> entry in section. More...
static void	CmdSets (int argc, char *argv[])
	Set or create key=<string> entry in section. More...
static int	Tokenize (char *string, char *tokv[], size_t tokmax)
	Tokenize input. More...
static Cmd_T *	MatchCmd (const char *sPattern, Cmd_T tblCmds[])
	Match command. More...
int	main (int argc, char *argv[])
	Example main. More...

Variables
static Config_T *	TheConfig = NULL
	the configuration db
static Cmd_T	CmdTbl []
	The command set.

Detailed Description

Example of using the librnr config module.

LastChangedDate

2011-11-18 13:30:34 -0700 (Fri, 18 Nov 2011)

Rev

1577

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2007-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

Definition in file example_config.c.

Macro Definition Documentation

#define CHKARGS	(		argc,
			min
	)

Value:

{ if((argc-1) < min) \
    { \
      fprintf(stderr, "Error: %d arguments required\n", min); \
      return; \
    } \
  }

Check argument count against minimum required.

Parameters

argc	Argument count.
min	Required minimum count.

Definition at line 77 of file example_config.c.

Referenced by CmdDbRead(), CmdDelete(), CmdFind(), CmdGetd(), CmdGeti(), CmdGets(), CmdLog(), CmdSectDelete(), CmdSectNew(), CmdSetd(), CmdSeti(), and CmdSets().

#define CHKCFG

(

)

Value:

{ \
    if(TheConfig == NULL) \
    { \
      fprintf(stderr, "Error: configuration db does not exist\n"); \
      return; \
    } \
  }

Check that the configuration db exists.

Definition at line 88 of file example_config.c.

Referenced by CmdDbDelete(), CmdDbPrint(), CmdDelete(), CmdFind(), CmdGetd(), CmdGeti(), CmdGets(), CmdSectDelete(), CmdSectNew(), CmdSetd(), CmdSeti(), and CmdSets().

#define CHKNOCFG

(

)

Value:

{ \
    if(TheConfig != NULL) \
    { \
      fprintf(stderr, "Error: configuration %s exists - delete first\n", \
        ConfigDbGetName(TheConfig)); \
      return; \
    } \
  }

Check that the configuration db does not exist.

Definition at line 100 of file example_config.c.

Referenced by CmdDbNew(), and CmdDbRead().

Function Documentation

static void CmdDbDelete ( int  argc, char *  argv[]  )

static

Delete configuration db.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 147 of file example_config.c.

References CHKCFG, ConfigDbDelete(), and NULL.

{
  CHKCFG();

  ConfigDbDelete(TheConfig);
  TheConfig = NULL;
}

static void CmdDbNew ( int  argc, char *  argv[]  )

static

Create new, empty configuration db.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 161 of file example_config.c.

References CHKNOCFG, ConfigDbNew(), and NULL.

{
  CHKNOCFG();

  TheConfig = ConfigDbNew(NULL);
}

static void CmdDbPrint ( int  argc, char *  argv[]  )

static

Print out entire configuration db.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 174 of file example_config.c.

References CHKCFG, and ConfigDbPrint().

{
  CHKCFG();

  ConfigDbPrint(TheConfig, stdout);
}

static void CmdDbRead ( int  argc, char *  argv[]  )

static

Create new configuration db from file.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 187 of file example_config.c.

References CHKARGS, CHKNOCFG, and ConfigDbRead().

{
  CHKARGS(argc, 1);
  CHKNOCFG();

  TheConfig = ConfigDbRead(argv[1]);
}

static void CmdDelete ( int  argc, char *  argv[]  )

static

Delete configuration key.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 201 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigDelete(), and OK.

{
  CHKARGS(argc, 2);
  CHKCFG();

  if( ConfigDelete(TheConfig, argv[1], argv[2]) != OK )
  {
    printf("Error: failed to delete\n");
  }
  else
  {
    printf("%s: [%s]: %s: deleted\n", ConfigDbGetName(TheConfig),
      argv[1], argv[2]);
  }
}

static void CmdFind ( int  argc, char *  argv[]  )

static

Find configuration key=values matching substring.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 223 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigDbIterNew(), ConfigGetStr(), ConfigIterDelete(), ConfigIterNext(), ConfigSectionIterNew(), and NULL.

{
  char          *sPat;
  size_t         lenPat;
  ConfigIter_T  *pIterSects;
  ConfigIter_T  *pIterKeys;
  const char    *sSectionName;
  const char    *sKey;
  const char    *sVal;

  CHKARGS(argc, 1);
  CHKCFG();

  sPat    = argv[1];
  lenPat  = strlen(sPat);

  pIterSects = ConfigDbIterNew(TheConfig);

  while( (sSectionName = ConfigIterNext(pIterSects)) != NULL )
  {
    pIterKeys = ConfigSectionIterNew(TheConfig, sSectionName);

    while( (sKey = ConfigIterNext(pIterKeys)) != NULL )
    {
      if( !strncmp(sPat, sKey, lenPat) )
      {
        sVal = ConfigGetStr(TheConfig, sSectionName, sKey);
        printf("%s: [%s]: %s=%s\n",
          ConfigDbGetName(TheConfig), sSectionName, sKey, sVal);
      }
    }

    ConfigIterDelete(pIterKeys);
  }

  ConfigIterDelete(pIterSects);
}

static void CmdGetd ( int  argc, char *  argv[]  )

static

Get configuration value string converting to double.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 267 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigGetDouble(), and OK.

{
  double  fVal;

  CHKARGS(argc, 2);
  CHKCFG();

  if( ConfigGetDouble(TheConfig, argv[1], argv[2], &fVal) != OK )
  {
    printf("Error: failed to get/convert\n");
  }
  else
  {
    printf("%s: [%s]: %s=%f\n", ConfigDbGetName(TheConfig),
      argv[1], argv[2], fVal);
  }
}

static void CmdGeti ( int  argc, char *  argv[]  )

static

Get configuration value string converting to int.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 291 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigGetInt(), and OK.

{
  int  iVal;

  CHKARGS(argc, 2);
  CHKCFG();

  if( ConfigGetInt(TheConfig, argv[1], argv[2], &iVal) != OK )
  {
    printf("Error: failed to get/convert\n");
  }
  else
  {
    printf("%s: [%s]: %s=%d\n", ConfigDbGetName(TheConfig),
      argv[1], argv[2], iVal);
  }
}

static void CmdGets ( int  argc, char *  argv[]  )

static

Get configuration value string.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 315 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigGetStr(), and NULL.

{
  const char  *sVal;

  CHKARGS(argc, 2);
  CHKCFG();

  if( (sVal = ConfigGetStr(TheConfig, argv[1], argv[2])) == NULL )
  {
    printf("Error: failed to get\n");
  }
  else
  {
    printf("%s: [%s]: %s=%s\n", ConfigDbGetName(TheConfig),
      argv[1], argv[2], sVal);
  }
}

static void CmdHelp ( int  argc, char *  argv[]  )

static

Print command help.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 524 of file example_config.c.

References Cmd_T::m_sCmdHelpArgs, Cmd_T::m_sCmdHelpDesc, Cmd_T::m_sCmdName, and NULL.

{
  Cmd_T *pCmd;
  int    n;

  for(pCmd=CmdTbl; pCmd->m_sCmdName!=NULL; pCmd++)
  {
    n = printf("%s %s", pCmd->m_sCmdName, pCmd->m_sCmdHelpArgs);
    printf("%*s - %s\n", 30-n, "", pCmd->m_sCmdHelpDesc);
  }
}

static void CmdLog ( int  argc, char *  argv[]  )

static

Set diagnotics logging level.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 130 of file example_config.c.

References CHKARGS, and LOG_SET_THRESHOLD().

{
  int   n;

  CHKARGS(argc, 1);

  n = atoi(argv[1]);

  LOG_SET_THRESHOLD(n);
}

static void CmdQuit ( int  argc, char *  argv[]  )

static

Quit this example program.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 119 of file example_config.c.

{
  exit(0);
}

static void CmdSectDelete ( int  argc, char *  argv[]  )

static

Delete entier configuration db section.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 339 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigSectionDelete(), ConfigSectionGet(), and NULL.

{
  ConfigSection_T *pSect;

  CHKARGS(argc, 1);
  CHKCFG();

  if( (pSect = ConfigSectionGet(TheConfig, argv[1])) == NULL )
  {
    printf("Error: failed to delete section\n");
  }
  else
  {
    ConfigSectionDelete(TheConfig, pSect);
    printf("%s: [%s] deleted\n", ConfigDbGetName(TheConfig), argv[1]);
  }
}

static void CmdSectNew ( int  argc, char *  argv[]  )

static

Create new, empty configuration db section.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 363 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigSectionNew(), and NULL.

{
  CHKARGS(argc, 1);
  CHKCFG();

  if( ConfigSectionNew(TheConfig, argv[1]) == NULL )
  {
    printf("Error: failed to add section\n");
  }
  else
  {
    printf("%s: [%s] added\n", ConfigDbGetName(TheConfig), argv[1]);
  }
}

static void CmdSetd ( int  argc, char *  argv[]  )

static

Set or create key=<double> entry in section.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 384 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigSetDouble(), and OK.

{
  double  fVal;

  CHKARGS(argc, 3);
  CHKCFG();

  fVal = atof(argv[3]);

  if( ConfigSetDouble(TheConfig, argv[1], argv[2], fVal) != OK )
  {
    printf("Error: failed to set\n");
  }
  else
  {
    printf("%s: [%s]: %s=%f\n", ConfigDbGetName(TheConfig),
        argv[1], argv[2], fVal);
  }
}

static void CmdSeti ( int  argc, char *  argv[]  )

static

Set or create key=<int> entry in section.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 410 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigSetInt(), and OK.

{
  int  iVal;

  CHKARGS(argc, 3);
  CHKCFG();

  iVal = atoi(argv[3]);

  if( ConfigSetInt(TheConfig, argv[1], argv[2], iVal) != OK )
  {
    printf("Error: failed to set\n");
  }
  else
  {
    printf("%s: [%s]: %s=%d\n", ConfigDbGetName(TheConfig),
        argv[1], argv[2], iVal);
  }
}

static void CmdSets ( int  argc, char *  argv[]  )

static

Set or create key=<string> entry in section.

Parameters

argc	Command argument count.
argv	Array of arguments.

Definition at line 436 of file example_config.c.

References CHKARGS, CHKCFG, ConfigDbGetName(), ConfigSetStr(), and OK.

{
  CHKARGS(argc, 3);
  CHKCFG();

  if( ConfigSetStr(TheConfig, argv[1], argv[2], argv[3]) != OK )
  {
    printf("Error: failed to set\n");
  }
  else
  {
    printf("%s: [%s]: %s=%s\n", ConfigDbGetName(TheConfig),
      argv[1], argv[2], argv[3]);
  }
}

int main	(	int	argc,
		char *	argv[]
	)

Example main.

Parameters

argc	Command-line argument count.
argv	Command-line argument list.

Exit Status:

Program exits with 0 success, > 0 on failure.

Definition at line 654 of file example_config.c.

References arraysize, Cmd_T::m_fnCmdExec, MatchCmd(), NULL, and Tokenize().

{
  char      input[256];
  int       tokc;
  char     *tokv[16];
  Cmd_T    *pCmd;

  printf("  Configuration Example\n");
  printf("(enter 'help' for list of commands; "
         "partial command matching supported)\n\n");

  // process user commands
  for(;;)
  {
    printf("config> ");

    // read user input
    if( !fgets(input, (int)sizeof(input), stdin) )
    {
      break;
    }

    // tokenize input
    tokc = Tokenize(input, tokv, arraysize(tokv));

    if( tokc <= 0 )
    {
      continue;
    }

    // find command
    pCmd = MatchCmd(tokv[0], CmdTbl);

    if( pCmd != NULL )
    {
      // execute command
      pCmd->m_fnCmdExec(tokc, tokv);
    }
  }

  return 0;
}

static Cmd_T* MatchCmd ( const char *  sPattern, Cmd_T  tblCmds[]  )

static

Match command.

Parameters

sPattern	(Partial) command string.
tblCmds	Table of commands.

Definition at line 581 of file example_config.c.

References Cmd_T::m_sCmdName, and NULL.

Referenced by main().

{
  Cmd_T         *p;
  Cmd_T         *pCmd = NULL;
  size_t         n;
  bool_t         bIsUnique = true;
  int            cnt;
  
  n = strlen(sPattern);

  // find command
  for(p=tblCmds; p->m_sCmdName!=NULL; p++)
  {
    if( !strncmp(sPattern, p->m_sCmdName, n) )
    {
      pCmd = p;
      break;
    }
  }

  // no matching command found
  if( pCmd == NULL )
  {
    fprintf(stderr, "Error: %s: Command not found\n", sPattern);
    return NULL;
  }

  // verify uniqueness
  for(p=tblCmds, cnt=0; p->m_sCmdName!=NULL; p++)
  {
    if( (p != pCmd) && !strncmp(sPattern, p->m_sCmdName, n) )
    {
      cnt++;

      // first non-unique
      if( bIsUnique )
      {
        fprintf(stderr, "Error: %s: Command not unique: Matches %s %s ",
            sPattern, pCmd->m_sCmdName, p->m_sCmdName);
        bIsUnique = false;
      }
      // subsequent non-unique
      else if( cnt < 3 )
      {
        fprintf(stderr, "%s ", p->m_sCmdName);
      }
      // too many to print
      else
      {
        fprintf(stderr, "...");
        break;
      }
    }
  }

  if( !bIsUnique )
  {
    fprintf(stderr, "\n");
    return NULL;
  }

  return pCmd;
}

static int Tokenize ( char *  string, char *  tokv[], size_t  tokmax  )

static

Tokenize input.

Parameters

	string	Input string
[out]	tokv	Array of tokens.
	tokmax	Maximum number of tokens.

Returns

Number of tokens.

Definition at line 545 of file example_config.c.

Referenced by main().

{
  int       tokc = 0;

  while( tokc < tokmax )
  {
    while(*string && isspace((int)*string))
    {
      string++;
    }
    if(!*string)
    {
      break;
    }
    tokv[tokc] = string;
    while(*string && !isspace((int)*string))
    {
      string++;
    }
    tokc++;
    if( *string == 0 )
    {
      break;
    }
    *string++ = 0;
  }

  return tokc;
}