option.h

Go to the documentation of this file.

/*
 * This work is licensed under a Creative Commons 
 * Attribution-Noncommercial-Share Alike 3.0 United States License.
 * 
 *    http://creativecommons.org/licenses/by-nc-sa/3.0/us/
 * 
 * You are free:
 * 
 *    to Share - to copy, distribute, display, and perform the work
 *    to Remix - to make derivative works
 * 
 * Under the following conditions:
 * 
 *    Attribution. You must attribute the work in the manner specified by the
 *    author or licensor (but not in any way that suggests that they endorse you
 *    or your use of the work).
 * 
 *    Noncommercial. You may not use this work for commercial purposes.
 * 
 *    Share Alike. If you alter, transform, or build upon this work, you may
 *    distribute the resulting work only under the same or similar license to
 *    this one.
 * 
 * For any reuse or distribution, you must make clear to others the license
 * terms of this work. The best way to do this is by including this header.
 * 
 * Any of the above conditions can be waived if you get permission from the
 * copyright holder.
 * 
 * Apart from the remix rights granted under this license, nothing in this
 * license impairs or restricts the author's moral rights.
 */


#ifndef OPTION_H
#define OPTION_H


#include <jwsc/config.h>

#include <stdlib.h>
#include <stdio.h>

#include "jwsc/base/error.h"


#ifdef __cplusplus
namespace jwsc {
extern "C" {
#endif


typedef const char* Option_string;

typedef char Option_flag;

typedef const char* Option_desc;

typedef const char* Option_arg;

typedef Error* (*Option_func_with_arg)(Option_arg);

typedef Error* (*Option_func_no_arg)(void);


typedef struct
{
    Option_string string;

    Option_flag flag;

    Option_desc desc;

    Option_func_with_arg func;
}
Option_with_arg;


typedef struct
{
    Option_string string;

    Option_flag flag;

    Option_desc desc;

    Option_func_no_arg func;
}
Option_no_arg;


void init_option_with_arg
(
    Option_with_arg*     opt,
    Option_string        str, 
    Option_flag          flag, 
    Option_desc          desc,
    Option_func_with_arg func
);


void init_option_no_arg
(
    Option_no_arg*     opt,
    Option_string      str, 
    Option_flag        flag, 
    Option_desc        desc,
    Option_func_no_arg func
);


Error* process_option_with_arg
(
    int              argc, 
    const char**     argv, 
    int*             argi,
    Option_with_arg* opt
);


Error* process_option_no_arg
(
    int            argc, 
    const char**   argv, 
    int*           argi,
    Option_no_arg* opt
);


Error* process_options
(
    int              argc, 
    const char**     argv, 
    int*             argi,
    int              num_opts_no_arg,
    Option_no_arg*   opts_no_arg,
    int              num_opts_with_arg,
    Option_with_arg* opts_with_arg
);


Error* process_options_from_file
(
    const char*      fname,
    int              num_opts_no_arg,
    Option_no_arg*   opts_no_arg,
    int              num_opts_with_arg,
    Option_with_arg* opts_with_arg
);


void print_option_with_arg
(
    FILE*            fp,
    int              opt_width,
    Option_with_arg* opt
);


void print_option_no_arg
(
    FILE*          fp,
    int            opt_width,
    Option_no_arg* opt
);


void print_options
(
    FILE*            fp,
    int              opt_width,
    int              num_opts_no_arg,
    Option_no_arg*   opts_no_arg,
    int              num_opts_with_arg,
    Option_with_arg* opts_with_arg
);


#ifdef __cplusplus
}
}
#endif


#endif