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, 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 /** Comment sign to use. */
  60 #define COMMENTSIGN ';'
  61 /** Standard size for char* string buffers. */
  62 #define STRLEN 4096
  63
  64 /*! \brief
  65  * Strip trailing spaces and if s ends with a ::CONTINUE remove that too.
  66  *
  67  * \returns TRUE if s ends with a CONTINUE, FALSE otherwise.
  68  */
  69 int continuing(char *s);
  70
  71 /*! \brief
  72  * Reads a line from a stream.
  73  *
  74  * This routine reads a string from stream of max length n, including
  75  * \0 and zero terminated, without newlines.  \p s should be long
  76  * enough (>= \p n)
  77  */
  78 char *fgets2(char *s, int n, FILE *stream);
  79
  80 /** Remove portion of a line after a ::COMMENTSIGN.  */
  81 void strip_comment(char *line);
  82
  83 /** Make a string uppercase. */
  84 void upstring(char *str);
  85
  86 /** Remove leading whitespace from a string. */
  87 void ltrim(char *str);
  88
  89 /** Remove trailing whitespace from a string. */
  90 void rtrim(char *str);
  91
  92 /** Remove leading and trailing whitespace from a string. */
  93 void trim(char *str);
  94
  95 /** Prints creation time stamp and user information into a file as comments. */
  96 void nice_header(FILE *out, const char *fn);
  97
  98 /** Version of gmx_strcasecmp() that also ignores '-' and '_'. */
  99 int gmx_strcasecmp_min(const char *str1, const char *str2);
 100 /** Version of gmx_strncasecmp() that also ignores '-' and '_'. */
 101 int gmx_strncasecmp_min(const char *str1, const char *str2, int n);
 102
 103 /** Case-insensitive strcmp(). */
 104 int gmx_strcasecmp(const char *str1, const char *str2);
 105 /** Case-insensitive strncmp(). */
 106 int gmx_strncasecmp(const char *str1, const char *str2, int n);
 107
 108 /** Creates a duplicate of \p src. */
 109 char *gmx_strdup(const char *src);
 110 /** Duplicates first \p n characters of \p src. */
 111 char *gmx_strndup(const char *src, int n);
 112
 113 /*! \brief
 114  * Pattern matching with wildcards.
 115  *
 116  * \param[in] pattern  Pattern to match against.
 117  * \param[in] str      String to match.
 118  * \returns   0 on match, GMX_NO_WCMATCH if there is no match.
 119  *
 120  * Matches \p str against \p pattern, which may contain * and ? wildcards.
 121  * All other characters are matched literally.
 122  * Currently, it is not possible to match literal * or ?.
 123  */
 124 int gmx_wcmatch(const char *pattern, const char *str);
 125
 126 /** Return value for gmx_wcmatch() when there is no match. */
 127 #define GMX_NO_WCMATCH 1
 128
 129 /** Magic hash initialization number from Dan J. Bernstein. */
 130 extern const unsigned int
 131     gmx_string_hash_init;
 132
 133 /*! \brief
 134  * Return a hash of the string according to Dan J. Bernsteins algorithm.
 135  *
 136  * \param[in] s          String to calculate hash for.
 137  * \param[in] hash_init  Initial (or previous) hash value.
 138  * \returns   Updated hash value (hash_init combined with string hash).
 139  *
 140  * On the first invocation for a new string, use the constant
 141  * gmx_string_hash_init for the second argument. If you want to create a hash
 142  * corresponding to several concatenated strings, provide the returned hash
 143  * value as hash_init for the second string, etc.
 144  */
 145 unsigned int
 146 gmx_string_fullhash_func(const char *s, unsigned int hash_init);
 147
 148 /*! \brief
 149  * Return a hash of the string according to Dan J. Bernsteins algorithm.
 150  *
 151  * \param[in] s          String to calculate hash for.
 152  * \param[in] hash_init  Initial (or previous) hash value.
 153  * \returns   Updated hash value (hash_init combined with string hash).
 154  *
 155  * Identical to gmx_string_fullhash_func, except that
 156  * this routine only uses characters for which isalnum(c) is true,
 157  * and all characters are converted to upper case.
 158  */
 159 unsigned int
 160 gmx_string_hash_func(const char *s, unsigned int hash_init);
 161
 162 /*! \brief
 163  * Wraps lines, optionally indenting lines.
 164  *
 165  * Wraps lines at \p linewidth, indenting all following lines by \p indent
 166  * spaces.  A temp buffer is allocated and returned, which can be disposed of
 167  * if no longer needed.
 168  * If \p bIndentFirst is FALSE, then the first line will not be indented, only
 169  * the lines that are created due to wapping.
 170  */
 171 char *wrap_lines(const char *buf, int line_width, int indent,
 172                  gmx_bool bIndentFirst);
 173
 174 /*! \brief
 175  * Convert a string to gmx_int64_t.
 176  *
 177  * This method works as the standard library function strtol(), except that it
 178  * does not support different bases.
 179  */
 180 gmx_int64_t str_to_int64_t(const char *str, char **endptr);
 181
 182 /** Minimum size of buffer to pass to gmx_step_str(). */
 183 #define STEPSTRSIZE 22
 184
 185 /*! \brief
 186  * Prints a gmx_int64_t value in buf and returns the pointer to buf.
 187  *
 188  * buf should be large enough to contain i: STEPSTRSIZE (22) chars.
 189  * When multiple gmx_int64_t values are printed in the same printf call,
 190  * be sure to call gmx_step_str with different buffers.
 191  */
 192 char *gmx_step_str(gmx_int64_t i, char *buf);
 193
 194 /*! \brief Construct an array of digits found in the input string
 195  *
 196  * \param[in]  digitstring  String that must contain only digits
 197  * \param[out] ndigits      Size of return array with the values of the digits
 198  * \param[out] digitlist    Array of digits found in
 199  *                          digitstring. Allocated by this function
 200  *                          with size *ndigits. Calling code is
 201  *                          responsible for deallocation.
 202  *
 203  * If digitstring is NULL, then ndigits is set to zero and digitlist
 204  * to NULL. If digitstring contains a non-digit character, a fatal
 205  * error results.
 206  */
 207 void parse_digits_from_plain_string(const char *digitstring, int *ndigits, int **digitlist);
 208
 209 /*! \brief Construct an array of digits from a comma separated input string
 210  *
 211  * \param[in]  digitstring  String that must contain only digits and commas
 212  * \param[out] ndigits      Size of return array with the values of the digits
 213  * \param[out] digitlist    Array of digits found in
 214  *                          digitstring. Allocated by this function
 215  *                          with size *ndigits. Calling code is
 216  *                          responsible for deallocation.
 217  *
 218  * If digitstring is NULL, then ndigits is set to zero and digitlist
 219  * to NULL. If digitstring contains a non digit-or-comma character, a fatal
 220  * error results.
 221  */
 222 void parse_digits_from_csv_string(const char *digitstring, int *ndigits, int **digitlist);
 223
 224 /*! \brief Construct an array of digits an input string
 225  *
 226  *
 227  * \param[in]  digitstring  String that must contain only digits, or only
 228  *                          digits and commas
 229  * \param[out] ndigits      Size of return array with the values of the digits
 230  * \param[out] digitlist    Array of digits found in
 231  *                          digitstring. Allocated by this function
 232  *                          with size *ndigits. Calling code is
 233  *                          responsible for deallocation.
 234  * If digitstring is NULL, then ndigits is set to zero and digitlist
 235  * to NULL. If digitstring contains a non digit-or-comma character, a fatal
 236  * error results.
 237  */
 238 void parse_digits_from_string(const char *digitstring, int *ndigits, int **digitlist);
 239
 240 #ifdef __cplusplus
 241 }
 242 #endif
 243
 244 #endif