mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-24 08:45:10 +03:00
7369133681
Reduce String memory overhead from 24 bytes to 16 bytes by limiting the maximum string length to <64Kbytes (which is larger than heap so no effective problem). Add Small String Optimization, SSO, which instead of allocating pointers to small strings on the heap will store the string in place of the pointer in the class. This should reduce memory fragmentation as Save up to 12 chars (11 + \0) in String itself by using the terminating \0 in the inline string as a flag to identify if this is a SSO or a heap string. Add a host test that verifies that no memory is allocated until a full 11 characters are assigned to a string, as well as checking all intermediate values. No user code changes should be required to work with this optimization.
364 lines
10 KiB
C++
364 lines
10 KiB
C++
/*
|
|
test_string.cpp - String tests
|
|
Copyright © 2018 Earle F. Philhower, III
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
*/
|
|
|
|
#include <catch.hpp>
|
|
#include <string.h>
|
|
#include <WString.h>
|
|
#include <limits.h>
|
|
|
|
TEST_CASE("String::trim", "[core][String]")
|
|
{
|
|
String str;
|
|
str = " abcd123 ";
|
|
str.trim();
|
|
REQUIRE(str == "abcd123");
|
|
}
|
|
|
|
TEST_CASE("String::replace", "[core][String]")
|
|
{
|
|
String str;
|
|
str = "The quick brown fox jumped over the lazy dog.";
|
|
String find = "fox";
|
|
String replace = "vulpes vulpes";
|
|
str.replace(find, replace);
|
|
REQUIRE(str == "The quick brown vulpes vulpes jumped over the lazy dog.");
|
|
}
|
|
|
|
TEST_CASE("String(value, base)", "[core][String]")
|
|
{
|
|
String strbase2(9999,2);
|
|
String strbase8(9999,8);
|
|
String strbase10(9999,10);
|
|
String strbase16(9999,16);
|
|
REQUIRE(strbase2 == "10011100001111");
|
|
REQUIRE(strbase8 == "23417");
|
|
REQUIRE(strbase10 == "9999");
|
|
REQUIRE(strbase16 == "270f");
|
|
String strnegi(-9999);
|
|
String strnegf(-2.123, 3);
|
|
REQUIRE(strnegi == "-9999");
|
|
REQUIRE(strnegf == "-2.123");
|
|
String strbase16l((long)999999,16);
|
|
REQUIRE(strbase16l == "f423f");
|
|
}
|
|
|
|
TEST_CASE("String constructors", "[core][String]")
|
|
{
|
|
String s0('c');
|
|
REQUIRE(s0 == "c");
|
|
String bin((unsigned char)5, 4);
|
|
REQUIRE(bin == "11");
|
|
String ib((unsigned int)999, 16);
|
|
REQUIRE(ib == "3e7");
|
|
String lb((unsigned long)3000000000, 8);
|
|
REQUIRE(lb == "26264057000");
|
|
String sl1((long)-2000000000, 10);
|
|
REQUIRE(sl1 == "-2000000000");
|
|
String s1("abcd");
|
|
String s2(s1);
|
|
REQUIRE(s1 == s2);
|
|
String *s3 = new String("manos");
|
|
s2 = *s3;
|
|
delete s3;
|
|
REQUIRE(s2 == "manos");
|
|
s3 = new String("thisismuchlongerthantheother");
|
|
s2 = s3->c_str();
|
|
delete s3;
|
|
REQUIRE(s2 == "thisismuchlongerthantheother");
|
|
String strf((float)3.14159, 5);
|
|
REQUIRE(strf == "3.14159");
|
|
String ssh(strf + "_" + s1);
|
|
REQUIRE(ssh == "3.14159_abcd");
|
|
String flash = (F("hello from flash"));
|
|
REQUIRE(flash == "hello from flash");
|
|
}
|
|
|
|
TEST_CASE("String concantenation", "[core][String]")
|
|
{
|
|
String str;
|
|
REQUIRE(str.length() == 0);
|
|
str.reserve(1000);
|
|
REQUIRE(str.length() == 0);
|
|
str.reserve(0);
|
|
REQUIRE(str.length() == 0);
|
|
str += 'a';
|
|
str += "bcde";
|
|
str += str;
|
|
str += 987;
|
|
str += (int)INT_MAX;
|
|
str += (int)INT_MIN;
|
|
REQUIRE(str == "abcdeabcde9872147483647-2147483648");
|
|
str += (unsigned char)69;
|
|
REQUIRE(str == "abcdeabcde9872147483647-214748364869");
|
|
str += (unsigned int)1969;
|
|
REQUIRE(str == "abcdeabcde9872147483647-2147483648691969");
|
|
str += (long)-123;
|
|
REQUIRE(str == "abcdeabcde9872147483647-2147483648691969-123");
|
|
str += (unsigned long)321;
|
|
REQUIRE(str == "abcdeabcde9872147483647-2147483648691969-123321");
|
|
str += (float)-1.01;
|
|
REQUIRE(str == "abcdeabcde9872147483647-2147483648691969-123321-1.01");
|
|
str += (double)1.01;
|
|
REQUIRE(str == "abcdeabcde9872147483647-2147483648691969-123321-1.011.01");
|
|
str = "clean";
|
|
REQUIRE(str.concat(str) == true);
|
|
REQUIRE(str == "cleanclean");
|
|
// non-decimal negative #s should be as if they were unsigned
|
|
str = String((int)-100, 16);
|
|
REQUIRE(str == "ffffff9c");
|
|
str = String((long)-101, 16);
|
|
REQUIRE(str == "ffffff9b");
|
|
str = String((int)-100, 10);
|
|
REQUIRE(str == "-100");
|
|
str = String((long)-100, 10);
|
|
REQUIRE(str == "-100");
|
|
}
|
|
|
|
TEST_CASE("String comparison", "[core][String]")
|
|
{
|
|
String alpha("I like fish!");
|
|
REQUIRE(alpha < "I like tacos!");
|
|
REQUIRE(alpha > "I like bacon!");
|
|
REQUIRE(alpha.equalsIgnoreCase("i LiKe FiSh!"));
|
|
REQUIRE(alpha.equalsConstantTime("I like fish!"));
|
|
REQUIRE(alpha != "I like fish?");
|
|
REQUIRE(alpha.startsWith("I like"));
|
|
REQUIRE(!alpha.startsWith("I lick"));
|
|
REQUIRE(alpha.startsWith("fish", 7));
|
|
REQUIRE(!alpha.startsWith("fish?", 7));
|
|
REQUIRE(alpha.endsWith("!"));
|
|
REQUIRE(alpha.endsWith("fish!"));
|
|
REQUIRE(!alpha.endsWith("sh?"));
|
|
}
|
|
|
|
TEST_CASE("String byte access", "[core][String]")
|
|
{
|
|
String s;
|
|
s.reserve(1000);
|
|
s = "Never Eat Soggy Waffles";
|
|
REQUIRE(s[0] == 'N');
|
|
REQUIRE(s[999] == 0);
|
|
s[6] = 'C';
|
|
REQUIRE(!strcmp(s.c_str(), "Never Cat Soggy Waffles"));
|
|
unsigned char buff[4];
|
|
s.getBytes(buff, 4, 6);
|
|
REQUIRE(!memcmp(buff, "Cat", 4));
|
|
s = "Never E";
|
|
memset(buff, 0, 4);
|
|
s.getBytes(buff, 4, 6);
|
|
bool ok = (buff[0] == 'E') && (buff[1] == 0) && (buff[2] == 0) && (buff[3] == 0);
|
|
REQUIRE(ok == true);
|
|
}
|
|
|
|
TEST_CASE("String conversion", "[core][String]")
|
|
{
|
|
String s = "12345";
|
|
long l = s.toInt();
|
|
REQUIRE(l == 12345);
|
|
s = "2147483647";
|
|
l = s.toInt();
|
|
REQUIRE(l == INT_MAX);
|
|
s = "-2147483647";
|
|
l = s.toInt();
|
|
REQUIRE(l == -2147483647);
|
|
s = "-2147483648";
|
|
l = s.toInt();
|
|
REQUIRE(l == INT_MIN);
|
|
s = "3.14159";
|
|
float f = s.toFloat();
|
|
REQUIRE( fabs(f - 3.14159) < 0.0001 );
|
|
}
|
|
|
|
TEST_CASE("String case", "[core][String]")
|
|
{
|
|
String s = "aBc_123";
|
|
s.toLowerCase();
|
|
REQUIRE(s == "abc_123");
|
|
s = "aBc_123";
|
|
s.toUpperCase();
|
|
REQUIRE(s == "ABC_123");
|
|
}
|
|
|
|
TEST_CASE("String nulls", "[core][String]")
|
|
{
|
|
String s;
|
|
REQUIRE(s == "");
|
|
REQUIRE(s.toFloat() == 0);
|
|
REQUIRE(s.toInt() == 0);
|
|
s.trim();
|
|
s.toUpperCase();
|
|
s.toLowerCase();
|
|
s.remove(1,1);
|
|
s.remove(10);
|
|
s.replace("taco", "burrito");
|
|
s.replace('a', 'b');
|
|
REQUIRE(s.substring(10, 20) == "");
|
|
REQUIRE(s.lastIndexOf("tacos", 1) == -1);
|
|
REQUIRE(s.lastIndexOf("tacos") == -1);
|
|
REQUIRE(s.lastIndexOf('t', 0) == -1);
|
|
REQUIRE(s.lastIndexOf('t') == -1);
|
|
REQUIRE(s.indexOf("tacos", 1) == -1);
|
|
REQUIRE(s.indexOf("tacos") == -1);
|
|
REQUIRE(s.indexOf('t', 1) == -1);
|
|
REQUIRE(s.indexOf('t') == -1);
|
|
s.getBytes(NULL, 100, 0);
|
|
s[0] = 't';
|
|
REQUIRE(s == "");
|
|
REQUIRE(s.length() == 0);
|
|
s.setCharAt(1, 't');
|
|
REQUIRE(s.startsWith("abc",0) == false);
|
|
REQUIRE(s.startsWith("def") == false);
|
|
REQUIRE(s.equalsConstantTime("def") == false);
|
|
REQUIRE(s.equalsConstantTime("") == true);
|
|
REQUIRE(s.equalsConstantTime(s) == true);
|
|
REQUIRE(s.equalsIgnoreCase(s) == true);
|
|
REQUIRE(s.equals("def") == false);
|
|
REQUIRE(s.equals("") == true);
|
|
REQUIRE(s.equals(s) == true);
|
|
String t = s;
|
|
REQUIRE(s.equals(t) == true);
|
|
REQUIRE((s <= ""));
|
|
REQUIRE(!(s < ""));
|
|
REQUIRE((s >= ""));
|
|
REQUIRE(!(s > ""));
|
|
s += "abc";
|
|
REQUIRE(s == "abc");
|
|
}
|
|
|
|
TEST_CASE("String sizes near 8b", "[core][String]")
|
|
{
|
|
// Test that proper amount of space allocated (including trailing 0)
|
|
// Need valgrind to verify no out-of-bounds errors, the strcmp()s will
|
|
// access each byte and cause an exception of the space was not properly
|
|
// allocated.
|
|
String s7("123456");
|
|
String s8("1234567");
|
|
String s9("12345678");
|
|
String s15("12345678901234");
|
|
String s16("123456789012345");
|
|
String s17("1234567890123456");
|
|
REQUIRE(!strcmp(s7.c_str(),"123456"));
|
|
REQUIRE(!strcmp(s8.c_str(),"1234567"));
|
|
REQUIRE(!strcmp(s9.c_str(),"12345678"));
|
|
REQUIRE(!strcmp(s15.c_str(),"12345678901234"));
|
|
REQUIRE(!strcmp(s16.c_str(),"123456789012345"));
|
|
REQUIRE(!strcmp(s17.c_str(),"1234567890123456"));
|
|
s7 += '_';
|
|
s8 += '_';
|
|
s9 += '_';
|
|
s15 += '_';
|
|
s16 += '_';
|
|
s17 += '_';
|
|
REQUIRE(!strcmp(s7.c_str(),"123456_"));
|
|
REQUIRE(!strcmp(s8.c_str(),"1234567_"));
|
|
REQUIRE(!strcmp(s9.c_str(),"12345678_"));
|
|
REQUIRE(!strcmp(s15.c_str(),"12345678901234_"));
|
|
REQUIRE(!strcmp(s16.c_str(),"123456789012345_"));
|
|
REQUIRE(!strcmp(s17.c_str(),"1234567890123456_"));
|
|
}
|
|
|
|
TEST_CASE("String SSO works", "[core][String]")
|
|
{
|
|
// This test assumes that SSO_SIZE==8, if that changes the test must as well
|
|
String s;
|
|
s += "0";
|
|
REQUIRE(s == "0");
|
|
REQUIRE(s.length() == 1);
|
|
const char *savesso = s.c_str();
|
|
s += 1;
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "01");
|
|
REQUIRE(s.length() == 2);
|
|
s += "2";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "012");
|
|
REQUIRE(s.length() == 3);
|
|
s += 3;
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "0123");
|
|
REQUIRE(s.length() == 4);
|
|
s += "4";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "01234");
|
|
REQUIRE(s.length() == 5);
|
|
s += "5";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "012345");
|
|
REQUIRE(s.length() == 6);
|
|
s += "6";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "0123456");
|
|
REQUIRE(s.length() == 7);
|
|
s += "7";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "01234567");
|
|
REQUIRE(s.length() == 8);
|
|
s += "8";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "012345678");
|
|
REQUIRE(s.length() == 9);
|
|
s += "9";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "0123456789");
|
|
REQUIRE(s.length() == 10);
|
|
s += "a";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "0123456789a");
|
|
REQUIRE(s.length() == 11);
|
|
if (sizeof(savesso) == 4) {
|
|
s += "b";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789ab");
|
|
REQUIRE(s.length() == 12);
|
|
s += "c";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abc");
|
|
REQUIRE(s.length() == 13);
|
|
} else {
|
|
s += "bcde";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "0123456789abcde");
|
|
REQUIRE(s.length() == 15);
|
|
s += "fghi";
|
|
REQUIRE(s.c_str() == savesso);
|
|
REQUIRE(s == "0123456789abcdefghi");
|
|
REQUIRE(s.length() == 19);
|
|
s += "j";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abcdefghij");
|
|
REQUIRE(s.length() == 20);
|
|
s += "k";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abcdefghijk");
|
|
REQUIRE(s.length() == 21);
|
|
s += "l";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abcdefghijkl");
|
|
REQUIRE(s.length() == 22);
|
|
s += "m";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abcdefghijklm");
|
|
REQUIRE(s.length() == 23);
|
|
s += "nopq";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abcdefghijklmnopq");
|
|
REQUIRE(s.length() == 27);
|
|
s += "rstu";
|
|
REQUIRE(s.c_str() != savesso);
|
|
REQUIRE(s == "0123456789abcdefghijklmnopqrstu");
|
|
REQUIRE(s.length() == 31);
|
|
}
|
|
}
|