mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-30 00:43:38 -05:00
9759608622
The Git project is not exactly the easiest project to get started in: it's written in C and POSIX shell, with bits of Perl, Rust and other languages sprinkled into it. On top of that, the project has grown somewhat organically over time, making the codebase hard to navigate. These are problems that we're aware of, and there have been and still are efforts to clean up some of the technical debt that is natural to exist an a project that is more than 20 years old. Furthermore, we provide resources to newcomers that help them out like our coding guidelines, code of conduct or "MyFirstContribution.adoc". But there is a rather practical problem: finding your way around in our project's tree is not easy. Doing a directory listing in the top-level directory will present you with more than 550 files, which makes it extremely hard for a newcomer to figure out what files they are even supposed to look at. This makes the onboarding experience somewhat harder than it really needs to be. This isn't only a problem for newcomers though, as I myself struggle to find the files I am looking for because of the sheer number of files. Besides the problem of discoverability it also creates a problem of structure. It is not obvious at all which files are part of "libgit.a" and which files are only linked into our final executables. So while we have this split in our build systems, that split is not evident at all in our tree. Introduce a new "lib/" directory and move all of our sources for "libgit.a" into it to fix these issues. It makes the split we have evident and reduces the number of files in our top-level tree from 550 files to ~80 files. This is still a lot of files, but it's significantly easier to navigate already. Furthermore, we can further iterate after this step and think about introducing a better structure for remaining files, as well. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
90 lines
2.3 KiB
C
90 lines
2.3 KiB
C
/*
|
|
* Copyright 2020 Google LLC
|
|
*
|
|
* Use of this source code is governed by a BSD-style
|
|
* license that can be found in the LICENSE file or at
|
|
* https://developers.google.com/open-source/licenses/bsd
|
|
*/
|
|
|
|
#ifndef ITER_H
|
|
#define ITER_H
|
|
|
|
#include "system.h"
|
|
#include "block.h"
|
|
#include "record.h"
|
|
|
|
#include "reftable-iterator.h"
|
|
|
|
/*
|
|
* The virtual function table for implementing generic reftable iterators.
|
|
*/
|
|
struct reftable_iterator_vtable {
|
|
int (*seek)(void *iter_arg, struct reftable_record *want);
|
|
int (*next)(void *iter_arg, struct reftable_record *rec);
|
|
void (*close)(void *iter_arg);
|
|
};
|
|
|
|
/*
|
|
* Position the iterator at the wanted record such that a call to
|
|
* `iterator_next()` would return that record, if it exists.
|
|
*/
|
|
int iterator_seek(struct reftable_iterator *it, struct reftable_record *want);
|
|
|
|
/*
|
|
* Yield the next record and advance the iterator. Returns <0 on error, 0 when
|
|
* a record was yielded, and >0 when the iterator hit an error.
|
|
*/
|
|
int iterator_next(struct reftable_iterator *it, struct reftable_record *rec);
|
|
|
|
/*
|
|
* Set up the iterator such that it behaves the same as an iterator with no
|
|
* entries.
|
|
*/
|
|
void iterator_set_empty(struct reftable_iterator *it);
|
|
|
|
/* iterator that produces only ref records that point to `oid` */
|
|
struct filtering_ref_iterator {
|
|
struct reftable_buf oid;
|
|
struct reftable_iterator it;
|
|
};
|
|
#define FILTERING_REF_ITERATOR_INIT \
|
|
{ \
|
|
.oid = REFTABLE_BUF_INIT \
|
|
}
|
|
|
|
void iterator_from_filtering_ref_iterator(struct reftable_iterator *,
|
|
struct filtering_ref_iterator *);
|
|
|
|
/* iterator that produces only ref records that point to `oid`,
|
|
* but using the object index.
|
|
*/
|
|
struct indexed_table_ref_iter {
|
|
struct reftable_table *table;
|
|
struct reftable_buf oid;
|
|
|
|
/* mutable */
|
|
uint64_t *offsets;
|
|
|
|
/* Points to the next offset to read. */
|
|
int offset_idx;
|
|
int offset_len;
|
|
struct reftable_block block;
|
|
struct block_iter cur;
|
|
int is_finished;
|
|
};
|
|
|
|
#define INDEXED_TABLE_REF_ITER_INIT { \
|
|
.cur = BLOCK_ITER_INIT, \
|
|
.oid = REFTABLE_BUF_INIT, \
|
|
}
|
|
|
|
void iterator_from_indexed_table_ref_iter(struct reftable_iterator *it,
|
|
struct indexed_table_ref_iter *itr);
|
|
|
|
/* Takes ownership of `offsets` */
|
|
int indexed_table_ref_iter_new(struct indexed_table_ref_iter **dest,
|
|
struct reftable_table *t, uint8_t *oid,
|
|
int oid_len, uint64_t *offsets, int offset_len);
|
|
|
|
#endif
|