Loading...
Searching...
No Matches
juce_StringPairArray.cpp
/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2022 - Raw Material Software Limited
JUCE is an open source library subject to commercial or open-source
licensing.
The code included in this file is provided under the terms of the ISC license
http://www.isc.org/downloads/software-support-policy/isc-license. 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.
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
namespace juce
{
StringPairArray::StringPairArray (bool shouldIgnoreCase) : ignoreCase (shouldIgnoreCase)
{
}
StringPairArray::StringPairArray (const StringPairArray& other)
: keys (other.keys),
values (other.values),
ignoreCase (other.ignoreCase)
{
}
StringPairArray& StringPairArray::operator= (const StringPairArray& other)
{
keys = other.keys;
values = other.values;
return *this;
}
bool StringPairArray::operator== (const StringPairArray& other) const
{
auto num = size();
if (num != other.size())
return false;
for (int i = 0; i < num; ++i)
{
if (keys[i] == other.keys[i]) // optimise for the case where the keys are in the same order
{
if (values[i] != other.values[i])
return false;
}
else
{
// if we encounter keys that are in a different order, search remaining items by brute force..
for (int j = i; j < num; ++j)
{
auto otherIndex = other.keys.indexOf (keys[j], other.ignoreCase);
if (otherIndex < 0 || values[j] != other.values[otherIndex])
return false;
}
return true;
}
}
return true;
}
bool StringPairArray::operator!= (const StringPairArray& other) const
{
return ! operator== (other);
}
const String& StringPairArray::operator[] (StringRef key) const
{
return values[keys.indexOf (key, ignoreCase)];
}
String StringPairArray::getValue (StringRef key, const String& defaultReturnValue) const
{
auto i = keys.indexOf (key, ignoreCase);
if (i >= 0)
return values[i];
return defaultReturnValue;
}
bool StringPairArray::containsKey (StringRef key) const noexcept
{
return keys.contains (key, ignoreCase);
}
void StringPairArray::set (const String& key, const String& value)
{
auto i = keys.indexOf (key, ignoreCase);
if (i >= 0)
{
values.set (i, value);
}
else
{
keys.add (key);
values.add (value);
}
}
void StringPairArray::addArray (const StringPairArray& other)
{
for (int i = 0; i < other.size(); ++i)
set (other.keys[i], other.values[i]);
}
void StringPairArray::clear()
{
keys.clear();
values.clear();
}
void StringPairArray::remove (StringRef key)
{
remove (keys.indexOf (key, ignoreCase));
}
void StringPairArray::remove (int index)
{
keys.remove (index);
values.remove (index);
}
void StringPairArray::setIgnoresCase (bool shouldIgnoreCase)
{
ignoreCase = shouldIgnoreCase;
}
bool StringPairArray::getIgnoresCase() const noexcept
{
return ignoreCase;
}
String StringPairArray::getDescription() const
{
String s;
for (int i = 0; i < keys.size(); ++i)
{
s << keys[i] << " = " << values[i];
if (i < keys.size())
s << ", ";
}
return s;
}
void StringPairArray::minimiseStorageOverheads()
{
keys.minimiseStorageOverheads();
values.minimiseStorageOverheads();
}
template <typename Map>
void StringPairArray::addMapImpl (const Map& toAdd)
{
// If we just called `set` for each item in `toAdd`, that would
// perform badly when adding to large StringPairArrays, as `set`
// has to loop through the whole container looking for matching keys.
// Instead, we use a temporary map to give us better lookup performance.
std::map<String, int> contents;
const auto normaliseKey = [this] (const String& key)
{
return ignoreCase ? key.toLowerCase() : key;
};
for (auto i = 0; i != size(); ++i)
contents.emplace (normaliseKey (getAllKeys().getReference (i)), i);
for (const auto& pair : toAdd)
{
const auto key = normaliseKey (pair.first);
const auto it = contents.find (key);
if (it != contents.cend())
{
values.getReference (it->second) = pair.second;
}
else
{
contents.emplace (key, static_cast<int> (contents.size()));
keys.add (pair.first);
values.add (pair.second);
}
}
}
void StringPairArray::addUnorderedMap (const std::unordered_map<String, String>& toAdd) { addMapImpl (toAdd); }
void StringPairArray::addMap (const std::map<String, String>& toAdd) { addMapImpl (toAdd); }
//==============================================================================
//==============================================================================
#if JUCE_UNIT_TESTS
static String operator""_S (const char* chars, size_t)
{
return String { chars };
}
class StringPairArrayTests final : public UnitTest
{
public:
StringPairArrayTests()
: UnitTest ("StringPairArray", UnitTestCategories::text)
{}
void runTest() override
{
beginTest ("addMap respects case sensitivity of StringPairArray");
{
StringPairArray insensitive { true };
insensitive.addMap ({ { "duplicate", "a" },
{ "Duplicate", "b" } });
expect (insensitive.size() == 1);
expectEquals (insensitive["DUPLICATE"], "a"_S);
StringPairArray sensitive { false };
sensitive.addMap ({ { "duplicate", "a"_S },
{ "Duplicate", "b"_S } });
expect (sensitive.size() == 2);
expectEquals (sensitive["duplicate"], "a"_S);
expectEquals (sensitive["Duplicate"], "b"_S);
expectEquals (sensitive["DUPLICATE"], ""_S);
}
beginTest ("addMap overwrites existing pairs");
{
StringPairArray insensitive { true };
insensitive.set ("key", "value");
insensitive.addMap ({ { "KEY", "VALUE" } });
expect (insensitive.size() == 1);
expectEquals (insensitive.getAllKeys()[0], "key"_S);
expectEquals (insensitive.getAllValues()[0], "VALUE"_S);
StringPairArray sensitive { false };
sensitive.set ("key", "value");
sensitive.addMap ({ { "KEY", "VALUE" },
{ "key", "another value" } });
expect (sensitive.size() == 2);
expect (sensitive.getAllKeys() == StringArray { "key", "KEY" });
expect (sensitive.getAllValues() == StringArray { "another value", "VALUE" });
}
beginTest ("addMap doesn't change the order of existing keys");
{
StringPairArray array;
array.set ("a", "a");
array.set ("z", "z");
array.set ("b", "b");
array.set ("y", "y");
array.set ("c", "c");
array.addMap ({ { "B", "B" },
{ "0", "0" },
{ "Z", "Z" } });
expect (array.getAllKeys() == StringArray { "a", "z", "b", "y", "c", "0" });
expect (array.getAllValues() == StringArray { "a", "Z", "B", "y", "c", "0" });
}
beginTest ("addMap has equivalent behaviour to addArray");
{
StringPairArray initial;
initial.set ("aaa", "aaa");
initial.set ("zzz", "zzz");
initial.set ("bbb", "bbb");
auto withAddMap = initial;
withAddMap.addMap ({ { "ZZZ", "ZZZ" },
{ "ddd", "ddd" } });
auto withAddArray = initial;
withAddArray.addArray ([]
{
StringPairArray toAdd;
toAdd.set ("ZZZ", "ZZZ");
toAdd.set ("ddd", "ddd");
return toAdd;
}());
expect (withAddMap == withAddArray);
}
}
};
static StringPairArrayTests stringPairArrayTests;
#endif
} // namespace juce
juce::StringArray::getReference
String & getReference(int index) noexcept
Definition juce_StringArray.cpp:126
juce::StringPairArray::setIgnoresCase
void setIgnoresCase(bool shouldIgnoreCase)
Definition juce_StringPairArray.cpp:139
juce::StringPairArray::getValue
String getValue(StringRef, const String &defaultReturnValue) const
Definition juce_StringPairArray.cpp:86
juce::StringPairArray::operator=
StringPairArray & operator=(const StringPairArray &other)
Definition juce_StringPairArray.cpp:37
juce::StringPairArray::containsKey
bool containsKey(StringRef key) const noexcept
Definition juce_StringPairArray.cpp:96
juce::StringPairArray::set
void set(const String &key, const String &value)
Definition juce_StringPairArray.cpp:101
juce::StringPairArray::clear
void clear()
Definition juce_StringPairArray.cpp:122
juce::StringPairArray::getDescription
String getDescription() const
Definition juce_StringPairArray.cpp:149
juce::StringPairArray::remove
void remove(StringRef key)
Definition juce_StringPairArray.cpp:128
juce::StringPairArray::StringPairArray
StringPairArray(bool ignoreCaseWhenComparingKeys=true)
Definition juce_StringPairArray.cpp:26
juce::StringPairArray::getIgnoresCase
bool getIgnoresCase() const noexcept
Definition juce_StringPairArray.cpp:144
juce::StringPairArray::operator[]
const String & operator[](StringRef key) const
Definition juce_StringPairArray.cpp:81
juce::StringPairArray::operator!=
bool operator!=(const StringPairArray &other) const
Definition juce_StringPairArray.cpp:76
juce::StringPairArray::minimiseStorageOverheads
void minimiseStorageOverheads()
Definition juce_StringPairArray.cpp:164
juce::StringPairArray::addMap
void addMap(const std::map< String, String > &mapToAdd)
Definition juce_StringPairArray.cpp:206
juce::StringPairArray::addArray
void addArray(const StringPairArray &other)
Definition juce_StringPairArray.cpp:116
juce::StringPairArray::addUnorderedMap
void addUnorderedMap(const std::unordered_map< String, String > &mapToAdd)
Definition juce_StringPairArray.cpp:205
juce::StringPairArray::size
int size() const noexcept
Definition juce_StringPairArray.h:93
juce::StringPairArray::operator==
bool operator==(const StringPairArray &other) const
Definition juce_StringPairArray.cpp:44
juce::StringPairArray::getAllKeys
const StringArray & getAllKeys() const noexcept
Definition juce_StringPairArray.h:87
juce::StringRef
Definition juce_StringRef.h:62
juce::String
Definition juce_String.h:53
juce::String::indexOf
int indexOf(StringRef textToLookFor) const noexcept
Definition juce_String.cpp:931
juce::UnitTest
Definition juce_UnitTest.h:70