mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 22:28: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>
68 lines
2.6 KiB
C
68 lines
2.6 KiB
C
#ifndef KWSET_H
|
|
#define KWSET_H
|
|
|
|
/* This file has been copied from commit e7ac713d^ in the GNU grep git
|
|
* repository. A few small changes have been made to adapt the code to
|
|
* Git.
|
|
*/
|
|
|
|
/* kwset.h - header declaring the keyword set library.
|
|
Copyright (C) 1989, 1998, 2005 Free Software Foundation, Inc.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, see <https://www.gnu.org/licenses/>. */
|
|
|
|
/* Written August 1989 by Mike Haertel.
|
|
The author may be reached (Email) at the address mike@ai.mit.edu,
|
|
or (US mail) as Mike Haertel c/o Free Software Foundation. */
|
|
|
|
extern const unsigned char tolower_trans_tbl[256];
|
|
|
|
struct kwsmatch
|
|
{
|
|
int index; /* Index number of matching keyword. */
|
|
size_t offset[1]; /* Offset of each submatch. */
|
|
size_t size[1]; /* Length of each submatch. */
|
|
};
|
|
|
|
struct kwset_t;
|
|
typedef struct kwset_t* kwset_t;
|
|
|
|
/* Return an opaque pointer to a newly allocated keyword set, or NULL
|
|
if enough memory cannot be obtained. The argument if non-NULL
|
|
specifies a table of character translations to be applied to all
|
|
pattern and search text. */
|
|
kwset_t kwsalloc(unsigned char const *);
|
|
|
|
/* Incrementally extend the keyword set to include the given string.
|
|
Return NULL for success, or an error message. Remember an index
|
|
number for each keyword included in the set. */
|
|
const char *kwsincr(kwset_t, char const *, size_t);
|
|
|
|
/* When the keyword set has been completely built, prepare it for
|
|
use. Return NULL for success, or an error message. */
|
|
const char *kwsprep(kwset_t);
|
|
|
|
/* Search through the given buffer for a member of the keyword set.
|
|
Return a pointer to the leftmost longest match found, or NULL if
|
|
no match is found. If foundlen is non-NULL, store the length of
|
|
the matching substring in the integer it points to. Similarly,
|
|
if foundindex is non-NULL, store the index of the particular
|
|
keyword found therein. */
|
|
size_t kwsexec(kwset_t, char const *, size_t, struct kwsmatch *);
|
|
|
|
/* Deallocate the given keyword set and all its associated storage. */
|
|
void kwsfree(kwset_t);
|
|
|
|
#endif /* KWSET_H */
|