mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-03 21:25:35 +00:00
139 lines
4.2 KiB
C
139 lines
4.2 KiB
C
/*
|
|
* 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_blob_h__
|
|
#define INCLUDE_git_blob_h__
|
|
|
|
#include "common.h"
|
|
#include "types.h"
|
|
#include "oid.h"
|
|
#include "object.h"
|
|
|
|
/**
|
|
* @file git2/blob.h
|
|
* @brief Git blob load and write routines
|
|
* @defgroup git_blob Git blob load and write routines
|
|
* @ingroup Git
|
|
* @{
|
|
*/
|
|
GIT_BEGIN_DECL
|
|
|
|
/**
|
|
* Lookup a blob object from a repository.
|
|
*
|
|
* @param blob pointer to the looked up blob
|
|
* @param repo the repo to use when locating the blob.
|
|
* @param id identity of the blob to locate.
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_INLINE(int) git_blob_lookup(git_blob **blob, git_repository *repo, const git_oid *id)
|
|
{
|
|
return git_object_lookup((git_object **)blob, repo, id, GIT_OBJ_BLOB);
|
|
}
|
|
|
|
/**
|
|
* Lookup a blob object from a repository,
|
|
* given a prefix of its identifier (short id).
|
|
*
|
|
* @see git_object_lookup_prefix
|
|
*
|
|
* @param blob pointer to the looked up blob
|
|
* @param repo the repo to use when locating the blob.
|
|
* @param id identity of the blob to locate.
|
|
* @param len the length of the short identifier
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_INLINE(int) git_blob_lookup_prefix(git_blob **blob, git_repository *repo, const git_oid *id, unsigned int len)
|
|
{
|
|
return git_object_lookup_prefix((git_object **)blob, repo, id, len, GIT_OBJ_BLOB);
|
|
}
|
|
|
|
/**
|
|
* Close an open blob
|
|
*
|
|
* This is a wrapper around git_object_close()
|
|
*
|
|
* IMPORTANT:
|
|
* It *is* necessary to call this method when you stop
|
|
* using a blob. Failure to do so will cause a memory leak.
|
|
*
|
|
* @param blob the blob to close
|
|
*/
|
|
|
|
GIT_INLINE(void) git_blob_close(git_blob *blob)
|
|
{
|
|
git_object_close((git_object *) blob);
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a read-only buffer with the raw content of a blob.
|
|
*
|
|
* A pointer to the raw content of a blob is returned;
|
|
* this pointer is owned internally by the object and shall
|
|
* not be free'd. The pointer may be invalidated at a later
|
|
* time.
|
|
*
|
|
* @param blob pointer to the blob
|
|
* @return the pointer; NULL if the blob has no contents
|
|
*/
|
|
GIT_EXTERN(const void *) git_blob_rawcontent(git_blob *blob);
|
|
|
|
/**
|
|
* Get the size in bytes of the contents of a blob
|
|
*
|
|
* @param blob pointer to the blob
|
|
* @return size on bytes
|
|
*/
|
|
GIT_EXTERN(size_t) git_blob_rawsize(git_blob *blob);
|
|
|
|
/**
|
|
* Read a file from the working folder of a repository
|
|
* and write it to the Object Database as a loose blob
|
|
*
|
|
* @param oid return the id of the written blob
|
|
* @param repo repository where the blob will be written.
|
|
* this repository cannot be bare
|
|
* @param path file from which the blob will be created,
|
|
* relative to the repository's working dir
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_EXTERN(int) git_blob_create_fromfile(git_oid *oid, git_repository *repo, const char *path);
|
|
|
|
|
|
/**
|
|
* Write an in-memory buffer to the ODB as a blob
|
|
*
|
|
* @param oid return the oid of the written blob
|
|
* @param repo repository where to blob will be written
|
|
* @param buffer data to be written into the blob
|
|
* @param len length of the data
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_EXTERN(int) git_blob_create_frombuffer(git_oid *oid, git_repository *repo, const void *buffer, size_t len);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|