Fixing more clang warnings

[gromacs.git] / src / gmxlib / string2.c

/*
 * 
 *                This source code is part of
 * 
 *                 G   R   O   M   A   C   S
 * 
 *          GROningen MAchine for Chemical Simulations
 * 
 *                        VERSION 3.2.0
 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
 * Copyright (c) 2001-2004, The GROMACS development team,
 * check out http://www.gromacs.org for more information.

 * 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.
 * 
 * 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.
 * 
 * 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
 * 
 * And Hey:
 * GROningen Mixture of Alchemy and Childrens' Stories
 */
/* This file is completely threadsafe - keep it that way! */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "gmx_header_config.h"

#ifdef GMX_CRAY_XT3
#undef HAVE_PWD_H
#endif

#include <stdio.h>
#include <ctype.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <time.h>

#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif


#ifdef HAVE_PWD_H
#include <pwd.h>
#endif
#include <time.h>
#include <assert.h>

#include "typedefs.h"
#include "smalloc.h"
#include "gmx_fatal.h"
#include "macros.h"
#include "string2.h"
#include "futil.h"

int continuing(char *s)
/* strip trailing spaces and if s ends with a CONTINUE remove that too.
 * returns TRUE if s ends with a CONTINUE, FALSE otherwise.
 */
{
  int sl;
  assert(s);

  rtrim(s);
  sl = strlen(s);
  if ((sl > 0) && (s[sl-1] == CONTINUE)) {
    s[sl-1] = 0;
    return TRUE;
  }
  else
    return FALSE;
}



char *fgets2(char *line, int n, FILE *stream)
/* This routine reads a string from stream of max length n
 * and zero terminated, without newlines
 * line should be long enough (>= n)
 */
{
  char *c;
  if (fgets(line,n,stream) == NULL) {
    return NULL;
  }
  if ((c=strchr(line,'\n')) != NULL) {
    *c = '\0';
  } else {
    /* A line not ending in a newline can only occur at the end of a file,
     * or because of n being too small.
     * Since both cases occur very infrequently, we can check for EOF.
     */
    if (!gmx_eof(stream)) {
      gmx_fatal(FARGS,"An input file contains a line longer than %d characters, while the buffer passed to fgets2 has size %d. The line starts with: '%20.20s'",n,n,line);
    }
  }
  if ((c=strchr(line,'\r')) != NULL) {
    *c = '\0';
  }

  return line;
}

void strip_comment (char *line)
{
  char *c;

  if (!line)
    return;

  /* search for a comment mark and replace it by a zero */
  if ((c = strchr(line,COMMENTSIGN)) != NULL) 
    (*c) = 0;
}

void upstring (char *str)
{
  int i;

  for (i=0; (i < (int)strlen(str)); i++) 
    str[i] = toupper(str[i]);
}

void ltrim (char *str)
{
  char *tr;
  int i,c;

  if (NULL == str)
    return;

  c = 0;
  while (('\0' != str[c]) && isspace(str[c]))
    c++;
  if (c > 0) 
    {
      for(i=c; ('\0' != str[i]); i++)
        str[i-c] = str[i];
      str[i-c] = '\0';
    }
}

void rtrim (char *str)
{
  int nul;

  if (NULL == str)
    return;

  nul = strlen(str)-1;
  while ((nul > 0) && ((str[nul] == ' ') || (str[nul] == '\t')) ) {
    str[nul] = '\0';
    nul--;
  }
}

void trim (char *str)
{
  ltrim (str);
  rtrim (str);
}

char *
gmx_ctime_r(const time_t *clock,char *buf, int n)
{
    char tmpbuf[STRLEN];
  
#ifdef GMX_NATIVE_WINDOWS
    /* Windows */
    ctime_s( tmpbuf, STRLEN, clock );
#elif (defined(__sun))
    /*Solaris*/
    ctime_r(clock, tmpbuf, n);
#else
    ctime_r(clock,tmpbuf);
#endif
    strncpy(buf,tmpbuf,n-1);
    buf[n-1]='\0';
    
    return buf;
}
          
void nice_header (FILE *out,const char *fn)
{
  const char *unk = "onbekend";
  time_t clock;
  const char *user=unk;
  int    gh;
  uid_t  uid;
  char   buf[256]="";
  char   timebuf[STRLEN];
#ifdef HAVE_PWD_H
  struct passwd *pw;
#endif

  /* Print a nice header above the file */
  time(&clock);
  fprintf (out,"%c\n",COMMENTSIGN);
  fprintf (out,"%c\tFile '%s' was generated\n",COMMENTSIGN,fn ? fn : unk);
  
#ifdef HAVE_PWD_H
  uid = getuid();
  pw  = getpwuid(uid);
  gh  = gethostname(buf,255);
  user= pw->pw_name;
#else
  uid = 0;
  gh  = -1;
#endif
  
  gmx_ctime_r(&clock,timebuf,STRLEN);
  fprintf (out,"%c\tBy user: %s (%d)\n",COMMENTSIGN,
           user ? user : unk,(int) uid);
  fprintf(out,"%c\tOn host: %s\n",COMMENTSIGN,(gh == 0) ? buf : unk);

  fprintf (out,"%c\tAt date: %s",COMMENTSIGN,timebuf);
  fprintf (out,"%c\n",COMMENTSIGN);
}

int gmx_strcasecmp_min(const char *str1, const char *str2)
{
  char ch1,ch2;
  
  do
    {
      do
        ch1=toupper(*(str1++));
      while ((ch1=='-') || (ch1=='_'));
      do 
        ch2=toupper(*(str2++));
      while ((ch2=='-') || (ch2=='_'));
      if (ch1!=ch2) return (ch1-ch2);
    }
  while (ch1);
  return 0; 
}

int gmx_strncasecmp_min(const char *str1, const char *str2, int n)
{
  char ch1,ch2;
  char *stri1, *stri2;

  stri1=(char *)str1;
  stri2=(char *)str2;  
  do
    {
      do
        ch1=toupper(*(str1++));
      while ((ch1=='-') || (ch1=='_'));
      do 
        ch2=toupper(*(str2++));
      while ((ch2=='-') || (ch2=='_'));
      if (ch1!=ch2) return (ch1-ch2);
    }
  while (ch1 && (str1-stri1<n) && (str2-stri2<n));
  return 0; 
}

int gmx_strcasecmp(const char *str1, const char *str2)
{
  char ch1,ch2;
  
  do
    {
      ch1=toupper(*(str1++));
      ch2=toupper(*(str2++));
      if (ch1!=ch2) return (ch1-ch2);
    }
  while (ch1);
  return 0; 
}

int gmx_strncasecmp(const char *str1, const char *str2, int n)
{
  char ch1,ch2;
 
  if(n==0) 
    return 0;

  do
    {
      ch1=toupper(*(str1++));
      ch2=toupper(*(str2++));
      if (ch1!=ch2) return (ch1-ch2);
      n--;
    }
  while (ch1 && n);
  return 0; 
}

char *gmx_strdup(const char *src)
{
  char *dest;

  snew(dest,strlen(src)+1);
  strcpy(dest,src);
  
  return dest;
}

char *
gmx_strndup(const char *src, int n)
{
    int   len;
    char *dest;

    len = strlen(src);
    if (len > n) 
    {
        len = n;
    }
    snew(dest, len+1);
    strncpy(dest, src, len);
    dest[len] = 0;
    return dest;
}

/*!
 * \param[in] pattern  Pattern to match against.
 * \param[in] str      String to match.
 * \returns   0 on match, GMX_NO_WCMATCH if there is no match.
 *
 * Matches \p str against \p pattern, which may contain * and ? wildcards.
 * All other characters are matched literally.
 * Currently, it is not possible to match literal * or ?.
 */
int
gmx_wcmatch(const char *pattern, const char *str)
{
    while (*pattern)
    {
        if (*pattern == '*')
        {
            /* Skip multiple wildcards in a sequence */
            while (*pattern == '*' || *pattern == '?')
            {
                ++pattern;
                /* For ?, we need to check that there are characters left
                 * in str. */
                if (*pattern == '?')
                {
                    if (*str == 0)
                    {
                        return GMX_NO_WCMATCH;
                    }
                    else
                    {
                        ++str;
                    }
                }
            }
            /* If the pattern ends after the star, we have a match */
            if (*pattern == 0)
            {
                return 0;
            }
            /* Match the rest against each possible suffix of str */
            while (*str)
            {
                /* Only do the recursive call if the first character
                 * matches. We don't have to worry about wildcards here,
                 * since we have processed them above. */
                if (*pattern == *str)
                {
                    int rc;
                    /* Match the suffix, and return if a match or an error */
                    rc = gmx_wcmatch(pattern, str);
                    if (rc != GMX_NO_WCMATCH)
                    {
                        return rc;
                    }
                }
                ++str;
            }
            /* If no suffix of str matches, we don't have a match */
            return GMX_NO_WCMATCH;
        }
        else if ((*pattern == '?' && *str != 0) || *pattern == *str)
        {
            ++str;
        }
        else
        {
            return GMX_NO_WCMATCH;
        }
        ++pattern;
    }
    /* When the pattern runs out, we have a match if the string has ended. */
    return (*str == 0) ? 0 : GMX_NO_WCMATCH;
}

char *wrap_lines(const char *buf,int line_width, int indent,gmx_bool bIndentFirst)
{
  char *b2;
  int i,i0,i2,j,b2len,lspace=0,l2space=0;
  gmx_bool bFirst,bFitsOnLine;

  /* characters are copied from buf to b2 with possible spaces changed
   * into newlines and extra space added for indentation.
   * i indexes buf (source buffer) and i2 indexes b2 (destination buffer)
   * i0 points to the beginning of the current line (in buf, source)
   * lspace and l2space point to the last space on the current line
   * bFirst is set to prevent indentation of first line
   * bFitsOnLine says if the first space occurred before line_width, if 
   * that is not the case, we have a word longer than line_width which 
   * will also not fit on the next line, so we might as well keep it on 
   * the current line (where it also won't fit, but looks better)
   */
  
  b2=NULL;
  b2len=strlen(buf)+1+indent;
  snew(b2,b2len);
  i0=i2=0;
  if (bIndentFirst)
    for(i2=0; (i2<indent); i2++)
      b2[i2] = ' ';
  bFirst=TRUE;
  do {
    l2space = -1;
    /* find the last space before end of line */
    for(i=i0; ((i-i0 < line_width) || (l2space==-1)) && (buf[i]); i++) {
      b2[i2++] = buf[i];
      /* remember the position of a space */
      if (buf[i] == ' ') {
        lspace = i;
        l2space = i2-1;
      }
      /* if we have a newline before the line is full, reset counters */
      if (buf[i]=='\n' && buf[i+1]) { 
        i0=i+1;
        b2len+=indent;
        srenew(b2, b2len);
        /* add indentation after the newline */
        for(j=0; (j<indent); j++)
          b2[i2++]=' ';
      }
    }
    /* If we are at the last newline, copy it */
    if (buf[i]=='\n' && !buf[i+1]) {
      b2[i2++] = buf[i++];
    }
    /* if we're not at the end of the string */
    if (buf[i]) {
      /* check if one word does not fit on the line */
      bFitsOnLine = (i-i0 <= line_width);
      /* reset line counters to just after the space */
      i0 = lspace+1;
      i2 = l2space+1;
      /* if the words fit on the line, and we're beyond the indentation part */
      if ( (bFitsOnLine) && (l2space >= indent) ) {
        /* start a new line */
        b2[l2space] = '\n';
        /* and add indentation */
        if (indent) {
          if (bFirst) {
            line_width-=indent;
            bFirst=FALSE;
          }
          b2len+=indent;
          srenew(b2, b2len);
          for(j=0; (j<indent); j++)
            b2[i2++]=' ';
          /* no extra spaces after indent; */
          while(buf[i0]==' ')
            i0++;
        }
      }
    }
  } while (buf[i]);
  b2[i2] = '\0';
  
  return b2;
}

char **split(char sep,char *str)
{
  char **ptr = NULL;
  int  n,nn,nptr = 0;
  
  if (str == NULL)
    return NULL;
  nn = strlen(str);
  for(n=0; (n<nn); n++)
    if (str[n] == sep)
      nptr++;
  snew(ptr,nptr+2);
  nptr = 0;
  while (*str != '\0') {
    while ((*str != '\0') && (*str == sep))
      str++;
    if (*str != '\0') {
      snew(ptr[nptr],1+strlen(str));
      n = 0;
      while ((*str != '\0') && (*str != sep)) {
        ptr[nptr][n] = *str;
        str++;
        n++;
      }
      ptr[nptr][n] = '\0';
      nptr++;
    }
  }
  ptr[nptr] = NULL;
  
  return ptr;
}


gmx_large_int_t
str_to_large_int_t(const char *str, char **endptr)
{
        int         sign = 1;
        gmx_large_int_t  val  = 0;
        char        ch;
        const char  *p;
        
        p = str;
        if(p==NULL)
        {
                *endptr=NULL;
                return 0;
        }
        
        /* Strip off initial white space */
        while(isspace(*p))
        {
                p++;
        }
        /* Conform to ISO C99 - return original pointer if string does not contain a number */
        if(*str=='\0')
        {
                *endptr=(char *)str;
        }
        
        if(*p=='-')
        {
                p++;
                sign *= -1;
        }
        
        while( ((ch=*p) != '\0') && isdigit(ch) )
        {
                /* Important to add sign here, so we dont overflow in final multiplication */
                ch = (ch-'0')*sign; 
                val = val*10 + ch;
                if(ch != val%10) 
                {
                        /* Some sort of overflow has occured, set endptr to original string */
                        *endptr=(char *)str;
                        errno = ERANGE;
                        return(0);
                }
                p++;
        }
        
        *endptr=(char *)p;
        
        return val;
}

char *gmx_strsep(char **stringp, const char *delim)
{
    char *ret;
    int len=strlen(delim);
    int i,j=0;
    int found=0;

    if (! *stringp)
        return NULL;
    ret=*stringp;
    do
    {
        if ( (*stringp)[j] == '\0')
        {
            found=1;
            *stringp=NULL;
            break;
        }
        for (i=0;i<len;i++)
        {
            if ( (*stringp)[j]==delim[i])
            {
                (*stringp)[j]='\0';
                *stringp=*stringp+j+1;
                found=1;
                break;
            }
        }
        j++;
    } while (!found);

    return ret;
}