global: introduce `USE_THE_REPOSITORY_VARIABLE` macro
Use of the `the_repository` variable is deprecated nowadays, and we
slowly but steadily convert the codebase to not use it anymore. Instead,
callers should be passing down the repository to work on via parameters.
It is hard though to prove that a given code unit does not use this
variable anymore. The most trivial case, merely demonstrating that there
is no direct use of `the_repository`, is already a bit of a pain during
code reviews as the reviewer needs to manually verify claims made by the
patch author. The bigger problem though is that we have many interfaces
that implicitly rely on `the_repository`.
Introduce a new `USE_THE_REPOSITORY_VARIABLE` macro that allows code
units to opt into usage of `the_repository`. The intent of this macro is
to demonstrate that a certain code unit does not use this variable
anymore, and to keep it from new dependencies on it in future changes,
be it explicit or implicit
For now, the macro only guards `the_repository` itself as well as
`the_hash_algo`. There are many more known interfaces where we have an
implicit dependency on `the_repository`, but those are not guarded at
the current point in time. Over time though, we should start to add
guards as required (or even better, just remove them).
Define the macro as required in our code units. As expected, most of our
code still relies on the global variable. Nearly all of our builtins
rely on the variable as there is no way yet to pass `the_repository` to
their entry point. For now, declare the macro in "biultin.h" to keep the
required changes at least a little bit more contained.
Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-06-14 14:50:23 +08:00
|
|
|
#define USE_THE_REPOSITORY_VARIABLE
|
|
|
|
|
2023-02-24 08:09:26 +08:00
|
|
|
#include "git-compat-util.h"
|
2023-04-23 04:17:20 +08:00
|
|
|
#include "hash.h"
|
2023-02-24 08:09:26 +08:00
|
|
|
#include "hex.h"
|
2010-01-22 07:25:19 +08:00
|
|
|
|
2020-02-23 04:17:28 +08:00
|
|
|
static int get_hash_hex_algop(const char *hex, unsigned char *hash,
|
|
|
|
const struct git_hash_algo *algop)
|
2010-01-22 07:25:19 +08:00
|
|
|
{
|
|
|
|
int i;
|
2020-02-23 04:17:28 +08:00
|
|
|
for (i = 0; i < algop->rawsz; i++) {
|
2016-09-03 23:59:20 +08:00
|
|
|
int val = hex2chr(hex);
|
|
|
|
if (val < 0)
|
2010-01-22 07:25:19 +08:00
|
|
|
return -1;
|
2020-02-23 04:17:28 +08:00
|
|
|
*hash++ = val;
|
2010-01-22 07:25:19 +08:00
|
|
|
hex += 2;
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
hex: retire get_sha1_hex()
The naming convention around get_sha1_hex() and its friends is
awkward these days, after "struct object_id" was introduced.
There are three public functions around this area:
* get_sha1_hex() - use the implied the_hash_algo, fill uchar *
* get_oid_hex() - use the implied the_hash_algo, fill oid *
* get_oid_hex_algop() - use the passed algop, fill oid *
Between the latter two, the "_algop" suffix signals whether the
the_hash_algo is used as the implied algorithm or the caller should
pass an algorithm explicitly. That is very much understandable and
is a good convention.
Between the former two, however, the "SHA1" vs "OID" in the names
differentiate in what type of variable the result is stored.
We could argue that it makes sense to use "SHA1" to mean "flat byte
buffer" to honor the historical practice in the days before "struct
object_id" was invented, but the natural fourth friend of the above
group would take an algop and fill a flat byte buffer, and it would
be strange to name it get_sha1_hex_algop(). Do we use the passed in
algo, or are we limited to SHA-1 ;-)?
In fact, such a function exists, albeit as a private helper function
used by the implementation of these functions, and is named a lot
more sensibly: get_hash_hex_algop().
Correct the misnomer of get_sha1_hex() and use "hash", instead of
"sha1", as "flat byte buffer that stores binary (as opposed to
hexadecimal) representation of the hash".
The four (2x2) friends now become:
* get_hash_hex() - use the implied the_hash_algo, fill uchar *
* get_oid_hex() - use the implied the_hash_algo, fill oid *
* get_hash_hex_algop() - use the passed algop, fill uchar *
* get_oid_hex_algop() - use the passed algop, fill oid *
As there are only two remaining calls to get_sha1_hex() in the
codebase right now, the blast radious of this change is fairly
small.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-07-25 07:11:03 +08:00
|
|
|
int get_hash_hex(const char *hex, unsigned char *sha1)
|
2020-02-23 04:17:28 +08:00
|
|
|
{
|
|
|
|
return get_hash_hex_algop(hex, sha1, the_hash_algo);
|
|
|
|
}
|
|
|
|
|
|
|
|
int get_oid_hex_algop(const char *hex, struct object_id *oid,
|
|
|
|
const struct git_hash_algo *algop)
|
|
|
|
{
|
2021-04-26 09:02:55 +08:00
|
|
|
int ret = get_hash_hex_algop(hex, oid->hash, algop);
|
2024-06-14 14:49:59 +08:00
|
|
|
if (!ret) {
|
2021-04-26 09:02:55 +08:00
|
|
|
oid_set_algo(oid, algop);
|
2024-06-14 14:49:59 +08:00
|
|
|
if (algop->rawsz != GIT_MAX_RAWSZ)
|
|
|
|
memset(oid->hash + algop->rawsz, 0,
|
|
|
|
GIT_MAX_RAWSZ - algop->rawsz);
|
|
|
|
}
|
2021-04-26 09:02:55 +08:00
|
|
|
return ret;
|
2020-02-23 04:17:28 +08:00
|
|
|
}
|
|
|
|
|
2020-02-23 04:17:29 +08:00
|
|
|
/*
|
|
|
|
* NOTE: This function relies on hash algorithms being in order from shortest
|
|
|
|
* length to longest length.
|
|
|
|
*/
|
|
|
|
int get_oid_hex_any(const char *hex, struct object_id *oid)
|
|
|
|
{
|
|
|
|
int i;
|
|
|
|
for (i = GIT_HASH_NALGOS - 1; i > 0; i--) {
|
2021-04-26 09:02:55 +08:00
|
|
|
if (!get_oid_hex_algop(hex, oid, &hash_algos[i]))
|
2020-02-23 04:17:29 +08:00
|
|
|
return i;
|
|
|
|
}
|
|
|
|
return GIT_HASH_UNKNOWN;
|
|
|
|
}
|
|
|
|
|
2015-03-14 07:39:28 +08:00
|
|
|
int get_oid_hex(const char *hex, struct object_id *oid)
|
|
|
|
{
|
2020-02-23 04:17:28 +08:00
|
|
|
return get_oid_hex_algop(hex, oid, the_hash_algo);
|
2015-03-14 07:39:28 +08:00
|
|
|
}
|
|
|
|
|
2020-02-23 04:17:28 +08:00
|
|
|
int parse_oid_hex_algop(const char *hex, struct object_id *oid,
|
|
|
|
const char **end,
|
|
|
|
const struct git_hash_algo *algop)
|
2017-02-20 08:10:13 +08:00
|
|
|
{
|
2021-04-26 09:02:55 +08:00
|
|
|
int ret = get_oid_hex_algop(hex, oid, algop);
|
2017-02-20 08:10:13 +08:00
|
|
|
if (!ret)
|
2020-02-23 04:17:28 +08:00
|
|
|
*end = hex + algop->hexsz;
|
2017-02-20 08:10:13 +08:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2020-02-23 04:17:29 +08:00
|
|
|
int parse_oid_hex_any(const char *hex, struct object_id *oid, const char **end)
|
|
|
|
{
|
|
|
|
int ret = get_oid_hex_any(hex, oid);
|
|
|
|
if (ret)
|
|
|
|
*end = hex + hash_algos[ret].hexsz;
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2020-02-23 04:17:28 +08:00
|
|
|
int parse_oid_hex(const char *hex, struct object_id *oid, const char **end)
|
|
|
|
{
|
|
|
|
return parse_oid_hex_algop(hex, oid, end, the_hash_algo);
|
|
|
|
}
|
|
|
|
|
2018-11-14 12:09:29 +08:00
|
|
|
char *hash_to_hex_algop_r(char *buffer, const unsigned char *hash,
|
|
|
|
const struct git_hash_algo *algop)
|
2010-01-22 07:25:19 +08:00
|
|
|
{
|
|
|
|
static const char hex[] = "0123456789abcdef";
|
2015-09-25 05:05:45 +08:00
|
|
|
char *buf = buffer;
|
2010-01-22 07:25:19 +08:00
|
|
|
int i;
|
|
|
|
|
2021-04-26 09:03:00 +08:00
|
|
|
/*
|
|
|
|
* Our struct object_id has been memset to 0, so default to printing
|
|
|
|
* using the default hash.
|
|
|
|
*/
|
|
|
|
if (algop == &hash_algos[0])
|
|
|
|
algop = the_hash_algo;
|
|
|
|
|
2018-11-14 12:09:29 +08:00
|
|
|
for (i = 0; i < algop->rawsz; i++) {
|
|
|
|
unsigned int val = *hash++;
|
2010-01-22 07:25:19 +08:00
|
|
|
*buf++ = hex[val >> 4];
|
|
|
|
*buf++ = hex[val & 0xf];
|
|
|
|
}
|
|
|
|
*buf = '\0';
|
|
|
|
|
|
|
|
return buffer;
|
|
|
|
}
|
2015-03-14 07:39:28 +08:00
|
|
|
|
2016-06-25 07:09:19 +08:00
|
|
|
char *oid_to_hex_r(char *buffer, const struct object_id *oid)
|
|
|
|
{
|
2021-04-26 09:03:01 +08:00
|
|
|
return hash_to_hex_algop_r(buffer, oid->hash, &hash_algos[oid->algo]);
|
2016-06-25 07:09:19 +08:00
|
|
|
}
|
|
|
|
|
2018-11-14 12:09:29 +08:00
|
|
|
char *hash_to_hex_algop(const unsigned char *hash, const struct git_hash_algo *algop)
|
2015-09-25 05:05:45 +08:00
|
|
|
{
|
|
|
|
static int bufno;
|
2017-03-27 00:01:24 +08:00
|
|
|
static char hexbuffer[4][GIT_MAX_HEXSZ + 1];
|
2016-10-24 01:57:30 +08:00
|
|
|
bufno = (bufno + 1) % ARRAY_SIZE(hexbuffer);
|
2018-11-14 12:09:29 +08:00
|
|
|
return hash_to_hex_algop_r(hexbuffer[bufno], hash, algop);
|
|
|
|
}
|
|
|
|
|
|
|
|
char *hash_to_hex(const unsigned char *hash)
|
|
|
|
{
|
|
|
|
return hash_to_hex_algop(hash, the_hash_algo);
|
2015-09-25 05:05:45 +08:00
|
|
|
}
|
|
|
|
|
2015-03-14 07:39:28 +08:00
|
|
|
char *oid_to_hex(const struct object_id *oid)
|
|
|
|
{
|
2021-04-26 09:03:01 +08:00
|
|
|
return hash_to_hex_algop(oid->hash, &hash_algos[oid->algo]);
|
2015-03-14 07:39:28 +08:00
|
|
|
}
|