https://github.com/slayers-git/argparse

A simple parser for the unix-like command line options
https://github.com/slayers-git/argparse

argparse args argument-parser c c89 cli command-line-parser freestanding freestanding-environments lib option-parser parser unix

Last synced: about 3 hours ago
JSON representation

A simple parser for the unix-like command line options

• Host: GitHub
• URL: https://github.com/slayers-git/argparse
• Owner: slayers-git
• License: lgpl-2.1
• Created: 2021-03-24T07:29:28.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-03T14:15:15.000Z (almost 3 years ago)
• Last Synced: 2025-02-04T04:30:53.013Z (about 14 hours ago)
• Topics: argparse, args, argument-parser, c, c89, cli, command-line-parser, freestanding, freestanding-environments, lib, option-parser, parser, unix
• Language: C
• Homepage:
• Size: 74.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Introduction

argparse is a simple parser for the command line options, that implements the parser for the standart Unix-like options

## Features

- Merged key-value arguments (i.e objdump -Mintel ...)

- Values without keys can be ignored, saved or return an error code (i.e gcc *argparse.c* -o argparse ...)

- Merged short arguments (i.e emerge -uavD ...)

- Long arguments (i.e emerge --ask --update --verbose ...)

- Arguments with an optional value

- No dynamic allocations and copying

- Can be compiled without stdlib (-ffreestanding)

## Example

Note: a more informative example can be found in example.c

```c

/*  --verbose -cj --move "/some/where/" test_project */

#include "argparse.h"

#include 

static char is_verbose = 0;

static char jump = 0;

static char jump_last = 0;

static char should_create = 0;

static char * project_name;

static char * move_to = NULL;

static char * not_moving = "not moving anywhere";

int main (int argc, char ** argv) {

	/* argparse does not check if a program had recieved any arguments */

	if (argc == 1) {

		return 0;

	}

	/* An array, describing the options, that this program accepts */

	arg_list list = {

		/* s ,  long opt  ,      handler      ,  value buffer  */ 

		{ 'v', "verbose"  , NULL              , &is_verbose    },

		{ 'c', "create"   , NULL              , &should_create },

		{ 'j', "jump"     , NULL              , &jump          },

		{ 'J', "jump-last", NULL              , &jump_last     },

		{ 'm', "move"     , arg_string_handler, &move_to       },

		{ 0 }

		/* NOTE */

		/* 's' stands for "short option" here

		 * "handler" is a function that accepts a parsed value

		 * of the argument, modifying and writing it into the 

		 * value buffer */

	};

	/* return code of the parser */

	arg_return code;

	/* in case of an error, this is going to point to the program's argument

	 * that was the cause of it */

	char * ptr;

	/* buffer for the elements, that are not keys */

	char * nk_buffer = NULL;

	/* size of the nk_buffer (will be overwritten with the amount of arguments that are not keys) */

	size_t buf_size  = 1;

	/* parse the program's arguments */

	if ((ptr = arg_parse (&argc, &argv, list, &nk_buffer, &buf_size, ARG_PARSE_DEFAULT, &code)) != NULL) {

		printf ("An error occured here: %s", ptr);

		return code;

	}

	/* if the user entered an argument, that does not belong to any key */

	if (nk_buffer)

		project_name = nk_buffer;

	if (move_to == NULL)

		move_to = not_moving;

	printf ("Name: %s\nCreate? %i\nVerbose? %i\nJump? %i\nJump-last? %i\nMove to: %s\n", (const char *)project_name, should_create, is_verbose, jump, jump_last, move_to);

	return 0;

}

```

## Installation

To build and install argparse on \*Unix systems, in your shell type

```bash

mkdir build && cd build\

cmake .. && make && sudo make install

```

To build examples to `cmake` command add `-DARGPARSE_EXAMPLES=1`; to include error messages via `arg_geterror ()` to `cmake` command add `-DARGPARSE_ERRORS=1`

Note, that if the library is compiled without error messages, a call to `arg_geterror ()` will always return NULL.