From patchwork Tue Nov 27 17:24:21 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Weimer X-Patchwork-Id: 30319 Received: (qmail 31094 invoked by alias); 27 Nov 2018 17:25:06 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Delivered-To: mailing list libc-alpha@sourceware.org Received: (qmail 30738 invoked by uid 89); 27 Nov 2018 17:24:45 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-26.9 required=5.0 tests=BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, KAM_SHORT, SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=001, Quote, letters X-HELO: mx1.redhat.com From: Florian Weimer To: libc-alpha@sourceware.org Subject: [PATCH] support: Implement support_quote_string Date: Tue, 27 Nov 2018 18:24:21 +0100 Message-ID: <87a7lufn7e.fsf@oldenburg.str.redhat.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.3 (gnu/linux) MIME-Version: 1.0 2018-11-27 Florian Weimer * support/support.h (support_quote_string): Declare. * support/support_quote_string.c: New file. * support/tst-support_quote_string.c: Likewise. * support/Makefile (libsupport-routines): Add support_quote_string. (tests): Add tst-support_quote_string. Reviewed-by: Jonathan Nieder diff --git a/support/Makefile b/support/Makefile index 2b663fbbfa..a2536980d1 100644 --- a/support/Makefile +++ b/support/Makefile @@ -58,6 +58,7 @@ libsupport-routines = \ support_openpty \ support_paths \ support_quote_blob \ + support_quote_string \ support_record_failure \ support_run_diff \ support_shared_allocate \ @@ -196,6 +197,7 @@ tests = \ tst-support_capture_subprocess \ tst-support_format_dns_packet \ tst-support_quote_blob \ + tst-support_quote_string \ tst-support_record_failure \ tst-test_compare \ tst-test_compare_blob \ diff --git a/support/support.h b/support/support.h index 9418cd11ef..835e7173eb 100644 --- a/support/support.h +++ b/support/support.h @@ -69,6 +69,11 @@ void support_write_file_string (const char *path, const char *contents); the result). */ char *support_quote_blob (const void *blob, size_t length); +/* Quote the contents of the at STR, in such a way that the result + string can be included in a C literal (in single/double quotes, + without putting the quotes into the result). */ +char *support_quote_string (const char *str); + /* Returns non-zero if the file descriptor is a regular file on a file system which supports holes (that is, seeking and writing does not allocate storage for the range of zeros). FD must refer to a diff --git a/support/support_quote_string.c b/support/support_quote_string.c new file mode 100644 index 0000000000..d324371b13 --- /dev/null +++ b/support/support_quote_string.c @@ -0,0 +1,26 @@ +/* Quote a string so that it can be used in C literals. + Copyright (C) 2018 Free Software Foundation, Inc. + This file is part of the GNU C Library. + + The GNU C Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + The GNU C Library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the GNU C Library; if not, see + . */ + +#include +#include + +char * +support_quote_string (const char *str) +{ + return support_quote_blob (str, strlen (str)); +} diff --git a/support/tst-support_quote_string.c b/support/tst-support_quote_string.c new file mode 100644 index 0000000000..3c004759b7 --- /dev/null +++ b/support/tst-support_quote_string.c @@ -0,0 +1,60 @@ +/* Test the support_quote_string function. + Copyright (C) 2018 Free Software Foundation, Inc. + This file is part of the GNU C Library. + + The GNU C Library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + The GNU C Library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with the GNU C Library; if not, see + . */ + +#include +#include +#include +#include + +static int +do_test (void) +{ + char *p = support_quote_string (""); + TEST_COMPARE (strlen (p), 0); + free (p); + p = support_quote_string ("X"); + TEST_COMPARE (strlen (p), 1); + TEST_COMPARE (p[0], 'X'); + free (p); + + /* Check escaping of backslash-escaped characters, and lack of + escaping for other shell meta-characters. */ + p = support_quote_string ("$()*?`@[]{}~\'\"X"); + TEST_COMPARE (strcmp (p, "$()*?`@[]{}~\\'\\\"X"), 0); + free (p); + + /* Check lack of escaping for letters and digits. */ +#define LETTERS_AND_DIGTS \ + "abcdefghijklmnopqrstuvwxyz" \ + "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \ + "0123456789" + p = support_quote_string (LETTERS_AND_DIGTS "@"); + TEST_COMPARE (strcmp (p, LETTERS_AND_DIGTS "@"), 0); + free (p); + + /* Check escaping of control characters and other non-printable + characters. */ + p = support_quote_string ("\r\n\t\a\b\f\v\1\177\200\377@"); + TEST_COMPARE (strcmp (p, "\\r\\n\\t\\a\\b\\f\\v\\001" + "\\177\\200\\377@"), 0); + free (p); + + return 0; +} + +#include