Merge branch 'jh/partial-clone-doc'
[git] / archive.h
1 #ifndef ARCHIVE_H
2 #define ARCHIVE_H
3
4 #include "pathspec.h"
5
6 struct repository;
7
8 struct archiver_args {
9         struct repository *repo;
10         const char *base;
11         size_t baselen;
12         struct tree *tree;
13         const unsigned char *commit_sha1;
14         const struct commit *commit;
15         timestamp_t time;
16         struct pathspec pathspec;
17         unsigned int verbose : 1;
18         unsigned int worktree_attributes : 1;
19         unsigned int convert : 1;
20         int compression_level;
21 };
22
23 /* main api */
24
25 extern int write_archive(int argc, const char **argv, const char *prefix,
26                          struct repository *repo,
27                          const char *name_hint, int remote);
28
29 const char *archive_format_from_filename(const char *filename);
30
31 /* archive backend stuff */
32
33 #define ARCHIVER_WANT_COMPRESSION_LEVELS 1
34 #define ARCHIVER_REMOTE 2
35 struct archiver {
36         const char *name;
37         int (*write_archive)(const struct archiver *, struct archiver_args *);
38         unsigned flags;
39         void *data;
40 };
41 extern void register_archiver(struct archiver *);
42
43 extern void init_tar_archiver(void);
44 extern void init_zip_archiver(void);
45
46 typedef int (*write_archive_entry_fn_t)(struct archiver_args *args,
47                                         const struct object_id *oid,
48                                         const char *path, size_t pathlen,
49                                         unsigned int mode);
50
51 extern int write_archive_entries(struct archiver_args *args, write_archive_entry_fn_t write_entry);
52 extern void *object_file_to_archive(const struct archiver_args *args,
53                                     const char *path, const struct object_id *oid,
54                                     unsigned int mode, enum object_type *type,
55                                     unsigned long *sizep);
56
57 #endif  /* ARCHIVE_H */