Sort all includes in src/gromacs
[alexxy/gromacs.git] / src / gromacs / utility / stringutil.cpp
index a0cf5c13ab56743bf226de63d5a6bdc19e24e8c3..5b2c725017a6e585b14e9d6d3832f76a58571d8a 100644 (file)
@@ -1,45 +1,51 @@
 /*
+ * This file is part of the GROMACS molecular simulation package.
  *
- *                This source code is part of
+ * Copyright (c) 2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
  *
- *                 G   R   O   M   A   C   S
- *
- *          GROningen MAchine for Chemical Simulations
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
  *
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  *
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
  *
  * To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
  */
 /*! \internal \file
  * \brief
  * Implements functions and classes in stringutil.h.
  *
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
  * \ingroup module_utility
  */
+#include "gmxpre.h"
+
 #include "stringutil.h"
 
 #include <cctype>
-#include <cstdio>
 #include <cstdarg>
+#include <cstdio>
 #include <cstring>
 
 #include <algorithm>
@@ -75,13 +81,28 @@ std::string stripSuffixIfPresent(const std::string &str, const char *suffix)
     return str;
 }
 
+std::string stripString(const std::string &str)
+{
+    std::string::const_iterator start = str.begin();
+    std::string::const_iterator end   = str.end();
+    while (start != end && std::isspace(*start))
+    {
+        ++start;
+    }
+    while (start != end && std::isspace(*(end - 1)))
+    {
+        --end;
+    }
+    return std::string(start, end);
+}
+
 std::string formatString(const char *fmt, ...)
 {
-    va_list ap;
-    char staticBuf[1024];
-    int length = 1024;
+    va_list           ap;
+    char              staticBuf[1024];
+    int               length = 1024;
     std::vector<char> dynamicBuf;
-    char *buf = staticBuf;
+    char             *buf = staticBuf;
 
     // TODO: There may be a better way of doing this on Windows, Microsoft
     // provides their own way of doing things...
@@ -108,6 +129,30 @@ std::string formatString(const char *fmt, ...)
     }
 }
 
+std::vector<std::string> splitString(const std::string &str)
+{
+    std::vector<std::string>          result;
+    std::string::const_iterator       currPos = str.begin();
+    const std::string::const_iterator end     = str.end();
+    while (currPos != end)
+    {
+        while (currPos != end && std::isspace(*currPos))
+        {
+            ++currPos;
+        }
+        const std::string::const_iterator startPos = currPos;
+        while (currPos != end && !std::isspace(*currPos))
+        {
+            ++currPos;
+        }
+        if (startPos != end)
+        {
+            result.push_back(std::string(startPos, currPos));
+        }
+    }
+    return result;
+}
+
 std::string concatenateStrings(const char *const *sarray, size_t count)
 {
     std::string result;
@@ -131,23 +176,47 @@ std::string concatenateStrings(const char *const *sarray, size_t count)
 namespace
 {
 
+/*! \brief
+ * Helper function to identify word boundaries for replaceAllWords().
+ *
+ * \returns  `true` if the character is considered part of a word.
+ *
+ * \ingroup module_utility
+ */
+bool isWordChar(char c)
+{
+    return std::isalnum(c) || c == '-' || c == '_';
+}
+
+/*! \brief
+ * Common implementation for string replacement functions.
+ *
+ * \param[in] input  Input string.
+ * \param[in] from   String to find.
+ * \param[in] to     String to use to replace \p from.
+ * \param[in] bWholeWords  Whether to only consider matches to whole words.
+ * \returns   \p input with all occurrences of \p from replaced with \p to.
+ * \throws    std::bad_alloc if out of memory.
+ *
+ * \ingroup module_utility
+ */
 std::string
 replaceInternal(const std::string &input, const char *from, const char *to,
                 bool bWholeWords)
 {
     GMX_RELEASE_ASSERT(from != NULL && to != NULL,
                        "Replacement strings must not be NULL");
-    size_t matchLength = std::strlen(from);
+    size_t      matchLength = std::strlen(from);
     std::string result;
-    size_t inputPos = 0;
-    size_t matchPos = input.find(from);
+    size_t      inputPos = 0;
+    size_t      matchPos = input.find(from);
     while (matchPos < input.length())
     {
         size_t matchEnd = matchPos + matchLength;
         if (bWholeWords)
         {
-            if (!((matchPos == 0 || !std::isalnum(input[matchPos-1]))
-                  && (matchEnd == input.length() || !std::isalnum(input[matchEnd]))))
+            if (!((matchPos == 0 || !isWordChar(input[matchPos-1]))
+                  && (matchEnd == input.length() || !isWordChar(input[matchEnd]))))
             {
                 matchPos = input.find(from, matchPos + 1);
                 continue;
@@ -163,7 +232,7 @@ replaceInternal(const std::string &input, const char *from, const char *to,
     return result;
 }
 
-} // namespace
+}   // namespace
 
 std::string
 replaceAll(const std::string &input, const char *from, const char *to)
@@ -171,120 +240,136 @@ replaceAll(const std::string &input, const char *from, const char *to)
     return replaceInternal(input, from, to, false);
 }
 
+std::string
+replaceAll(const std::string &input, const std::string &from,
+           const std::string &to)
+{
+    return replaceInternal(input, from.c_str(), to.c_str(), false);
+}
+
 std::string
 replaceAllWords(const std::string &input, const char *from, const char *to)
 {
     return replaceInternal(input, from, to, true);
 }
 
+std::string
+replaceAllWords(const std::string &input, const std::string &from,
+                const std::string &to)
+{
+    return replaceInternal(input, from.c_str(), to.c_str(), true);
+}
+
+
 /********************************************************************
- * TextLineWrapper::Impl
+ * TextLineWrapperSettings
  */
 
-/*! \internal \brief
- * Private implementation class for TextLineWrapper.
- *
- * \ingroup module_utility
- */
-class TextLineWrapper::Impl
+TextLineWrapperSettings::TextLineWrapperSettings()
+    : maxLength_(0), indent_(0), firstLineIndent_(-1),
+      bStripLeadingWhitespace_(true), continuationChar_('\0')
 {
-    public:
-        //! Initialize default values for the wrapper.
-        Impl() : maxLength_(0) {}
-
-        /*! \brief
-         * Helper method to find the next wrapped line.
-         *
-         * \param[in]     input         Full input string.
-         * \param[in,out] lineStartPtr
-         *      Index of first character for the line to wrap.
-         *      On exit, index of the first character of the next line.
-         * \returns   Next output line.
-         */
-        std::string wrapNextLine(const std::string &input,
-                                 size_t *lineStartPtr) const;
-
-        //! Maximum length of output lines, or <= 0 if no limit.
-        int                     maxLength_;
-};
+}
 
-std::string
-TextLineWrapper::Impl::wrapNextLine(const std::string &input,
-                                    size_t *lineStartPtr) const
+
+/********************************************************************
+ * TextLineWrapper
+ */
+
+size_t
+TextLineWrapper::findNextLine(const char *input, size_t lineStart) const
 {
-    // Strip leading whitespace.
-    size_t lineStart = input.find_first_not_of(' ', *lineStartPtr);
-    if (lineStart == std::string::npos)
+    size_t inputLength = std::strlen(input);
+    bool   bFirstLine  = (lineStart == 0 || input[lineStart - 1] == '\n');
+    // Ignore leading whitespace if necessary.
+    if (!bFirstLine || settings_.bStripLeadingWhitespace_)
     {
-        *lineStartPtr = lineStart;
-        return std::string();
+        lineStart += std::strspn(input + lineStart, " ");
+        if (lineStart >= inputLength)
+        {
+            return inputLength;
+        }
     }
 
-    size_t lineEnd = std::string::npos;
-    size_t nextNewline
-        = std::min(input.find('\n', lineStart), input.length());
-    if (maxLength_ <= 0 || nextNewline <= lineStart + maxLength_)
-    {
-        lineEnd = nextNewline;
-    }
-    else
+    int    indent = (bFirstLine ? settings_.firstLineIndent() : settings_.indent());
+    size_t lastAllowedBreakPoint
+        = (settings_.lineLength() > 0
+           ? std::min(lineStart + settings_.lineLength() - indent, inputLength)
+           : inputLength);
+    // Ignore trailing whitespace.
+    lastAllowedBreakPoint += std::strspn(input + lastAllowedBreakPoint, " ");
+    size_t lineEnd = lineStart;
+    do
     {
-        size_t bestSpace = input.rfind(' ', lineStart + maxLength_);
-        if (bestSpace < lineStart || bestSpace == std::string::npos)
+        const char *nextBreakPtr = std::strpbrk(input + lineEnd, " \n");
+        size_t      nextBreak
+            = (nextBreakPtr != NULL ? nextBreakPtr - input : inputLength);
+        if (nextBreak > lastAllowedBreakPoint && lineEnd > lineStart)
         {
-            bestSpace = input.find(' ', lineStart);
+            break;
         }
-        lineEnd = std::min(bestSpace, nextNewline);
+        lineEnd = nextBreak + 1;
     }
+    while (lineEnd < lastAllowedBreakPoint && input[lineEnd - 1] != '\n');
+    return (lineEnd < inputLength ? lineEnd : inputLength);
+}
+
+size_t
+TextLineWrapper::findNextLine(const std::string &input, size_t lineStart) const
+{
+    return findNextLine(input.c_str(), lineStart);
+}
 
-    if (lineEnd == std::string::npos)
+std::string
+TextLineWrapper::formatLine(const std::string &input,
+                            size_t lineStart, size_t lineEnd) const
+{
+    size_t inputLength = input.length();
+    bool   bFirstLine  = (lineStart == 0 || input[lineStart - 1] == '\n');
+    // Strip leading whitespace if necessary.
+    if (!bFirstLine || settings_.bStripLeadingWhitespace_)
     {
-        lineEnd = input.length();
+        lineStart = input.find_first_not_of(' ', lineStart);
+        if (lineStart >= inputLength)
+        {
+            return std::string();
+        }
     }
-    *lineStartPtr = lineEnd + 1;
+    int  indent        = (bFirstLine ? settings_.firstLineIndent() : settings_.indent());
+    bool bContinuation = (lineEnd < inputLength && input[lineEnd - 1] != '\n');
     // Strip trailing whitespace.
     while (lineEnd > lineStart && std::isspace(input[lineEnd - 1]))
     {
         --lineEnd;
     }
 
-    size_t lineLength = lineEnd - lineStart;
-    return input.substr(lineStart, lineLength);
-}
-
-/********************************************************************
- * TextLineWrapper
- */
-
-TextLineWrapper::TextLineWrapper()
-    : impl_(new Impl)
-{
-}
-
-TextLineWrapper::~TextLineWrapper()
-{
-}
-
-TextLineWrapper &TextLineWrapper::setLineLength(int length)
-{
-    impl_->maxLength_ = length;
-    return *this;
+    size_t      lineLength = lineEnd - lineStart;
+    std::string result(indent, ' ');
+    result.append(input, lineStart, lineLength);
+    if (bContinuation && settings_.continuationChar_ != '\0')
+    {
+        result.append(1, ' ');
+        result.append(1, settings_.continuationChar_);
+    }
+    return result;
 }
 
 std::string
 TextLineWrapper::wrapToString(const std::string &input) const
 {
     std::string result;
-    size_t lineStart = 0;
-    size_t length = input.length();
+    size_t      lineStart = 0;
+    size_t      length    = input.length();
     while (lineStart < length)
     {
-        result.append(impl_->wrapNextLine(input, &lineStart));
-        if (lineStart < length
-            || (lineStart == length && input[length - 1] == '\n'))
+        size_t nextLineStart = findNextLine(input, lineStart);
+        result.append(formatLine(input, lineStart, nextLineStart));
+        if (nextLineStart < length
+            || (nextLineStart == length && input[length - 1] == '\n'))
         {
             result.append("\n");
         }
+        lineStart = nextLineStart;
     }
     return result;
 }
@@ -293,10 +378,13 @@ std::vector<std::string>
 TextLineWrapper::wrapToVector(const std::string &input) const
 {
     std::vector<std::string> result;
-    size_t lineStart = 0;
-    while (lineStart < input.length())
+    size_t                   lineStart = 0;
+    size_t                   length    = input.length();
+    while (lineStart < length)
     {
-        result.push_back(impl_->wrapNextLine(input, &lineStart));
+        size_t nextLineStart = findNextLine(input, lineStart);
+        result.push_back(formatLine(input, lineStart, nextLineStart));
+        lineStart = nextLineStart;
     }
     return result;
 }