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, 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 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53 #if 0
  54 }
  55 #endif
  56
  57 /** Continuation character. */
  58 #define CONTINUE    '\\'
  59 /** Standard size for char* string buffers. */
  60 #define STRLEN 4096
  61
  62 /*! \brief
  63  * Strip trailing spaces and if s ends with a ::CONTINUE remove that too.
  64  *
  65  * \returns TRUE if s ends with a CONTINUE, FALSE otherwise.
  66  */
  67 int continuing(char *s);
  68
  69 /*! \brief
  70  * Reads a line from a stream.
  71  *
  72  * This routine reads a string from stream of max length n, including
  73  * \0 and zero terminated, without newlines.  \p s should be long
  74  * enough (>= \p n)
  75  */
  76 char *fgets2(char *s, int n, FILE *stream);
  77
  78 /** Remove portion of a line after a ';' comment sign.  */
  79 void strip_comment(char *line);
  80
  81 /** Make a string uppercase. */
  82 void upstring(char *str);
  83
  84 /** Remove leading whitespace from a string. */
  85 void ltrim(char *str);
  86
  87 /** Remove trailing whitespace from a string. */
  88 void rtrim(char *str);
  89
  90 /** Remove leading and trailing whitespace from a string. */
  91 void trim(char *str);
  92
  93 /** Version of gmx_strcasecmp() that also ignores '-' and '_'. */
  94 int gmx_strcasecmp_min(const char *str1, const char *str2);
  95 /** Version of gmx_strncasecmp() that also ignores '-' and '_'. */
  96 int gmx_strncasecmp_min(const char *str1, const char *str2, int n);
  97
  98 /** Case-insensitive strcmp(). */
  99 int gmx_strcasecmp(const char *str1, const char *str2);
 100 /** Case-insensitive strncmp(). */
 101 int gmx_strncasecmp(const char *str1, const char *str2, int n);
 102
 103 /** Creates a duplicate of \p src. */
 104 char *gmx_strdup(const char *src);
 105 /** Duplicates first \p n characters of \p src. */
 106 char *gmx_strndup(const char *src, int n);
 107
 108 /*! \brief
 109  * Pattern matching with wildcards.
 110  *
 111  * \param[in] pattern  Pattern to match against.
 112  * \param[in] str      String to match.
 113  * \returns   0 on match, GMX_NO_WCMATCH if there is no match.
 114  *
 115  * Matches \p str against \p pattern, which may contain * and ? wildcards.
 116  * All other characters are matched literally.
 117  * Currently, it is not possible to match literal * or ?.
 118  */
 119 int gmx_wcmatch(const char *pattern, const char *str);
 120
 121 /** Return value for gmx_wcmatch() when there is no match. */
 122 #define GMX_NO_WCMATCH 1
 123
 124 /** Magic hash initialization number from Dan J. Bernstein. */
 125 extern const unsigned int
 126     gmx_string_hash_init;
 127
 128 /*! \brief
 129  * Return a hash of the string according to Dan J. Bernsteins algorithm.
 130  *
 131  * \param[in] s          String to calculate hash for.
 132  * \param[in] hash_init  Initial (or previous) hash value.
 133  * \returns   Updated hash value (hash_init combined with string hash).
 134  *
 135  * On the first invocation for a new string, use the constant
 136  * gmx_string_hash_init for the second argument. If you want to create a hash
 137  * corresponding to several concatenated strings, provide the returned hash
 138  * value as hash_init for the second string, etc.
 139  */
 140 unsigned int
 141 gmx_string_fullhash_func(const char *s, unsigned int hash_init);
 142
 143 /*! \brief
 144  * Return a hash of the string according to Dan J. Bernsteins algorithm.
 145  *
 146  * \param[in] s          String to calculate hash for.
 147  * \param[in] hash_init  Initial (or previous) hash value.
 148  * \returns   Updated hash value (hash_init combined with string hash).
 149  *
 150  * Identical to gmx_string_fullhash_func, except that
 151  * this routine only uses characters for which isalnum(c) is true,
 152  * and all characters are converted to upper case.
 153  */
 154 unsigned int
 155 gmx_string_hash_func(const char *s, unsigned int hash_init);
 156
 157 /*! \brief
 158  * Wraps lines, optionally indenting lines.
 159  *
 160  * Wraps lines at \p linewidth, indenting all following lines by \p indent
 161  * spaces.  A temp buffer is allocated and returned, which can be disposed of
 162  * if no longer needed.
 163  * If \p bIndentFirst is FALSE, then the first line will not be indented, only
 164  * the lines that are created due to wapping.
 165  */
 166 char *wrap_lines(const char *buf, int line_width, int indent,
 167                  gmx_bool bIndentFirst);
 168
 169 /*! \brief
 170  * Convert a string to gmx_int64_t.
 171  *
 172  * This method works as the standard library function strtol(), except that it
 173  * does not support different bases.
 174  */
 175 gmx_int64_t str_to_int64_t(const char *str, char **endptr);
 176
 177 /** Minimum size of buffer to pass to gmx_step_str(). */
 178 #define STEPSTRSIZE 22
 179
 180 /*! \brief
 181  * Prints a gmx_int64_t value in buf and returns the pointer to buf.
 182  *
 183  * buf should be large enough to contain i: STEPSTRSIZE (22) chars.
 184  * When multiple gmx_int64_t values are printed in the same printf call,
 185  * be sure to call gmx_step_str with different buffers.
 186  */
 187 char *gmx_step_str(gmx_int64_t i, char *buf);
 188
 189 #ifdef __cplusplus
 190 }
 191 #endif
 192
 193 #endif