util/SplitString: new utility class

Replaces GLib's g_strsplit().
This commit is contained in:
Max Kellermann 2014-12-03 21:39:45 +01:00
parent c1c0fc79bc
commit e69bef3ce3
8 changed files with 185 additions and 34 deletions

View File

@ -375,6 +375,7 @@ libutil_a_SOURCES = \
src/util/NumberParser.hxx \ src/util/NumberParser.hxx \
src/util/StringUtil.cxx src/util/StringUtil.hxx \ src/util/StringUtil.cxx src/util/StringUtil.hxx \
src/util/DivideString.cxx src/util/DivideString.hxx \ src/util/DivideString.cxx src/util/DivideString.hxx \
src/util/SplitString.cxx src/util/SplitString.hxx \
src/util/FormatString.cxx src/util/FormatString.hxx \ src/util/FormatString.cxx src/util/FormatString.hxx \
src/util/Tokenizer.cxx src/util/Tokenizer.hxx \ src/util/Tokenizer.cxx src/util/Tokenizer.hxx \
src/util/TextFile.hxx \ src/util/TextFile.hxx \
@ -2002,6 +2003,7 @@ endif
test_test_util_SOURCES = \ test_test_util_SOURCES = \
test/DivideStringTest.hxx \ test/DivideStringTest.hxx \
test/SplitStringTest.hxx \
test/UriUtilTest.hxx \ test/UriUtilTest.hxx \
test/TestCircularBuffer.hxx \ test/TestCircularBuffer.hxx \
test/test_util.cxx test/test_util.cxx

View File

@ -1237,9 +1237,8 @@ fi
AM_CONDITIONAL(ENABLE_HTTPD_OUTPUT, test x$enable_httpd_output = xyes) AM_CONDITIONAL(ENABLE_HTTPD_OUTPUT, test x$enable_httpd_output = xyes)
dnl ----------------------------------- JACK ---------------------------------- dnl ----------------------------------- JACK ----------------------------------
MPD_ENABLE_AUTO_PKG_DEPENDS(jack, JACK, [jack >= 0.100], MPD_ENABLE_AUTO_PKG(jack, JACK, [jack >= 0.100],
[JACK output plugin], [libjack not found], [], [JACK output plugin], [libjack not found])
[enable_glib], [Cannot use --enable-jack with --disable-glib])
if test x$enable_jack = xyes; then if test x$enable_jack = xyes; then
# check whether jack_set_info_function() is available # check whether jack_set_info_function() is available
@ -1252,9 +1251,8 @@ if test x$enable_jack = xyes; then
fi fi
dnl ---------------------------------- libao ---------------------------------- dnl ---------------------------------- libao ----------------------------------
MPD_ENABLE_AUTO_PKG_DEPENDS(ao, AO, [ao], MPD_ENABLE_AUTO_PKG(ao, AO, [ao],
[libao output plugin], [libao not found], [], [libao output plugin], [libao not found])
[enable_glib], [Cannot use --enable-ao with --disable-glib])
dnl ---------------------------------- OpenAL --------------------------------- dnl ---------------------------------- OpenAL ---------------------------------
AC_SUBST(OPENAL_CFLAGS,"") AC_SUBST(OPENAL_CFLAGS,"")

View File

@ -21,12 +21,12 @@
#include "AoOutputPlugin.hxx" #include "AoOutputPlugin.hxx"
#include "../OutputAPI.hxx" #include "../OutputAPI.hxx"
#include "util/DivideString.hxx" #include "util/DivideString.hxx"
#include "util/SplitString.hxx"
#include "util/Error.hxx" #include "util/Error.hxx"
#include "util/Domain.hxx" #include "util/Domain.hxx"
#include "Log.hxx" #include "Log.hxx"
#include <ao/ao.h> #include <ao/ao.h>
#include <glib.h>
#include <string.h> #include <string.h>
@ -127,22 +127,18 @@ AoOutput::Configure(const config_param &param, Error &error)
value = param.GetBlockValue("options", nullptr); value = param.GetBlockValue("options", nullptr);
if (value != nullptr) { if (value != nullptr) {
gchar **_options = g_strsplit(value, ";", 0); for (const auto &i : SplitString(value, ';')) {
const DivideString ss(i.c_str(), '=');
for (unsigned i = 0; _options[i] != nullptr; ++i) {
const DivideString ss(_options[i], '=');
if (!ss.IsDefined()) { if (!ss.IsDefined()) {
error.Format(ao_output_domain, error.Format(ao_output_domain,
"problems parsing options \"%s\"", "problems parsing options \"%s\"",
_options[i]); i.c_str());
return false; return false;
} }
ao_append_option(&options, ss.GetFirst(), ss.GetSecond()); ao_append_option(&options, ss.GetFirst(), ss.GetSecond());
} }
g_strfreev(_options);
} }
return true; return true;

View File

@ -21,13 +21,13 @@
#include "JackOutputPlugin.hxx" #include "JackOutputPlugin.hxx"
#include "../OutputAPI.hxx" #include "../OutputAPI.hxx"
#include "config/ConfigError.hxx" #include "config/ConfigError.hxx"
#include "util/SplitString.hxx"
#include "util/Error.hxx" #include "util/Error.hxx"
#include "util/Domain.hxx" #include "util/Domain.hxx"
#include "Log.hxx" #include "Log.hxx"
#include <assert.h> #include <assert.h>
#include <glib.h>
#include <jack/jack.h> #include <jack/jack.h>
#include <jack/types.h> #include <jack/types.h>
#include <jack/ringbuffer.h> #include <jack/ringbuffer.h>
@ -56,10 +56,10 @@ struct JackOutput {
/* configuration */ /* configuration */
char *source_ports[MAX_PORTS]; std::string source_ports[MAX_PORTS];
unsigned num_source_ports; unsigned num_source_ports;
char *destination_ports[MAX_PORTS]; std::string destination_ports[MAX_PORTS];
unsigned num_destination_ports; unsigned num_destination_ports;
size_t ringbuffer_size; size_t ringbuffer_size;
@ -261,13 +261,13 @@ mpd_jack_connect(JackOutput *jd, Error &error)
for (unsigned i = 0; i < jd->num_source_ports; ++i) { for (unsigned i = 0; i < jd->num_source_ports; ++i) {
jd->ports[i] = jack_port_register(jd->client, jd->ports[i] = jack_port_register(jd->client,
jd->source_ports[i], jd->source_ports[i].c_str(),
JACK_DEFAULT_AUDIO_TYPE, JACK_DEFAULT_AUDIO_TYPE,
JackPortIsOutput, 0); JackPortIsOutput, 0);
if (jd->ports[i] == nullptr) { if (jd->ports[i] == nullptr) {
error.Format(jack_output_domain, error.Format(jack_output_domain,
"Cannot register output port \"%s\"", "Cannot register output port \"%s\"",
jd->source_ports[i]); jd->source_ports[i].c_str());
mpd_jack_disconnect(jd); mpd_jack_disconnect(jd);
return false; return false;
} }
@ -283,23 +283,19 @@ mpd_jack_test_default_device(void)
} }
static unsigned static unsigned
parse_port_list(const char *source, char **dest, Error &error) parse_port_list(const char *source, std::string dest[], Error &error)
{ {
char **list = g_strsplit(source, ",", 0);
unsigned n = 0; unsigned n = 0;
for (auto &&i : SplitString(source, ',')) {
for (n = 0; list[n] != nullptr; ++n) {
if (n >= MAX_PORTS) { if (n >= MAX_PORTS) {
error.Set(config_domain, error.Set(config_domain,
"too many port names"); "too many port names");
return 0; return 0;
} }
dest[n] = list[n]; dest[n++] = std::move(i);
} }
g_free(list);
if (n == 0) { if (n == 0) {
error.Format(config_domain, error.Format(config_domain,
"at least one port name expected"); "at least one port name expected");
@ -392,12 +388,6 @@ mpd_jack_finish(AudioOutput *ao)
{ {
JackOutput *jd = (JackOutput *)ao; JackOutput *jd = (JackOutput *)ao;
for (unsigned i = 0; i < jd->num_source_ports; ++i)
g_free(jd->source_ports[i]);
for (unsigned i = 0; i < jd->num_destination_ports; ++i)
g_free(jd->destination_ports[i]);
delete jd; delete jd;
} }
@ -505,8 +495,8 @@ mpd_jack_start(JackOutput *jd, Error &error)
/* use the configured output ports */ /* use the configured output ports */
num_destination_ports = jd->num_destination_ports; num_destination_ports = jd->num_destination_ports;
memcpy(destination_ports, jd->destination_ports, for (unsigned i = 0; i < num_destination_ports; ++i)
num_destination_ports * sizeof(*destination_ports)); destination_ports[i] = jd->destination_ports[i].c_str();
jports = nullptr; jports = nullptr;
} }

59
src/util/SplitString.cxx Normal file
View File

@ -0,0 +1,59 @@
/*
* Copyright (C) 2003-2014 The Music Player Daemon Project
* http://www.musicpd.org
*
* 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 of the License, 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "SplitString.hxx"
#include "StringUtil.hxx"
#include <string.h>
std::forward_list<std::string>
SplitString(const char *s, char separator, bool strip)
{
if (strip)
s = StripLeft(s);
std::forward_list<std::string> list;
if (*s == 0)
return list;
auto i = list.before_begin();
while (true) {
const char *next = strchr(s, separator);
if (next == nullptr)
break;
const char *end = next++;
if (strip)
end = StripRight(s, end);
i = list.emplace_after(i, s, end);
s = next;
if (strip)
s = StripLeft(s);
}
const char *end = s + strlen(s);
if (strip)
end = StripRight(s, end);
list.emplace_after(i, s, end);
return list;
}

39
src/util/SplitString.hxx Normal file
View File

@ -0,0 +1,39 @@
/*
* Copyright (C) 2003-2014 The Music Player Daemon Project
* http://www.musicpd.org
*
* 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 of the License, 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_SPLIT_STRING_HXX
#define MPD_SPLIT_STRING_HXX
#include <forward_list>
#include <string>
/**
* Split a string at a certain separator character into sub strings
* and returns a list of these.
*
* Two consecutive separator characters result in an empty string in
* the list.
*
* An empty input string, as a special case, results in an empty list
* (and not a list with an empty string).
*/
std::forward_list<std::string>
SplitString(const char *s, char separator, bool strip=true);
#endif

65
test/SplitStringTest.hxx Normal file
View File

@ -0,0 +1,65 @@
/*
* Unit tests for src/util/
*/
#include "check.h"
#include "util/SplitString.hxx"
#include "util/Macros.hxx"
#include <cppunit/TestFixture.h>
#include <cppunit/extensions/HelperMacros.h>
#include <string.h>
class SplitStringTest : public CppUnit::TestFixture {
CPPUNIT_TEST_SUITE(SplitStringTest);
CPPUNIT_TEST(TestBasic);
CPPUNIT_TEST(TestStrip);
CPPUNIT_TEST(TestNoStrip);
CPPUNIT_TEST(TestEmpty);
CPPUNIT_TEST_SUITE_END();
public:
void TestBasic() {
constexpr char input[] = "foo.bar";
const char *const output[] = { "foo", "bar" };
size_t i = 0;
for (auto p : SplitString(input, '.')) {
CPPUNIT_ASSERT(i < ARRAY_SIZE(output));
CPPUNIT_ASSERT(p == output[i]);
++i;
}
CPPUNIT_ASSERT_EQUAL(ARRAY_SIZE(output), i);
}
void TestStrip() {
constexpr char input[] = " foo\t.\r\nbar\r\n2";
const char *const output[] = { "foo", "bar\r\n2" };
size_t i = 0;
for (auto p : SplitString(input, '.')) {
CPPUNIT_ASSERT(i < ARRAY_SIZE(output));
CPPUNIT_ASSERT(p == output[i]);
++i;
}
CPPUNIT_ASSERT_EQUAL(ARRAY_SIZE(output), i);
}
void TestNoStrip() {
constexpr char input[] = " foo\t.\r\nbar\r\n2";
const char *const output[] = { " foo\t", "\r\nbar\r\n2" };
size_t i = 0;
for (auto p : SplitString(input, '.', false)) {
CPPUNIT_ASSERT(i < ARRAY_SIZE(output));
CPPUNIT_ASSERT(p == output[i]);
++i;
}
CPPUNIT_ASSERT_EQUAL(ARRAY_SIZE(output), i);
}
void TestEmpty() {
CPPUNIT_ASSERT(SplitString("", '.').empty());
}
};

View File

@ -4,6 +4,7 @@
#include "config.h" #include "config.h"
#include "DivideStringTest.hxx" #include "DivideStringTest.hxx"
#include "SplitStringTest.hxx"
#include "UriUtilTest.hxx" #include "UriUtilTest.hxx"
#include "TestCircularBuffer.hxx" #include "TestCircularBuffer.hxx"
@ -15,6 +16,7 @@
#include <stdlib.h> #include <stdlib.h>
CPPUNIT_TEST_SUITE_REGISTRATION(DivideStringTest); CPPUNIT_TEST_SUITE_REGISTRATION(DivideStringTest);
CPPUNIT_TEST_SUITE_REGISTRATION(SplitStringTest);
CPPUNIT_TEST_SUITE_REGISTRATION(UriUtilTest); CPPUNIT_TEST_SUITE_REGISTRATION(UriUtilTest);
CPPUNIT_TEST_SUITE_REGISTRATION(TestCircularBuffer); CPPUNIT_TEST_SUITE_REGISTRATION(TestCircularBuffer);