Refactor git transport options parsing
[git/git.git] / transport.h
CommitLineData
9b288516
DB
1#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
5#include "remote.h"
6
aa5af974
IL
7struct git_transport_options {
8 unsigned thin : 1;
9 unsigned keep : 1;
10 unsigned followtags : 1;
11 int depth;
12 const char *uploadpack;
13 const char *receivepack;
14};
15
9b288516 16struct transport {
9b288516
DB
17 struct remote *remote;
18 const char *url;
9b288516 19 void *data;
4577370e 20 const struct ref *remote_refs;
9b288516 21
9b288516
DB
22 /**
23 * Returns 0 if successful, positive if the option is not
24 * recognized or is inapplicable, and negative if the option
25 * is applicable but the value is invalid.
26 **/
27 int (*set_option)(struct transport *connection, const char *name,
28 const char *value);
29
37148311
DB
30 /**
31 * Returns a list of the remote side's refs. In order to allow
32 * the transport to try to share connections, for_push is a
33 * hint as to whether the ultimate operation is a push or a fetch.
34 *
35 * If the transport is able to determine the remote hash for
36 * the ref without a huge amount of effort, it should store it
37 * in the ref's old_sha1 field; otherwise it should be all 0.
38 **/
64fcef2d 39 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
40
41 /**
42 * Fetch the objects for the given refs. Note that this gets
43 * an array, and should ignore the list structure.
44 *
45 * If the transport did not get hashes for refs in
46 * get_refs_list(), it should set the old_sha1 fields in the
47 * provided refs now.
48 **/
49 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
50
51 /**
52 * Push the objects and refs. Send the necessary objects, and
53 * then, for any refs where peer_ref is set and
54 * peer_ref->new_sha1 is different from old_sha1, tell the
55 * remote side to update each ref in the list from old_sha1 to
56 * peer_ref->new_sha1.
57 *
58 * Where possible, set the status for each ref appropriately.
59 *
60 * The transport must modify new_sha1 in the ref to the new
61 * value if the remote accepted the change. Note that this
62 * could be a different value from peer_ref->new_sha1 if the
63 * process involved generating new commits.
64 **/
64fcef2d 65 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516
DB
66 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
67
37148311
DB
68 /** get_refs_list(), fetch(), and push_refs() can keep
69 * resources (such as a connection) reserved for futher
70 * use. disconnect() releases these resources.
71 **/
9b288516 72 int (*disconnect)(struct transport *connection);
824d5776 73 char *pack_lockfile;
cff7123c 74 signed verbose : 3;
21188b1e
MV
75 /* Force progress even if the output is not a tty */
76 unsigned progress : 1;
aa5af974
IL
77 /*
78 * If transport is at least potentially smart, this points to
79 * git_transport_options structure to use in case transport
80 * actually turns out to be smart.
81 */
82 struct git_transport_options *smart_options;
9b288516
DB
83};
84
824d5776
SP
85#define TRANSPORT_PUSH_ALL 1
86#define TRANSPORT_PUSH_FORCE 2
2e13e5d8 87#define TRANSPORT_PUSH_DRY_RUN 4
94c89ba6 88#define TRANSPORT_PUSH_MIRROR 8
bcd2e266 89#define TRANSPORT_PUSH_VERBOSE 16
1965ff74 90#define TRANSPORT_PUSH_PORCELAIN 32
afdeeb00 91#define TRANSPORT_PUSH_QUIET 64
824d5776 92
9b288516 93/* Returns a transport suitable for the url */
e5f4e214 94struct transport *transport_get(struct remote *, const char *);
9b288516
DB
95
96/* Transport options which apply to git:// and scp-style URLs */
97
c29727d5
DB
98/* The program to use on the remote side to send a pack */
99#define TRANS_OPT_UPLOADPACK "uploadpack"
100
9b288516
DB
101/* The program to use on the remote side to receive a pack */
102#define TRANS_OPT_RECEIVEPACK "receivepack"
103
104/* Transfer the data as a thin pack if not null */
105#define TRANS_OPT_THIN "thin"
106
c29727d5
DB
107/* Keep the pack that was transferred if not null */
108#define TRANS_OPT_KEEP "keep"
109
c29727d5
DB
110/* Limit the depth of the fetch if not null */
111#define TRANS_OPT_DEPTH "depth"
112
41fa7d2e
SP
113/* Aggressively fetch annotated tags if possible */
114#define TRANS_OPT_FOLLOWTAGS "followtags"
115
9b288516
DB
116/**
117 * Returns 0 if the option was used, non-zero otherwise. Prints a
118 * message to stderr if the option is not used.
119 **/
120int transport_set_option(struct transport *transport, const char *name,
121 const char *value);
122
123int transport_push(struct transport *connection,
07436e43
MM
124 int refspec_nr, const char **refspec, int flags,
125 int * nonfastforward);
9b288516 126
4577370e 127const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 128
37148311 129int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 130void transport_unlock_pack(struct transport *transport);
9b288516 131int transport_disconnect(struct transport *transport);
47abd85b 132char *transport_anonymize_url(const char *url);
9b288516 133
6eb996b5 134/* Transport methods defined outside transport.c */
c9e388bb 135int transport_helper_init(struct transport *transport, const char *name);
6eb996b5 136
9b288516 137#endif