src/support/lstrings.C

   1 /**
   2  * \file lstrings.C
   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 "lstrings.h"
  15 #include "support/std_sstream.h"
  16 #include "debug.h"
  17 #include "lyxlib.h"
  18 #include "tostr.h"
  19
  20 #include <boost/tokenizer.hpp>
  21 #include <boost/assert.hpp>
  22 #include <boost/format.hpp>
  23
  24 #include <algorithm>
  25
  26 #include <cctype>
  27 #include <cstdlib>
  28
  29 using std::transform;
  30 using std::string;
  31 using std::vector;
  32
  33 #ifndef CXX_GLOBAL_CSTD
  34 using std::atof;
  35 using std::isdigit;
  36 using std::tolower;
  37 using std::toupper;
  38 #endif
  39
  40
  41 namespace lyx {
  42 namespace support {
  43
  44 int compare_no_case(string const & s, string const & s2)
  45 {
  46         string::const_iterator p = s.begin();
  47         string::const_iterator p2 = s2.begin();
  48
  49         while (p != s.end() && p2 != s2.end()) {
  50                 int const lc1 = tolower(*p);
  51                 int const lc2 = tolower(*p2);
  52                 if (lc1 != lc2)
  53                         return (lc1 < lc2) ? -1 : 1;
  54                 ++p;
  55                 ++p2;
  56         }
  57
  58         if (s.size() == s2.size())
  59                 return 0;
  60         if (s.size() < s2.size())
  61                 return -1;
  62         return 1;
  63 }
  64
  65
  66 namespace {
  67         int ascii_tolower(int c) {
  68                 if (c >= 'A' && c <= 'Z')
  69                         return c - 'A' + 'a';
  70                 return c;
  71         }
  72 }
  73
  74
  75 int compare_ascii_no_case(string const & s, string const & s2)
  76 {
  77         string::const_iterator p = s.begin();
  78         string::const_iterator p2 = s2.begin();
  79
  80         while (p != s.end() && p2 != s2.end()) {
  81                 int const lc1 = ascii_tolower(*p);
  82                 int const lc2 = ascii_tolower(*p2);
  83                 if (lc1 != lc2)
  84                         return (lc1 < lc2) ? -1 : 1;
  85                 ++p;
  86                 ++p2;
  87         }
  88
  89         if (s.size() == s2.size())
  90                 return 0;
  91         if (s.size() < s2.size())
  92                 return -1;
  93         return 1;
  94 }
  95
  96
  97 int compare_no_case(string const & s, string const & s2, unsigned int len)
  98 {
  99         string::const_iterator p = s.begin();
 100         string::const_iterator p2 = s2.begin();
 101         unsigned int i = 0;
 102         while (i < len && p != s.end() && p2 != s2.end()) {
 103                 int const lc1 = tolower(*p);
 104                 int const lc2 = tolower(*p2);
 105                 if (lc1 != lc2)
 106                         return (lc1 < lc2) ? -1 : 1;
 107                 ++i;
 108                 ++p;
 109                 ++p2;
 110         }
 111
 112         if (s.size() >= len && s2.size() >= len)
 113                 return 0;
 114         if (s.size() < s2.size())
 115                 return -1;
 116         return 1;
 117 }
 118
 119
 120 bool isStrInt(string const & str)
 121 {
 122         if (str.empty()) return false;
 123
 124         // Remove leading and trailing white space chars.
 125         string const tmpstr = trim(str);
 126         if (tmpstr.empty()) return false;
 127
 128         string::const_iterator cit = tmpstr.begin();
 129         if ((*cit) == '-') ++cit;
 130         string::const_iterator end = tmpstr.end();
 131         for (; cit != end; ++cit) {
 132                 if (!isdigit((*cit))) return false;
 133         }
 134         return true;
 135 }
 136
 137
 138 bool isStrUnsignedInt(string const & str)
 139 {
 140         if (str.empty()) return false;
 141
 142         // Remove leading and trailing white space chars.
 143         string const tmpstr = trim(str);
 144         if (tmpstr.empty()) return false;
 145
 146         string::const_iterator cit = tmpstr.begin();
 147         string::const_iterator end = tmpstr.end();
 148         for (; cit != end; ++cit) {
 149                 if (!isdigit((*cit))) return false;
 150         }
 151         return true;
 152 }
 153
 154
 155 int strToInt(string const & str)
 156 {
 157         if (isStrInt(str)) {
 158                 // Remove leading and trailing white space chars.
 159                 string const tmpstr = trim(str);
 160                 // Do the conversion proper.
 161                 return atoi(tmpstr);
 162         } else {
 163                 return 0;
 164         }
 165 }
 166
 167
 168 unsigned int strToUnsignedInt(string const & str)
 169 {
 170         if (isStrUnsignedInt(str)) {
 171                 // Remove leading and trailing white space chars.
 172                 string const tmpstr = trim(str);
 173                 // Do the conversion proper.
 174                 return atoi(tmpstr);
 175         } else {
 176                 return 0;
 177         }
 178 }
 179
 180
 181 bool isStrDbl(string const & str)
 182 {
 183         if (str.empty()) return false;
 184
 185         // Remove leading and trailing white space chars.
 186         string const tmpstr = trim(str);
 187         if (tmpstr.empty()) return false;
 188         //      if (1 < tmpstr.count('.')) return false;
 189
 190         string::const_iterator cit = tmpstr.begin();
 191         bool found_dot(false);
 192         if ((*cit) == '-') ++cit;
 193         string::const_iterator end = tmpstr.end();
 194         for (; cit != end; ++cit) {
 195                 if (!isdigit((*cit))
 196                     && '.' != (*cit)) {
 197                         return false;
 198                 }
 199                 if ('.' == (*cit)) {
 200                         if (found_dot) {
 201                                 return false;
 202                         } else {
 203                                 found_dot = true;
 204                         }
 205                 }
 206         }
 207         return true;
 208 }
 209
 210
 211 double strToDbl(string const & str)
 212 {
 213         if (isStrDbl(str)) {
 214                 // Remove leading and trailing white space chars.
 215                 string const tmpstr = trim(str);
 216                 // Do the conversion proper.
 217                 return ::atof(tmpstr.c_str());
 218         } else {
 219                 return 0.0;
 220         }
 221 }
 222
 223
 224 char lowercase(char c)
 225 {
 226         return char(tolower(c));
 227 }
 228
 229
 230 char uppercase(char c)
 231 {
 232         return char(toupper(c));
 233 }
 234
 235
 236 namespace {
 237
 238 // since we cannot use std::tolower and std::toupper directly in the
 239 // calls to std::transform yet, we use these helper clases. (Lgb)
 240
 241 struct local_lowercase {
 242         char operator()(char c) const {
 243                 return tolower(c);
 244         }
 245 };
 246
 247 struct local_uppercase {
 248         char operator()(char c) const {
 249                 return toupper(c);
 250         }
 251 };
 252
 253 struct local_ascii_lowercase {
 254         char operator()(char c) const {
 255                 return ascii_tolower(c);
 256         }
 257 };
 258
 259 } // end of anon namespace
 260
 261 string const lowercase(string const & a)
 262 {
 263         string tmp(a);
 264         transform(tmp.begin(), tmp.end(), tmp.begin(), local_lowercase());
 265         return tmp;
 266 }
 267
 268 string const uppercase(string const & a)
 269 {
 270         string tmp(a);
 271         transform(tmp.begin(), tmp.end(), tmp.begin(), local_uppercase());
 272         return tmp;
 273 }
 274
 275
 276 string const ascii_lowercase(string const & a)
 277 {
 278         string tmp(a);
 279         transform(tmp.begin(), tmp.end(), tmp.begin(),
 280                   local_ascii_lowercase());
 281         return tmp;
 282 }
 283
 284
 285 bool prefixIs(string const & a, string const & pre)
 286 {
 287         string::size_type const prelen = pre.length();
 288         string::size_type const alen = a.length();
 289
 290         if (prelen > alen || a.empty())
 291                 return false;
 292         else {
 293 #if defined(STD_STRING_IS_GOOD)
 294                 return a.compare(0, prelen, pre) == 0;
 295 #else
 296                 return ::strncmp(a.c_str(), pre.c_str(), prelen) == 0;
 297 #endif
 298         }
 299 }
 300
 301
 302 bool suffixIs(string const & a, char c)
 303 {
 304         if (a.empty()) return false;
 305         return a[a.length() - 1] == c;
 306 }
 307
 308
 309 bool suffixIs(string const & a, string const & suf)
 310 {
 311         string::size_type const suflen = suf.length();
 312         string::size_type const alen = a.length();
 313
 314         if (suflen > alen) {
 315                 return false;
 316         } else {
 317 #if !defined(USE_INCLUDED_STRING) && !defined(STD_STRING_IS_GOOD)
 318                 string tmp(a, alen - suflen);
 319                 return ::strncmp(tmp.c_str(), suf.c_str(), suflen) == 0;
 320 #else
 321                 return a.compare(alen - suflen, suflen, suf) == 0;
 322 #endif
 323         }
 324 }
 325
 326
 327 bool containsOnly(string const & s, string const & cset)
 328 {
 329         return s.find_first_not_of(cset) == string::npos;
 330 }
 331
 332
 333 // ale970405+lasgoutt-970425
 334 // rewritten to use new string (Lgb)
 335 string const token(string const & a, char delim, int n)
 336 {
 337         if (a.empty()) return string();
 338
 339         string::size_type k = 0;
 340         string::size_type i = 0;
 341
 342         // Find delimiter or end of string
 343         for (; n--;)
 344                 if ((i = a.find(delim, i)) == string::npos)
 345                         break;
 346                 else
 347                         ++i; // step delim
 348         // i is now the n'th delim (or string::npos)
 349         if (i == string::npos) return string();
 350         k = a.find(delim, i);
 351         // k is now the n'th + 1 delim (or string::npos)
 352
 353         return a.substr(i, k - i);
 354 }
 355
 356
 357 // this could probably be faster and/or cleaner, but it seems to work (JMarc)
 358 // rewritten to use new string (Lgb)
 359 int tokenPos(string const & a, char delim, string const & tok)
 360 {
 361         int i = 0;
 362         string str(a);
 363         string tmptok;
 364
 365         while (!str.empty()) {
 366                 str = split(str, tmptok, delim);
 367                 if (tok == tmptok)
 368                         return i;
 369                 ++i;
 370         }
 371         return -1;
 372 }
 373
 374
 375 string const subst(string const & a, char oldchar, char newchar)
 376 {
 377         string tmp(a);
 378         string::iterator lit = tmp.begin();
 379         string::iterator end = tmp.end();
 380         for (; lit != end; ++lit)
 381                 if ((*lit) == oldchar)
 382                         (*lit) = newchar;
 383         return tmp;
 384 }
 385
 386
 387 string const subst(string const & a,
 388                    string const & oldstr, string const & newstr)
 389 {
 390         string lstr = a;
 391         string::size_type i = 0;
 392         string::size_type const olen = oldstr.length();
 393         while ((i = lstr.find(oldstr, i)) != string::npos) {
 394                 lstr.replace(i, olen, newstr);
 395                 i += newstr.length(); // We need to be sure that we dont
 396                 // use the same i over and over again.
 397         }
 398         return lstr;
 399 }
 400
 401
 402 string const trim(string const & a, char const * p)
 403 {
 404         BOOST_ASSERT(p);
 405
 406         if (a.empty() || !*p)
 407                 return a;
 408
 409         string::size_type r = a.find_last_not_of(p);
 410         string::size_type l = a.find_first_not_of(p);
 411
 412         // Is this the minimal test? (lgb)
 413         if (r == string::npos && l == string::npos)
 414                 return string();
 415
 416         return a.substr(l, r - l + 1);
 417 }
 418
 419
 420 string const rtrim(string const & a, char const * p)
 421 {
 422         BOOST_ASSERT(p);
 423
 424         if (a.empty() || !*p)
 425                 return a;
 426
 427         string::size_type r = a.find_last_not_of(p);
 428
 429         // Is this test really needed? (Lgb)
 430         if (r == string::npos)
 431                 return string();
 432
 433         return a.substr(0, r + 1);
 434 }
 435
 436
 437 string const ltrim(string const & a, char const * p)
 438 {
 439         BOOST_ASSERT(p);
 440
 441         if (a.empty() || !*p)
 442                 return a;
 443
 444         string::size_type l = a.find_first_not_of(p);
 445
 446         if (l == string::npos)
 447                 return string();
 448
 449         return a.substr(l, string::npos);
 450 }
 451
 452
 453 string const split(string const & a, string & piece, char delim)
 454 {
 455         string tmp;
 456         string::size_type i = a.find(delim);
 457         if (i == a.length() - 1) {
 458                 piece = a.substr(0, i);
 459         } else if (i != string::npos) {
 460                 piece = a.substr(0, i);
 461                 tmp = a.substr(i + 1);
 462         } else if (i == 0) {
 463                 piece.erase();
 464                 tmp = a.substr(i + 1);
 465         } else {
 466                 piece = a;
 467         }
 468         return tmp;
 469 }
 470
 471
 472 string const split(string const & a, char delim)
 473 {
 474         string tmp;
 475         string::size_type i = a.find(delim);
 476         if (i != string::npos) // found delim
 477                 tmp = a.substr(i + 1);
 478         return tmp;
 479 }
 480
 481
 482 // ale970521
 483 string const rsplit(string const & a, string & piece, char delim)
 484 {
 485         string tmp;
 486         string::size_type i = a.rfind(delim);
 487         if (i != string::npos) { // delimiter was found
 488                 piece = a.substr(0, i);
 489                 tmp = a.substr(i + 1);
 490         } else { // delimiter was not found
 491                 piece.erase();
 492         }
 493         return tmp;
 494 }
 495
 496
 497 // This function escapes 8-bit characters and other problematic
 498 // characters that cause problems in latex labels.
 499 string const escape(string const & lab)
 500 {
 501         char hexdigit[16] = { '0', '1', '2', '3', '4', '5', '6', '7',
 502                               '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
 503         string enc;
 504         for (string::size_type i = 0; i < lab.length(); ++i) {
 505                 unsigned char c= lab[i];
 506                 if (c >= 128 || c == '=' || c == '%') {
 507                         enc += '=';
 508                         enc += hexdigit[c>>4];
 509                         enc += hexdigit[c & 15];
 510                 } else {
 511                         enc += c;
 512                 }
 513         }
 514         return enc;
 515 }
 516
 517
 518 /// gives a vector of stringparts which have the delimiter delim
 519 vector<string> const getVectorFromString(string const & str,
 520                                          string const & delim)
 521 {
 522 // Lars would like this code to go, but for now his replacement (below)
 523 // doesn't fullfil the same function. I have, therefore, reactivated the
 524 // old code for now. Angus 11 Nov 2002.
 525 #if 1
 526         vector<string> vec;
 527         if (str.empty())
 528                 return vec;
 529         string keys(rtrim(str));
 530         for(;;) {
 531                 string::size_type const idx = keys.find(delim);
 532                 if (idx == string::npos) {
 533                         vec.push_back(ltrim(keys));
 534                         break;
 535                 }
 536                 string const key = trim(keys.substr(0, idx));
 537                 if (!key.empty())
 538                         vec.push_back(key);
 539                 string::size_type const start = idx + delim.size();
 540                 keys = keys.substr(start);
 541         }
 542         return vec;
 543 #else
 544         boost::char_separator<char> sep(delim.c_str());
 545         boost::tokenizer<boost::char_separator<char> > tokens(str, sep);
 546 #ifndef USE_INCLUDED_STRING
 547         return vector<string>(tokens.begin(), tokens.end());
 548 #else
 549         vector<string> vec;
 550         using boost::tokenizer;
 551         using boost::char_separator;
 552
 553         tokenizer<char_separator<char> >::iterator it = tokens.begin();
 554         tokenizer<char_separator<char> >::iterator end = tokens.end();
 555         for (; it != end; ++it) {
 556                 vec.push_back(STRCONV((*it)));
 557         }
 558         return vec;
 559 #endif
 560 #endif
 561 }
 562
 563
 564 // the same vice versa
 565 string const getStringFromVector(vector<string> const & vec,
 566                                  string const & delim)
 567 {
 568         string str;
 569         int i = 0;
 570         for (vector<string>::const_iterator it = vec.begin();
 571              it != vec.end(); ++it) {
 572                 string item = trim(*it);
 573                 if (item.empty())
 574                         continue;
 575                 if (i++ > 0)
 576                         str += delim;
 577                 str += item;
 578         }
 579         return str;
 580 }
 581
 582
 583 #if USE_BOOST_FORMAT
 584
 585 string bformat(string const & fmt, string const & arg1)
 586 {
 587         return (boost::format(fmt) % arg1).str();
 588 }
 589
 590
 591 string bformat(string const & fmt, string const & arg1, string const & arg2)
 592 {
 593         return (boost::format(fmt) % arg1 % arg2).str();
 594 }
 595
 596
 597 string bformat(string const & fmt, int arg1, int arg2)
 598 {
 599         return (boost::format(fmt) % arg1 % arg2).str();
 600 }
 601
 602
 603 string bformat(string const & fmt, string const & arg1, string const & arg2,
 604         string const & arg3)
 605 {
 606         return (boost::format(fmt) % arg1 % arg2 % arg3).str();
 607 }
 608
 609
 610 string bformat(string const & fmt, string const & arg1, string const & arg2,
 611         string const & arg3, string const & arg4)
 612 {
 613         return (boost::format(fmt) % arg1 % arg2 % arg3 % arg4).str();
 614 }
 615
 616
 617 string bformat(string const & fmt, string const & arg1, string const & arg2,
 618         string const & arg3, string const & arg4, string const & arg5)
 619 {
 620         return (boost::format(fmt) % arg1 % arg2 % arg3 % arg4 % arg5).str();
 621 }
 622
 623 #else
 624
 625 string bformat(string const & fmt, string const & arg1)
 626 {
 627         BOOST_ASSERT(contains(fmt, "%1$s"));
 628         string const str = subst(fmt, "%1$s", arg1);
 629         return subst(str, "%%", "%");
 630 }
 631
 632
 633 string bformat(string const & fmt, string const & arg1, string const & arg2)
 634 {
 635         BOOST_ASSERT(contains(fmt, "%1$s"));
 636         BOOST_ASSERT(contains(fmt, "%2$s"));
 637         string str = subst(fmt, "%1$s", arg1);
 638         str = subst(str, "%2$s", arg2);
 639         return subst(str, "%%", "%");
 640 }
 641
 642
 643 string bformat(string const & fmt, int arg1, int arg2)
 644 {
 645         BOOST_ASSERT(contains(fmt, "%1$d"));
 646         BOOST_ASSERT(contains(fmt, "%2$d"));
 647         string str = subst(fmt, "%1$d", tostr(arg1));
 648         str = subst(str, "%2$d", tostr(arg2));
 649         return subst(str, "%%", "%");
 650 }
 651
 652
 653 string bformat(string const & fmt, string const & arg1, string const & arg2,
 654         string const & arg3)
 655 {
 656         BOOST_ASSERT(contains(fmt, "%1$s"));
 657         BOOST_ASSERT(contains(fmt, "%2$s"));
 658         BOOST_ASSERT(contains(fmt, "%3$s"));
 659         string str = subst(fmt, "%1$s", arg1);
 660         str = subst(str, "%2$s", arg2);
 661         str = subst(str, "%3$s", arg3);
 662         return subst(str, "%%", "%");
 663 }
 664
 665
 666 string bformat(string const & fmt, string const & arg1, string const & arg2,
 667         string const & arg3, string const & arg4)
 668 {
 669         BOOST_ASSERT(contains(fmt, "%1$s"));
 670         BOOST_ASSERT(contains(fmt, "%2$s"));
 671         BOOST_ASSERT(contains(fmt, "%3$s"));
 672         BOOST_ASSERT(contains(fmt, "%4$s"));
 673         string str = subst(fmt, "%1$s", arg1);
 674         str = subst(str, "%2$s", arg2);
 675         str = subst(str, "%3$s", arg3);
 676         str = subst(str, "%4$s", arg4);
 677         return subst(str, "%%", "%");
 678 }
 679
 680
 681 string bformat(string const & fmt, string const & arg1, string const & arg2,
 682         string const & arg3, string const & arg4, string const & arg5)
 683 {
 684         BOOST_ASSERT(contains(fmt, "%1$s"));
 685         BOOST_ASSERT(contains(fmt, "%2$s"));
 686         BOOST_ASSERT(contains(fmt, "%3$s"));
 687         BOOST_ASSERT(contains(fmt, "%4$s"));
 688         BOOST_ASSERT(contains(fmt, "%5$s"));
 689         string str = subst(fmt, "%1$s", arg1);
 690         str = subst(str, "%2$s", arg2);
 691         str = subst(str, "%3$s", arg3);
 692         str = subst(str, "%4$s", arg4);
 693         str = subst(str, "%5$s", arg5);
 694         return subst(str, "%%", "%");
 695 }
 696
 697 #endif
 698
 699 } // namespace support
 700 } // namespace lyx