thodg/libgit2/src/pqueue.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/pqueue.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_pqueue_h__
  #define INCLUDE_pqueue_h__
  
  #include "common.h"
  
  #include "vector.h"
  
  typedef git_vector git_pqueue;
  
  enum {
  	/* flag meaning: don't grow heap, keep highest values only */
  	GIT_PQUEUE_FIXED_SIZE = (GIT_VECTOR_FLAG_MAX << 1),
  };
  
  /**
   * Initialize priority queue
   *
   * @param pq The priority queue struct to initialize
   * @param flags Flags (see above) to control queue behavior
   * @param init_size The initial queue size
   * @param cmp The entry priority comparison function
   * @return 0 on success, <0 on error
   */
  extern int git_pqueue_init(
  	git_pqueue *pq,
  	uint32_t flags,
  	size_t init_size,
  	git_vector_cmp cmp);
  
  #define git_pqueue_free  git_vector_free
  #define git_pqueue_clear git_vector_clear
  #define git_pqueue_size  git_vector_length
  #define git_pqueue_get   git_vector_get
  #define git_pqueue_reverse git_vector_reverse
  
  /**
   * Insert a new item into the queue
   *
   * @param pq The priority queue
   * @param item Pointer to the item data
   * @return 0 on success, <0 on failure
   */
  extern int git_pqueue_insert(git_pqueue *pq, void *item);
  
  /**
   * Remove the top item in the priority queue
   *
   * @param pq The priority queue
   * @return item from heap on success, NULL if queue is empty
   */
  extern void *git_pqueue_pop(git_pqueue *pq);
  
  #endif
  

Download