blob: e60e3dd31c79f1c04b7afcae8eb5623238e1234f [file] [log] [blame]
Franck Bui-Huu4df096a2006-09-07 15:12:02 +02001#ifndef ARCHIVE_H
2#define ARCHIVE_H
3
Elijah Newrenef3ca952018-08-15 10:54:05 -07004#include "cache.h"
Nguyễn Thái Ngọc Duyf3e743a2013-07-14 15:35:44 +07005#include "pathspec.h"
6
Nguyễn Thái Ngọc Duyb612ee22018-08-13 18:14:35 +02007struct repository;
8
Franck Bui-Huu4df096a2006-09-07 15:12:02 +02009struct archiver_args {
Nguyễn Thái Ngọc Duyb612ee22018-08-13 18:14:35 +020010 struct repository *repo;
Franck Bui-Huu4df096a2006-09-07 15:12:02 +020011 const char *base;
René Scharfed53fe812008-07-15 09:49:38 +020012 size_t baselen;
Franck Bui-Huu4df096a2006-09-07 15:12:02 +020013 struct tree *tree;
brian m. carlsonbbf05cf2019-02-19 00:05:20 +000014 const struct object_id *commit_oid;
René Scharfe8460b2f2007-09-03 20:07:01 +020015 const struct commit *commit;
Johannes Schindelindddbad72017-04-26 21:29:31 +020016 timestamp_t time;
Nguyễn Thái Ngọc Duyf3e743a2013-07-14 15:35:44 +070017 struct pathspec pathspec;
Junio C Hamanoe0ffb242006-09-09 22:42:02 -070018 unsigned int verbose : 1;
Nguyễn Thái Ngọc Duyba053ea2009-04-18 00:18:05 +020019 unsigned int worktree_attributes : 1;
Nguyễn Thái Ngọc Duy9cb513b2012-05-03 08:51:03 +070020 unsigned int convert : 1;
René Scharfe3a176c62008-07-18 16:30:32 +020021 int compression_level;
Franck Bui-Huu4df096a2006-09-07 15:12:02 +020022};
23
Nguyễn Thái Ngọc Duyb612ee22018-08-13 18:14:35 +020024/* main api */
25
Denton Liu55454422019-04-29 04:28:14 -040026int write_archive(int argc, const char **argv, const char *prefix,
Denton Liuad6dad02019-04-29 04:28:23 -040027 struct repository *repo,
28 const char *name_hint, int remote);
Nguyễn Thái Ngọc Duyb612ee22018-08-13 18:14:35 +020029
30const char *archive_format_from_filename(const char *filename);
31
32/* archive backend stuff */
33
Jeff King13e0f882011-06-21 21:23:33 -040034#define ARCHIVER_WANT_COMPRESSION_LEVELS 1
Jeff King7b977302011-06-21 23:17:35 -040035#define ARCHIVER_REMOTE 2
Jeff King13e0f882011-06-21 21:23:33 -040036struct archiver {
37 const char *name;
Jeff King4d7c9892011-06-21 21:24:07 -040038 int (*write_archive)(const struct archiver *, struct archiver_args *);
Jeff King13e0f882011-06-21 21:23:33 -040039 unsigned flags;
Jeff King4d7c9892011-06-21 21:24:07 -040040 void *data;
Jeff King13e0f882011-06-21 21:23:33 -040041};
Denton Liu55454422019-04-29 04:28:14 -040042void register_archiver(struct archiver *);
Jeff King13e0f882011-06-21 21:23:33 -040043
Denton Liu55454422019-04-29 04:28:14 -040044void init_tar_archiver(void);
45void init_zip_archiver(void);
46void init_archivers(void);
Franck Bui-Huu4df096a2006-09-07 15:12:02 +020047
Nguyễn Thái Ngọc Duy9cb513b2012-05-03 08:51:03 +070048typedef int (*write_archive_entry_fn_t)(struct archiver_args *args,
brian m. carlson015ff4f2018-03-12 02:27:35 +000049 const struct object_id *oid,
Nguyễn Thái Ngọc Duy9cb513b2012-05-03 08:51:03 +070050 const char *path, size_t pathlen,
51 unsigned int mode);
René Scharfe562e25a2008-07-14 21:22:24 +020052
Denton Liu55454422019-04-29 04:28:14 -040053int write_archive_entries(struct archiver_args *args, write_archive_entry_fn_t write_entry);
54void *object_file_to_archive(const struct archiver_args *args,
Denton Liuad6dad02019-04-29 04:28:23 -040055 const char *path, const struct object_id *oid,
56 unsigned int mode, enum object_type *type,
57 unsigned long *sizep);
René Scharfe562e25a2008-07-14 21:22:24 +020058
Franck Bui-Huu4df096a2006-09-07 15:12:02 +020059#endif /* ARCHIVE_H */