sc_options.h

Go to the documentation of this file.

/*
  This file is part of the SC Library.
  The SC Library provides support for parallel scientific applications.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
 
  The SC Library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  The SC Library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with the SC Library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/
 
#ifndef SC_OPTIONS_H
#define SC_OPTIONS_H
 
#include <sc_keyvalue.h>
 
SC_EXTERN_C_BEGIN;
 
typedef struct sc_options sc_options_t;
 
typedef int         (*sc_options_callback_t) (sc_options_t * opt,
                                              const char *opt_arg,
                                              void *data);
 
sc_options_t       *sc_options_new (const char *program_path);
 
void                sc_options_destroy_deep (sc_options_t * opt);
 
void                sc_options_destroy (sc_options_t * opt);
 
void                sc_options_set_spacing (sc_options_t * opt,
                                            int space_type, int space_help);
 
void                sc_options_add_switch (sc_options_t * opt,
                                           int opt_char,
                                           const char *opt_name,
                                           int *variable,
                                           const char *help_string);
 
void                sc_options_add_bool (sc_options_t * opt,
                                         int opt_char,
                                         const char *opt_name,
                                         int *variable, int init_value,
                                         const char *help_string);
 
void                sc_options_add_int (sc_options_t * opt,
                                        int opt_char,
                                        const char *opt_name,
                                        int *variable, int init_value,
                                        const char *help_string);
 
void                sc_options_add_size_t (sc_options_t * opt,
                                           int opt_char,
                                           const char *opt_name,
                                           size_t *variable,
                                           size_t init_value,
                                           const char *help_string);
 
void                sc_options_add_double (sc_options_t * opt,
                                           int opt_char,
                                           const char *opt_name,
                                           double *variable,
                                           double init_value,
                                           const char *help_string);
 
void                sc_options_add_string (sc_options_t * opt,
                                           int opt_char,
                                           const char *opt_name,
                                           const char **variable,
                                           const char *init_value,
                                           const char *help_string);
 
void                sc_options_add_inifile (sc_options_t * opt,
                                            int opt_char,
                                            const char *opt_name,
                                            const char *help_string);
 
void                sc_options_add_jsonfile (sc_options_t * opt,
                                             int opt_char,
                                             const char *opt_name,
                                             const char *help_string);
 
void                sc_options_add_callback (sc_options_t * opt,
                                             int opt_char,
                                             const char *opt_name,
                                             int has_arg,
                                             sc_options_callback_t fn,
                                             void *data,
                                             const char *help_string);
 
void                sc_options_add_keyvalue (sc_options_t * opt,
                                             int opt_char,
                                             const char *opt_name,
                                             int *variable,
                                             const char *init_value,
                                             sc_keyvalue_t * keyvalue,
                                             const char *help_string);
 
void                sc_options_add_suboptions (sc_options_t * opt,
                                               sc_options_t * subopt,
                                               const char *prefix);
 
void                sc_options_print_usage (int package_id, int log_priority,
                                            sc_options_t * opt,
                                            const char *arg_usage);
 
void                sc_options_print_summary (int package_id,
                                              int log_priority,
                                              sc_options_t * opt);
 
int                 sc_options_load (int package_id, int err_priority,
                                     sc_options_t * opt, const char *file);
 
int                 sc_options_load_ini (int package_id, int err_priority,
                                         sc_options_t * opt,
                                         const char *inifile, void *re);
 
int                 sc_options_load_json (int package_id, int err_priority,
                                          sc_options_t * opt,
                                          const char *jsonfile, void *re);
 
int                 sc_options_save (int package_id, int err_priority,
                                     sc_options_t * opt, const char *inifile);
 
int                 sc_options_load_args (int package_id, int err_priority,
                                          sc_options_t * opt,
                                          const char *inifile);
 
int                 sc_options_parse (int package_id, int err_priority,
                                      sc_options_t * opt, int argc,
                                      char **argv);
 
SC_EXTERN_C_END;
 
#endif /* !SC_OPTIONS_H */