Welcome to mirror list, hosted at ThFree Co, Russian Federation.

microtar.h « src - github.com/amachronic/microtar.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: a6d058b77e343eecf03326c45281fe39cf97ba33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 * Copyright (c) 2017 rxi
 * Copyright (c) 2021 Aidan MacDonald
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef MICROTAR_H
#define MICROTAR_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include <stdlib.h>

enum {
    MTAR_ESUCCESS     =  0,
    MTAR_EFAILURE     = -1,
    MTAR_EOPENFAIL    = -2,
    MTAR_EREADFAIL    = -3,
    MTAR_EWRITEFAIL   = -4,
    MTAR_ESEEKFAIL    = -5,
    MTAR_EBADCHKSUM   = -6,
    MTAR_ENULLRECORD  = -7,
    MTAR_ENOTFOUND    = -8,
    MTAR_EOVERFLOW    = -9,
    MTAR_EAPI         = -10,
    MTAR_ELAST        = MTAR_EAPI,
};

enum {
    MTAR_TREG   = '0',
    MTAR_TLNK   = '1',
    MTAR_TSYM   = '2',
    MTAR_TCHR   = '3',
    MTAR_TBLK   = '4',
    MTAR_TDIR   = '5',
    MTAR_TFIFO  = '6',
};

typedef struct mtar_header mtar_header_t;
typedef struct mtar mtar_t;
typedef struct mtar_ops mtar_ops_t;

typedef int(*mtar_foreach_cb)(mtar_t*, const mtar_header_t*, void*);

struct mtar_header {
    unsigned mode;
    unsigned owner;
    unsigned group;
    unsigned size;
    unsigned mtime;
    unsigned type;
    char name[101]; /* +1 byte in order to ensure null termination */
    char linkname[101];
};

struct mtar_ops {
    int(*read)(void* stream, void* data, unsigned size);
    int(*write)(void* stream, const void* data, unsigned size);
    int(*seek)(void* stream, unsigned pos);
    int(*close)(void* stream);
};

struct mtar {
    char buffer[512];       /* IO buffer, put first to allow library users to
                             * control its alignment */
    int state;              /* Used to simplify the API and verify API usage */
    unsigned pos;           /* Current position in file */
    unsigned header_pos;    /* Position of the current header */
    mtar_header_t header;   /* Most recently parsed header */
    const mtar_ops_t* ops;  /* Stream operations */
    void* stream;           /* Stream handle */
};

const char* mtar_strerror(int err);

int mtar_open(mtar_t* tar, const char* filename, const char* mode);

int mtar_init(mtar_t* tar, const mtar_ops_t* ops, void* stream);
int mtar_close(mtar_t* tar);
int mtar_is_open(mtar_t* tar);

const mtar_header_t* mtar_get_header(const mtar_t* tar);

int mtar_rewind(mtar_t* tar);
int mtar_next(mtar_t* tar);
int mtar_foreach(mtar_t* tar, mtar_foreach_cb cb, void* arg);
int mtar_find(mtar_t* tar, const char* name);
int mtar_read_data(mtar_t* tar, void* ptr, unsigned size);

#ifdef __cplusplus
}
#endif

#endif