thodg/libgit2/src/cli/error.h

• Show log

  Commit

• Hash : 3a3ab065
  Author :
  Date : 2020-05-03T23:13:28
  

  cli: infrastructure for a cli project Introduce a command-line interface for libgit2. The goal is for it to be git-compatible. 1. The libgit2 developers can more easily dogfood libgit2 to find bugs, and performance issues. 2. There is growing usage of libgit2's examples as a client; libgit2's examples should be exactly that - simple code samples that illustrate libgit2's usage. This satisfies that need directly. 3. By producing a client ourselves, we can better understand the needs of client creators, possibly producing a shared "middleware" for commonly-used pieces of client functionality like interacting with external tools. 4. Since git is the reference implementation, we may be able to benefit from git's unit tests, running their test suite against our CLI to ensure correct behavior. This commit introduces a simple infrastructure for the CLI. The CLI is currently links libgit2 statically; this is because the utility layer is required for libgit2 _but_ shares the error state handling with libgit2 itself. There's no obviously good solution here without introducing annoying indirection or more complexity. Until we can untangle that dependency, this is a good step forward. In the meantime, we link the libgit2 object files, but we do not include the (private) libgit2 headers. This constrains the CLI to the public libgit2 interfaces.

Download

• src/cli/error.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  
  #ifndef CLI_error_h__
  #define CLI_error_h__
  
  #include "cli.h"
  #include <stdio.h>
  
  #define CLI_EXIT_OK      0
  #define CLI_EXIT_ERROR   1
  #define CLI_EXIT_OS    128
  #define CLI_EXIT_GIT   128
  #define CLI_EXIT_USAGE 129
  
  #define cli_error__print(fmt) do { \
  		va_list ap; \
  		va_start(ap, fmt); \
  		fprintf(stderr, "%s: ", PROGRAM_NAME); \
  		vfprintf(stderr, fmt, ap); \
  		fprintf(stderr, "\n"); \
  		va_end(ap); \
  	} while(0)
  
  GIT_INLINE(int) cli_error(const char *fmt, ...)
  {
  	cli_error__print(fmt);
  	return CLI_EXIT_ERROR;
  }
  
  GIT_INLINE(int) cli_error_usage(const char *fmt, ...)
  {
  	cli_error__print(fmt);
  	return CLI_EXIT_USAGE;
  }
  
  GIT_INLINE(int) cli_error_git(void)
  {
  	const git_error *err = git_error_last();
  	fprintf(stderr, "%s: %s\n", PROGRAM_NAME,
  	        err ? err->message : "unknown error");
  	return CLI_EXIT_GIT;
  }
  
  #define cli_error_os() (perror(PROGRAM_NAME), CLI_EXIT_OS)
  
  #endif /* CLI_error_h__ */
  

Download