libpkgconf/argvsplit.c - main - githubmirror/pkgconf

libpkgconf/argvsplit.c
234 строки5 KB
Ariadne Conill
libpkgconf: argvsplit: add a split which leaves the quoting in place
02 авг 2026, 01:13
02 авг 2026, 01:136b0fd20
/*
 * argvsplit.c
 * argv_split() routine
 *
 * SPDX-License-Identifier: pkgconf
 *
 * Copyright (c) 2012, 2017 pkgconf authors (see AUTHORS).
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * This software is provided 'as is' and without any warranty, express or
 * implied.  In no event shall the authors be liable for any damages arising
 * from the use of this software.
 */

#include <libpkgconf/stdinc.h>
#include <libpkgconf/libpkgconf.h>

/*
 * !doc
 *
 * libpkgconf `argvsplit` module
 * =============================
 *
 * This is a lowlevel module which provides parsing of strings into argument vectors,
 * similar to what a shell would do.
 */

/*
 * !doc
 *
 * .. c:function:: void pkgconf_argv_free(char **argv)
 *
 *    Frees an argument vector.
 *
 *    :param char** argv: The argument vector to free.
 *    :return: nothing
 */
void
pkgconf_argv_free(char **argv)
{
	if (argv == NULL)
		return;

	free(argv[0]);
	free(argv);
}

/*
 * Walk `src`, breaking it at whitespace which is neither quoted nor escaped.
 *
 * When `raw` is set, the quoting and escaping is only read to find those breaks:
 * the quotes and backslashes are copied into the argument along with everything
 * else, leaving it spelled exactly as it was written.  Otherwise they are
 * consumed, as a shell would consume them.
 */
static int
argv_split(const char *src, int *argc, char ***argv, bool raw)
{
	char *buf = calloc(1, strlen(src) + 1);
	if (buf == NULL)
		return -1;

	const char *src_iter;
	char *dst_iter;
	int argc_count = 0;
	int argv_size = 5;
	char quote = 0;
	bool escaped = false;

	src_iter = src;
	dst_iter = buf;

	*argv = calloc(argv_size, sizeof (void *));
	if (*argv == NULL)
	{
		free(buf);
		return -1;
	}

	(*argv)[argc_count] = dst_iter;

	while (*src_iter)
	{
		if (escaped)
		{
			/* POSIX: only \CHAR is special inside a double quote if CHAR is {$, `, ", \, newline}. */
			if (quote == '"' && !raw)
			{
				if (!(*src_iter == '$' || *src_iter == '`' || *src_iter == '"' || *src_iter == '\\'))
					*dst_iter++ = '\\';

				*dst_iter++ = *src_iter;
			}
			else
			{
				*dst_iter++ = *src_iter;
			}

			escaped = false;
		}
		else if (quote)
		{
			if (*src_iter == quote)
			{
				quote = 0;

				if (raw)
					*dst_iter++ = *src_iter;
			}
			else if (*src_iter == '\\' && quote != '\'')
			{
				escaped = true;

				if (raw)
					*dst_iter++ = *src_iter;
			}
			else
				*dst_iter++ = *src_iter;
		}
		else if (isspace((unsigned char)*src_iter))
		{
			if ((*argv)[argc_count] != NULL)
			{
				argc_count++, dst_iter++;

				if (argc_count == argv_size)
				{
					char **new_argv;

					argv_size += 5;
					new_argv = pkgconf_reallocarray(*argv, argv_size, sizeof(void *));
					if (new_argv == NULL)
					{
						free(*argv);
						free(buf);
						*argv = NULL;
						return -1;
					}

					*argv = new_argv;
				}

				(*argv)[argc_count] = dst_iter;
			}
		}
		else switch(*src_iter)
		{
			case '\\':
				escaped = true;

				if (raw)
					*dst_iter++ = *src_iter;
				break;

			case '\"':
			case '\'':
				quote = *src_iter;

				if (raw)
					*dst_iter++ = *src_iter;
				break;

			default:
				*dst_iter++ = *src_iter;
				break;
		}

		src_iter++;
	}

	if (escaped || quote)
	{
		free(*argv);
		free(buf);
		*argv = NULL;
		return -1;
	}

	if (strlen((*argv)[argc_count]))
	{
		argc_count++;
	}

	*argc = argc_count;
	return 0;
}

/*
 * !doc
 *
 * .. c:function:: int pkgconf_argv_split(const char *src, int *argc, char ***argv)
 *
 *    Splits a string into an argument vector, consuming shell quoting and
 *    backslash escapes the way a shell would.
 *
 *    :param char*   src: The string to split.
 *    :param int*    argc: A pointer to an integer to store the argument count.
 *    :param char*** argv: A pointer to a pointer for an argument vector.
 *    :return: 0 on success, -1 on error.
 *    :rtype: int
 */
int
pkgconf_argv_split(const char *src, int *argc, char ***argv)
{
	return argv_split(src, argc, argv, false);
}

/*
 * !doc
 *
 * .. c:function:: int pkgconf_argv_split_raw(const char *src, int *argc, char ***argv)
 *
 *    Splits a string into an argument vector without interpreting it: the
 *    quoting and escaping says where the arguments end, but is left in the text.
 *
 *    This is for input which still has to be expanded.  Consuming the quoting
 *    here would consume only what the input itself spells, leaving whatever a
 *    variable substitutes into it unconsumed, so it is left for a second pass
 *    over the finished text.
 *
 *    :param char*   src: The string to split.
 *    :param int*    argc: A pointer to an integer to store the argument count.
 *    :param char*** argv: A pointer to a pointer for an argument vector.
 *    :return: 0 on success, -1 on error.
 *    :rtype: int
 */
int
pkgconf_argv_split_raw(const char *src, int *argc, char ***argv)
{
	return argv_split(src, argc, argv, true);
}