Source/cmStringCommand.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmStringCommand.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2008-08-26 16:54:06 $
   7   Version:   $Revision: 1.28 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #include "cmStringCommand.h"
  18 #include <cmsys/RegularExpression.hxx>
  19 #include <cmsys/SystemTools.hxx>
  20
  21 #include <stdlib.h> // required for atoi
  22 #include <ctype.h>
  23 #include <time.h>
  24
  25 //----------------------------------------------------------------------------
  26 bool cmStringCommand
  27 ::InitialPass(std::vector<std::string> const& args, cmExecutionStatus &)
  28 {
  29   if(args.size() < 1)
  30     {
  31     this->SetError("must be called with at least one argument.");
  32     return false;
  33     }
  34
  35   const std::string &subCommand = args[0];
  36   if(subCommand == "REGEX")
  37     {
  38     return this->HandleRegexCommand(args);
  39     }
  40   else if(subCommand == "REPLACE")
  41     {
  42     return this->HandleReplaceCommand(args);
  43     }
  44   else if(subCommand == "TOLOWER")
  45     {
  46     return this->HandleToUpperLowerCommand(args, false);
  47     }
  48   else if(subCommand == "TOUPPER")
  49     {
  50     return this->HandleToUpperLowerCommand(args, true);
  51     }
  52   else if(subCommand == "COMPARE")
  53     {
  54     return this->HandleCompareCommand(args);
  55     }
  56   else if(subCommand == "ASCII")
  57     {
  58     return this->HandleAsciiCommand(args);
  59     }
  60   else if(subCommand == "CONFIGURE")
  61     {
  62     return this->HandleConfigureCommand(args);
  63     }
  64   else if(subCommand == "LENGTH")
  65     {
  66     return this->HandleLengthCommand(args);
  67     }
  68   else if(subCommand == "SUBSTRING")
  69     {
  70     return this->HandleSubstringCommand(args);
  71     }
  72   else if(subCommand == "STRIP")
  73     {
  74     return this->HandleStripCommand(args);
  75     }
  76   else if(subCommand == "RANDOM")
  77     {
  78     return this->HandleRandomCommand(args);
  79     }
  80
  81   std::string e = "does not recognize sub-command "+subCommand;
  82   this->SetError(e.c_str());
  83   return false;
  84 }
  85
  86 //----------------------------------------------------------------------------
  87 bool cmStringCommand::HandleToUpperLowerCommand(
  88   std::vector<std::string> const& args, bool toUpper)
  89 {
  90   if ( args.size() < 3 )
  91     {
  92     this->SetError("no output variable specified");
  93     return false;
  94     }
  95
  96   std::string outvar = args[2];
  97   std::string output;
  98
  99   if (toUpper)
 100     {
 101     output = cmSystemTools::UpperCase(args[1]);
 102     }
 103   else
 104     {
 105     output = cmSystemTools::LowerCase(args[1]);
 106     }
 107
 108   // Store the output in the provided variable.
 109   this->Makefile->AddDefinition(outvar.c_str(), output.c_str());
 110   return true;
 111 }
 112
 113 //----------------------------------------------------------------------------
 114 bool cmStringCommand::HandleAsciiCommand(std::vector<std::string> const& args)
 115 {
 116   if ( args.size() < 3 )
 117     {
 118     this->SetError("No output variable specified");
 119     return false;
 120     }
 121   std::string::size_type cc;
 122   std::string outvar = args[args.size()-1];
 123   std::string output = "";
 124   for ( cc = 1; cc < args.size()-1; cc ++ )
 125     {
 126     int ch = atoi(args[cc].c_str());
 127     if ( ch > 0 && ch < 256 )
 128       {
 129       output += static_cast<char>(ch);
 130       }
 131     else
 132       {
 133       std::string error = "Character with code ";
 134       error += ch;
 135       error += " does not exist.";
 136       this->SetError(error.c_str());
 137       return false;
 138       }
 139     }
 140   // Store the output in the provided variable.
 141   this->Makefile->AddDefinition(outvar.c_str(), output.c_str());
 142   return true;
 143 }
 144
 145 //----------------------------------------------------------------------------
 146 bool cmStringCommand::HandleConfigureCommand(
 147   std::vector<std::string> const& args)
 148 {
 149   if ( args.size() < 2 )
 150     {
 151     this->SetError("No input string specified.");
 152     return false;
 153     }
 154   else if ( args.size() < 3 )
 155     {
 156     this->SetError("No output variable specified.");
 157     return false;
 158     }
 159
 160   // Parse options.
 161   bool escapeQuotes = false;
 162   bool atOnly = false;
 163   for(unsigned int i = 3; i < args.size(); ++i)
 164     {
 165     if(args[i] == "@ONLY")
 166       {
 167       atOnly = true;
 168       }
 169     else if(args[i] == "ESCAPE_QUOTES")
 170       {
 171       escapeQuotes = true;
 172       }
 173     else
 174       {
 175       cmOStringStream err;
 176       err << "Unrecognized argument \"" << args[i] << "\"";
 177       this->SetError(err.str().c_str());
 178       return false;
 179       }
 180     }
 181
 182   // Configure the string.
 183   std::string output;
 184   this->Makefile->ConfigureString(args[1], output, atOnly, escapeQuotes);
 185
 186   // Store the output in the provided variable.
 187   this->Makefile->AddDefinition(args[2].c_str(), output.c_str());
 188
 189   return true;
 190 }
 191
 192 //----------------------------------------------------------------------------
 193 bool cmStringCommand::HandleRegexCommand(std::vector<std::string> const& args)
 194 {
 195   if(args.size() < 2)
 196     {
 197     this->SetError("sub-command REGEX requires a mode to be specified.");
 198     return false;
 199     }
 200   std::string mode = args[1];
 201   if(mode == "MATCH")
 202     {
 203     if(args.size() < 5)
 204       {
 205       this->SetError("sub-command REGEX, mode MATCH needs "
 206                      "at least 5 arguments total to command.");
 207       return false;
 208       }
 209     return this->RegexMatch(args);
 210     }
 211   else if(mode == "MATCHALL")
 212     {
 213     if(args.size() < 5)
 214       {
 215       this->SetError("sub-command REGEX, mode MATCHALL needs "
 216                      "at least 5 arguments total to command.");
 217       return false;
 218       }
 219     return this->RegexMatchAll(args);
 220     }
 221   else if(mode == "REPLACE")
 222     {
 223     if(args.size() < 6)
 224       {
 225       this->SetError("sub-command REGEX, mode REPLACE needs "
 226                      "at least 6 arguments total to command.");
 227       return false;
 228       }
 229     return this->RegexReplace(args);
 230     }
 231
 232   std::string e = "sub-command REGEX does not recognize mode "+mode;
 233   this->SetError(e.c_str());
 234   return false;
 235 }
 236
 237 //----------------------------------------------------------------------------
 238 bool cmStringCommand::RegexMatch(std::vector<std::string> const& args)
 239 {
 240   //"STRING(REGEX MATCH <regular_expression> <output variable>
 241   // <input> [<input>...])\n";
 242   std::string regex = args[2];
 243   std::string outvar = args[3];
 244
 245   // Concatenate all the last arguments together.
 246   std::string input = args[4];
 247   for(unsigned int i=5; i < args.size(); ++i)
 248     {
 249     input += args[i];
 250     }
 251
 252   this->ClearMatches(this->Makefile);
 253   // Compile the regular expression.
 254   cmsys::RegularExpression re;
 255   if(!re.compile(regex.c_str()))
 256     {
 257     std::string e =
 258       "sub-command REGEX, mode MATCH failed to compile regex \""+regex+"\".";
 259     this->SetError(e.c_str());
 260     return false;
 261     }
 262
 263   // Scan through the input for all matches.
 264   std::string output;
 265   if(re.find(input.c_str()))
 266     {
 267     this->StoreMatches(this->Makefile, re);
 268     std::string::size_type l = re.start();
 269     std::string::size_type r = re.end();
 270     if(r-l == 0)
 271       {
 272       std::string e =
 273         "sub-command REGEX, mode MATCH regex \""+regex+
 274         "\" matched an empty string.";
 275       this->SetError(e.c_str());
 276       return false;
 277       }
 278     output = input.substr(l, r-l);
 279     }
 280
 281   // Store the output in the provided variable.
 282   this->Makefile->AddDefinition(outvar.c_str(), output.c_str());
 283   return true;
 284 }
 285
 286 //----------------------------------------------------------------------------
 287 bool cmStringCommand::RegexMatchAll(std::vector<std::string> const& args)
 288 {
 289   //"STRING(REGEX MATCHALL <regular_expression> <output variable> <input>
 290   // [<input>...])\n";
 291   std::string regex = args[2];
 292   std::string outvar = args[3];
 293
 294   // Concatenate all the last arguments together.
 295   std::string input = args[4];
 296   for(unsigned int i=5; i < args.size(); ++i)
 297     {
 298     input += args[i];
 299     }
 300
 301   this->ClearMatches(this->Makefile);
 302   // Compile the regular expression.
 303   cmsys::RegularExpression re;
 304   if(!re.compile(regex.c_str()))
 305     {
 306     std::string e =
 307       "sub-command REGEX, mode MATCHALL failed to compile regex \""+
 308       regex+"\".";
 309     this->SetError(e.c_str());
 310     return false;
 311     }
 312
 313   // Scan through the input for all matches.
 314   std::string output;
 315   const char* p = input.c_str();
 316   while(re.find(p))
 317     {
 318     this->StoreMatches(this->Makefile, re);
 319     std::string::size_type l = re.start();
 320     std::string::size_type r = re.end();
 321     if(r-l == 0)
 322       {
 323       std::string e = "sub-command REGEX, mode MATCHALL regex \""+
 324         regex+"\" matched an empty string.";
 325       this->SetError(e.c_str());
 326       return false;
 327       }
 328     if(output.length() > 0)
 329       {
 330       output += ";";
 331       }
 332     output += std::string(p+l, r-l);
 333     p += r;
 334     }
 335
 336   // Store the output in the provided variable.
 337   this->Makefile->AddDefinition(outvar.c_str(), output.c_str());
 338   return true;
 339 }
 340
 341 //----------------------------------------------------------------------------
 342 bool cmStringCommand::RegexReplace(std::vector<std::string> const& args)
 343 {
 344   //"STRING(REGEX REPLACE <regular_expression> <replace_expression>
 345   // <output variable> <input> [<input>...])\n"
 346   std::string regex = args[2];
 347   std::string replace = args[3];
 348   std::string outvar = args[4];
 349
 350   // Pull apart the replace expression to find the escaped [0-9] values.
 351   std::vector<RegexReplacement> replacement;
 352   std::string::size_type l = 0;
 353   while(l < replace.length())
 354     {
 355     std::string::size_type r = replace.find("\\", l);
 356     if(r == std::string::npos)
 357       {
 358       r = replace.length();
 359       replacement.push_back(replace.substr(l, r-l));
 360       }
 361     else
 362       {
 363       if(r-l > 0)
 364         {
 365         replacement.push_back(replace.substr(l, r-l));
 366         }
 367       if(r == (replace.length()-1))
 368         {
 369         this->SetError("sub-command REGEX, mode REPLACE: "
 370                        "replace-expression ends in a backslash.");
 371         return false;
 372         }
 373       if((replace[r+1] >= '0') && (replace[r+1] <= '9'))
 374         {
 375         replacement.push_back(replace[r+1]-'0');
 376         }
 377       else if(replace[r+1] == 'n')
 378         {
 379         replacement.push_back("\n");
 380         }
 381       else if(replace[r+1] == '\\')
 382         {
 383         replacement.push_back("\\");
 384         }
 385       else
 386         {
 387         std::string e = "sub-command REGEX, mode REPLACE: Unknown escape \"";
 388         e += replace.substr(r, 2);
 389         e += "\"in replace-expression.";
 390         this->SetError(e.c_str());
 391         return false;
 392         }
 393       r += 2;
 394       }
 395     l = r;
 396     }
 397
 398   // Concatenate all the last arguments together.
 399   std::string input = args[5];
 400   for(unsigned int i=6; i < args.size(); ++i)
 401     {
 402     input += args[i];
 403     }
 404
 405   this->ClearMatches(this->Makefile);
 406   // Compile the regular expression.
 407   cmsys::RegularExpression re;
 408   if(!re.compile(regex.c_str()))
 409     {
 410     std::string e =
 411       "sub-command REGEX, mode REPLACE failed to compile regex \""+
 412       regex+"\".";
 413     this->SetError(e.c_str());
 414     return false;
 415     }
 416
 417   // Scan through the input for all matches.
 418   std::string output;
 419   std::string::size_type base = 0;
 420   while(re.find(input.c_str()+base))
 421     {
 422     this->StoreMatches(this->Makefile, re);
 423     std::string::size_type l2 = re.start();
 424     std::string::size_type r = re.end();
 425
 426     // Concatenate the part of the input that was not matched.
 427     output += input.substr(base, l2);
 428
 429     // Make sure the match had some text.
 430     if(r-l2 == 0)
 431       {
 432       std::string e = "sub-command REGEX, mode REPLACE regex \""+
 433         regex+"\" matched an empty string.";
 434       this->SetError(e.c_str());
 435       return false;
 436       }
 437
 438     // Concatenate the replacement for the match.
 439     for(unsigned int i=0; i < replacement.size(); ++i)
 440       {
 441       if(replacement[i].number < 0)
 442         {
 443         // This is just a plain-text part of the replacement.
 444         output += replacement[i].value;
 445         }
 446       else
 447         {
 448         // Replace with part of the match.
 449         int n = replacement[i].number;
 450         std::string::size_type start = re.start(n);
 451         std::string::size_type end = re.end(n);
 452         std::string::size_type len = input.length()-base;
 453         if((start != std::string::npos) && (end != std::string::npos) &&
 454            (start <= len) && (end <= len))
 455           {
 456           output += input.substr(base+start, end-start);
 457           }
 458         else
 459           {
 460           std::string e =
 461             "sub-command REGEX, mode REPLACE: replace expression \""+
 462             replace+"\" contains an out-of-range escape for regex \""+
 463             regex+"\".";
 464           this->SetError(e.c_str());
 465           return false;
 466           }
 467         }
 468       }
 469
 470     // Move past the match.
 471     base += r;
 472     }
 473
 474   // Concatenate the text after the last match.
 475   output += input.substr(base, input.length()-base);
 476
 477   // Store the output in the provided variable.
 478   this->Makefile->AddDefinition(outvar.c_str(), output.c_str());
 479   return true;
 480 }
 481
 482 //----------------------------------------------------------------------------
 483 void cmStringCommand::ClearMatches(cmMakefile* mf)
 484 {
 485   for (unsigned int i=0; i<10; i++)
 486     {
 487     char name[128];
 488     sprintf(name, "CMAKE_MATCH_%d", i);
 489     mf->AddDefinition(name, "");
 490     }
 491 }
 492
 493 //----------------------------------------------------------------------------
 494 void cmStringCommand::StoreMatches(cmMakefile* mf,cmsys::RegularExpression& re)
 495 {
 496   for (unsigned int i=0; i<10; i++)
 497     {
 498     char name[128];
 499     sprintf(name, "CMAKE_MATCH_%d", i);
 500     mf->AddDefinition(name, re.match(i).c_str());
 501     }
 502 }
 503
 504 //----------------------------------------------------------------------------
 505 bool cmStringCommand::HandleCompareCommand(std::vector<std::string> const&
 506                                            args)
 507 {
 508   if(args.size() < 2)
 509     {
 510     this->SetError("sub-command COMPARE requires a mode to be specified.");
 511     return false;
 512     }
 513   std::string mode = args[1];
 514   if((mode == "EQUAL") || (mode == "NOTEQUAL") ||
 515      (mode == "LESS") || (mode == "GREATER"))
 516     {
 517     if(args.size() < 5)
 518       {
 519       std::string e = "sub-command COMPARE, mode ";
 520       e += mode;
 521       e += " needs at least 5 arguments total to command.";
 522       this->SetError(e.c_str());
 523       return false;
 524       }
 525
 526     const std::string& left = args[2];
 527     const std::string& right = args[3];
 528     const std::string& outvar = args[4];
 529     bool result;
 530     if(mode == "LESS")
 531       {
 532       result = (left < right);
 533       }
 534     else if(mode == "GREATER")
 535       {
 536       result = (left > right);
 537       }
 538     else if(mode == "EQUAL")
 539       {
 540       result = (left == right);
 541       }
 542     else // if(mode == "NOTEQUAL")
 543       {
 544       result = !(left == right);
 545       }
 546     if(result)
 547       {
 548       this->Makefile->AddDefinition(outvar.c_str(), "1");
 549       }
 550     else
 551       {
 552       this->Makefile->AddDefinition(outvar.c_str(), "0");
 553       }
 554     return true;
 555     }
 556   std::string e = "sub-command COMPARE does not recognize mode "+mode;
 557   this->SetError(e.c_str());
 558   return false;
 559 }
 560
 561 //----------------------------------------------------------------------------
 562 bool cmStringCommand::HandleReplaceCommand(std::vector<std::string> const&
 563                                            args)
 564 {
 565   if(args.size() < 5)
 566     {
 567     this->SetError("sub-command REPLACE requires four arguments.");
 568     return false;
 569     }
 570
 571   const std::string& matchExpression = args[1];
 572   const std::string& replaceExpression = args[2];
 573   const std::string& variableName = args[3];
 574
 575   std::string input = args[4];
 576   for(unsigned int i=5; i < args.size(); ++i)
 577     {
 578     input += args[i];
 579     }
 580
 581   cmsys::SystemTools::ReplaceString(input, matchExpression.c_str(),
 582                                     replaceExpression.c_str());
 583
 584   this->Makefile->AddDefinition(variableName.c_str(), input.c_str());
 585   return true;
 586 }
 587
 588 //----------------------------------------------------------------------------
 589 bool cmStringCommand::HandleSubstringCommand(std::vector<std::string> const&
 590                                              args)
 591 {
 592   if(args.size() != 5)
 593     {
 594     this->SetError("sub-command REPLACE requires four arguments.");
 595     return false;
 596     }
 597
 598   const std::string& stringValue = args[1];
 599   int begin = atoi(args[2].c_str());
 600   int end = atoi(args[3].c_str());
 601   const std::string& variableName = args[4];
 602
 603   size_t stringLength = stringValue.size();
 604   int intStringLength = static_cast<int>(stringLength);
 605   if ( begin < 0 || begin > intStringLength )
 606     {
 607     cmOStringStream ostr;
 608     ostr << "begin index: " << begin << " is out of range 0 - "
 609          << stringLength;
 610     this->SetError(ostr.str().c_str());
 611     return false;
 612     }
 613   int leftOverLength = intStringLength - begin;
 614   if ( end < 0 || end > leftOverLength )
 615     {
 616     cmOStringStream ostr;
 617     ostr << "end index: " << end << " is out of range " << 0 << " - "
 618          << leftOverLength;
 619     this->SetError(ostr.str().c_str());
 620     return false;
 621     }
 622
 623   this->Makefile->AddDefinition(variableName.c_str(),
 624                                 stringValue.substr(begin, end).c_str());
 625   return true;
 626 }
 627
 628 //----------------------------------------------------------------------------
 629 bool cmStringCommand
 630 ::HandleLengthCommand(std::vector<std::string> const& args)
 631 {
 632   if(args.size() != 3)
 633     {
 634     this->SetError("sub-command LENGTH requires two arguments.");
 635     return false;
 636     }
 637
 638   const std::string& stringValue = args[1];
 639   const std::string& variableName = args[2];
 640
 641   size_t length = stringValue.size();
 642   char buffer[1024];
 643   sprintf(buffer, "%d", static_cast<int>(length));
 644
 645   this->Makefile->AddDefinition(variableName.c_str(), buffer);
 646   return true;
 647 }
 648
 649 //----------------------------------------------------------------------------
 650 bool cmStringCommand::HandleStripCommand(
 651   std::vector<std::string> const& args)
 652 {
 653  if(args.size() != 3)
 654     {
 655     this->SetError("sub-command LENGTH requires two arguments.");
 656     return false;
 657     }
 658
 659   const std::string& stringValue = args[1];
 660   const std::string& variableName = args[2];
 661   size_t inStringLength = stringValue.size();
 662   size_t startPos = inStringLength + 1;
 663   size_t endPos = 0;
 664   const char* ptr = stringValue.c_str();
 665   size_t cc;
 666   for ( cc = 0; cc < inStringLength; ++ cc )
 667     {
 668     if ( !isspace(*ptr) )
 669       {
 670       if ( startPos > inStringLength )
 671         {
 672         startPos = cc;
 673         }
 674       endPos = cc;
 675       }
 676     ++ ptr;
 677     }
 678
 679   size_t outLength = 0;
 680
 681   // if the input string didn't contain any non-space characters, return
 682   // an empty string
 683   if (startPos > inStringLength)
 684     {
 685     outLength = 0;
 686     startPos = 0;
 687     }
 688   else
 689     {
 690     outLength=endPos - startPos + 1;
 691     }
 692
 693   this->Makefile->AddDefinition(variableName.c_str(),
 694     stringValue.substr(startPos, outLength).c_str());
 695   return true;
 696 }
 697
 698 //----------------------------------------------------------------------------
 699 bool cmStringCommand
 700 ::HandleRandomCommand(std::vector<std::string> const& args)
 701 {
 702   if(args.size() < 2 || args.size() == 3 || args.size() == 5)
 703     {
 704     this->SetError("sub-command RANDOM requires at least one argument.");
 705     return false;
 706     }
 707
 708   int length = 5;
 709   const char cmStringCommandDefaultAlphabet[] = "qwertyuiopasdfghjklzxcvbnm"
 710     "QWERTYUIOPASDFGHJKLZXCVBNM"
 711     "0123456789";
 712   std::string alphabet;
 713
 714   if ( args.size() > 3 )
 715     {
 716     size_t i = 1;
 717     size_t stopAt = args.size() - 2;
 718
 719     for ( ; i < stopAt; ++i )
 720       {
 721       if ( args[i] == "LENGTH" )
 722         {
 723         ++i;
 724         length = atoi(args[i].c_str());
 725         }
 726       else if ( args[i] == "ALPHABET" )
 727         {
 728         ++i;
 729         alphabet = args[i];
 730         }
 731       }
 732     }
 733   if ( !alphabet.size() )
 734     {
 735     alphabet = cmStringCommandDefaultAlphabet;
 736     }
 737
 738   double sizeofAlphabet = alphabet.size();
 739   if ( sizeofAlphabet < 1 )
 740     {
 741     this->SetError("sub-command RANDOM invoked with bad alphabet.");
 742     return false;
 743     }
 744   if ( length < 1 )
 745     {
 746     this->SetError("sub-command RANDOM invoked with bad length.");
 747     return false;
 748     }
 749   const std::string& variableName = args[args.size()-1];
 750
 751   std::vector<char> result;
 752   srand((int)time(NULL));
 753   const char* alphaPtr = alphabet.c_str();
 754   int cc;
 755   for ( cc = 0; cc < length; cc ++ )
 756     {
 757     int idx=(int) (sizeofAlphabet* rand()/(RAND_MAX+1.0));
 758     result.push_back(*(alphaPtr + idx));
 759     }
 760   result.push_back(0);
 761
 762   this->Makefile->AddDefinition(variableName.c_str(), &*result.begin());
 763   return true;
 764 }