example_log.c File Reference

Example of librnr support for logging and command-line options processing. More...

#include <stdio.h>
#include <string.h>
#include <libgen.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/opts.h"
#include "version.h"

Go to the source code of this file.

Functions
static void	logtest_num1 (void *p, const char *sFruit, int n, int half, double f, int hex, bool_t bAreRipe)
	Log test number 1. More...
static void	logtest_num2 (int count)
	Log test number 2. More...
static int	runlogtests ()
	Run log test(s). More...
static int	init (int argc, char *argv[])
	Main initialization. More...
int	main (int argc, char *argv[])
	Example main. More...

Variables
static char *	Argv0
	the command
static int	OptsTest = 1
	test option value
static OptsPgmInfo_T	LogExamplePgmInfo
	Program information. More...
static OptsInfo_T	LogExampleOptsInfo []
	Command line options information. More...

Detailed Description

Example of librnr support for logging and command-line options processing.

LastChangedDate

2012-10-31 09:53:31 -0600 (Wed, 31 Oct 2012)

Rev

2497

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_log.c.

Function Documentation

static int init ( int  argc, char *  argv[]  )

static

Main initialization.

Parameters

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

Returns

Returns 1 on success, exits on failure.

Definition at line 201 of file example_log.c.

References Argv0, CHKEXPR_INT, LOG_GET_LOGFP(), LOG_LEVEL_DIAG1, LOGABLE, LOGDIAG1, OptsGet(), OptsTest, and PkgInfo.

Referenced by main().

{
  FILE  *fp;
  int    i;

  // name of this process
  Argv0 = basename(argv[0]);

  // parse input options
  argv = OptsGet(Argv0, &PkgInfo, &LogExamplePgmInfo, LogExampleOptsInfo, true,
                 &argc, argv);

  // test log helper macro
  CHKEXPR_INT(OptsTest, ((OptsTest >= 0) || (OptsTest <= 3)), 0);

  // test complicated logging
  if( LOGABLE(LOG_LEVEL_DIAG1) )
  {
    LOGDIAG1("Post options processed non-option arguments:");
    fp = LOG_GET_LOGFP();
    for(i=0; i<argc; ++i)
    {
      fprintf(fp, "  argv[%d]=\"%s\"\n", i, argv[i]);
    }
  }
 
  return 1;
}

static void logtest_num1 ( void *  p, const char *  sFruit, int  n, int  half, double  f, int  hex, bool_t  bAreRipe  )

static

Log test number 1.

Parameters

p	Void pointer.
sFruit	Character pointer.
n	Integer.
half	Short.
f	Double.
hex	Integer in hex.
bAreRipe	Boolean.

Definition at line 111 of file example_log.c.

References _TBOOL, _TFLOAT, _THEX, _TINT, _TPTR, _TSHORT, _TSTR, LOGDIAG1CALL, and LOGDIAG2.

Referenced by runlogtests().

{
  // test log function call diagnostics 1
  LOGDIAG1CALL(_TPTR(p), _TSTR(sFruit), _TINT(n), _TSHORT(half), _TFLOAT(f),
      _THEX(hex), _TBOOL(bAreRipe));

  // test diagnostic 2 test
  if( bAreRipe )
  {
    LOGDIAG2("There are %d juicy %s in %s", n, sFruit, "Tuscany");
  }
  else
  {
    LOGDIAG2("There are %d green %s in %s", n, sFruit, "Utah");
  }
}

static void logtest_num2 ( int  count )

static

Log test number 2.

Parameters

count

Count.

Definition at line 134 of file example_log.c.

References _TINT, LOGDIAG2CALL, LOGDIAG4, LOGERROR, LOGSYSERROR, LOGWARN, and NULL.

Referenced by runlogtests().

{
  FILE        *fp;
  const char  *sFileName = "PackingShedOnStrike.newsflash";

  // test log function call diagnostics 2
  LOGDIAG2CALL(_TINT(count));

  LOGWARN("Ebola is your friend, Mr. %s.", "Sicko");

  // test error logging
  while( count-- > 0 )
  {
    LOGERROR("Salmonella scare %d...", count);
  }

  // test system error logging
  if( (fp = fopen(sFileName, "r")) == NULL )
  {
    LOGSYSERROR("%s", sFileName);
  }
  else
  {
    LOGDIAG4("%s: what a pleasant surprise", sFileName);
    fclose(fp);
  }
}

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 239 of file example_log.c.

References init(), and runlogtests().

{
  printf("arch   : %s\n", ARCH);

  if( !init(argc, argv) )
  {
    return 3;
  }

  return runlogtests()? 0: 4;
}

static int runlogtests ( )

static

Run log test(s).

Returns

1 on success, > 0 on failure.

Definition at line 167 of file example_log.c.

References LOGERROR, logtest_num1(), logtest_num2(), and OptsTest.

Referenced by main().

{
  short   h = 10;
  int     i = 12;

  switch( OptsTest )
  {
    case 0:
      break;
    case 1:
      logtest_num1(&i, "apples", 53, h, 123.5, 0xdead, false);
      break;
    case 2:
      logtest_num2(3);
      break;
    case 3:
      logtest_num1(&h, "pears", 12, h, -1.5E-2, 0xf1, true);
      logtest_num2(3);
      break;
    default:
      LOGERROR("bug: %d: unexpected test", OptsTest);
      return 0;
  }
  return 1;
}

Variable Documentation

OptsInfo_T LogExampleOptsInfo[]

static

Initial value:

=
{
  
  {
    .long_opt   = "test",
    .short_opt  = 't',
    .has_arg    = required_argument,
    .has_default= true,
    .opt_addr   = &OptsTest,
    .fn_cvt     = OptsCvtArgInt,
    .fn_fmt     = OptsFmtInt,
    .arg_name   = "<test>",
    .opt_desc   =
      "Set the logging test(s) to conduct.\n"
      "%A is one of:\n"
      "  0   - No tests.\n"
      "  1   - Test #1.\n"
      "  2   - Test #2.\n"
      "  3   - All tests."
  },

  {NULL, }
}

Command line options information.

Definition at line 76 of file example_log.c.

OptsPgmInfo_T LogExamplePgmInfo

static

Initial value:

=
{
  .synopsis = "Example of librnr logging and options processing facilities.",

  .long_desc = 
    "The %P command demonstrates various macros and functions of the "
    "librnr logging facilities, plus command-line options processing."
}

Program information.

Definition at line 64 of file example_log.c.