OpenTTD: src/string.cpp Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

string.cpp
Go to the documentation of this file.
1 /* $Id: string.cpp 27020 2014-10-15 18:31:37Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD 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, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #include "stdafx.h"
13 #include "debug.h"
14 #include "core/alloc_func.hpp"
15 #include "core/math_func.hpp"
16 #include "string_func.h"
17 #include "string_base.h"
18
19 #include "table/control_codes.h"
20
21 #include <stdarg.h>
22 #include <ctype.h> /* required for tolower() */
23
24 #ifdef _MSC_VER
25 #include <errno.h> // required by vsnprintf implementation for MSVC
26 #endif
27
28 #ifdef WITH_ICU
29 /* Required by strnatcmp. */
30 #include <unicode/ustring.h>
31 #include "language.h"
32 #include "gfx_func.h"
33 #endif /* WITH_ICU */
34
35 /* The function vsnprintf is used internally to perform the required formatting
36 * tasks. As such this one must be allowed, and makes sure it's terminated. */
37 #include "safeguards.h"
38 #undef vsnprintf
39
50 int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap)
51 {
52 ptrdiff_t diff = last - str;
53 if (diff < 0) return 0;
54 return min((int)diff, vsnprintf(str, diff + 1, format, ap));
55 }
56
73 char *strecat(char *dst, const char *src, const char *last)
74 {
75 assert(dst <= last);
76 while (*dst != '\0') {
77 if (dst == last) return dst;
78 dst++;
79 }
80
81 return strecpy(dst, src, last);
82 }
83
84
101 char *strecpy(char *dst, const char *src, const char *last)
102 {
103 assert(dst <= last);
104 while (dst != last && *src != '\0') {
105 *dst++ = *src++;
106 }
107 *dst = '\0';
108
109 if (dst == last && *src != '\0') {
110 #if defined(STRGEN) || defined(SETTINGSGEN)
111 error("String too long for destination buffer");
112 #else /* STRGEN || SETTINGSGEN */
113 DEBUG(misc, 0, "String too long for destination buffer");
114 #endif /* STRGEN || SETTINGSGEN */
115 }
116 return dst;
117 }
118
126 char *stredup(const char *s, const char *last)
127 {
128 size_t len = last == NULL ? strlen(s) : ttd_strnlen(s, last - s + 1);
129 char *tmp = CallocT<char>(len + 1);
130 memcpy(tmp, s, len);
131 return tmp;
132 }
133
139 char *CDECL str_fmt(const char *str, ...)
140 {
141 char buf[4096];
142 va_list va;
143
144 va_start(va, str);
145 int len = vseprintf(buf, lastof(buf), str, va);
146 va_end(va);
147 char *p = MallocT<char>(len + 1);
148 memcpy(p, buf, len + 1);
149 return p;
150 }
151
158 void str_fix_scc_encoded(char *str, const char *last)
159 {
160 while (str <= last && *str != '\0') {
161 size_t len = Utf8EncodedCharLen(*str);
162 if ((len == 0 && str + 4 > last) || str + len > last) break;
163
164 WChar c;
165 len = Utf8Decode(&c, str);
166 if (c == '\0') break;
167
168 if (c == 0xE028 || c == 0xE02A) {
169 c = SCC_ENCODED;
170 }
171 str += Utf8Encode(str, c);
172 }
173 *str = '\0';
174 }
175
176
184 void str_validate(char *str, const char *last, StringValidationSettings settings)
185 {
186 /* Assume the ABSOLUTE WORST to be in str as it comes from the outside. */
187
188 char *dst = str;
189 while (str <= last && *str != '\0') {
190 size_t len = Utf8EncodedCharLen(*str);
191 /* If the character is unknown, i.e. encoded length is 0
192 * we assume worst case for the length check.
193 * The length check is needed to prevent Utf8Decode to read
194 * over the terminating '\0' if that happens to be placed
195 * within the encoding of an UTF8 character. */
196 if ((len == 0 && str + 4 > last) || str + len > last) break;
197
198 WChar c;
199 len = Utf8Decode(&c, str);
200 /* It's possible to encode the string termination character
201 * into a multiple bytes. This prevents those termination
202 * characters to be skipped */
203 if (c == '\0') break;
204
205 if ((IsPrintable(c) && (c < SCC_SPRITE_START || c > SCC_SPRITE_END)) || ((settings & SVS_ALLOW_CONTROL_CODE) != 0 && c == SCC_ENCODED)) {
206 /* Copy the character back. Even if dst is current the same as str
207 * (i.e. no characters have been changed) this is quicker than
208 * moving the pointers ahead by len */
209 do {
210 *dst++ = *str++;
211 } while (--len != 0);
212 } else if ((settings & SVS_ALLOW_NEWLINE) != 0 && c == '\n') {
213 *dst++ = *str++;
214 } else {
215 if ((settings & SVS_ALLOW_NEWLINE) != 0 && c == '\r' && str[1] == '\n') {
216 str += len;
217 continue;
218 }
219 /* Replace the undesirable character with a question mark */
220 str += len;
221 if ((settings & SVS_REPLACE_WITH_QUESTION_MARK) != 0) *dst++ = '?';
222 }
223 }
224
225 *dst = '\0';
226 }
227
233 void ValidateString(const char *str)
234 {
235 /* We know it is '\0' terminated. */
236 str_validate(const_cast<char *>(str), str + strlen(str) + 1);
237 }
238
239
247 bool StrValid(const char *str, const char *last)
248 {
249 /* Assume the ABSOLUTE WORST to be in str as it comes from the outside. */
250
251 while (str <= last && *str != '\0') {
252 size_t len = Utf8EncodedCharLen(*str);
253 /* Encoded length is 0 if the character isn't known.
254 * The length check is needed to prevent Utf8Decode to read
255 * over the terminating '\0' if that happens to be placed
256 * within the encoding of an UTF8 character. */
257 if (len == 0 || str + len > last) return false;
258
259 WChar c;
260 len = Utf8Decode(&c, str);
261 if (!IsPrintable(c) || (c >= SCC_SPRITE_START && c <= SCC_SPRITE_END)) {
262 return false;
263 }
264
265 str += len;
266 }
267
268 return *str == '\0';
269 }
270
272 void str_strip_colours(char *str)
273 {
274 char *dst = str;
275 WChar c;
276 size_t len;
277
278 for (len = Utf8Decode(&c, str); c != '\0'; len = Utf8Decode(&c, str)) {
279 if (c < SCC_BLUE || c > SCC_BLACK) {
280 /* Copy the character back. Even if dst is current the same as str
281 * (i.e. no characters have been changed) this is quicker than
282 * moving the pointers ahead by len */
283 do {
284 *dst++ = *str++;
285 } while (--len != 0);
286 } else {
287 /* Just skip (strip) the colour codes */
288 str += len;
289 }
290 }
291 *dst = '\0';
292 }
293
300 size_t Utf8StringLength(const char *s)
301 {
302 size_t len = 0;
303 const char *t = s;
304 while (Utf8Consume(&t) != 0) len++;
305 return len;
306 }
307
308
320 bool strtolower(char *str)
321 {
322 bool changed = false;
323 for (; *str != '\0'; str++) {
324 char new_str = tolower(*str);
325 changed |= new_str != *str;
326 *str = new_str;
327 }
328 return changed;
329 }
330
338 bool IsValidChar(WChar key, CharSetFilter afilter)
339 {
340 switch (afilter) {
341 case CS_ALPHANUMERAL: return IsPrintable(key);
342 case CS_NUMERAL: return (key >= '0' && key <= '9');
343 case CS_NUMERAL_SPACE: return (key >= '0' && key <= '9') || key == ' ';
344 case CS_ALPHA: return IsPrintable(key) && !(key >= '0' && key <= '9');
345 case CS_HEXADECIMAL: return (key >= '0' && key <= '9') || (key >= 'a' && key <= 'f') || (key >= 'A' && key <= 'F');
346 }
347
348 return false;
349 }
350
351 #ifdef WIN32
352 #ifdef _MSC_VER
353
360 int CDECL vsnprintf(char *str, size_t size, const char *format, va_list ap)
361 {
362 if (size == 0) return 0;
363
364 errno = 0;
365 int ret = _vsnprintf(str, size, format, ap);
366
367 if (ret < 0) {
368 if (errno != ERANGE) {
369 /* There's a formatting error, better get that looked
370 * at properly instead of ignoring it. */
371 NOT_REACHED();
372 }
373 } else if ((size_t)ret < size) {
374 /* The buffer is big enough for the number of
375 * characters stored (excluding null), i.e.
376 * the string has been null-terminated. */
377 return ret;
378 }
379
380 /* The buffer is too small for _vsnprintf to write the
381 * null-terminator at its end and return size. */
382 str[size - 1] = '\0';
383 return (int)size;
384 }
385 #endif /* _MSC_VER */
386
387 #endif /* WIN32 */
388
398 int CDECL seprintf(char *str, const char *last, const char *format, ...)
399 {
400 va_list ap;
401
402 va_start(ap, format);
403 int ret = vseprintf(str, last, format, ap);
404 va_end(ap);
405 return ret;
406 }
407
408
416 char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16])
417 {
418 char *p = buf;
419
420 for (uint i = 0; i < 16; i++) {
421 p += seprintf(p, last, "%02X", md5sum[i]);
422 }
423
424 return p;
425 }
426
427
428 /* UTF-8 handling routines */
429
430
437 size_t Utf8Decode(WChar *c, const char *s)
438 {
439 assert(c != NULL);
440
441 if (!HasBit(s[0], 7)) {
442 /* Single byte character: 0xxxxxxx */
443 *c = s[0];
444 return 1;
445 } else if (GB(s[0], 5, 3) == 6) {
446 if (IsUtf8Part(s[1])) {
447 /* Double byte character: 110xxxxx 10xxxxxx */
448 *c = GB(s[0], 0, 5) << 6 | GB(s[1], 0, 6);
449 if (*c >= 0x80) return 2;
450 }
451 } else if (GB(s[0], 4, 4) == 14) {
452 if (IsUtf8Part(s[1]) && IsUtf8Part(s[2])) {
453 /* Triple byte character: 1110xxxx 10xxxxxx 10xxxxxx */
454 *c = GB(s[0], 0, 4) << 12 | GB(s[1], 0, 6) << 6 | GB(s[2], 0, 6);
455 if (*c >= 0x800) return 3;
456 }
457 } else if (GB(s[0], 3, 5) == 30) {
458 if (IsUtf8Part(s[1]) && IsUtf8Part(s[2]) && IsUtf8Part(s[3])) {
459 /* 4 byte character: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx */
460 *c = GB(s[0], 0, 3) << 18 | GB(s[1], 0, 6) << 12 | GB(s[2], 0, 6) << 6 | GB(s[3], 0, 6);
461 if (*c >= 0x10000 && *c <= 0x10FFFF) return 4;
462 }
463 }
464
465 /* DEBUG(misc, 1, "[utf8] invalid UTF-8 sequence"); */
466 *c = '?';
467 return 1;
468 }
469
470
477 size_t Utf8Encode(char *buf, WChar c)
478 {
479 if (c < 0x80) {
480 *buf = c;
481 return 1;
482 } else if (c < 0x800) {
483 *buf++ = 0xC0 + GB(c, 6, 5);
484 *buf = 0x80 + GB(c, 0, 6);
485 return 2;
486 } else if (c < 0x10000) {
487 *buf++ = 0xE0 + GB(c, 12, 4);
488 *buf++ = 0x80 + GB(c, 6, 6);
489 *buf = 0x80 + GB(c, 0, 6);
490 return 3;
491 } else if (c < 0x110000) {
492 *buf++ = 0xF0 + GB(c, 18, 3);
493 *buf++ = 0x80 + GB(c, 12, 6);
494 *buf++ = 0x80 + GB(c, 6, 6);
495 *buf = 0x80 + GB(c, 0, 6);
496 return 4;
497 }
498
499 /* DEBUG(misc, 1, "[utf8] can't UTF-8 encode value 0x%X", c); */
500 *buf = '?';
501 return 1;
502 }
503
511 size_t Utf8TrimString(char *s, size_t maxlen)
512 {
513 size_t length = 0;
514
515 for (const char *ptr = strchr(s, '\0'); *s != '\0';) {
516 size_t len = Utf8EncodedCharLen(*s);
517 /* Silently ignore invalid UTF8 sequences, our only concern trimming */
518 if (len == 0) len = 1;
519
520 /* Take care when a hard cutoff was made for the string and
521 * the last UTF8 sequence is invalid */
522 if (length + len >= maxlen || (s + len > ptr)) break;
523 s += len;
524 length += len;
525 }
526
527 *s = '\0';
528 return length;
529 }
530
531 #ifdef DEFINE_STRCASESTR
532 char *strcasestr(const char *haystack, const char *needle)
533 {
534 size_t hay_len = strlen(haystack);
535 size_t needle_len = strlen(needle);
536 while (hay_len >= needle_len) {
537 if (strncasecmp(haystack, needle, needle_len) == 0) return const_cast<char *>(haystack);
538
539 haystack++;
540 hay_len--;
541 }
542
543 return NULL;
544 }
545 #endif /* DEFINE_STRCASESTR */
546
555 static const char *SkipGarbage(const char *str)
556 {
557 while (*str != '\0' && (*str < '0' || IsInsideMM(*str, ';', '@' + 1) || IsInsideMM(*str, '[', '`' + 1) || IsInsideMM(*str, '{', '~' + 1))) str++;
558 return str;
559 }
560
569 int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front)
570 {
571 if (ignore_garbage_at_front) {
572 s1 = SkipGarbage(s1);
573 s2 = SkipGarbage(s2);
574 }
575 #ifdef WITH_ICU
576 if (_current_collator != NULL) {
577 UErrorCode status = U_ZERO_ERROR;
578 int result;
579
580 /* We want to use the new faster method for ICU 4.2 and higher. */
581 #if U_ICU_VERSION_MAJOR_NUM > 4 || (U_ICU_VERSION_MAJOR_NUM == 4 && U_ICU_VERSION_MINOR_NUM >= 2)
582 /* The StringPiece parameter gets implicitly constructed from the char *. */
583 result = _current_collator->compareUTF8(s1, s2, status);
584 #else /* The following for 4.0 and lower. */
585 UChar buffer1[DRAW_STRING_BUFFER];
586 u_strFromUTF8Lenient(buffer1, lengthof(buffer1), NULL, s1, -1, &status);
587 UChar buffer2[DRAW_STRING_BUFFER];
588 u_strFromUTF8Lenient(buffer2, lengthof(buffer2), NULL, s2, -1, &status);
589
590 result = _current_collator->compare(buffer1, buffer2, status);
591 #endif /* ICU version check. */
592 if (U_SUCCESS(status)) return result;
593 }
594
595 #endif /* WITH_ICU */
596
597 /* Do a normal comparison if ICU is missing or if we cannot create a collator. */
598 return strcasecmp(s1, s2);
599 }
600
601 #ifdef WITH_ICU
602
603 #include <unicode/utext.h>
604 #include <unicode/brkiter.h>
605
607 class IcuStringIterator : public StringIterator
608 {
609 icu::BreakIterator *char_itr;
610 icu::BreakIterator *word_itr;
611
612 SmallVector<UChar, 32> utf16_str;
613 SmallVector<size_t, 32> utf16_to_utf8;
614
615 public:
616 IcuStringIterator() : char_itr(NULL), word_itr(NULL)
617 {
618 UErrorCode status = U_ZERO_ERROR;
619 this->char_itr = icu::BreakIterator::createCharacterInstance(icu::Locale(_current_language != NULL ? _current_language->isocode : "en"), status);
620 this->word_itr = icu::BreakIterator::createWordInstance(icu::Locale(_current_language != NULL ? _current_language->isocode : "en"), status);
621
622 *this->utf16_str.Append() = '\0';
623 *this->utf16_to_utf8.Append() = 0;
624 }
625
626 virtual ~IcuStringIterator()
627 {
628 delete this->char_itr;
629 delete this->word_itr;
630 }
631
632 virtual void SetString(const char *s)
633 {
634 const char *string_base = s;
635
636 /* Unfortunately current ICU versions only provide rudimentary support
637 * for word break iterators (especially for CJK languages) in combination
638 * with UTF-8 input. As a work around we have to convert the input to
639 * UTF-16 and create a mapping back to UTF-8 character indices. */
640 this->utf16_str.Clear();
641 this->utf16_to_utf8.Clear();
642
643 while (*s != '\0') {
644 size_t idx = s - string_base;
645
646 WChar c = Utf8Consume(&s);
647 if (c < 0x10000) {
648 *this->utf16_str.Append() = (UChar)c;
649 } else {
650 /* Make a surrogate pair. */
651 *this->utf16_str.Append() = (UChar)(0xD800 + ((c - 0x10000) >> 10));
652 *this->utf16_str.Append() = (UChar)(0xDC00 + ((c - 0x10000) & 0x3FF));
653 *this->utf16_to_utf8.Append() = idx;
654 }
655 *this->utf16_to_utf8.Append() = idx;
656 }
657 *this->utf16_str.Append() = '\0';
658 *this->utf16_to_utf8.Append() = s - string_base;
659
660 UText text = UTEXT_INITIALIZER;
661 UErrorCode status = U_ZERO_ERROR;
662 utext_openUChars(&text, this->utf16_str.Begin(), this->utf16_str.Length() - 1, &status);
663 this->char_itr->setText(&text, status);
664 this->word_itr->setText(&text, status);
665 this->char_itr->first();
666 this->word_itr->first();
667 }
668
669 virtual size_t SetCurPosition(size_t pos)
670 {
671 /* Convert incoming position to an UTF-16 string index. */
672 uint utf16_pos = 0;
673 for (uint i = 0; i < this->utf16_to_utf8.Length(); i++) {
674 if (this->utf16_to_utf8[i] == pos) {
675 utf16_pos = i;
676 break;
677 }
678 }
679
680 /* isBoundary has the documented side-effect of setting the current
681 * position to the first valid boundary equal to or greater than
682 * the passed value. */
683 this->char_itr->isBoundary(utf16_pos);
684 return this->utf16_to_utf8[this->char_itr->current()];
685 }
686
687 virtual size_t Next(IterType what)
688 {
689 int32_t pos;
690 switch (what) {
691 case ITER_CHARACTER:
692 pos = this->char_itr->next();
693 break;
694
695 case ITER_WORD:
696 pos = this->word_itr->following(this->char_itr->current());
697 /* The ICU word iterator considers both the start and the end of a word a valid
698 * break point, but we only want word starts. Move to the next location in
699 * case the new position points to whitespace. */
700 while (pos != icu::BreakIterator::DONE &&
701 IsWhitespace(Utf16DecodeChar((const uint16 *)&this->utf16_str[pos]))) {
702 int32_t new_pos = this->word_itr->next();
703 /* Don't set it to DONE if it was valid before. Otherwise we'll return END
704 * even though the iterator wasn't at the end of the string before. */
705 if (new_pos == icu::BreakIterator::DONE) break;
706 pos = new_pos;
707 }
708
709 this->char_itr->isBoundary(pos);
710 break;
711
712 default:
713 NOT_REACHED();
714 }
715
716 return pos == icu::BreakIterator::DONE ? END : this->utf16_to_utf8[pos];
717 }
718
719 virtual size_t Prev(IterType what)
720 {
721 int32_t pos;
722 switch (what) {
723 case ITER_CHARACTER:
724 pos = this->char_itr->previous();
725 break;
726
727 case ITER_WORD:
728 pos = this->word_itr->preceding(this->char_itr->current());
729 /* The ICU word iterator considers both the start and the end of a word a valid
730 * break point, but we only want word starts. Move to the previous location in
731 * case the new position points to whitespace. */
732 while (pos != icu::BreakIterator::DONE &&
733 IsWhitespace(Utf16DecodeChar((const uint16 *)&this->utf16_str[pos]))) {
734 int32_t new_pos = this->word_itr->previous();
735 /* Don't set it to DONE if it was valid before. Otherwise we'll return END
736 * even though the iterator wasn't at the start of the string before. */
737 if (new_pos == icu::BreakIterator::DONE) break;
738 pos = new_pos;
739 }
740
741 this->char_itr->isBoundary(pos);
742 break;
743
744 default:
745 NOT_REACHED();
746 }
747
748 return pos == icu::BreakIterator::DONE ? END : this->utf16_to_utf8[pos];
749 }
750 };
751
752 /* static */ StringIterator *StringIterator::Create()
753 {
754 return new IcuStringIterator();
755 }
756
757 #else
758
760 class DefaultStringIterator : public StringIterator
761 {
762 const char *string;
763 size_t len;
764 size_t cur_pos;
765
766 public:
767 DefaultStringIterator() : string(NULL), len(0), cur_pos(0)
768 {
769 }
770
771 virtual void SetString(const char *s)
772 {
773 this->string = s;
774 this->len = strlen(s);
775 this->cur_pos = 0;
776 }
777
778 virtual size_t SetCurPosition(size_t pos)
779 {
780 assert(this->string != NULL && pos <= this->len);
781 /* Sanitize in case we get a position inside an UTF-8 sequence. */
782 while (pos > 0 && IsUtf8Part(this->string[pos])) pos--;
783 return this->cur_pos = pos;
784 }
785
786 virtual size_t Next(IterType what)
787 {
788 assert(this->string != NULL);
789
790 /* Already at the end? */
791 if (this->cur_pos >= this->len) return END;
792
793 switch (what) {
794 case ITER_CHARACTER: {
795 WChar c;
796 this->cur_pos += Utf8Decode(&c, this->string + this->cur_pos);
797 return this->cur_pos;
798 }
799
800 case ITER_WORD: {
801 WChar c;
802 /* Consume current word. */
803 size_t offs = Utf8Decode(&c, this->string + this->cur_pos);
804 while (this->cur_pos < this->len && !IsWhitespace(c)) {
805 this->cur_pos += offs;
806 offs = Utf8Decode(&c, this->string + this->cur_pos);
807 }
808 /* Consume whitespace to the next word. */
809 while (this->cur_pos < this->len && IsWhitespace(c)) {
810 this->cur_pos += offs;
811 offs = Utf8Decode(&c, this->string + this->cur_pos);
812 }
813
814 return this->cur_pos;
815 }
816
817 default:
818 NOT_REACHED();
819 }
820
821 return END;
822 }
823
824 virtual size_t Prev(IterType what)
825 {
826 assert(this->string != NULL);
827
828 /* Already at the beginning? */
829 if (this->cur_pos == 0) return END;
830
831 switch (what) {
832 case ITER_CHARACTER:
833 return this->cur_pos = Utf8PrevChar(this->string + this->cur_pos) - this->string;
834
835 case ITER_WORD: {
836 const char *s = this->string + this->cur_pos;
837 WChar c;
838 /* Consume preceding whitespace. */
839 do {
840 s = Utf8PrevChar(s);
841 Utf8Decode(&c, s);
842 } while (s > this->string && IsWhitespace(c));
843 /* Consume preceding word. */
844 while (s > this->string && !IsWhitespace(c)) {
845 s = Utf8PrevChar(s);
846 Utf8Decode(&c, s);
847 }
848 /* Move caret back to the beginning of the word. */
849 if (IsWhitespace(c)) Utf8Consume(&s);
850
851 return this->cur_pos = s - this->string;
852 }
853
854 default:
855 NOT_REACHED();
856 }
857
858 return END;
859 }
860 };
861
862 /* static */ StringIterator *StringIterator::Create()
863 {
864 return new DefaultStringIterator();
865 }
866
867 #endif