src/support/lstrings.cpp

   1 /**
   2  * \file lstrings.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "support/lstrings.h"
  15
  16 #include "support/convert.h"
  17 #include "support/qstring_helpers.h"
  18 #include "support/textutils.h"
  19
  20 #include <boost/tokenizer.hpp>
  21 #include <boost/assert.hpp>
  22
  23 #include <algorithm>
  24
  25 using namespace std;
  26
  27 namespace lyx {
  28
  29 // Using this allows us to have docstring default arguments in headers
  30 // without #include "support/docstring" there.
  31 docstring const & empty_docstring()
  32 {
  33         static docstring s;
  34         return s;
  35 }
  36
  37 // Using this allows us to have string default arguments in headers
  38 // without #include <string>
  39 string const & empty_string()
  40 {
  41         static string s;
  42         return s;
  43 }
  44
  45 /**
  46  * Convert a QChar into a UCS4 character.
  47  * This is a hack (it does only make sense for the common part of the UCS4
  48  * and UTF16 encodings) and should not be used.
  49  * This does only exist because of performance reasons (a real conversion
  50  * using iconv is too slow on windows).
  51  */
  52 static inline char_type qchar_to_ucs4(QChar const & qchar)
  53 {
  54         BOOST_ASSERT(is_utf16(static_cast<char_type>(qchar.unicode())));
  55         return static_cast<char_type>(qchar.unicode());
  56 }
  57
  58
  59 /**
  60  * Convert a UCS4 character into a QChar.
  61  * This is a hack (it does only make sense for the common part of the UCS4
  62  * and UTF16 encodings) and should not be used.
  63  * This does only exist because of performance reasons (a real conversion
  64  * using iconv is too slow on windows).
  65  */
  66 static inline QChar const ucs4_to_qchar(char_type const ucs4)
  67 {
  68         BOOST_ASSERT(is_utf16(ucs4));
  69         return QChar(static_cast<unsigned short>(ucs4));
  70 }
  71
  72
  73 namespace {
  74         /// Maximum valid UCS4 code point
  75         char_type const ucs4_max = 0x10ffff;
  76 }
  77
  78
  79 bool isLetterChar(char_type c)
  80 {
  81         if (!is_utf16(c)) {
  82                 if (c > ucs4_max)
  83                         // outside the UCS4 range
  84                         return false;
  85                 // assume that all non-utf16 characters are letters
  86                 return true;
  87         }
  88         return ucs4_to_qchar(c).isLetter();
  89 }
  90
  91
  92 bool isAlphaASCII(char_type c)
  93 {
  94         return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  95 }
  96
  97
  98 bool isPrintable(char_type c)
  99 {
 100         if (!is_utf16(c)) {
 101                 if (c > ucs4_max)
 102                         // outside the UCS4 range
 103                         return false;
 104                 // assume that all non-utf16 characters are printable
 105                 return true;
 106         }
 107         return ucs4_to_qchar(c).isPrint();
 108 }
 109
 110
 111 bool isPrintableNonspace(char_type c)
 112 {
 113         if (!is_utf16(c)) {
 114                 if (c > ucs4_max)
 115                         // outside the UCS4 range
 116                         return false;
 117                 // assume that all non-utf16 characters are printable and
 118                 // no space
 119                 return true;
 120         }
 121         QChar const qc = ucs4_to_qchar(c);
 122         return qc.isPrint() && !qc.isSpace();
 123 }
 124
 125
 126 bool isSpace(char_type c)
 127 {
 128         if (!is_utf16(c)) {
 129                 // assume that no non-utf16 character is a space
 130                 // c outside the UCS4 range is catched as well
 131                 return false;
 132         }
 133         QChar const qc = ucs4_to_qchar(c);
 134         return qc.isSpace();
 135 }
 136
 137
 138 bool isDigit(char_type c)
 139 {
 140         if (!is_utf16(c))
 141                 // assume that no non-utf16 character is a digit
 142                 // c outside the UCS4 range is catched as well
 143                 return false;
 144         return ucs4_to_qchar(c).isDigit();
 145 }
 146
 147
 148 bool isDigitASCII(char_type c)
 149 {
 150         return '0' <= c && c <= '9';
 151 }
 152
 153 namespace support {
 154
 155 int compare_no_case(docstring const & s, docstring const & s2)
 156 {
 157         docstring::const_iterator p = s.begin();
 158         docstring::const_iterator p2 = s2.begin();
 159
 160         while (p != s.end() && p2 != s2.end()) {
 161                 char_type const lc1 = lowercase(*p);
 162                 char_type const lc2 = lowercase(*p2);
 163                 if (lc1 != lc2)
 164                         return (lc1 < lc2) ? -1 : 1;
 165                 ++p;
 166                 ++p2;
 167         }
 168
 169         if (s.size() == s2.size())
 170                 return 0;
 171         if (s.size() < s2.size())
 172                 return -1;
 173         return 1;
 174 }
 175
 176
 177 namespace {
 178
 179 template<typename Char>
 180 Char ascii_tolower(Char c) {
 181         if (c >= 'A' && c <= 'Z')
 182                 return c - 'A' + 'a';
 183         return c;
 184 }
 185
 186 }
 187
 188
 189 int compare_ascii_no_case(string const & s, string const & s2)
 190 {
 191         string::const_iterator p = s.begin();
 192         string::const_iterator p2 = s2.begin();
 193
 194         while (p != s.end() && p2 != s2.end()) {
 195                 int const lc1 = ascii_tolower(*p);
 196                 int const lc2 = ascii_tolower(*p2);
 197                 if (lc1 != lc2)
 198                         return (lc1 < lc2) ? -1 : 1;
 199                 ++p;
 200                 ++p2;
 201         }
 202
 203         if (s.size() == s2.size())
 204                 return 0;
 205         if (s.size() < s2.size())
 206                 return -1;
 207         return 1;
 208 }
 209
 210
 211 int compare_ascii_no_case(docstring const & s, docstring const & s2)
 212 {
 213         docstring::const_iterator p = s.begin();
 214         docstring::const_iterator p2 = s2.begin();
 215
 216         while (p != s.end() && p2 != s2.end()) {
 217                 char_type const lc1 = ascii_tolower(*p);
 218                 char_type const lc2 = ascii_tolower(*p2);
 219                 if (lc1 != lc2)
 220                         return (lc1 < lc2) ? -1 : 1;
 221                 ++p;
 222                 ++p2;
 223         }
 224
 225         if (s.size() == s2.size())
 226                 return 0;
 227         if (s.size() < s2.size())
 228                 return -1;
 229         return 1;
 230 }
 231
 232
 233 bool isStrInt(string const & str)
 234 {
 235         if (str.empty())
 236                 return false;
 237
 238         // Remove leading and trailing white space chars.
 239         string const tmpstr = trim(str);
 240         if (tmpstr.empty())
 241                 return false;
 242
 243         string::const_iterator cit = tmpstr.begin();
 244         if ((*cit) == '-')
 245                 ++cit;
 246
 247         string::const_iterator end = tmpstr.end();
 248         for (; cit != end; ++cit)
 249                 if (!isdigit((*cit)))
 250                         return false;
 251
 252         return true;
 253 }
 254
 255
 256 bool isStrUnsignedInt(string const & str)
 257 {
 258         if (str.empty())
 259                 return false;
 260
 261         // Remove leading and trailing white space chars.
 262         string const tmpstr = trim(str);
 263         if (tmpstr.empty())
 264                 return false;
 265
 266         string::const_iterator cit = tmpstr.begin();
 267         string::const_iterator end = tmpstr.end();
 268         for (; cit != end; ++cit)
 269                 if (!isdigit((*cit)))
 270                         return false;
 271
 272         return true;
 273 }
 274
 275
 276 bool isStrDbl(string const & str)
 277 {
 278         if (str.empty())
 279                 return false;
 280
 281         // Remove leading and trailing white space chars.
 282         string const tmpstr = trim(str);
 283         if (tmpstr.empty())
 284                 return false;
 285         //      if (tmpstr.count('.') > 1) return false;
 286
 287         string::const_iterator cit = tmpstr.begin();
 288         bool found_dot = false;
 289         if (*cit == '-')
 290                 ++cit;
 291         string::const_iterator end = tmpstr.end();
 292         for (; cit != end; ++cit) {
 293                 if (!isdigit(*cit) && *cit != '.')
 294                         return false;
 295                 if ('.' == (*cit)) {
 296                         if (found_dot)
 297                                 return false;
 298                         found_dot = true;
 299                 }
 300         }
 301         return true;
 302 }
 303
 304
 305 static bool isHexChar(char_type c)
 306 {
 307         return c == '0' ||
 308                 c == '1' ||
 309                 c == '2' ||
 310                 c == '3' ||
 311                 c == '4' ||
 312                 c == '5' ||
 313                 c == '6' ||
 314                 c == '7' ||
 315                 c == '8' ||
 316                 c == '9' ||
 317                 c == 'a' || c == 'A' ||
 318                 c == 'b' || c == 'B' ||
 319                 c == 'c' || c == 'C' ||
 320                 c == 'd' || c == 'D' ||
 321                 c == 'e' || c == 'E' ||
 322                 c == 'f' || c == 'F';
 323 }
 324
 325
 326 bool isHex(docstring const & str)
 327 {
 328         int index = 0;
 329
 330         if (str.length() > 2 && str[0] == '0' &&
 331             (str[1] == 'x' || str[1] == 'X'))
 332                 index = 2;
 333
 334         int const len = str.length();
 335
 336         for (; index < len; ++index) {
 337                 if (!isHexChar(str[index]))
 338                         return false;
 339         }
 340         return true;
 341 }
 342
 343
 344 int hexToInt(docstring const & str)
 345 {
 346         string s = to_ascii(str);
 347         int h;
 348         sscanf(s.c_str(), "%x", &h);
 349         return h;
 350 }
 351
 352
 353 bool isAscii(docstring const & str)
 354 {
 355         int const len = str.length();
 356         for (int i = 0; i < len; ++i)
 357                 if (str[i] >= 0x80)
 358                         return false;
 359         return true;
 360 }
 361
 362
 363 bool isAscii(string const & str)
 364 {
 365         int const len = str.length();
 366         for (int i = 0; i < len; ++i)
 367                 if (static_cast<unsigned char>(str[i]) >= 0x80)
 368                         return false;
 369         return true;
 370 }
 371
 372
 373 char lowercase(char c)
 374 {
 375         BOOST_ASSERT(static_cast<unsigned char>(c) < 0x80);
 376         return char(tolower(c));
 377 }
 378
 379
 380 char uppercase(char c)
 381 {
 382         BOOST_ASSERT(static_cast<unsigned char>(c) < 0x80);
 383         return char(toupper(c));
 384 }
 385
 386
 387 char_type lowercase(char_type c)
 388 {
 389         if (!is_utf16(c))
 390                 // We don't know how to lowercase a non-utf16 char
 391                 return c;
 392         return qchar_to_ucs4(ucs4_to_qchar(c).toLower());
 393 }
 394
 395
 396 char_type uppercase(char_type c)
 397 {
 398         if (!is_utf16(c))
 399                 // We don't know how to uppercase a non-utf16 char
 400                 return c;
 401         return qchar_to_ucs4(ucs4_to_qchar(c).toUpper());
 402 }
 403
 404
 405 namespace {
 406
 407 // since we cannot use tolower and toupper directly in the
 408 // calls to transform yet, we use these helper clases. (Lgb)
 409
 410 struct local_lowercase {
 411         char_type operator()(char_type c) const {
 412                 if (!is_utf16(c))
 413                         // We don't know how to lowercase a non-utf16 char
 414                         return c;
 415                 return qchar_to_ucs4(ucs4_to_qchar(c).toLower());
 416         }
 417 };
 418
 419 struct local_uppercase {
 420         char_type operator()(char_type c) const {
 421                 if (!is_utf16(c))
 422                         // We don't know how to uppercase a non-utf16 char
 423                         return c;
 424                 return qchar_to_ucs4(ucs4_to_qchar(c).toUpper());
 425         }
 426 };
 427
 428 template<typename Char> struct local_ascii_lowercase {
 429         Char operator()(Char c) const { return ascii_tolower(c); }
 430 };
 431
 432 } // end of anon namespace
 433
 434 docstring const lowercase(docstring const & a)
 435 {
 436         docstring tmp(a);
 437         transform(tmp.begin(), tmp.end(), tmp.begin(), local_lowercase());
 438         return tmp;
 439 }
 440
 441
 442 docstring const uppercase(docstring const & a)
 443 {
 444         docstring tmp(a);
 445         transform(tmp.begin(), tmp.end(), tmp.begin(), local_uppercase());
 446         return tmp;
 447 }
 448
 449
 450 string const ascii_lowercase(string const & a)
 451 {
 452         string tmp(a);
 453         transform(tmp.begin(), tmp.end(), tmp.begin(),
 454                   local_ascii_lowercase<char>());
 455         return tmp;
 456 }
 457
 458
 459 docstring const ascii_lowercase(docstring const & a)
 460 {
 461         docstring tmp(a);
 462         transform(tmp.begin(), tmp.end(), tmp.begin(),
 463                   local_ascii_lowercase<char_type>());
 464         return tmp;
 465 }
 466
 467
 468 bool prefixIs(docstring const & a, char_type c)
 469 {
 470         if (a.empty())
 471                 return false;
 472         return a[0] == c;
 473 }
 474
 475
 476 bool prefixIs(string const & a, string const & pre)
 477 {
 478         size_t const prelen = pre.length();
 479         size_t const alen = a.length();
 480         return prelen <= alen && !a.empty() && a.compare(0, prelen, pre) == 0;
 481 }
 482
 483
 484 bool prefixIs(docstring const & a, docstring const & pre)
 485 {
 486         size_t const prelen = pre.length();
 487         size_t const alen = a.length();
 488         return prelen <= alen && !a.empty() && a.compare(0, prelen, pre) == 0;
 489 }
 490
 491
 492 bool suffixIs(string const & a, char c)
 493 {
 494         if (a.empty()) return false;
 495         return a[a.length() - 1] == c;
 496 }
 497
 498
 499 bool suffixIs(docstring const & a, char_type c)
 500 {
 501         if (a.empty())
 502                 return false;
 503         return a[a.length() - 1] == c;
 504 }
 505
 506
 507 bool suffixIs(string const & a, string const & suf)
 508 {
 509         size_t const suflen = suf.length();
 510         size_t const alen = a.length();
 511         return suflen <= alen && a.compare(alen - suflen, suflen, suf) == 0;
 512 }
 513
 514
 515 bool containsOnly(string const & s, string const & cset)
 516 {
 517         return s.find_first_not_of(cset) == string::npos;
 518 }
 519
 520
 521 // ale970405+lasgoutt-970425
 522 // rewritten to use new string (Lgb)
 523 string const token(string const & a, char delim, int n)
 524 {
 525         if (a.empty())
 526                 return string();
 527
 528         size_t k = 0;
 529         size_t i = 0;
 530
 531         // Find delimiter or end of string
 532         for (; n--;) {
 533                 if ((i = a.find(delim, i)) == string::npos)
 534                         break;
 535                 else
 536                         ++i; // step delim
 537         }
 538
 539         // i is now the n'th delim (or string::npos)
 540         if (i == string::npos)
 541                 return string();
 542
 543         k = a.find(delim, i);
 544         // k is now the n'th + 1 delim (or string::npos)
 545
 546         return a.substr(i, k - i);
 547 }
 548
 549
 550 docstring const token(docstring const & a, char_type delim, int n)
 551 {
 552         if (a.empty())
 553                 return docstring();
 554
 555         size_t k = 0;
 556         size_t i = 0;
 557
 558         // Find delimiter or end of string
 559         for (; n--;) {
 560                 if ((i = a.find(delim, i)) == docstring::npos)
 561                         break;
 562                 else
 563                         ++i; // step delim
 564         }
 565
 566         // i is now the n'th delim (or string::npos)
 567         if (i == docstring::npos)
 568                 return docstring();
 569
 570         k = a.find(delim, i);
 571         // k is now the n'th + 1 delim (or string::npos)
 572
 573         return a.substr(i, k - i);
 574 }
 575
 576
 577 // this could probably be faster and/or cleaner, but it seems to work (JMarc)
 578 // rewritten to use new string (Lgb)
 579 int tokenPos(string const & a, char delim, string const & tok)
 580 {
 581         int i = 0;
 582         string str = a;
 583         string tmptok;
 584
 585         while (!str.empty()) {
 586                 str = split(str, tmptok, delim);
 587                 if (tok == tmptok)
 588                         return i;
 589                 ++i;
 590         }
 591         return -1;
 592 }
 593
 594
 595 namespace {
 596
 597 /// Substitute all \a oldchar with \a newchar
 598 template<typename Ch> inline
 599 basic_string<Ch> const subst_char(basic_string<Ch> const & a,
 600                 Ch oldchar, Ch newchar)
 601 {
 602         typedef basic_string<Ch> String;
 603         String tmp(a);
 604         typename String::iterator lit = tmp.begin();
 605         typename String::iterator end = tmp.end();
 606         for (; lit != end; ++lit)
 607                 if ((*lit) == oldchar)
 608                         (*lit) = newchar;
 609         return tmp;
 610 }
 611
 612 /// Substitute all \a oldchar with \a newchar
 613 docstring const subst_char(docstring const & a,
 614         docstring::value_type oldchar, docstring::value_type newchar)
 615 {
 616         docstring tmp(a);
 617         docstring::iterator lit = tmp.begin();
 618         docstring::iterator end = tmp.end();
 619         for (; lit != end; ++lit)
 620                 if ((*lit) == oldchar)
 621                         (*lit) = newchar;
 622         return tmp;
 623 }
 624
 625
 626 /// substitutes all instances of \a oldstr with \a newstr
 627 template<typename String> inline
 628 String const subst_string(String const & a,
 629                 String const & oldstr, String const & newstr)
 630 {
 631         BOOST_ASSERT(!oldstr.empty());
 632         String lstr = a;
 633         size_t i = 0;
 634         size_t const olen = oldstr.length();
 635         while ((i = lstr.find(oldstr, i)) != string::npos) {
 636                 lstr.replace(i, olen, newstr);
 637                 i += newstr.length(); // We need to be sure that we dont
 638                 // use the same i over and over again.
 639         }
 640         return lstr;
 641 }
 642
 643 docstring const subst_string(docstring const & a,
 644                 docstring const & oldstr, docstring const & newstr)
 645 {
 646         BOOST_ASSERT(!oldstr.empty());
 647         docstring lstr = a;
 648         size_t i = 0;
 649         size_t const olen = oldstr.length();
 650         while ((i = lstr.find(oldstr, i)) != string::npos) {
 651                 lstr.replace(i, olen, newstr);
 652                 i += newstr.length(); // We need to be sure that we dont
 653                 // use the same i over and over again.
 654         }
 655         return lstr;
 656 }
 657
 658 }
 659
 660
 661 string const subst(string const & a, char oldchar, char newchar)
 662 {
 663         return subst_char(a, oldchar, newchar);
 664 }
 665
 666
 667 docstring const subst(docstring const & a,
 668                 char_type oldchar, char_type newchar)
 669 {
 670         return subst_char(a, oldchar, newchar);
 671 }
 672
 673
 674 string const subst(string const & a,
 675                 string const & oldstr, string const & newstr)
 676 {
 677         return subst_string(a, oldstr, newstr);
 678 }
 679
 680
 681 docstring const subst(docstring const & a,
 682                 docstring const & oldstr, docstring const & newstr)
 683 {
 684         return subst_string(a, oldstr, newstr);
 685 }
 686
 687
 688 docstring const trim(docstring const & a, char const * p)
 689 {
 690         BOOST_ASSERT(p);
 691
 692         if (a.empty() || !*p)
 693                 return a;
 694
 695         docstring s = from_ascii(p);
 696         size_t r = a.find_last_not_of(s);
 697         size_t l = a.find_first_not_of(s);
 698
 699         // Is this the minimal test? (lgb)
 700         if (r == docstring::npos && l == docstring::npos)
 701                 return docstring();
 702
 703         return a.substr(l, r - l + 1);
 704 }
 705
 706
 707 string const trim(string const & a, char const * p)
 708 {
 709         BOOST_ASSERT(p);
 710
 711         if (a.empty() || !*p)
 712                 return a;
 713
 714         size_t r = a.find_last_not_of(p);
 715         size_t l = a.find_first_not_of(p);
 716
 717         // Is this the minimal test? (lgb)
 718         if (r == string::npos && l == string::npos)
 719                 return string();
 720
 721         return a.substr(l, r - l + 1);
 722 }
 723
 724
 725 string const rtrim(string const & a, char const * p)
 726 {
 727         BOOST_ASSERT(p);
 728
 729         if (a.empty() || !*p)
 730                 return a;
 731
 732         size_t r = a.find_last_not_of(p);
 733
 734         // Is this test really needed? (Lgb)
 735         if (r == string::npos)
 736                 return string();
 737
 738         return a.substr(0, r + 1);
 739 }
 740
 741
 742 docstring const rtrim(docstring const & a, char const * p)
 743 {
 744         BOOST_ASSERT(p);
 745
 746         if (a.empty() || !*p)
 747                 return a;
 748
 749         size_t r = a.find_last_not_of(from_ascii(p));
 750
 751         // Is this test really needed? (Lgb)
 752         if (r == docstring::npos)
 753                 return docstring();
 754
 755         return a.substr(0, r + 1);
 756 }
 757
 758
 759 string const ltrim(string const & a, char const * p)
 760 {
 761         BOOST_ASSERT(p);
 762         if (a.empty() || !*p)
 763                 return a;
 764         size_t l = a.find_first_not_of(p);
 765         if (l == string::npos)
 766                 return string();
 767         return a.substr(l, string::npos);
 768 }
 769
 770
 771 docstring const ltrim(docstring const & a, char const * p)
 772 {
 773         BOOST_ASSERT(p);
 774         if (a.empty() || !*p)
 775                 return a;
 776         size_t l = a.find_first_not_of(from_ascii(p));
 777         if (l == docstring::npos)
 778                 return docstring();
 779         return a.substr(l, docstring::npos);
 780 }
 781
 782 namespace {
 783
 784 template<typename String, typename Char> inline
 785 String const doSplit(String const & a, String & piece, Char delim)
 786 {
 787         String tmp;
 788         size_t i = a.find(delim);
 789         if (i == a.length() - 1) {
 790                 piece = a.substr(0, i);
 791         } else if (i != String::npos) {
 792                 piece = a.substr(0, i);
 793                 tmp = a.substr(i + 1);
 794         } else if (i == 0) {
 795                 piece.erase();
 796                 tmp = a.substr(i + 1);
 797         } else {
 798                 piece = a;
 799         }
 800         return tmp;
 801 }
 802
 803 template<typename Char> inline
 804 docstring const doSplit(docstring const & a, docstring & piece, Char delim)
 805 {
 806         docstring tmp;
 807         size_t i = a.find(delim);
 808         if (i == a.length() - 1) {
 809                 piece = a.substr(0, i);
 810         } else if (i != docstring::npos) {
 811                 piece = a.substr(0, i);
 812                 tmp = a.substr(i + 1);
 813         } else if (i == 0) {
 814                 piece.erase();
 815                 tmp = a.substr(i + 1);
 816         } else {
 817                 piece = a;
 818         }
 819         return tmp;
 820 }
 821
 822 } // anon
 823
 824
 825 string const split(string const & a, string & piece, char delim)
 826 {
 827         return doSplit(a, piece, delim);
 828 }
 829
 830
 831 docstring const split(docstring const & a, docstring & piece, char_type delim)
 832 {
 833         return doSplit(a, piece, delim);
 834 }
 835
 836
 837 string const split(string const & a, char delim)
 838 {
 839         string tmp;
 840         size_t i = a.find(delim);
 841         if (i != string::npos) // found delim
 842                 tmp = a.substr(i + 1);
 843         return tmp;
 844 }
 845
 846
 847 // ale970521
 848 string const rsplit(string const & a, string & piece, char delim)
 849 {
 850         string tmp;
 851         size_t i = a.rfind(delim);
 852         if (i != string::npos) { // delimiter was found
 853                 piece = a.substr(0, i);
 854                 tmp = a.substr(i + 1);
 855         } else { // delimiter was not found
 856                 piece.erase();
 857         }
 858         return tmp;
 859 }
 860
 861
 862 docstring const escape(docstring const & lab)
 863 {
 864         char_type hexdigit[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 865                                    '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
 866         docstring enc;
 867         for (size_t i = 0; i < lab.length(); ++i) {
 868                 char_type c = lab[i];
 869                 if (c >= 128 || c == '=' || c == '%') {
 870                         // Although char_type is a 32 bit type we know that
 871                         // UCS4 occupies only 21 bits, so we don't need to
 872                         // encode bigger values. Test for 2^24 because we
 873                         // can encode that with the 6 hex digits that are
 874                         // needed for 21 bits anyway.
 875                         BOOST_ASSERT(c < (1 << 24));
 876                         enc += '=';
 877                         enc += hexdigit[(c>>20) & 15];
 878                         enc += hexdigit[(c>>16) & 15];
 879                         enc += hexdigit[(c>>12) & 15];
 880                         enc += hexdigit[(c>> 8) & 15];
 881                         enc += hexdigit[(c>> 4) & 15];
 882                         enc += hexdigit[ c      & 15];
 883                 } else {
 884                         enc += c;
 885                 }
 886         }
 887         return enc;
 888 }
 889
 890
 891 namespace {
 892
 893 template<typename String> vector<String> const
 894 getVectorFromStringT(String const & str, String const & delim)
 895 {
 896 // Lars would like this code to go, but for now his replacement (below)
 897 // doesn't fullfil the same function. I have, therefore, reactivated the
 898 // old code for now. Angus 11 Nov 2002.
 899 #if 1
 900         vector<String> vec;
 901         if (str.empty())
 902                 return vec;
 903         String keys = rtrim(str);
 904         while (true) {
 905                 size_t const idx = keys.find(delim);
 906                 if (idx == String::npos) {
 907                         vec.push_back(ltrim(keys));
 908                         break;
 909                 }
 910                 String const key = trim(keys.substr(0, idx));
 911                 if (!key.empty())
 912                         vec.push_back(key);
 913                 size_t const start = idx + delim.size();
 914                 keys = keys.substr(start);
 915         }
 916         return vec;
 917 #else
 918         typedef boost::char_separator<typename String::value_type> Separator;
 919         typedef boost::tokenizer<Separator, typename String::const_iterator, String> Tokenizer;
 920         Separator sep(delim.c_str());
 921         Tokenizer tokens(str, sep);
 922         return vector<String>(tokens.begin(), tokens.end());
 923 #endif
 924 }
 925
 926 } // namespace anon
 927
 928
 929 vector<string> const getVectorFromString(string const & str,
 930                                          string const & delim)
 931 {
 932         return getVectorFromStringT<string>(str, delim);
 933 }
 934
 935
 936 vector<docstring> const getVectorFromString(docstring const & str,
 937                                             docstring const & delim)
 938 {
 939         return getVectorFromStringT<docstring>(str, delim);
 940 }
 941
 942
 943 // the same vice versa
 944 string const getStringFromVector(vector<string> const & vec,
 945                                  string const & delim)
 946 {
 947         string str;
 948         int i = 0;
 949         for (vector<string>::const_iterator it = vec.begin();
 950              it != vec.end(); ++it) {
 951                 string item = trim(*it);
 952                 if (item.empty())
 953                         continue;
 954                 if (i++ > 0)
 955                         str += delim;
 956                 str += item;
 957         }
 958         return str;
 959 }
 960
 961
 962 int findToken(char const * const str[], string const & search_token)
 963 {
 964         int i = 0;
 965
 966         while (str[i][0] && str[i] != search_token)
 967                 ++i;
 968         if (!str[i][0])
 969                 i = -1;
 970         return i;
 971 }
 972
 973
 974 docstring const externalLineEnding(docstring const & str)
 975 {
 976 #if defined(__APPLE__)
 977         // The MAC clipboard uses \r for lineendings, and we use \n
 978         return subst(str, '\n', '\r');
 979 #elif defined (_WIN32) || (defined (__CYGWIN__) && defined (X_DISPLAY_MISSING))
 980         // Windows clipboard uses \r\n for lineendings, and we use \n
 981         return subst(str, from_ascii("\n"), from_ascii("\r\n"));
 982 #else
 983         return str;
 984 #endif
 985 }
 986
 987
 988 docstring const internalLineEnding(docstring const & str)
 989 {
 990         docstring const s = subst(str, from_ascii("\r\n"), from_ascii("\n"));
 991         return subst(s, '\r', '\n');
 992 }
 993
 994
 995 template<>
 996 docstring bformat(docstring const & fmt, int arg1)
 997 {
 998         BOOST_ASSERT(contains(fmt, from_ascii("%1$d")));
 999         docstring const str = subst(fmt, from_ascii("%1$d"), convert<docstring>(arg1));
1000         return subst(str, from_ascii("%%"), from_ascii("%"));
1001 }
1002
1003
1004 template<>
1005 docstring bformat(docstring const & fmt, long arg1)
1006 {
1007         BOOST_ASSERT(contains(fmt, from_ascii("%1$d")));
1008         docstring const str = subst(fmt, from_ascii("%1$d"), convert<docstring>(arg1));
1009         return subst(str, from_ascii("%%"), from_ascii("%"));
1010 }
1011
1012
1013 template<>
1014 docstring bformat(docstring const & fmt, unsigned int arg1)
1015 {
1016         BOOST_ASSERT(contains(fmt, from_ascii("%1$d")));
1017         docstring const str = subst(fmt, from_ascii("%1$d"), convert<docstring>(arg1));
1018         return subst(str, from_ascii("%%"), from_ascii("%"));
1019 }
1020
1021
1022 template<>
1023 docstring bformat(docstring const & fmt, docstring arg1)
1024 {
1025         BOOST_ASSERT(contains(fmt, from_ascii("%1$s")));
1026         docstring const str = subst(fmt, from_ascii("%1$s"), arg1);
1027         return subst(str, from_ascii("%%"), from_ascii("%"));
1028 }
1029
1030
1031 template<>
1032 docstring bformat(docstring const & fmt, char * arg1)
1033 {
1034         BOOST_ASSERT(contains(fmt, from_ascii("%1$s")));
1035         docstring const str = subst(fmt, from_ascii("%1$s"), from_ascii(arg1));
1036         return subst(str, from_ascii("%%"), from_ascii("%"));
1037 }
1038
1039
1040 template<>
1041 docstring bformat(docstring const & fmt, docstring arg1, docstring arg2)
1042 {
1043         BOOST_ASSERT(contains(fmt, from_ascii("%1$s")));
1044         BOOST_ASSERT(contains(fmt, from_ascii("%2$s")));
1045         docstring str = subst(fmt, from_ascii("%1$s"), arg1);
1046         str = subst(str, from_ascii("%2$s"), arg2);
1047         return subst(str, from_ascii("%%"), from_ascii("%"));
1048 }
1049
1050
1051 template<>
1052 docstring bformat(docstring const & fmt, char const * arg1, docstring arg2)
1053 {
1054         BOOST_ASSERT(contains(fmt, from_ascii("%1$s")));
1055         BOOST_ASSERT(contains(fmt, from_ascii("%2$s")));
1056         docstring str = subst(fmt, from_ascii("%1$s"), from_ascii(arg1));
1057         str = subst(fmt, from_ascii("%2$s"), arg2);
1058         return subst(str, from_ascii("%%"), from_ascii("%"));
1059 }
1060
1061
1062 template<>
1063 docstring bformat(docstring const & fmt, int arg1, int arg2)
1064 {
1065         BOOST_ASSERT(contains(fmt, from_ascii("%1$d")));
1066         BOOST_ASSERT(contains(fmt, from_ascii("%2$d")));
1067         docstring str = subst(fmt, from_ascii("%1$d"), convert<docstring>(arg1));
1068         str = subst(str, from_ascii("%2$d"), convert<docstring>(arg2));
1069         return subst(str, from_ascii("%%"), from_ascii("%"));
1070 }
1071
1072
1073 template<>
1074 docstring bformat(docstring const & fmt, docstring arg1, docstring arg2, docstring arg3)
1075 {
1076         BOOST_ASSERT(contains(fmt, from_ascii("%1$s")));
1077         BOOST_ASSERT(contains(fmt, from_ascii("%2$s")));
1078         BOOST_ASSERT(contains(fmt, from_ascii("%3$s")));
1079         docstring str = subst(fmt, from_ascii("%1$s"), arg1);
1080         str = subst(str, from_ascii("%2$s"), arg2);
1081         str = subst(str, from_ascii("%3$s"), arg3);
1082         return subst(str, from_ascii("%%"), from_ascii("%"));
1083 }
1084
1085
1086 template<>
1087 docstring bformat(docstring const & fmt,
1088                docstring arg1, docstring arg2, docstring arg3, docstring arg4)
1089 {
1090         BOOST_ASSERT(contains(fmt, from_ascii("%1$s")));
1091         BOOST_ASSERT(contains(fmt, from_ascii("%2$s")));
1092         BOOST_ASSERT(contains(fmt, from_ascii("%3$s")));
1093         BOOST_ASSERT(contains(fmt, from_ascii("%4$s")));
1094         docstring str = subst(fmt, from_ascii("%1$s"), arg1);
1095         str = subst(str, from_ascii("%2$s"), arg2);
1096         str = subst(str, from_ascii("%3$s"), arg3);
1097         str = subst(str, from_ascii("%4$s"), arg4);
1098         return subst(str, from_ascii("%%"), from_ascii("%"));
1099 }
1100
1101 } // namespace support
1102 } // namespace lyx