argparse.h File Reference

Contains functions for extracting content from the argument vector. More...

Go to the source code of this file.

Enumerations
enum	FLAG_TYPE {   FLAG_CREATE , FLAG_MODIFY , FLAG_REMOVE , FLAG_LIST ,   FLAG_INVALID }
	Possible flag types. More...

Functions
FLAG_TYPE	get_flag (char *flag_string)
	Assigns a string to its corresponding flag type.
const char *	get_content_arg (char *str_arg)
	Safely extracts any of the non-flag arguments in the argument vector.

Detailed Description

Contains functions for extracting content from the argument vector.

Manipulates the caller buffer to extract the content.

Definition in file argparse.h.

Enumeration Type Documentation

FLAG_TYPE

enum FLAG_TYPE

Possible flag types.

Enumerator
FLAG_CREATE	-c
FLAG_MODIFY	-m
FLAG_REMOVE	-r
FLAG_LIST	-l
FLAG_INVALID	invalid/malformed flag

Definition at line 14 of file argparse.h.

{
  FLAG_CREATE, 
  FLAG_MODIFY, 
  FLAG_REMOVE, 
  FLAG_LIST, 
  FLAG_INVALID 
} FLAG_TYPE;

Function Documentation

get_content_arg()

const char * get_content_arg

(

char *

str_arg

)

Safely extracts any of the non-flag arguments in the argument vector.

Parameters

str_arg

Pointer to the argument string

Returns

Pointer to the extracted argument.

Definition at line 38 of file argparse.c.

{
  size_t arg_len = strnlen(str_arg, MAX_CONTENT_LENGTH); 
  char* ret = (char*)malloc(arg_len+1); // +1 for null term
  strncpy(ret, str_arg, arg_len+1);
  return ret;
}

get_flag()

FLAG_TYPE get_flag

(

char *

flag_string

)

Assigns a string to its corresponding flag type.

Compares the argument with the possible flags.

Parameters

flag_string

Pointer to the flag string in the argument vector

Returns

Flag type corresponding to the input flag string

Definition at line 9 of file argparse.c.

{
  const size_t ARG_FLAG_LENGTH = strnlen(flag_string, FLAG_LENGTH);
  if (flag_string == NULL || ARG_FLAG_LENGTH != 2)
  {
    printf("Flag error: empty or malformed flag (len: %zu)\n", ARG_FLAG_LENGTH);
    return FLAG_INVALID; 
  }
 
  if ( strncmp( flag_string, "-c", ARG_FLAG_LENGTH ) == 0 )
  {
    return FLAG_CREATE;
  } 
  else if ( strncmp ( flag_string, "-r", ARG_FLAG_LENGTH) == 0 )
  {
    return FLAG_REMOVE;
  }
  else if ( strncmp ( flag_string, "-m", ARG_FLAG_LENGTH) == 0 )
  {
    return FLAG_MODIFY;
  }
  else if ( strncmp ( flag_string, "-l", ARG_FLAG_LENGTH) == 0 )
  {
    return FLAG_LIST;
  }
 
  return FLAG_INVALID;
}