sc/option/sc_option.h
2023-04-21 00:43:26 +03:00

67 lines
2.4 KiB
C

/*
* BSD-3-Clause
*
* Copyright 2021 Ozan Tezcan
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SC_OPTION_H
#define SC_OPTION_H
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#define SC_OPTION_VERSION "2.0.0"
struct sc_option_item {
const char letter;
const char *name;
};
struct sc_option {
struct sc_option_item *options;
int count;
char **argv;
};
/**
*
* @param opt Already initialized sc_opt struct
* @param index Index for argv
* @param value [out] Value for the option if exists. It should be after '='
* sign. e.g., -key=value or -k=value. If value does not exists
* (*value) will point to '\0' character. It won't be NULL itself.
*
* To check if option has value associated : if (*value != '\0')
*
* @return Letter for the option. If option is not known, '?' will be
* returned.
*/
char sc_option_at(struct sc_option *opt, int index, char **value);
#endif