diff options
Diffstat (limited to 'src/git/oid.h')
-rw-r--r-- | src/git/oid.h | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/src/git/oid.h b/src/git/oid.h new file mode 100644 index 000000000..dd95fb53d --- /dev/null +++ b/src/git/oid.h @@ -0,0 +1,90 @@ +/* + * This file is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License, version 2, + * as published by the Free Software Foundation. + * + * In addition to the permissions in the GNU General Public License, + * the authors give you unlimited permission to link the compiled + * version of this file into combinations with other programs, + * and to distribute those combinations without any restriction + * coming from the use of this file. (The General Public License + * restrictions do apply in other respects; for example, they cover + * modification of the file, and distribution when not linked into + * a combined executable.) + * + * This file is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; see the file COPYING. If not, write to + * the Free Software Foundation, 51 Franklin Street, Fifth Floor, + * Boston, MA 02110-1301, USA. + */ + +#ifndef INCLUDE_git_oid_h__ +#define INCLUDE_git_oid_h__ + +#include "common.h" + +/** + * @file git/oid.h + * @brief Git object id routines + * @defgroup git_oid Git object id routines + * @ingroup Git + * @{ + */ +GIT_BEGIN_DECL + +/** Unique identity of any object (commit, tree, blob, tag). */ +typedef struct +{ + /** raw binary formatted id */ + unsigned char id[20]; +} git_oid; + +/** + * Parse a hex formatted object id into a git_oid. + * @param out oid structure the result is written into. + * @param str input hex string; must be pointing at the start of + * the hex sequence and have at least the number of bytes + * needed for an oid encoded in hex (40 bytes). + * @return GIT_SUCCESS if valid; GIT_ENOTOID on failure. + */ +GIT_EXTERN(int) git_oid_mkstr(git_oid *out, const char *str); + +/** + * Copy an already raw oid into a git_oid structure. + * @param out oid structure the result is written into. + * @param raw the raw input bytes to be copied. + */ +GIT_INLINE(void) git_oid_mkraw(git_oid *out, const unsigned char *raw) +{ + memcpy(out->id, raw, sizeof(out->id)); +} + +/** + * Copy an oid from one structure to another. + * @param out oid structure the result is written into. + * @param src oid structure to copy from. + */ +GIT_INLINE(void) git_oid_cpy(git_oid *out, const git_oid *src) +{ + memcpy(out->id, src->id, sizeof(out->id)); +} + +/** + * Compare two oid structures. + * @param a first oid structure. + * @param b second oid structure. + * @return <0, 0, >0 if a < b, a == b, a > b. + */ +GIT_INLINE(int) git_oid_cmp(const git_oid *a, const git_oid *b) +{ + return memcmp(a->id, b->id, sizeof(a->id)); +} + +/** @} */ +GIT_END_DECL +#endif |