regexec: prefix all regexec function calls with p_

Prefix all the calls to the the regexec family of functions with `p_`.
This allows us to swap out all the regular expression functions with our
own implementation.  Move the declarations to `posix_regex.h` for
simpler inclusion.

12 files changed, 106 insertions, 77 deletions

diff --git a/src/common.h b/src/common.h
index 18ba72dd1..03679fc27 100644
--- a/src/common.h
+++ b/src/common.h
@@ -85,7 +85,8 @@
  */
 #include "git2/deprecated.h"
 
-#include <regex.h>
+#include "posix.h"
+#include "posix_regex.h"
 
 #define DEFAULT_BUFSIZE 65536
 #define FILEIO_BUFSIZE DEFAULT_BUFSIZE
@@ -118,7 +119,7 @@ void git_error_set(int error_class, const char *string, ...) GIT_FORMAT_PRINTF(2
  * Set the error message for a regex failure, using the internal regex
  * error code lookup and return a libgit error code.
  */
-int git_error_set_regex(const regex_t *regex, int error_code);
+int git_error_set_regex(const p_regex_t *regex, int error_code);
 
 /**
  * Set error message for user callback if needed.
diff --git a/src/config.c b/src/config.c
index fce1aad3b..5519fe19c 100644
--- a/src/config.c
+++ b/src/config.c
@@ -345,7 +345,7 @@ typedef struct {
 	git_config_iterator parent;
 	git_config_iterator *current;
 	const git_config *cfg;
-	regex_t regex;
+	p_regex_t regex;
 	size_t i;
 } all_iter;
 
@@ -423,7 +423,7 @@ static int all_iter_glob_next(git_config_entry **entry, git_config_iterator *_it
 	 */
 	while ((error = all_iter_next(entry, _iter)) == 0) {
 		/* skip non-matching keys if regexp was provided */
-		if (regexec(&iter->regex, (*entry)->name, 0, NULL, 0) != 0)
+		if (p_regexec(&iter->regex, (*entry)->name, 0, NULL, 0) != 0)
 			continue;
 
 		/* and simply return if we like the entry's name */
@@ -447,7 +447,7 @@ static void all_iter_glob_free(git_config_iterator *_iter)
 {
 	all_iter *iter = (all_iter *) _iter;
 
-	regfree(&iter->regex);
+	p_regfree(&iter->regex);
 	all_iter_free(_iter);
 }
 
@@ -480,7 +480,7 @@ int git_config_iterator_glob_new(git_config_iterator **out, const git_config *cf
 	iter = git__calloc(1, sizeof(all_iter));
 	GIT_ERROR_CHECK_ALLOC(iter);
 
-	if ((result = p_regcomp(&iter->regex, regexp, REG_EXTENDED)) != 0) {
+	if ((result = p_regcomp(&iter->regex, regexp, P_REG_EXTENDED)) != 0) {
 		git_error_set_regex(&iter->regex, result);
 		git__free(iter);
 		return -1;
@@ -510,15 +510,15 @@ int git_config_backend_foreach_match(
 {
 	git_config_entry *entry;
 	git_config_iterator* iter;
-	regex_t regex;
+	p_regex_t regex;
 	int error = 0;
 
 	assert(backend && cb);
 
 	if (regexp != NULL) {
-		if ((error = p_regcomp(&regex, regexp, REG_EXTENDED)) != 0) {
+		if ((error = p_regcomp(&regex, regexp, P_REG_EXTENDED)) != 0) {
 			git_error_set_regex(&regex, error);
-			regfree(&regex);
+			p_regfree(&regex);
 			return -1;
 		}
 	}
@@ -530,7 +530,7 @@ int git_config_backend_foreach_match(
 
 	while (!(iter->next(&entry, iter) < 0)) {
 		/* skip non-matching keys if regexp was provided */
-		if (regexp && regexec(&regex, entry->name, 0, NULL, 0) != 0)
+		if (regexp && p_regexec(&regex, entry->name, 0, NULL, 0) != 0)
 			continue;
 
 		/* abort iterator on non-zero return value */
@@ -541,7 +541,7 @@ int git_config_backend_foreach_match(
 	}
 
 	if (regexp != NULL)
-		regfree(&regex);
+		p_regfree(&regex);
 
 	iter->free(iter);
 
@@ -981,7 +981,7 @@ typedef struct {
 	git_config_iterator parent;
 	git_config_iterator *iter;
 	char *name;
-	regex_t regex;
+	p_regex_t regex;
 	int have_regex;
 } multivar_iter;
 
@@ -997,7 +997,7 @@ static int multivar_iter_next(git_config_entry **entry, git_config_iterator *_it
 		if (!iter->have_regex)
 			return 0;
 
-		if (regexec(&iter->regex, (*entry)->value, 0, NULL, 0) == 0)
+		if (p_regexec(&iter->regex, (*entry)->value, 0, NULL, 0) == 0)
 			return 0;
 	}
 
@@ -1012,7 +1012,7 @@ void multivar_iter_free(git_config_iterator *_iter)
 
 	git__free(iter->name);
 	if (iter->have_regex)
-		regfree(&iter->regex);
+		p_regfree(&iter->regex);
 	git__free(iter);
 }
 
@@ -1032,11 +1032,11 @@ int git_config_multivar_iterator_new(git_config_iterator **out, const git_config
 		goto on_error;
 
 	if (regexp != NULL) {
-		error = p_regcomp(&iter->regex, regexp, REG_EXTENDED);
+		error = p_regcomp(&iter->regex, regexp, P_REG_EXTENDED);
 		if (error != 0) {
 			git_error_set_regex(&iter->regex, error);
 			error = -1;
-			regfree(&iter->regex);
+			p_regfree(&iter->regex);
 			goto on_error;
 		}
 
diff --git a/src/config_file.c b/src/config_file.c
index 48a9a26d4..716205851 100644
--- a/src/config_file.c
+++ b/src/config_file.c
@@ -21,7 +21,6 @@
 
 #include <ctype.h>
 #include <sys/types.h>
-#include <regex.h>
 
 /* Max depth for [include] directives */
 #define MAX_INCLUDE_DEPTH 10
@@ -62,7 +61,7 @@ typedef struct {
 } diskfile_parse_state;
 
 static int config_read(git_config_entries *entries, const git_repository *repo, git_config_file *file, git_config_level_t level, int depth);
-static int config_write(diskfile_backend *cfg, const char *orig_key, const char *key, const regex_t *preg, const char *value);
+static int config_write(diskfile_backend *cfg, const char *orig_key, const char *key, const p_regex_t *preg, const char *value);
 static char *escape_value(const char *ptr);
 
 static int config_snapshot(git_config_backend **out, git_config_backend *in);
@@ -329,7 +328,7 @@ static int config_set_multivar(
 {
 	diskfile_backend *b = (diskfile_backend *)cfg;
 	char *key;
-	regex_t preg;
+	p_regex_t preg;
 	int result;
 
 	assert(regexp);
@@ -337,7 +336,7 @@ static int config_set_multivar(
 	if ((result = git_config__normalize_name(name, &key)) < 0)
 		return result;
 
-	result = p_regcomp(&preg, regexp, REG_EXTENDED);
+	result = p_regcomp(&preg, regexp, P_REG_EXTENDED);
 	if (result != 0) {
 		git_error_set_regex(&preg, result);
 		result = -1;
@@ -352,7 +351,7 @@ static int config_set_multivar(
 
 out:
 	git__free(key);
-	regfree(&preg);
+	p_regfree(&preg);
 
 	return result;
 }
@@ -395,7 +394,7 @@ static int config_delete_multivar(git_config_backend *cfg, const char *name, con
 	diskfile_backend *b = (diskfile_backend *)cfg;
 	git_config_entries *entries = NULL;
 	git_config_entry *entry = NULL;
-	regex_t preg = { 0 };
+	p_regex_t preg = { 0 };
 	char *key = NULL;
 	int result;
 
@@ -413,7 +412,7 @@ static int config_delete_multivar(git_config_backend *cfg, const char *name, con
 		goto out;
 	}
 
-	if ((result = p_regcomp(&preg, regexp, REG_EXTENDED)) != 0) {
+	if ((result = p_regcomp(&preg, regexp, P_REG_EXTENDED)) != 0) {
 		git_error_set_regex(&preg, result);
 		result = -1;
 		goto out;
@@ -428,7 +427,7 @@ static int config_delete_multivar(git_config_backend *cfg, const char *name, con
 out:
 	git_config_entries_free(entries);
 	git__free(key);
-	regfree(&preg);
+	p_regfree(&preg);
 	return result;
 }
 
@@ -954,7 +953,7 @@ struct write_data {
 	const char *section;
 	const char *orig_name;
 	const char *name;
-	const regex_t *preg;
+	const p_regex_t *preg;
 	const char *value;
 };
 
@@ -1059,7 +1058,7 @@ static int write_on_variable(
 
 	/* If we have a regex to match the value, see if it matches */
 	if (has_matched && write_data->preg != NULL)
-		has_matched = (regexec(write_data->preg, var_value, 0, NULL, 0) == 0);
+		has_matched = (p_regexec(write_data->preg, var_value, 0, NULL, 0) == 0);
 
 	/* If this isn't the name/value we're looking for, simply dump the
 	 * existing data back out and continue on.
@@ -1120,7 +1119,7 @@ static int write_on_eof(
 /*
  * This is pretty much the parsing, except we write out anything we don't have
  */
-static int config_write(diskfile_backend *cfg, const char *orig_key, const char *key, const regex_t *preg, const char* value)
+static int config_write(diskfile_backend *cfg, const char *orig_key, const char *key, const p_regex_t *preg, const char* value)
 {
 	int result;
 	char *orig_section, *section, *orig_name, *name, *ldot;
diff --git a/src/diff_driver.c b/src/diff_driver.c
index 959cf6258..0ca652c69 100644
--- a/src/diff_driver.c
+++ b/src/diff_driver.c
@@ -9,6 +9,7 @@
 
 #include "git2/attr.h"
 
+#include "common.h"
 #include "diff.h"
 #include "strmap.h"
 #include "map.h"
@@ -24,7 +25,7 @@ typedef enum {
 } git_diff_driver_t;
 
 typedef struct {
-	regex_t re;
+	p_regex_t re;
 	int flags;
 } git_diff_driver_pattern;
 
@@ -38,7 +39,7 @@ struct git_diff_driver {
 	uint32_t binary_flags;
 	uint32_t other_flags;
 	git_array_t(git_diff_driver_pattern) fn_patterns;
-	regex_t  word_pattern;
+	p_regex_t  word_pattern;
 	char name[GIT_FLEX_ARRAY];
 };
 
@@ -129,7 +130,7 @@ static int diff_driver_add_patterns(
 
 static int diff_driver_xfuncname(const git_config_entry *entry, void *payload)
 {
-	return diff_driver_add_patterns(payload, entry->value, REG_EXTENDED);
+	return diff_driver_add_patterns(payload, entry->value, P_REG_EXTENDED);
 }
 
 static int diff_driver_funcname(const git_config_entry *entry, void *payload)
@@ -204,12 +205,12 @@ static int git_diff_driver_builtin(
 
 	if (ddef->fns &&
 		(error = diff_driver_add_patterns(
-			drv, ddef->fns, ddef->flags | REG_EXTENDED)) < 0)
+			drv, ddef->fns, ddef->flags | P_REG_EXTENDED)) < 0)
 		goto done;
 
 	if (ddef->words &&
 		(error = p_regcomp(
-			&drv->word_pattern, ddef->words, ddef->flags | REG_EXTENDED)))
+			&drv->word_pattern, ddef->words, ddef->flags | P_REG_EXTENDED)))
 	{
 		error = git_error_set_regex(&drv->word_pattern, error);
 		goto done;
@@ -309,7 +310,7 @@ static int git_diff_driver_load(
 		goto done;
 	if (!ce || !ce->value)
 		/* no diff.<driver>.wordregex, so just continue */;
-	else if (!(error = p_regcomp(&drv->word_pattern, ce->value, REG_EXTENDED)))
+	else if (!(error = p_regcomp(&drv->word_pattern, ce->value, P_REG_EXTENDED)))
 		found_driver = true;
 	else {
 		/* TODO: warn about bad regex instead of failure */
@@ -393,10 +394,10 @@ void git_diff_driver_free(git_diff_driver *driver)
 		return;
 
 	for (i = 0; i < git_array_size(driver->fn_patterns); ++i)
-		regfree(& git_array_get(driver->fn_patterns, i)->re);
+		p_regfree(& git_array_get(driver->fn_patterns, i)->re);
 	git_array_clear(driver->fn_patterns);
 
-	regfree(&driver->word_pattern);
+	p_regfree(&driver->word_pattern);
 
 	git__free(driver);
 }
@@ -444,12 +445,12 @@ static int diff_context_line__pattern_match(
 	git_diff_driver *driver, git_buf *line)
 {
 	size_t i, maxi = git_array_size(driver->fn_patterns);
-	regmatch_t pmatch[2];
+	p_regmatch_t pmatch[2];
 
 	for (i = 0; i < maxi; ++i) {
 		git_diff_driver_pattern *pat = git_array_get(driver->fn_patterns, i);
 
-		if (!regexec(&pat->re, line->ptr, 2, pmatch, 0)) {
+		if (!p_regexec(&pat->re, line->ptr, 2, pmatch, 0)) {
 			if (pat->flags & REG_NEGATE)
 				return false;
 
diff --git a/src/errors.c b/src/errors.c
index afa340936..8ef491916 100644
--- a/src/errors.c
+++ b/src/errors.c
@@ -105,16 +105,16 @@ void git_error_set_str(int error_class, const char *string)
 		set_error_from_buffer(error_class);
 }
 
-int git_error_set_regex(const regex_t *regex, int error_code)
+int git_error_set_regex(const p_regex_t *regex, int error_code)
 {
 	char error_buf[1024];
 
 	assert(error_code);
 
-	regerror(error_code, regex, error_buf, sizeof(error_buf));
+	p_regerror(error_code, regex, error_buf, sizeof(error_buf));
 	git_error_set_str(GIT_ERROR_REGEX, error_buf);
 
-	if (error_code == REG_NOMATCH)
+	if (error_code == P_REG_NOMATCH)
 		return GIT_ENOTFOUND;
 
 	return GIT_EINVALIDSPEC;
diff --git a/src/posix_regex.h b/src/posix_regex.h
new file mode 100644
index 000000000..fa9190695
--- /dev/null
+++ b/src/posix_regex.h
@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) the libgit2 contributors. All rights reserved.
+ *
+ * This file is part of libgit2, distributed under the GNU GPL v2 with
+ * a Linking Exception. For full terms see the included COPYING file.
+ */
+#ifndef INCLUDE_posix_regex_h__
+#define INCLUDE_posix_regex_h__
+
+#include "common.h"
+#include <regex.h>
+
+/*
+ * Regular expressions: if the operating system has p_regcomp_l,
+ * use that as our p_regcomp implementation, otherwise fall back
+ * to standard regcomp.
+ */
+
+#define P_REG_EXTENDED REG_EXTENDED
+#define P_REG_ICASE REG_ICASE
+#define P_REG_NOMATCH REG_NOMATCH
+
+#define p_regex_t regex_t
+#define p_regmatch_t regmatch_t
+
+#define p_regerror regerror
+#define p_regexec regexec
+#define p_regfree regfree
+
+#ifdef GIT_USE_REGCOMP_L
+#include <xlocale.h>
+
+GIT_INLINE(int) p_regcomp(p_regex_t *preg, const char *pattern, int cflags)
+{
+	return regcomp_l(preg, pattern, cflags, (locale_t) 0);
+}
+#else
+# define p_regcomp regcomp
+#endif
+
+#endif
diff --git a/src/revparse.c b/src/revparse.c
index 50ee31ca0..4bde0d7f2 100644
--- a/src/revparse.c
+++ b/src/revparse.c
@@ -42,7 +42,7 @@ static int maybe_abbrev(git_object** out, git_repository *repo, const char *spec
 	return maybe_sha_or_abbrev(out, repo, spec, speclen);
 }
 
-static int build_regex(regex_t *regex, const char *pattern)
+static int build_regex(p_regex_t *regex, const char *pattern)
 {
 	int error;
 
@@ -51,13 +51,13 @@ static int build_regex(regex_t *regex, const char *pattern)
 		return GIT_EINVALIDSPEC;
 	}
 
-	error = p_regcomp(regex, pattern, REG_EXTENDED);
+	error = p_regcomp(regex, pattern, P_REG_EXTENDED);
 	if (!error)
 		return 0;
 
 	error = git_error_set_regex(regex, error);
 
-	regfree(regex);
+	p_regfree(regex);
 
 	return error;
 }
@@ -66,7 +66,7 @@ static int maybe_describe(git_object**out, git_repository *repo, const char *spe
 {
 	const char *substr;
 	int error;
-	regex_t regex;
+	p_regex_t regex;
 
 	substr = strstr(spec, "-g");
 
@@ -76,8 +76,8 @@ static int maybe_describe(git_object**out, git_repository *repo, const char *spe
 	if (build_regex(&regex, ".+-[0-9]+-g[0-9a-fA-F]+") < 0)
 		return -1;
 
-	error = regexec(&regex, spec, 0, NULL, 0);
-	regfree(&regex);
+	error = p_regexec(&regex, spec, 0, NULL, 0);
+	p_regfree(&regex);
 
 	if (error)
 		return GIT_ENOTFOUND;
@@ -143,12 +143,12 @@ static int retrieve_previously_checked_out_branch_or_revision(git_object **out,
 {
 	git_reference *ref = NULL;
 	git_reflog *reflog = NULL;
-	regex_t preg;
+	p_regex_t preg;
 	int error = -1;
 	size_t i, numentries, cur;
 	const git_reflog_entry *entry;
 	const char *msg;
-	regmatch_t regexmatches[2];
+	p_regmatch_t regexmatches[2];
 	git_buf buf = GIT_BUF_INIT;
 
 	cur = position;
@@ -173,7 +173,7 @@ static int retrieve_previously_checked_out_branch_or_revision(git_object **out,
 		if (!msg)
 			continue;
 
-		if (regexec(&preg, msg, 2, regexmatches, 0))
+		if (p_regexec(&preg, msg, 2, regexmatches, 0))
 			continue;
 
 		cur--;
@@ -199,7 +199,7 @@ static int retrieve_previously_checked_out_branch_or_revision(git_object **out,
 cleanup:
 	git_reference_free(ref);
 	git_buf_dispose(&buf);
-	regfree(&preg);
+	p_regfree(&preg);
 	git_reflog_free(reflog);
 	return error;
 }
@@ -448,7 +448,7 @@ cleanup:
 	return error;
 }
 
-static int walk_and_search(git_object **out, git_revwalk *walk, regex_t *regex)
+static int walk_and_search(git_object **out, git_revwalk *walk, p_regex_t *regex)
 {
 	int error;
 	git_oid oid;
@@ -460,7 +460,7 @@ static int walk_and_search(git_object **out, git_revwalk *walk, regex_t *regex)
 		if ((error < 0) && (error != GIT_ENOTFOUND))
 			return -1;
 
-		if (!regexec(regex, git_commit_message((git_commit*)obj), 0, NULL, 0)) {
+		if (!p_regexec(regex, git_commit_message((git_commit*)obj), 0, NULL, 0)) {
 			*out = obj;
 			return 0;
 		}
@@ -476,7 +476,7 @@ static int walk_and_search(git_object **out, git_revwalk *walk, regex_t *regex)
 
 static int handle_grep_syntax(git_object **out, git_repository *repo, const git_oid *spec_oid, const char *pattern)
 {
-	regex_t preg;
+	p_regex_t preg;
 	git_revwalk *walk = NULL;
 	int error;
 
@@ -497,7 +497,7 @@ static int handle_grep_syntax(git_object **out, git_repository *repo, const git_
 	error = walk_and_search(out, walk, &preg);
 
 cleanup:
-	regfree(&preg);
+	p_regfree(&preg);
 	git_revwalk_free(walk);
 
 	return error;
diff --git a/src/unix/posix.h b/src/unix/posix.h
index f2fffd5c9..f969f8362 100644
--- a/src/unix/posix.h
+++ b/src/unix/posix.h
@@ -89,14 +89,4 @@ GIT_INLINE(int) p_futimes(int f, const struct p_timeval t[2])
 # define p_futimes futimes
 #endif
 
-#ifdef GIT_USE_REGCOMP_L
-#include <xlocale.h>
-GIT_INLINE(int) p_regcomp(regex_t *preg, const char *pattern, int cflags)
-{
-	return regcomp_l(preg, pattern, cflags, (locale_t) 0);
-}
-#else
-# define p_regcomp regcomp
-#endif
-
 #endif
diff --git a/src/userdiff.h b/src/userdiff.h
index 91c1f42dc..8bde6303f 100644
--- a/src/userdiff.h
+++ b/src/userdiff.h
@@ -29,7 +29,7 @@ typedef struct {
 #define PATTERNS(NAME, FN_PATS, WORD_PAT) \
 	{ NAME, FN_PATS, WORD_PAT WORD_DEFAULT, 0 }
 #define IPATTERN(NAME, FN_PATS, WORD_PAT) \
-	{ NAME, FN_PATS, WORD_PAT WORD_DEFAULT, REG_ICASE }
+	{ NAME, FN_PATS, WORD_PAT WORD_DEFAULT, P_REG_ICASE }
 
 /*
  * The table of diff driver patterns
diff --git a/src/win32/posix.h b/src/win32/posix.h
index d5ab2e8f5..e427d64c3 100644
--- a/src/win32/posix.h
+++ b/src/win32/posix.h
@@ -60,7 +60,4 @@ extern int p_lstat_posixly(const char *filename, struct stat *buf);
 extern struct tm * p_localtime_r(const time_t *timer, struct tm *result);
 extern struct tm * p_gmtime_r(const time_t *timer, struct tm *result);
 
-/* Use the bundled regcomp */
-#define p_regcomp regcomp
-
 #endif
diff --git a/tests/clar_libgit2.h b/tests/clar_libgit2.h
index da6ff2974..5ea62e75e 100644
--- a/tests/clar_libgit2.h
+++ b/tests/clar_libgit2.h
@@ -3,8 +3,8 @@
 
 #include "clar.h"
 #include <git2.h>
-#include <posix.h>
 #include "common.h"
+#include "posix.h"
 
 /**
  * Replace for `clar_must_pass` that passes the last library error as the
diff --git a/tests/core/posix.c b/tests/core/posix.c
index 529ee37f7..281285024 100644
--- a/tests/core/posix.c
+++ b/tests/core/posix.c
@@ -154,7 +154,7 @@ void test_core_posix__utimes(void)
 
 void test_core_posix__p_regcomp_ignores_global_locale_ctype(void)
 {
-	regex_t preg;
+	p_regex_t preg;
 	int error = 0;
 
 	const char* oldlocale = setlocale(LC_CTYPE, NULL);
@@ -169,8 +169,8 @@ void test_core_posix__p_regcomp_ignores_global_locale_ctype(void)
 		cl_fail("Expected locale to be switched to multibyte");
 	}
 
-	p_regcomp(&preg, "[\xc0-\xff][\x80-\xbf]", REG_EXTENDED);
-	regfree(&preg);
+	p_regcomp(&preg, "[\xc0-\xff][\x80-\xbf]", P_REG_EXTENDED);
+	p_regfree(&preg);
 
 	setlocale(LC_CTYPE, oldlocale);
 
@@ -184,14 +184,14 @@ void test_core_posix__p_regcomp_compile_userdiff_regexps(void)
 	for (idx = 0; idx < ARRAY_SIZE(builtin_defs); ++idx) {
 		git_diff_driver_definition ddef = builtin_defs[idx];
 		int error = 0;
-		regex_t preg;
+		p_regex_t preg;
 
-		error = p_regcomp(&preg, ddef.fns, REG_EXTENDED | ddef.flags);
-		regfree(&preg);
+		error = p_regcomp(&preg, ddef.fns, P_REG_EXTENDED | ddef.flags);
+		p_regfree(&preg);
 		cl_must_pass(error);
 
-		error = p_regcomp(&preg, ddef.words, REG_EXTENDED);
-		regfree(&preg);
+		error = p_regcomp(&preg, ddef.words, P_REG_EXTENDED);
+		p_regfree(&preg);
 		cl_must_pass(error);
 	}
 }