mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-06 23:03:35 +00:00
129 lines
4.0 KiB
C
129 lines
4.0 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.
|
|
* The generated blob object is owned by the revision
|
|
* repo and shall not be freed by the user.
|
|
*
|
|
* @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);
|
|
}
|
|
|
|
/**
|
|
* Create a new in-memory git_blob.
|
|
*
|
|
* The blob object must be manually filled using
|
|
* the 'set_rawcontent' methods before it can
|
|
* be written back to disk.
|
|
*
|
|
* @param blob pointer to the new blob
|
|
* @param repo The repository where the object will reside
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_INLINE(int) git_blob_new(git_blob **blob, git_repository *repo)
|
|
{
|
|
return git_object_new((git_object **)blob, repo, GIT_OBJ_BLOB);
|
|
}
|
|
|
|
/**
|
|
* Fill a blob with the contents inside
|
|
* the pointed file.
|
|
*
|
|
* @param blob pointer to the new blob
|
|
* @param filename name of the file to read
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_EXTERN(int) git_blob_set_rawcontent_fromfile(git_blob *blob, const char *filename);
|
|
|
|
/**
|
|
* Fill a blob with the contents inside
|
|
* the pointed buffer
|
|
*
|
|
* @param blob pointer to the blob
|
|
* @param buffer buffer with the contents for the blob
|
|
* @param len size of the buffer
|
|
* @return 0 on success; error code otherwise
|
|
*/
|
|
GIT_EXTERN(int) git_blob_set_rawcontent(git_blob *blob, const void *buffer, size_t len);
|
|
|
|
/**
|
|
* 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 (e.g. when changing the contents of the blob).
|
|
*
|
|
* @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(int) 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,
|
|
* if such doesn't exist yet.
|
|
*
|
|
* @param written_id return the id of the written blob
|
|
* @param repo repository where the blob will be written
|
|
* @param path file from which the blob will be created
|
|
*/
|
|
GIT_EXTERN(int) git_blob_writefile(git_oid *written_id, git_repository *repo, const char *path);
|
|
|
|
/** @} */
|
|
GIT_END_DECL
|
|
#endif
|