source: git/factory/ftest/ftest_util.m4 @ 040544

dnl $Id: ftest_util.m4,v 1.11 1997-11-13 08:37:43 schmidt Exp $
dnl
dnl ftest_util.m4 - m4 macros used by the factory test environment.
dnl
dnl "External" macro start with prefix `ftest', "internal" macros
dnl with prefix `_'.
dnl
dnl Note: mind the ';'!
dnl
dnl do not output anything of this library
divert(-1)

#
# - internal macros.
#

#
# _stripTWS() - strip trailing white space from $1.
#
define(`_stripTWS', `dnl
patsubst(`$1', `[       ]*$')')

#
# _qstripTWS() - strip trailing white space from $1, return
#   quoted result.
#
define(`_qstripTWS', `dnl
ifelse(
  translit(`$1', `      '), `', ,
  `patsubst(`$1', `\(.*[^       ]\)[    ]*$', ``\1'')')')


#
# - external macros.
#

#
# ftestSetNameOfGame() - set name of game.
#
# $1: name of algorithm
# $2: usage of algorithm
#
# These are stored in the macros `ftestAlgorithm' and
# `ftestUsage', resp.  Leave notice on creator of this file.
#
define(`ftestSetNameOfGame', `dnl
define(`ftestAlgorithm',``$1'')dnl
define(`ftestUsage',``$2'')dnl
`/* This file was automatically generated by m4 using the ftest_util.m4 library */'')

#
# ftestPreprocInit() - initial preprocessor directives.
#
# In addition, we change m4's comment character.
#
define(`ftestPreprocInit', `dnl
changecom(`//')dnl
`#include <unistd.h>

#define TIMING
#include <timing.h>

#include <factory.h>

#include "ftest_util.h"
#include "ftest_io.h"
'')

#
# ftestGlobalInit() - global initialization.
#
define(`ftestGlobalInit', `dnl
`TIMING_DEFINE_PRINT( ftestTimer )'')

#
# ftestMainInit() - initialization in main().
#
define(`ftestMainInit', `dnl
`int optind = 0;
    ftestStatusT check = UndefinedResult;

    ftestSetName( argv[0], "'ftestAlgorithm`", 'ftestUsage`);

    ftestSignalCatch()'')

#
# ftestMainExit() - clean up in main().
#
define(`ftestMainExit', `dnl
`return check'')

#
# ftestOutVar() - declare output variable.
#
# $1: type of output variable
# $2: name of output variable
#
# Stores type of variable in macro _ftestOutType_<name>.
#
define(`ftestOutVar', `dnl
define(`_ftestOutType_'_qstripTWS(`$2'), `$1')dnl
ifelse(`$1', `int',
  ``$1 '_qstripTWS(`$2')` = 0;'',
  ``$1 '_qstripTWS(`$2')`;'')')

#
# ftestInVar() - declare input variable.
#
# $1: type of input variable
# $2: name of input variable
#
# Stores type of variable in macro _ftestInType_<name>.
#
define(`ftestInVar', `dnl
define(`_ftestInType_'_qstripTWS(`$2'), `$1')dnl
ifelse(`$1', `int',
  ``$1 '_qstripTWS(`$2')` = 0;'',
  ``$1 '_qstripTWS(`$2')`;'')`
    bool ftestArgGiven$2= false'')

#
# ftestGetOpts() - read options.
#
define(`ftestGetOpts', `dnl
`ftestGetOpts( argc, argv, optind )'')

#
# ftestGetEnv() - read environment.
#
define(`ftestGetEnv', `dnl
`ftestGetEnv( argc, argv, optind );
    ftestPrintEnv()'')

#
# ftestGetInVar() - read variable from command line.
#
# $1: name of input variable
# $2: default for optional command line arguments
#
define(`ftestGetInVar', `dnl
ifelse(`$#', `1',
  ``if ( argv[ optind ] ) {
        ftestArgGiven$1= true;
        $1= ftestGet'_stripTWS(`_ftestInType_$1')`( argv[ optind++ ] );
    } else
        ftestError( CommandlineError,
                    "expected '_stripTWS(`_ftestInType_$1')` at position %d in commandline\n",
                    optind )'',
  ``if ( argv[ optind ] ) {
        ftestArgGiven$1 = true;
        $1 = ftestGet'_stripTWS(`_ftestInType_$1')`( argv[ optind++ ] );
    } else
        $1 = '_qstripTWS(`$2')')')

#
# ftestArgGiven() - check whether an argument was given.
#
# $1: name of input variable
#
define(`ftestArgGiven', `dnl
`ftestArgGiven'_qstripTWS(`$1')')

#
# ftestSetEnv() - set factory environment.
#
define(`ftestSetEnv', `dnl
`ftestSetEnv();
    ftestPrintEnv()'')

#
# ftestRun() - run test.
#
# $1: code to execute
#
define(`ftestRun', `dnl
`ftestWriteSeed();                      // save random generator seed
    if ( ftestAlarm )
        alarm( ftestAlarm );            // set alarm
    TIMING_START(ftestTimer);
    while ( ftestCircle > 0 ) {
        $1
        ftestCircle--;
    };
    TIMING_END(ftestTimer)'')

#
# ftestCheck() - run check.
#
# $1: check function (with parameters) to call
#
define(`ftestCheck', `dnl
`check = '_qstripTWS(`$1')')

#
# ftestOuput() - print results.
#
# Expands to code to print timer and check.  Then, for each
# argument pair `resultName, result', expands to print this
# pair.
#

# internal auxiliary function
define(`_ftestOutput', `dnl
ifelse(`$#', `0', ,
  `$#', `1', ,
``;
    ftestPrintResult( $1, '_qstripTWS(`$2')` )'_ftestOutput(shift(shift($@)))')')

define(`ftestOutput', `dnl
`ftestPrintTimer( timing_ftestTimer_time );
    ftestPrintCheck( check )'_ftestOutput($@)')

dnl switch on output again
divert`'dnl