SCAN_OPTIONS 3.02

[Back] [Japanese Page]

NAME

set_options - routine to register options
set_option - routine to register an option
alias_option - routine to an register alias of option
scan_options - analyze command-line options
is_option - routine to get result of analyzing options
reset_options - clear internal buffer for these routines

SYNOPSIS

#include <options.h>

typedef struct {
  char *opt;
  void *var;
} option_record;
opt - a key string
var - an argument

void set_options(int n, option_record options[]);
n - the number of key strings to register
options - an array of structure which includes the key and the variable

option_complex *set_option(char *key, ...)
key, ... - key string and multi-variable arguments

option_complex *alias_option(char *key, char *alias);
key - already registered key
alias - its alias

void scan_options(int argc, char *argv[]);
argc - the number of command-line arguments
argv - command-line arguments

int is_option(char *key);
key - the key string

int reset_options()

DESCRIPTION

These routines are for analyzing command-line arguments with keys registered by the structure option_record and set_options or the procedure set_option. You register keys by using set_option or set_options according to your own option rules with variables. You execute scan_options and the variables are set by keys and command-line arguments. You can also get each result of analysis on the key about whether the key exists in command-line arguments or not. Last of all, please execute reset_options to be free internal buffer used by these routines. For an example, a procedure to analyze options with command-line arguments is as follows:
 
char title[256];
int number, color, width, height;
unsigned long plot;
float weight;
int flag, mode, sw;
option_record options[] = {
  { "-title %s", title },
  { "-number %d", &number },
  { "-weight %f", &weight },
  { "-flag[-]", &flag },
  { "[-+]mode", &mode },
  { "[+-]sw", &sw },
  { "-color Red Green Blue", &color },
  { "-plot None|Line|Dot|Point", &plot },
  { "-help", NULL },
};

set_options(9, options);
set_option("-geom %dx%d", &width, &height);
alias_option("-geom", "-geometry");
scan_options(argc, argv);
if (is_option("-help"))
  show_help();
reset_options();


For the styles of key, please see option.h

SEE ALSO

option.h

AUTHOR

Taiji Yamada <taiji@aihara.co.jp>