thodg/libgit2/src/annotated_commit.h

• Show log

  Commit

• Hash : 0c7f49dd
  Author :
  Date : 2017-06-30T13:39:01
  

  Make sure to always include "common.h" first
  
  Next to including several files, our "common.h" header also declares
  various macros which are then used throughout the project. As such, we
  have to make sure to always include this file first in all
  implementation files. Otherwise, we might encounter problems or even
  silent behavioural differences due to macros or defines not being
  defined as they should be. So in fact, our header and implementation
  files should make sure to always include "common.h" first.
  
  This commit does so by establishing a common include pattern. Header
  files inside of "src" will now always include "common.h" as its first
  other file, separated by a newline from all the other includes to make
  it stand out as special. There are two cases for the implementation
  files. If they do have a matching header file, they will always include
  this one first, leading to "common.h" being transitively included as
  first file. If they do not have a matching header file, they instead
  include "common.h" as first file themselves.
  
  This fixes the outlined problems and will become our standard practice
  for header and source files inside of the "src/" from now on.
  

Download

• src/annotated_commit.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 INCLUDE_annotated_commit_h__
  #define INCLUDE_annotated_commit_h__
  
  #include "common.h"
  
  #include "oidarray.h"
  
  #include "git2/oid.h"
  
  typedef enum {
  	GIT_ANNOTATED_COMMIT_REAL = 1,
  	GIT_ANNOTATED_COMMIT_VIRTUAL = 2,
  } git_annotated_commit_t;
  
  /**
   * Internal structure for merge inputs.  An annotated commit is generally
   * "real" and backed by an actual commit in the repository, but merge will
   * internally create "virtual" commits that are in-memory intermediate
   * commits backed by an index.
   */
  struct git_annotated_commit {
  	git_annotated_commit_t type;
  
  	/* real commit */
  	git_commit *commit;
  	git_tree *tree;
  
  	/* virtual commit structure */
  	git_index *index;
  	git_array_oid_t parents;
  
  	/* how this commit was looked up */
  	const char *description;
  
  	const char *ref_name;
  	const char *remote_url;
  
  	char id_str[GIT_OID_HEXSZ+1];
  };
  
  extern int git_annotated_commit_from_head(git_annotated_commit **out,
  	git_repository *repo);
  extern int git_annotated_commit_from_commit(git_annotated_commit **out,
  	git_commit *commit);
  
  #endif
  

Download