1 /***************************************************************************
2 copyright : (C) 2002 - 2008 by Scott Wheeler
3 email : wheeler@kde.org
4 ***************************************************************************/
6 /***************************************************************************
7 * This library is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU Lesser General Public License version *
9 * 2.1 as published by the Free Software Foundation. *
11 * This library is distributed in the hope that it will be useful, but *
12 * WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the Free Software *
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
21 * Alternatively, this file is available under the Mozilla Public *
22 * License Version 1.1. You may obtain a copy of the License at *
23 * http://www.mozilla.org/MPL/ *
24 ***************************************************************************/
33 #include "tbytevector.h"
35 // This is a bit ugly to keep writing over and over again.
37 // A rather obscure feature of the C++ spec that I hadn't thought of that makes
38 // working with C libs much more effecient. There's more here:
40 // http://www.informit.com/isapi/product_id~{9C84DAB4-FE6E-49C5-BB0A-FB50331233EA}/content/index.asp
42 #define DATA(x) (&(x->data[0]))
45 static const uint crcTable[256] = {
46 0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9, 0x130476dc, 0x17c56b6b,
47 0x1a864db2, 0x1e475005, 0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, 0x2b4bcb61,
48 0x350c9b64, 0x31cd86d3, 0x3c8ea00a, 0x384fbdbd, 0x4c11db70, 0x48d0c6c7,
49 0x4593e01e, 0x4152fda9, 0x5f15adac, 0x5bd4b01b, 0x569796c2, 0x52568b75,
50 0x6a1936c8, 0x6ed82b7f, 0x639b0da6, 0x675a1011, 0x791d4014, 0x7ddc5da3,
51 0x709f7b7a, 0x745e66cd, 0x9823b6e0, 0x9ce2ab57, 0x91a18d8e, 0x95609039,
52 0x8b27c03c, 0x8fe6dd8b, 0x82a5fb52, 0x8664e6e5, 0xbe2b5b58, 0xbaea46ef,
53 0xb7a96036, 0xb3687d81, 0xad2f2d84, 0xa9ee3033, 0xa4ad16ea, 0xa06c0b5d,
54 0xd4326d90, 0xd0f37027, 0xddb056fe, 0xd9714b49, 0xc7361b4c, 0xc3f706fb,
55 0xceb42022, 0xca753d95, 0xf23a8028, 0xf6fb9d9f, 0xfbb8bb46, 0xff79a6f1,
56 0xe13ef6f4, 0xe5ffeb43, 0xe8bccd9a, 0xec7dd02d, 0x34867077, 0x30476dc0,
57 0x3d044b19, 0x39c556ae, 0x278206ab, 0x23431b1c, 0x2e003dc5, 0x2ac12072,
58 0x128e9dcf, 0x164f8078, 0x1b0ca6a1, 0x1fcdbb16, 0x018aeb13, 0x054bf6a4,
59 0x0808d07d, 0x0cc9cdca, 0x7897ab07, 0x7c56b6b0, 0x71159069, 0x75d48dde,
60 0x6b93dddb, 0x6f52c06c, 0x6211e6b5, 0x66d0fb02, 0x5e9f46bf, 0x5a5e5b08,
61 0x571d7dd1, 0x53dc6066, 0x4d9b3063, 0x495a2dd4, 0x44190b0d, 0x40d816ba,
62 0xaca5c697, 0xa864db20, 0xa527fdf9, 0xa1e6e04e, 0xbfa1b04b, 0xbb60adfc,
63 0xb6238b25, 0xb2e29692, 0x8aad2b2f, 0x8e6c3698, 0x832f1041, 0x87ee0df6,
64 0x99a95df3, 0x9d684044, 0x902b669d, 0x94ea7b2a, 0xe0b41de7, 0xe4750050,
65 0xe9362689, 0xedf73b3e, 0xf3b06b3b, 0xf771768c, 0xfa325055, 0xfef34de2,
66 0xc6bcf05f, 0xc27dede8, 0xcf3ecb31, 0xcbffd686, 0xd5b88683, 0xd1799b34,
67 0xdc3abded, 0xd8fba05a, 0x690ce0ee, 0x6dcdfd59, 0x608edb80, 0x644fc637,
68 0x7a089632, 0x7ec98b85, 0x738aad5c, 0x774bb0eb, 0x4f040d56, 0x4bc510e1,
69 0x46863638, 0x42472b8f, 0x5c007b8a, 0x58c1663d, 0x558240e4, 0x51435d53,
70 0x251d3b9e, 0x21dc2629, 0x2c9f00f0, 0x285e1d47, 0x36194d42, 0x32d850f5,
71 0x3f9b762c, 0x3b5a6b9b, 0x0315d626, 0x07d4cb91, 0x0a97ed48, 0x0e56f0ff,
72 0x1011a0fa, 0x14d0bd4d, 0x19939b94, 0x1d528623, 0xf12f560e, 0xf5ee4bb9,
73 0xf8ad6d60, 0xfc6c70d7, 0xe22b20d2, 0xe6ea3d65, 0xeba91bbc, 0xef68060b,
74 0xd727bbb6, 0xd3e6a601, 0xdea580d8, 0xda649d6f, 0xc423cd6a, 0xc0e2d0dd,
75 0xcda1f604, 0xc960ebb3, 0xbd3e8d7e, 0xb9ff90c9, 0xb4bcb610, 0xb07daba7,
76 0xae3afba2, 0xaafbe615, 0xa7b8c0cc, 0xa379dd7b, 0x9b3660c6, 0x9ff77d71,
77 0x92b45ba8, 0x9675461f, 0x8832161a, 0x8cf30bad, 0x81b02d74, 0x857130c3,
78 0x5d8a9099, 0x594b8d2e, 0x5408abf7, 0x50c9b640, 0x4e8ee645, 0x4a4ffbf2,
79 0x470cdd2b, 0x43cdc09c, 0x7b827d21, 0x7f436096, 0x7200464f, 0x76c15bf8,
80 0x68860bfd, 0x6c47164a, 0x61043093, 0x65c52d24, 0x119b4be9, 0x155a565e,
81 0x18197087, 0x1cd86d30, 0x029f3d35, 0x065e2082, 0x0b1d065b, 0x0fdc1bec,
82 0x3793a651, 0x3352bbe6, 0x3e119d3f, 0x3ad08088, 0x2497d08d, 0x2056cd3a,
83 0x2d15ebe3, 0x29d4f654, 0xc5a92679, 0xc1683bce, 0xcc2b1d17, 0xc8ea00a0,
84 0xd6ad50a5, 0xd26c4d12, 0xdf2f6bcb, 0xdbee767c, 0xe3a1cbc1, 0xe760d676,
85 0xea23f0af, 0xeee2ed18, 0xf0a5bd1d, 0xf464a0aa, 0xf9278673, 0xfde69bc4,
86 0x89b8fd09, 0x8d79e0be, 0x803ac667, 0x84fbdbd0, 0x9abc8bd5, 0x9e7d9662,
87 0x933eb0bb, 0x97ffad0c, 0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668,
88 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4
92 * A templatized KMP find that works both with a ByteVector and a ByteVectorMirror.
95 template <class Vector>
96 int vectorFind(const Vector &v, const Vector &pattern, uint offset, int byteAlign)
98 if(pattern.size() > v.size() || offset > v.size() - 1)
101 // Let's go ahead and special case a pattern of size one since that's common
102 // and easy to make fast.
104 if(pattern.size() == 1) {
106 for(uint i = offset; i < v.size(); i++) {
107 if(v[i] == p && (i - offset) % byteAlign == 0)
113 uchar lastOccurrence[256];
115 for(uint i = 0; i < 256; ++i)
116 lastOccurrence[i] = uchar(pattern.size());
118 for(uint i = 0; i < pattern.size() - 1; ++i)
119 lastOccurrence[uchar(pattern[i])] = uchar(pattern.size() - i - 1);
121 for(uint i = pattern.size() - 1 + offset; i < v.size(); i += lastOccurrence[uchar(v.at(i))]) {
123 int iPattern = pattern.size() - 1;
125 while(iPattern >= 0 && v.at(iBuffer) == pattern[iPattern]) {
130 if(-1 == iPattern && (iBuffer + 1 - offset) % byteAlign == 0)
138 * Wraps the accessors to a ByteVector to make the search algorithm access the
139 * elements in reverse.
142 * \see ByteVector::rfind()
145 class ByteVectorMirror
148 ByteVectorMirror(const ByteVector &source) : v(source) {}
150 char operator[](int index) const
152 return v[v.size() - index - 1];
155 char at(int index) const
157 return v.at(v.size() - index - 1);
160 ByteVectorMirror mid(uint index, uint length = 0xffffffff) const
162 return length == 0xffffffff ? v.mid(0, index) : v.mid(index - length, length);
170 int find(const ByteVectorMirror &pattern, uint offset = 0, int byteAlign = 1) const
172 ByteVectorMirror v(*this);
175 offset = size() - offset - pattern.size();
180 const int pos = vectorFind<ByteVectorMirror>(v, pattern, offset, byteAlign);
182 // If the offset is zero then we need to adjust the location in the search
183 // to be appropriately reversed. If not we need to account for the fact
184 // that the recursive call (called from the above line) has already ajusted
185 // for this but that the normal templatized find above will add the offset
186 // to the returned value.
188 // This is a little confusing at first if you don't first stop to think
189 // through the logic involved in the forward search.
194 return size() - pos - pattern.size();
202 T toNumber(const std::vector<char> &data, bool mostSignificantByteFirst)
206 if(data.size() <= 0) {
207 debug("ByteVectorMirror::toNumber<T>() -- data is empty, returning 0");
211 uint size = sizeof(T);
212 uint last = data.size() > size ? size - 1 : data.size() - 1;
214 for(uint i = 0; i <= last; i++)
215 sum |= (T) uchar(data[i]) << ((mostSignificantByteFirst ? last - i : i) * 8);
221 ByteVector fromNumber(T value, bool mostSignificantByteFirst)
223 int size = sizeof(T);
225 ByteVector v(size, 0);
227 for(int i = 0; i < size; i++)
228 v[i] = uchar(value >> ((mostSignificantByteFirst ? size - 1 - i : i) * 8) & 0xff);
234 using namespace TagLib;
236 class ByteVector::ByteVectorPrivate : public RefCounter
239 ByteVectorPrivate() : RefCounter(), size(0) {}
240 ByteVectorPrivate(const std::vector<char> &v) : RefCounter(), data(v), size(v.size()) {}
241 ByteVectorPrivate(TagLib::uint len, char value) : RefCounter(), data(len, value), size(len) {}
243 std::vector<char> data;
245 // std::vector<T>::size() is very slow, so we'll cache the value
250 ////////////////////////////////////////////////////////////////////////////////
252 ////////////////////////////////////////////////////////////////////////////////
254 ByteVector ByteVector::null;
256 ByteVector ByteVector::fromCString(const char *s, uint length)
260 if(length == 0xffffffff)
263 v.setData(s, length);
268 ByteVector ByteVector::fromUInt(uint value, bool mostSignificantByteFirst)
270 return fromNumber<uint>(value, mostSignificantByteFirst);
273 ByteVector ByteVector::fromShort(short value, bool mostSignificantByteFirst)
275 return fromNumber<short>(value, mostSignificantByteFirst);
278 ByteVector ByteVector::fromLongLong(long long value, bool mostSignificantByteFirst)
280 return fromNumber<long long>(value, mostSignificantByteFirst);
283 ////////////////////////////////////////////////////////////////////////////////
285 ////////////////////////////////////////////////////////////////////////////////
287 ByteVector::ByteVector()
289 d = new ByteVectorPrivate;
292 ByteVector::ByteVector(uint size, char value)
294 d = new ByteVectorPrivate(size, value);
297 ByteVector::ByteVector(const ByteVector &v) : d(v.d)
302 ByteVector::ByteVector(char c)
304 d = new ByteVectorPrivate;
305 d->data.push_back(c);
309 ByteVector::ByteVector(const char *data, uint length)
311 d = new ByteVectorPrivate;
312 setData(data, length);
315 ByteVector::ByteVector(const char *data)
317 d = new ByteVectorPrivate;
321 ByteVector::~ByteVector()
327 ByteVector &ByteVector::setData(const char *data, uint length)
334 ::memcpy(DATA(d), data, length);
339 ByteVector &ByteVector::setData(const char *data)
341 return setData(data, ::strlen(data));
344 char *ByteVector::data()
347 return size() > 0 ? DATA(d) : 0;
350 const char *ByteVector::data() const
352 return size() > 0 ? DATA(d) : 0;
355 ByteVector ByteVector::mid(uint index, uint length) const
364 if(length < 0xffffffff && length + index < size())
365 endIt = d->data.begin() + index + length;
367 endIt = d->data.end();
369 v.d->data.insert(v.d->data.begin(), ConstIterator(d->data.begin() + index), endIt);
370 v.d->size = v.d->data.size();
375 char ByteVector::at(uint index) const
377 return index < size() ? d->data[index] : 0;
380 int ByteVector::find(const ByteVector &pattern, uint offset, int byteAlign) const
382 return vectorFind<ByteVector>(*this, pattern, offset, byteAlign);
385 int ByteVector::rfind(const ByteVector &pattern, uint offset, int byteAlign) const
387 // Ok, this is a little goofy, but pretty cool after it sinks in. Instead of
388 // reversing the find method's Boyer-Moore search algorithm I created a "mirror"
389 // for a ByteVector to reverse the behavior of the accessors.
391 ByteVectorMirror v(*this);
392 ByteVectorMirror p(pattern);
394 return v.find(p, offset, byteAlign);
397 bool ByteVector::containsAt(const ByteVector &pattern, uint offset, uint patternOffset, uint patternLength) const
399 if(pattern.size() < patternLength)
400 patternLength = pattern.size();
402 // do some sanity checking -- all of these things are needed for the search to be valid
404 if(patternLength > size() || offset >= size() || patternOffset >= pattern.size() || patternLength == 0)
407 // loop through looking for a mismatch
409 for(uint i = 0; i < patternLength - patternOffset; i++) {
410 if(at(i + offset) != pattern[i + patternOffset])
417 bool ByteVector::startsWith(const ByteVector &pattern) const
419 return containsAt(pattern, 0);
422 bool ByteVector::endsWith(const ByteVector &pattern) const
424 return containsAt(pattern, size() - pattern.size());
427 ByteVector &ByteVector::replace(const ByteVector &pattern, const ByteVector &with)
429 if(pattern.size() == 0 || pattern.size() > size())
432 const int patternSize = pattern.size();
433 const int withSize = with.size();
435 int offset = find(pattern);
439 const int originalSize = size();
441 if(withSize > patternSize)
442 resize(originalSize + withSize - patternSize);
444 if(patternSize != withSize)
445 ::memcpy(data() + offset + withSize, mid(offset + patternSize).data(), originalSize - offset - patternSize);
447 if(withSize < patternSize)
448 resize(originalSize + withSize - patternSize);
450 ::memcpy(data() + offset, with.data(), withSize);
452 offset = find(pattern, offset + withSize);
458 int ByteVector::endsWithPartialMatch(const ByteVector &pattern) const
460 if(pattern.size() > size())
463 const int startIndex = size() - pattern.size();
465 // try to match the last n-1 bytes from the vector (where n is the pattern
466 // size) -- continue trying to match n-2, n-3...1 bytes
468 for(uint i = 1; i < pattern.size(); i++) {
469 if(containsAt(pattern, startIndex + i, 0, pattern.size() - i))
470 return startIndex + i;
476 ByteVector &ByteVector::append(const ByteVector &v)
479 return *this; // Simply return if appending nothing.
483 uint originalSize = d->size;
484 resize(d->size + v.d->size);
485 ::memcpy(DATA(d) + originalSize, DATA(v.d), v.size());
490 ByteVector &ByteVector::clear()
499 TagLib::uint ByteVector::size() const
504 ByteVector &ByteVector::resize(uint size, char padding)
507 d->data.reserve(size);
508 d->data.insert(d->data.end(), size - d->size, padding);
511 d->data.erase(d->data.begin() + size, d->data.end());
518 ByteVector::Iterator ByteVector::begin()
520 return d->data.begin();
523 ByteVector::ConstIterator ByteVector::begin() const
525 return d->data.begin();
528 ByteVector::Iterator ByteVector::end()
530 return d->data.end();
533 ByteVector::ConstIterator ByteVector::end() const
535 return d->data.end();
538 bool ByteVector::isNull() const
543 bool ByteVector::isEmpty() const
545 return d->data.size() == 0;
548 TagLib::uint ByteVector::checksum() const
551 for(ByteVector::ConstIterator it = begin(); it != end(); ++it)
552 sum = (sum << 8) ^ crcTable[((sum >> 24) & 0xff) ^ uchar(*it)];
556 TagLib::uint ByteVector::toUInt(bool mostSignificantByteFirst) const
558 return toNumber<uint>(d->data, mostSignificantByteFirst);
561 short ByteVector::toShort(bool mostSignificantByteFirst) const
563 return toNumber<unsigned short>(d->data, mostSignificantByteFirst);
566 long long ByteVector::toLongLong(bool mostSignificantByteFirst) const
568 return toNumber<unsigned long long>(d->data, mostSignificantByteFirst);
571 const char &ByteVector::operator[](int index) const
573 return d->data[index];
576 char &ByteVector::operator[](int index)
580 return d->data[index];
583 bool ByteVector::operator==(const ByteVector &v) const
585 if(d->size != v.d->size)
588 return ::memcmp(data(), v.data(), size()) == 0;
591 bool ByteVector::operator!=(const ByteVector &v) const
593 return !operator==(v);
596 bool ByteVector::operator==(const char *s) const
598 if(d->size != ::strlen(s))
601 return ::memcmp(data(), s, d->size) == 0;
604 bool ByteVector::operator!=(const char *s) const
606 return !operator==(s);
609 bool ByteVector::operator<(const ByteVector &v) const
611 int result = ::memcmp(data(), v.data(), d->size < v.d->size ? d->size : v.d->size);
616 return size() < v.size();
619 bool ByteVector::operator>(const ByteVector &v) const
624 ByteVector ByteVector::operator+(const ByteVector &v) const
626 ByteVector sum(*this);
631 ByteVector &ByteVector::operator=(const ByteVector &v)
644 ByteVector &ByteVector::operator=(char c)
646 *this = ByteVector(c);
650 ByteVector &ByteVector::operator=(const char *data)
652 *this = ByteVector(data);
656 ////////////////////////////////////////////////////////////////////////////////
658 ////////////////////////////////////////////////////////////////////////////////
660 void ByteVector::detach()
664 d = new ByteVectorPrivate(d->data);
668 ////////////////////////////////////////////////////////////////////////////////
670 ////////////////////////////////////////////////////////////////////////////////
672 std::ostream &operator<<(std::ostream &s, const ByteVector &v)
674 for(TagLib::uint i = 0; i < v.size(); i++)