src/gromacs/utility/stringutil.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2011,2012,2013,2014,2015, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions and classes in stringutil.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_utility
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "stringutil.h"
  45
  46 #include <cctype>
  47 #include <cstdarg>
  48 #include <cstdio>
  49 #include <cstring>
  50
  51 #include <algorithm>
  52 #include <string>
  53 #include <vector>
  54
  55 #include "gromacs/utility/gmxassert.h"
  56
  57 namespace gmx
  58 {
  59
  60 bool endsWith(const std::string &str, const char *suffix)
  61 {
  62     if (suffix == NULL || suffix[0] == '\0')
  63     {
  64         return true;
  65     }
  66     size_t length = std::strlen(suffix);
  67     return (str.length() >= length
  68             && str.compare(str.length() - length, length, suffix) == 0);
  69 }
  70
  71 std::string stripSuffixIfPresent(const std::string &str, const char *suffix)
  72 {
  73     if (suffix != NULL)
  74     {
  75         size_t suffixLength = std::strlen(suffix);
  76         if (suffixLength > 0 && endsWith(str, suffix))
  77         {
  78             return str.substr(0, str.length() - suffixLength);
  79         }
  80     }
  81     return str;
  82 }
  83
  84 std::string stripString(const std::string &str)
  85 {
  86     std::string::const_iterator start = str.begin();
  87     std::string::const_iterator end   = str.end();
  88     while (start != end && std::isspace(*start))
  89     {
  90         ++start;
  91     }
  92     while (start != end && std::isspace(*(end - 1)))
  93     {
  94         --end;
  95     }
  96     return std::string(start, end);
  97 }
  98
  99 std::string formatString(const char *fmt, ...)
 100 {
 101     va_list           ap;
 102     char              staticBuf[1024];
 103     int               length = 1024;
 104     std::vector<char> dynamicBuf;
 105     char             *buf = staticBuf;
 106
 107     // TODO: There may be a better way of doing this on Windows, Microsoft
 108     // provides their own way of doing things...
 109     while (1)
 110     {
 111         va_start(ap, fmt);
 112         int n = vsnprintf(buf, length, fmt, ap);
 113         va_end(ap);
 114         if (n > -1 && n < length)
 115         {
 116             std::string result(buf);
 117             return result;
 118         }
 119         if (n > -1)
 120         {
 121             length = n + 1;
 122         }
 123         else
 124         {
 125             length *= 2;
 126         }
 127         dynamicBuf.resize(length);
 128         buf = &dynamicBuf[0];
 129     }
 130 }
 131
 132 std::vector<std::string> splitString(const std::string &str)
 133 {
 134     std::vector<std::string>          result;
 135     std::string::const_iterator       currPos = str.begin();
 136     const std::string::const_iterator end     = str.end();
 137     while (currPos != end)
 138     {
 139         while (currPos != end && std::isspace(*currPos))
 140         {
 141             ++currPos;
 142         }
 143         const std::string::const_iterator startPos = currPos;
 144         while (currPos != end && !std::isspace(*currPos))
 145         {
 146             ++currPos;
 147         }
 148         if (startPos != end)
 149         {
 150             result.push_back(std::string(startPos, currPos));
 151         }
 152     }
 153     return result;
 154 }
 155
 156 namespace
 157 {
 158
 159 /*! \brief
 160  * Helper function to identify word boundaries for replaceAllWords().
 161  *
 162  * \returns  `true` if the character is considered part of a word.
 163  *
 164  * \ingroup module_utility
 165  */
 166 bool isWordChar(char c)
 167 {
 168     return std::isalnum(c) || c == '-' || c == '_';
 169 }
 170
 171 /*! \brief
 172  * Common implementation for string replacement functions.
 173  *
 174  * \param[in] input  Input string.
 175  * \param[in] from   String to find.
 176  * \param[in] to     String to use to replace \p from.
 177  * \param[in] bWholeWords  Whether to only consider matches to whole words.
 178  * \returns   \p input with all occurrences of \p from replaced with \p to.
 179  * \throws    std::bad_alloc if out of memory.
 180  *
 181  * \ingroup module_utility
 182  */
 183 std::string
 184 replaceInternal(const std::string &input, const char *from, const char *to,
 185                 bool bWholeWords)
 186 {
 187     GMX_RELEASE_ASSERT(from != NULL && to != NULL,
 188                        "Replacement strings must not be NULL");
 189     size_t      matchLength = std::strlen(from);
 190     std::string result;
 191     size_t      inputPos = 0;
 192     size_t      matchPos = input.find(from);
 193     while (matchPos < input.length())
 194     {
 195         size_t matchEnd = matchPos + matchLength;
 196         if (bWholeWords)
 197         {
 198             if (!((matchPos == 0 || !isWordChar(input[matchPos-1]))
 199                   && (matchEnd == input.length() || !isWordChar(input[matchEnd]))))
 200             {
 201                 matchPos = input.find(from, matchPos + 1);
 202                 continue;
 203             }
 204
 205         }
 206         result.append(input, inputPos, matchPos - inputPos);
 207         result.append(to);
 208         inputPos = matchEnd;
 209         matchPos = input.find(from, inputPos);
 210     }
 211     result.append(input, inputPos, matchPos - inputPos);
 212     return result;
 213 }
 214
 215 }   // namespace
 216
 217 std::string
 218 replaceAll(const std::string &input, const char *from, const char *to)
 219 {
 220     return replaceInternal(input, from, to, false);
 221 }
 222
 223 std::string
 224 replaceAll(const std::string &input, const std::string &from,
 225            const std::string &to)
 226 {
 227     return replaceInternal(input, from.c_str(), to.c_str(), false);
 228 }
 229
 230 std::string
 231 replaceAllWords(const std::string &input, const char *from, const char *to)
 232 {
 233     return replaceInternal(input, from, to, true);
 234 }
 235
 236 std::string
 237 replaceAllWords(const std::string &input, const std::string &from,
 238                 const std::string &to)
 239 {
 240     return replaceInternal(input, from.c_str(), to.c_str(), true);
 241 }
 242
 243
 244 /********************************************************************
 245  * TextLineWrapperSettings
 246  */
 247
 248 TextLineWrapperSettings::TextLineWrapperSettings()
 249     : maxLength_(0), indent_(0), firstLineIndent_(-1),
 250       bStripLeadingWhitespace_(false), continuationChar_('\0')
 251 {
 252 }
 253
 254
 255 /********************************************************************
 256  * TextLineWrapper
 257  */
 258
 259 size_t
 260 TextLineWrapper::findNextLine(const char *input, size_t lineStart) const
 261 {
 262     size_t inputLength = std::strlen(input);
 263     bool   bFirstLine  = (lineStart == 0 || input[lineStart - 1] == '\n');
 264     // Ignore leading whitespace if necessary.
 265     if (!bFirstLine || settings_.bStripLeadingWhitespace_)
 266     {
 267         lineStart += std::strspn(input + lineStart, " ");
 268         if (lineStart >= inputLength)
 269         {
 270             return inputLength;
 271         }
 272     }
 273
 274     int    indent = (bFirstLine ? settings_.firstLineIndent() : settings_.indent());
 275     size_t lastAllowedBreakPoint
 276         = (settings_.lineLength() > 0
 277            ? std::min(lineStart + settings_.lineLength() - indent, inputLength)
 278            : inputLength);
 279     // Ignore trailing whitespace.
 280     lastAllowedBreakPoint += std::strspn(input + lastAllowedBreakPoint, " ");
 281     size_t lineEnd = lineStart;
 282     do
 283     {
 284         const char *nextBreakPtr = std::strpbrk(input + lineEnd, " \n");
 285         size_t      nextBreak
 286             = (nextBreakPtr != NULL ? nextBreakPtr - input : inputLength);
 287         if (nextBreak > lastAllowedBreakPoint && lineEnd > lineStart)
 288         {
 289             break;
 290         }
 291         lineEnd = nextBreak + 1;
 292     }
 293     while (lineEnd < lastAllowedBreakPoint && input[lineEnd - 1] != '\n');
 294     return (lineEnd < inputLength ? lineEnd : inputLength);
 295 }
 296
 297 size_t
 298 TextLineWrapper::findNextLine(const std::string &input, size_t lineStart) const
 299 {
 300     return findNextLine(input.c_str(), lineStart);
 301 }
 302
 303 std::string
 304 TextLineWrapper::formatLine(const std::string &input,
 305                             size_t lineStart, size_t lineEnd) const
 306 {
 307     size_t inputLength = input.length();
 308     bool   bFirstLine  = (lineStart == 0 || input[lineStart - 1] == '\n');
 309     // Strip leading whitespace if necessary.
 310     if (!bFirstLine || settings_.bStripLeadingWhitespace_)
 311     {
 312         lineStart = input.find_first_not_of(' ', lineStart);
 313         if (lineStart >= inputLength)
 314         {
 315             return std::string();
 316         }
 317     }
 318     int  indent        = (bFirstLine ? settings_.firstLineIndent() : settings_.indent());
 319     bool bContinuation = (lineEnd < inputLength && input[lineEnd - 1] != '\n');
 320     // Strip trailing whitespace.
 321     while (lineEnd > lineStart && std::isspace(input[lineEnd - 1]))
 322     {
 323         --lineEnd;
 324     }
 325
 326     const size_t lineLength = lineEnd - lineStart;
 327     if (lineLength == 0)
 328     {
 329         return std::string();
 330     }
 331     std::string result(indent, ' ');
 332     result.append(input, lineStart, lineLength);
 333     if (bContinuation && settings_.continuationChar_ != '\0')
 334     {
 335         result.append(1, ' ');
 336         result.append(1, settings_.continuationChar_);
 337     }
 338     return result;
 339 }
 340
 341 std::string
 342 TextLineWrapper::wrapToString(const std::string &input) const
 343 {
 344     std::string result;
 345     size_t      lineStart = 0;
 346     size_t      length    = input.length();
 347     while (lineStart < length)
 348     {
 349         size_t nextLineStart = findNextLine(input, lineStart);
 350         result.append(formatLine(input, lineStart, nextLineStart));
 351         if (nextLineStart < length
 352             || (nextLineStart == length && input[length - 1] == '\n'))
 353         {
 354             result.append("\n");
 355         }
 356         lineStart = nextLineStart;
 357     }
 358     return result;
 359 }
 360
 361 std::vector<std::string>
 362 TextLineWrapper::wrapToVector(const std::string &input) const
 363 {
 364     std::vector<std::string> result;
 365     size_t                   lineStart = 0;
 366     size_t                   length    = input.length();
 367     while (lineStart < length)
 368     {
 369         size_t nextLineStart = findNextLine(input, lineStart);
 370         result.push_back(formatLine(input, lineStart, nextLineStart));
 371         lineStart = nextLineStart;
 372     }
 373     return result;
 374 }
 375
 376 } // namespace gmx