cargs.h

Go to the documentation of this file.

/*
MIT License
 
Copyright (c) 2022 Leonard Iklé
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */
#pragma once
 
#ifndef CAG_LIBRARY_H
#define CAG_LIBRARY_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
 
#if defined(_WIN32) || defined(__CYGWIN__)
#define CAG_EXPORT __declspec(dllexport)
#define CAG_IMPORT __declspec(dllimport)
#elif __GNUC__ >= 4
#define CAG_EXPORT __attribute__((visibility("default")))
#define CAG_IMPORT __attribute__((visibility("default")))
#else
#define CAG_EXPORT
#define CAG_IMPORT
#endif
 
#if defined(CAG_SHARED)
#if defined(CAG_EXPORTS)
#define CAG_PUBLIC CAG_EXPORT
#else
#define CAG_PUBLIC CAG_IMPORT
#endif
#else
#define CAG_PUBLIC
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct cag_option
{
  const char identifier;
  const char *access_letters;
  const char *access_name;
  const char *value_name;
  const char *description;
} cag_option;
 
typedef struct cag_option_context
{
  const struct cag_option *options;
  size_t option_count;
  int argc;
  char **argv;
  int index;
  int inner_index;
  bool forced_end;
  char identifier;
  char *value;
} cag_option_context;
 
#define CAG_ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 
CAG_PUBLIC void cag_option_print(const cag_option *options, size_t option_count,
  FILE *destination);
 
CAG_PUBLIC void cag_option_prepare(cag_option_context *context,
  const cag_option *options, size_t option_count, int argc, char **argv);
 
CAG_PUBLIC bool cag_option_fetch(cag_option_context *context);
 
CAG_PUBLIC char cag_option_get(const cag_option_context *context);
 
CAG_PUBLIC const char *cag_option_get_value(const cag_option_context *context);
 
CAG_PUBLIC int cag_option_get_index(const cag_option_context *context);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif