optarg.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_OPTARG_H__
#define CDI_OPTARG_H__
 
#include <stdbool.h>
 
#include "cdi_core_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
#define OPTARG_MAX_OPTION_ARGS (20)
 
#define OPTARG_MAX_OPTION_LENGTH (16)
 
#define OPTARG_MAX_SHORT_OPTION_LENGTH (5)
 
#define OPTARG_MAX_ARG_STR_LENGTH (16)
 
#define OPTARG_MAX_DESCRIPTION_STRING_LEN (800)
 
#define OPTARG_MAX_IP_STRING_LEN (20)
 
#define OPTARG_OPTION_ARRAY_MAX_CHAR_LEN (400)
 
#define OPTARG_USAGE_DESCRIPTION_INDENT (1 + OPTARG_MAX_SHORT_OPTION_LENGTH + 5 + OPTARG_MAX_OPTION_LENGTH + 1 + OPTARG_MAX_ARG_STR_LENGTH + 3)
 
#define OPTARG_AVM_USAGE_LIST_INDENT (29)
 
typedef struct
{
    const char* short_name_str;
    const char* long_name_str;
    int num_args;
    const char* argument_str;
    const CdiEnumStringKey* arg_choices_array_ptr;
    const char* description_str;
} OptDef;
 
typedef struct
{
    int option_index;
    char short_name_str[OPTARG_MAX_SHORT_OPTION_LENGTH];
    int num_args;
    const char* args_array[OPTARG_MAX_OPTION_ARGS];
} OptArg;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
void PrintKeyArrayNames(const CdiEnumStringKey* key_array, const int indent);
 
void PrintOption(const OptDef* option_ptr);
 
void PrintUsage(const OptDef* opt_array_ptr, bool has_error);
 
bool GetOpt(int argc, const char* argv_ptr[], int* index_ptr, OptDef* opt_array_ptr, OptArg* this_opt_ptr);
 
#endif // CDI_OPTARG_H__