src/gromacs/utility/cstringutil.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2012,2013,2014,2015,2017,2018, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \file
  38  * \brief Generic C string handling functions.
  39  *
  40  * \inpublicapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_CSTRINGUTIL_H
  44 #define GMX_UTILITY_CSTRINGUTIL_H
  45
  46 #include <stdio.h>
  47
  48 #include "gromacs/utility/basedefinitions.h"
  49
  50 /** Continuation character. */
  51 #define CONTINUE    '\\'
  52 /** Standard size for char* string buffers. */
  53 #define STRLEN 4096
  54
  55 /*! \brief
  56  * Strip trailing spaces and if s ends with a ::CONTINUE remove that too.
  57  *
  58  * \returns TRUE if s ends with a CONTINUE, FALSE otherwise.
  59  */
  60 int continuing(char *s);
  61
  62 /*! \brief
  63  * Reads a line from a stream.
  64  *
  65  * This routine reads a string from stream of max length n, including
  66  * \0 and zero terminated, without newlines.  \p s should be long
  67  * enough (>= \p n)
  68  */
  69 char *fgets2(char *s, int n, FILE *stream);
  70
  71 /** Remove portion of a line after a ';' comment sign.  */
  72 void strip_comment(char *line);
  73
  74 /** Make a string uppercase. */
  75 void upstring(char *str);
  76
  77 /** Remove leading whitespace from a string. */
  78 void ltrim(char *str);
  79
  80 /** Remove trailing whitespace from a string. */
  81 void rtrim(char *str);
  82
  83 /** Remove leading and trailing whitespace from a string. */
  84 void trim(char *str);
  85
  86 /** Version of gmx_strcasecmp() that also ignores '-' and '_'. */
  87 int gmx_strcasecmp_min(const char *str1, const char *str2);
  88 /** Version of gmx_strncasecmp() that also ignores '-' and '_'. */
  89 int gmx_strncasecmp_min(const char *str1, const char *str2, int n);
  90
  91 /** Case-insensitive strcmp(). */
  92 int gmx_strcasecmp(const char *str1, const char *str2);
  93 /** Case-insensitive strncmp(). */
  94 int gmx_strncasecmp(const char *str1, const char *str2, int n);
  95
  96 /** Creates a duplicate of \p src. */
  97 char *gmx_strdup(const char *src);
  98 /** Duplicates first \p n characters of \p src. */
  99 char *gmx_strndup(const char *src, int n);
 100
 101 /*! \brief
 102  * Pattern matching with wildcards.
 103  *
 104  * \param[in] pattern  Pattern to match against.
 105  * \param[in] str      String to match.
 106  * \returns   0 on match, GMX_NO_WCMATCH if there is no match.
 107  *
 108  * Matches \p str against \p pattern, which may contain * and ? wildcards.
 109  * All other characters are matched literally.
 110  * Currently, it is not possible to match literal * or ?.
 111  */
 112 int gmx_wcmatch(const char *pattern, const char *str);
 113
 114 /** Return value for gmx_wcmatch() when there is no match. */
 115 #define GMX_NO_WCMATCH 1
 116
 117 /** Magic hash initialization number from Dan J. Bernstein. */
 118 extern const unsigned int
 119     gmx_string_hash_init;
 120
 121 /*! \brief
 122  * Return a hash of the string according to Dan J. Bernsteins algorithm.
 123  *
 124  * \param[in] s          String to calculate hash for.
 125  * \param[in] hash_init  Initial (or previous) hash value.
 126  * \returns   Updated hash value (hash_init combined with string hash).
 127  *
 128  * On the first invocation for a new string, use the constant
 129  * gmx_string_hash_init for the second argument. If you want to create a hash
 130  * corresponding to several concatenated strings, provide the returned hash
 131  * value as hash_init for the second string, etc.
 132  */
 133 unsigned int
 134 gmx_string_fullhash_func(const char *s, unsigned int hash_init);
 135
 136 /*! \brief
 137  * Return a hash of the string according to Dan J. Bernsteins algorithm.
 138  *
 139  * \param[in] s          String to calculate hash for.
 140  * \param[in] hash_init  Initial (or previous) hash value.
 141  * \returns   Updated hash value (hash_init combined with string hash).
 142  *
 143  * Identical to gmx_string_fullhash_func, except that
 144  * this routine only uses characters for which isalnum(c) is true,
 145  * and all characters are converted to upper case.
 146  */
 147 unsigned int
 148 gmx_string_hash_func(const char *s, unsigned int hash_init);
 149
 150 /*! \brief
 151  * Wraps lines, optionally indenting lines.
 152  *
 153  * Wraps lines at \p linewidth, indenting all following lines by \p indent
 154  * spaces.  A temp buffer is allocated and returned, which can be disposed of
 155  * if no longer needed.
 156  * If \p bIndentFirst is FALSE, then the first line will not be indented, only
 157  * the lines that are created due to wapping.
 158  */
 159 char *wrap_lines(const char *buf, int line_width, int indent,
 160                  gmx_bool bIndentFirst);
 161
 162 /*! \brief
 163  * Convert a string to int64_t.
 164  *
 165  * This method works as the standard library function strtol(), except that it
 166  * does not support different bases.
 167  */
 168 int64_t str_to_int64_t(const char *str, char **endptr);
 169
 170 /** Minimum size of buffer to pass to gmx_step_str(). */
 171 #define STEPSTRSIZE 22
 172
 173 /*! \brief
 174  * Prints a int64_t value in buf and returns the pointer to buf.
 175  *
 176  * buf should be large enough to contain i: STEPSTRSIZE (22) chars.
 177  * When multiple int64_t values are printed in the same printf call,
 178  * be sure to call gmx_step_str with different buffers.
 179  */
 180 char *gmx_step_str(int64_t i, char *buf);
 181
 182 #endif