Commit 6533aadc by Shawn O. Pearce

Drop the _t suffix as it is a POSIX reserved namespace

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
parent de2220a4
...@@ -12,7 +12,15 @@ All #define macros start with 'GIT_'. ...@@ -12,7 +12,15 @@ All #define macros start with 'GIT_'.
Type Definitions Type Definitions
---------------- ----------------
All types end in '_t'; for example git_oid_t or git_odb_t. Most types should be opaque, e.g.:
----
typedef struct git_odb git_odb;
----
with allocation functions returning an "instance" created within
the library, and not within the application. This allows the type
to grow (or shrink) in size without rebuilding client code.
Public Exported Function Definitions Public Exported Function Definitions
......
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
#include "git_commit.h" #include "git_commit.h"
const git_oid_t *git_commit_id(git_commit_t *c) const git_oid *git_commit_id(git_commit *c)
{ {
return &c->id; return &c->id;
} }
...@@ -50,10 +50,10 @@ ...@@ -50,10 +50,10 @@
GIT_BEGIN_DECL GIT_BEGIN_DECL
/** Parsed representation of a commit object. */ /** Parsed representation of a commit object. */
typedef struct git_commit_t git_commit_t; typedef struct git_commit git_commit;
#ifdef GIT__PRIVATE #ifdef GIT__PRIVATE
struct git_commit_t { struct git_commit {
git_oid_t id; git_oid id;
time_t commit_time; time_t commit_time;
unsigned parsed:1, unsigned parsed:1,
flags:26; flags:26;
...@@ -66,17 +66,17 @@ struct git_commit_t { ...@@ -66,17 +66,17 @@ struct git_commit_t {
* @param id identity of the commit to locate. If the object is * @param id identity of the commit to locate. If the object is
* an annotated tag it will be peeled back to the commit. * an annotated tag it will be peeled back to the commit.
* @return the commit; NULL if the commit does not exist in the * @return the commit; NULL if the commit does not exist in the
* pool's git_odb_t, or if the commit is present but is * pool's git_odb, or if the commit is present but is
* too malformed to be parsed successfully. * too malformed to be parsed successfully.
*/ */
GIT_EXTERN(git_commit_t*) git_commit_parse(git_revp_t *pool, const git_oid_t *id); GIT_EXTERN(git_commit*) git_commit_parse(git_revp *pool, const git_oid *id);
/** /**
* Get the id of a commit. * Get the id of a commit.
* @param commit a previously parsed commit. * @param commit a previously parsed commit.
* @return object identity for the commit. * @return object identity for the commit.
*/ */
GIT_EXTERN(const git_oid_t*) git_commit_id(git_commit_t *commit); GIT_EXTERN(const git_oid*) git_commit_id(git_commit *commit);
/** /**
* Get the application data address. * Get the application data address.
...@@ -85,7 +85,7 @@ GIT_EXTERN(const git_oid_t*) git_commit_id(git_commit_t *commit); ...@@ -85,7 +85,7 @@ GIT_EXTERN(const git_oid_t*) git_commit_id(git_commit_t *commit);
* Applications should cast to something like * Applications should cast to something like
* 'struct mydata*' in order to access fields. * 'struct mydata*' in order to access fields.
*/ */
GIT_EXTERN(void*) git_commit_appdata(git_commit_t *commit); GIT_EXTERN(void*) git_commit_appdata(git_commit *commit);
/** @} */ /** @} */
GIT_END_DECL GIT_END_DECL
......
...@@ -80,7 +80,7 @@ GIT_BEGIN_DECL ...@@ -80,7 +80,7 @@ GIT_BEGIN_DECL
#define GIT_ENOTFOUND (GIT_ERROR - 2) #define GIT_ENOTFOUND (GIT_ERROR - 2)
/** A revision traversal pool. */ /** A revision traversal pool. */
typedef struct git_revp_t git_revp_t; typedef struct git_revp git_revp;
/** @} */ /** @} */
GIT_END_DECL GIT_END_DECL
......
...@@ -35,21 +35,21 @@ ...@@ -35,21 +35,21 @@
#include "git_odb.h" #include "git_odb.h"
struct git_odb_t { struct git_odb {
/** Path to the "objects" directory. */ /** Path to the "objects" directory. */
const char *path; const char *path;
/** Alternate databases to search. */ /** Alternate databases to search. */
git_odb_t **alternates; git_odb **alternates;
/** Number of alternates available. */ /** Number of alternates available. */
unsigned n_alternates; unsigned n_alternates;
}; };
int git_odb_read( int git_odb_read(
git_sobj_t *out, git_sobj *out,
git_odb_t *db, git_odb *db,
const git_oid_t *id) const git_oid *id)
{ {
if (!git_odb__read_packed(out, db, id)) if (!git_odb__read_packed(out, db, id))
return GIT_SUCCESS; return GIT_SUCCESS;
......
...@@ -50,7 +50,7 @@ ...@@ -50,7 +50,7 @@
GIT_BEGIN_DECL GIT_BEGIN_DECL
/** An open object database handle. */ /** An open object database handle. */
typedef struct git_odb_t git_odb_t; typedef struct git_odb git_odb;
/** /**
* Open an object database for read/write access. * Open an object database for read/write access.
...@@ -60,14 +60,14 @@ typedef struct git_odb_t git_odb_t; ...@@ -60,14 +60,14 @@ typedef struct git_odb_t git_odb_t;
* @return GIT_SUCCESS if the database opened; otherwise an error * @return GIT_SUCCESS if the database opened; otherwise an error
* code describing why the open was not possible. * code describing why the open was not possible.
*/ */
GIT_EXTERN(int) git_odb_open(git_odb_t **out, const char *objects_dir); GIT_EXTERN(int) git_odb_open(git_odb **out, const char *objects_dir);
/** /**
* Close an open object database. * Close an open object database.
* @param db database pointer to close. If NULL no action is taken. * @param db database pointer to close. If NULL no action is taken.
* The pointer is set to NULL when the close is completed. * The pointer is set to NULL when the close is completed.
*/ */
GIT_EXTERN(void) git_odb_close(git_odb_t **db); GIT_EXTERN(void) git_odb_close(git_odb **db);
/** Basic type (loose or packed) of any Git object. */ /** Basic type (loose or packed) of any Git object. */
typedef enum { typedef enum {
...@@ -80,14 +80,14 @@ typedef enum { ...@@ -80,14 +80,14 @@ typedef enum {
GIT_OBJ__EXT2 = 5, /**< Reserved for future use. */ GIT_OBJ__EXT2 = 5, /**< Reserved for future use. */
GIT_OBJ_OFS_DELTA = 6, /**< A delta, base is given by an offset. */ GIT_OBJ_OFS_DELTA = 6, /**< A delta, base is given by an offset. */
GIT_OBJ_REF_DELTA = 7, /**< A delta, base is given by object id. */ GIT_OBJ_REF_DELTA = 7, /**< A delta, base is given by object id. */
} git_otype_t; } git_otype;
/** A small object read from the database. */ /** A small object read from the database. */
typedef struct { typedef struct {
void *data; /**< Raw, decompressed object data. */ void *data; /**< Raw, decompressed object data. */
size_t len ; /**< Total number of bytes in data. */ size_t len ; /**< Total number of bytes in data. */
git_otype_t type; /**< Type of this object. */ git_otype type; /**< Type of this object. */
} git_sobj_t; } git_sobj;
/** /**
* Read a small object from the database. * Read a small object from the database.
...@@ -101,7 +101,7 @@ typedef struct { ...@@ -101,7 +101,7 @@ typedef struct {
* - GIT_SUCCESS if the object was read; * - GIT_SUCCESS if the object was read;
* - GIT_ENOTFOUND if the object is not in the database. * - GIT_ENOTFOUND if the object is not in the database.
*/ */
GIT_EXTERN(int) git_odb_read(git_sobj_t *out, git_odb_t *db, const git_oid_t *id); GIT_EXTERN(int) git_odb_read(git_sobj *out, git_odb *db, const git_oid *id);
/** /**
* Read a small object from the database using only pack files. * Read a small object from the database using only pack files.
...@@ -115,7 +115,7 @@ GIT_EXTERN(int) git_odb_read(git_sobj_t *out, git_odb_t *db, const git_oid_t *id ...@@ -115,7 +115,7 @@ GIT_EXTERN(int) git_odb_read(git_sobj_t *out, git_odb_t *db, const git_oid_t *id
* - GIT_SUCCESS if the object was read. * - GIT_SUCCESS if the object was read.
* - GIT_ENOTFOUND if the object is not in the database. * - GIT_ENOTFOUND if the object is not in the database.
*/ */
GIT_EXTERN(int) git_odb__read_packed(git_sobj_t *out, git_odb_t *db, const git_oid_t *id); GIT_EXTERN(int) git_odb__read_packed(git_sobj *out, git_odb *db, const git_oid *id);
/** /**
* Read a small object from the database using only loose object files. * Read a small object from the database using only loose object files.
...@@ -129,7 +129,7 @@ GIT_EXTERN(int) git_odb__read_packed(git_sobj_t *out, git_odb_t *db, const git_o ...@@ -129,7 +129,7 @@ GIT_EXTERN(int) git_odb__read_packed(git_sobj_t *out, git_odb_t *db, const git_o
* - GIT_SUCCESS if the object was read. * - GIT_SUCCESS if the object was read.
* - GIT_ENOTFOUND if the object is not in the database. * - GIT_ENOTFOUND if the object is not in the database.
*/ */
GIT_EXTERN(int) git_odb__read_loose(git_sobj_t *out, git_odb_t *db, const git_oid_t *id); GIT_EXTERN(int) git_odb__read_loose(git_sobj *out, git_odb *db, const git_oid *id);
/** /**
* Release all memory used by the sobj structure. * Release all memory used by the sobj structure.
...@@ -140,7 +140,7 @@ GIT_EXTERN(int) git_odb__read_loose(git_sobj_t *out, git_odb_t *db, const git_oi ...@@ -140,7 +140,7 @@ GIT_EXTERN(int) git_odb__read_loose(git_sobj_t *out, git_odb_t *db, const git_oi
* *
* @param obj object descriptor to free. * @param obj object descriptor to free.
*/ */
GIT_EXTERN(void) git_sobj_close(git_sobj_t *obj); GIT_EXTERN(void) git_sobj_close(git_sobj *obj);
/** @} */ /** @} */
GIT_END_DECL GIT_END_DECL
......
...@@ -55,7 +55,7 @@ static signed char from_hex[] = { ...@@ -55,7 +55,7 @@ static signed char from_hex[] = {
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* f0 */ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, /* f0 */
}; };
int git_oid_mkstr(git_oid_t *out, const char *str) int git_oid_mkstr(git_oid *out, const char *str)
{ {
int p; int p;
for (p = 0; p < sizeof(out->id); p++, str += 2) { for (p = 0; p < sizeof(out->id); p++, str += 2) {
...@@ -67,7 +67,7 @@ int git_oid_mkstr(git_oid_t *out, const char *str) ...@@ -67,7 +67,7 @@ int git_oid_mkstr(git_oid_t *out, const char *str)
return GIT_SUCCESS; return GIT_SUCCESS;
} }
void git_oid_mkraw(git_oid_t *out, const unsigned char *raw) void git_oid_mkraw(git_oid *out, const unsigned char *raw)
{ {
memcpy(out->id, raw, sizeof(out->id)); memcpy(out->id, raw, sizeof(out->id));
} }
...@@ -52,7 +52,7 @@ typedef struct ...@@ -52,7 +52,7 @@ typedef struct
{ {
/** raw binary formatted id */ /** raw binary formatted id */
unsigned char id[20]; unsigned char id[20];
} git_oid_t; } git_oid;
/** /**
* Parse a hex formatted object id into a git_oid. * Parse a hex formatted object id into a git_oid.
...@@ -62,14 +62,14 @@ typedef struct ...@@ -62,14 +62,14 @@ typedef struct
* needed for an oid encoded in hex (40 bytes). * needed for an oid encoded in hex (40 bytes).
* @return GIT_SUCCESS if valid; GIT_ENOTOID on failure. * @return GIT_SUCCESS if valid; GIT_ENOTOID on failure.
*/ */
GIT_EXTERN(int) git_oid_mkstr(git_oid_t *out, const char *str); GIT_EXTERN(int) git_oid_mkstr(git_oid *out, const char *str);
/** /**
* Copy an already raw oid into a git_oid structure. * Copy an already raw oid into a git_oid structure.
* @param out oid structure the result is written into. * @param out oid structure the result is written into.
* @param raw the raw input bytes to be copied. * @param raw the raw input bytes to be copied.
*/ */
GIT_EXTERN(void) git_oid_mkraw(git_oid_t *out, const unsigned char *raw); GIT_EXTERN(void) git_oid_mkraw(git_oid *out, const unsigned char *raw);
/** @} */ /** @} */
GIT_END_DECL GIT_END_DECL
......
...@@ -37,22 +37,22 @@ ...@@ -37,22 +37,22 @@
#include <stdlib.h> #include <stdlib.h>
#include <string.h> #include <string.h>
struct git_revp_attr_t { struct git_revp_attr {
size_t app_size; size_t app_size;
int (*app_init)(git_commit_t *, void *); int (*app_init)(git_commit *, void *);
}; };
struct git_revp_t { struct git_revp {
git_odb_t *db; git_odb *db;
git_revp_attr_t attr; git_revp_attr attr;
}; };
git_revp_t *git_revp_alloc( git_revp *git_revp_alloc(
git_odb_t *db, git_odb *db,
const git_revp_attr_t *attr) const git_revp_attr *attr)
{ {
git_revp_t *walk = malloc(sizeof(*walk)); git_revp *walk = malloc(sizeof(*walk));
if (!walk) if (!walk)
return NULL; return NULL;
...@@ -65,7 +65,7 @@ git_revp_t *git_revp_alloc( ...@@ -65,7 +65,7 @@ git_revp_t *git_revp_alloc(
return walk; return walk;
} }
void git_revp_free(git_revp_t *walk) void git_revp_free(git_revp *walk)
{ {
free(walk); free(walk);
} }
...@@ -50,7 +50,7 @@ ...@@ -50,7 +50,7 @@
GIT_BEGIN_DECL GIT_BEGIN_DECL
/** Configuration of a revision pool. */ /** Configuration of a revision pool. */
typedef struct git_revp_attr_t git_revp_attr_t; typedef struct git_revp_attr git_revp_attr;
/** /**
* Allocate an empty pool configuration. * Allocate an empty pool configuration.
...@@ -61,13 +61,13 @@ typedef struct git_revp_attr_t git_revp_attr_t; ...@@ -61,13 +61,13 @@ typedef struct git_revp_attr_t git_revp_attr_t;
* @return a new configuration block. * @return a new configuration block.
* NULL if there is insufficient memory. * NULL if there is insufficient memory.
*/ */
GIT_EXTERN(git_revp_attr_t*) git_revp_attr_alloc(void); GIT_EXTERN(git_revp_attr*) git_revp_attr_alloc(void);
/** /**
* Setup the application's per-commit data allocation. * Setup the application's per-commit data allocation.
* *
* If size is non-zero the requested number of bytes is allocated * If size is non-zero the requested number of bytes is allocated
* alongside every git_commit_t used by the revision pool, allowing * alongside every git_commit used by the revision pool, allowing
* constant-time access to per-commit application data. * constant-time access to per-commit application data.
* *
* If init is not NULL the function is invoked with the commit and * If init is not NULL the function is invoked with the commit and
...@@ -81,22 +81,22 @@ GIT_EXTERN(git_revp_attr_t*) git_revp_attr_alloc(void); ...@@ -81,22 +81,22 @@ GIT_EXTERN(git_revp_attr_t*) git_revp_attr_alloc(void);
* *
* @param attr the pool configuration to adjust. * @param attr the pool configuration to adjust.
* @param size number of bytes required by the application on * @param size number of bytes required by the application on
* each rev_commit_t instance within the pool. * each rev_commit instance within the pool.
* @param init optional callback function to initialize the * @param init optional callback function to initialize the
* application data space. If NULL the application * application data space. If NULL the application
* space will be zeroed. If supplied the application * space will be zeroed. If supplied the application
* space may contain random garbage. * space may contain random garbage.
*/ */
GIT_EXTERN(void) git_revp_attr_appdata( GIT_EXTERN(void) git_revp_attr_appdata(
git_revp_attr_t *attr, git_revp_attr *attr,
size_t size, size_t size,
int (*init)(git_commit_t *, void *)); int (*init)(git_commit *, void *));
/** /**
* Free a pool configuration. * Free a pool configuration.
* @param attr the configuration to free. No-op if NULL. * @param attr the configuration to free. No-op if NULL.
*/ */
GIT_EXTERN(void) git_revp_attr_free(git_revp_attr_t *attr); GIT_EXTERN(void) git_revp_attr_free(git_revp_attr *attr);
/** /**
* Allocate a new revision traversal pool. * Allocate a new revision traversal pool.
...@@ -111,42 +111,42 @@ GIT_EXTERN(void) git_revp_attr_free(git_revp_attr_t *attr); ...@@ -111,42 +111,42 @@ GIT_EXTERN(void) git_revp_attr_free(git_revp_attr_t *attr);
* NULL to use a default configuration. * NULL to use a default configuration.
* @return the new traversal handle; NULL if memory is exhausted. * @return the new traversal handle; NULL if memory is exhausted.
*/ */
GIT_EXTERN(git_revp_t*) git_revp_alloc( GIT_EXTERN(git_revp*) git_revp_alloc(
git_odb_t *db, git_odb *db,
const git_revp_attr_t *attr); const git_revp_attr *attr);
/** /**
* Reset the traversal machinary for reuse. * Reset the traversal machinary for reuse.
* @param pool traversal handle to reset. * @param pool traversal handle to reset.
*/ */
GIT_EXTERN(void) git_revp_reset(git_revp_t *pool); GIT_EXTERN(void) git_revp_reset(git_revp *pool);
/** /**
* Mark an object to start traversal from. * Mark an object to start traversal from.
* @param pool the pool being used for the traversal. * @param pool the pool being used for the traversal.
* @param commit the commit the commit to start from. * @param commit the commit the commit to start from.
*/ */
GIT_EXTERN(void) git_revp_pushc(git_revp_t *pool, git_commit_t *commit); GIT_EXTERN(void) git_revp_pushc(git_revp *pool, git_commit *commit);
/** /**
* Mark a commit (and its ancestors) uninteresting for the output. * Mark a commit (and its ancestors) uninteresting for the output.
* @param pool the pool being used for the traversal. * @param pool the pool being used for the traversal.
* @param commit the commit the commit to start from. * @param commit the commit the commit to start from.
*/ */
GIT_EXTERN(void) git_revp_hidec(git_revp_t *pool, git_commit_t *commit); GIT_EXTERN(void) git_revp_hidec(git_revp *pool, git_commit *commit);
/** /**
* Get the next commit from the revision traversal. * Get the next commit from the revision traversal.
* @param pool the pool to pop the commit from. * @param pool the pool to pop the commit from.
* @return next commit; NULL if there is no more output. * @return next commit; NULL if there is no more output.
*/ */
GIT_EXTERN(git_commit_t*) git_revp_nextc(git_revp_t *pool); GIT_EXTERN(git_commit*) git_revp_nextc(git_revp *pool);
/** /**
* Free a revwalk previously allocated. * Free a revwalk previously allocated.
* @param pool traversal handle to close. If NULL nothing occurs. * @param pool traversal handle to close. If NULL nothing occurs.
*/ */
GIT_EXTERN(void) git_revp_free(git_revp_t *pool); GIT_EXTERN(void) git_revp_free(git_revp *pool);
/** @} */ /** @} */
GIT_END_DECL GIT_END_DECL
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment