apio/minitar
1
1
Fork 0
Code Issues Pull Requests Releases 15 Activity
577f99cca6
minitar/minitar.h

60 lines
1.2 KiB
C
Raw Normal View History

Initial groundwork
2022-11-05 17:52:51 +00:00
#ifndef MINITAR_H
#define MINITAR_H
Do not automatically read an entry's contents, leave it up to the user This API change modifies minitar_read_entry to skip over the file's contents and instead store the current read position in the entry. struct minitar_entry no longer has a ptr field, but has a position field (of type fpos_t) for internal use. minitar_free_entry no longer frees entry->ptr. A new function has been added, minitar_read_contents(). It reads a certain number of bytes from an entry (which is capped to the entry's size) into a user-provided buffer. This function can be called at any time provided it is called with a valid archive stream and entry. This is achieved by calling fgetpos() to store the start of the entry's contents in the entry's position field while reading it. Then minitar_read_contents() will store the current position, rewind to the entry's position, read the chosen number of bytes from the archive, and then rewind back to the current position. Since this is a breaking change, it needs a major version bump. Since there was no version, I bumped it to 1.0.0 :)
2022-11-21 19:20:37 +00:00
#include <stdio.h>
Basic file listing :)
2022-11-05 19:10:48 +00:00
#include <sys/types.h>
Initial groundwork
2022-11-05 17:52:51 +00:00
Only define the contents of a struct minitar inside minitar This structure should be opaque for everyone using the library, and every public API just uses a pointer to it.
2022-11-06 10:04:52 +00:00
#ifdef _IN_MINITAR
Initial groundwork
2022-11-05 17:52:51 +00:00
struct minitar
{
FILE* stream;
};
Only define the contents of a struct minitar inside minitar This structure should be opaque for everyone using the library, and every public API just uses a pointer to it.
2022-11-06 10:04:52 +00:00
#else
struct minitar;
#endif
Initial groundwork
2022-11-05 17:52:51 +00:00
Basic file listing :)
2022-11-05 19:10:48 +00:00
enum minitar_file_type
{
MTAR_REGULAR,
MTAR_DIRECTORY
};
struct minitar_entry_metadata
{
Full path is now metadata->path and basename metadata->name Shouldn't have rushed to 1.0.0 so quickly. Oh well, I guess I can allow 1.1.0...
2022-11-23 17:32:10 +00:00
char path[257];
char name[128];
Basic file listing :)
2022-11-05 19:10:48 +00:00
mode_t mode;
uid_t uid;
gid_t gid;
size_t size;
time_t mtime;
enum minitar_file_type type;
char uname[32];
char gname[32];
};
struct minitar_entry
{
struct minitar_entry_metadata metadata;
Do not automatically read an entry's contents, leave it up to the user This API change modifies minitar_read_entry to skip over the file's contents and instead store the current read position in the entry. struct minitar_entry no longer has a ptr field, but has a position field (of type fpos_t) for internal use. minitar_free_entry no longer frees entry->ptr. A new function has been added, minitar_read_contents(). It reads a certain number of bytes from an entry (which is capped to the entry's size) into a user-provided buffer. This function can be called at any time provided it is called with a valid archive stream and entry. This is achieved by calling fgetpos() to store the start of the entry's contents in the entry's position field while reading it. Then minitar_read_contents() will store the current position, rewind to the entry's position, read the chosen number of bytes from the archive, and then rewind back to the current position. Since this is a breaking change, it needs a major version bump. Since there was no version, I bumped it to 1.0.0 :)
2022-11-21 19:20:37 +00:00
fpos_t position;
Basic file listing :)
2022-11-05 19:10:48 +00:00
};
Make it C++-compatible
2022-11-06 11:35:30 +00:00
#ifdef __cplusplus
extern "C"
{
#endif
struct minitar* minitar_open(const char* pathname);
struct minitar_entry* minitar_read_entry(struct minitar* mp);
void minitar_free_entry(struct minitar_entry* entry);
void minitar_rewind(struct minitar* mp);
struct minitar_entry* minitar_find_by_name(struct minitar* mp, const char* name);
Full path is now metadata->path and basename metadata->name Shouldn't have rushed to 1.0.0 so quickly. Oh well, I guess I can allow 1.1.0...
2022-11-23 17:32:10 +00:00
struct minitar_entry* minitar_find_by_path(struct minitar* mp, const char* path);
Make it C++-compatible
2022-11-06 11:35:30 +00:00
struct minitar_entry* minitar_find_any_of(struct minitar* mp, enum minitar_file_type type);
Do not automatically read an entry's contents, leave it up to the user This API change modifies minitar_read_entry to skip over the file's contents and instead store the current read position in the entry. struct minitar_entry no longer has a ptr field, but has a position field (of type fpos_t) for internal use. minitar_free_entry no longer frees entry->ptr. A new function has been added, minitar_read_contents(). It reads a certain number of bytes from an entry (which is capped to the entry's size) into a user-provided buffer. This function can be called at any time provided it is called with a valid archive stream and entry. This is achieved by calling fgetpos() to store the start of the entry's contents in the entry's position field while reading it. Then minitar_read_contents() will store the current position, rewind to the entry's position, read the chosen number of bytes from the archive, and then rewind back to the current position. Since this is a breaking change, it needs a major version bump. Since there was no version, I bumped it to 1.0.0 :)
2022-11-21 19:20:37 +00:00
size_t minitar_read_contents(struct minitar* mp, struct minitar_entry* entry, char* buf, size_t max);
Reorder function declarations in minitar.h
2022-11-30 10:20:36 +00:00
int minitar_close(struct minitar* mp);
Make it C++-compatible
2022-11-06 11:35:30 +00:00
#ifdef __cplusplus
}
#endif
Initial groundwork
2022-11-05 17:52:51 +00:00
#endif
Reference in New Issue Copy Permalink