WordN.c

Go to the documentation of this file.

/************************************************************************/
/**

   \file       WordN.c
   
   \version    V1.21
   \date       07.07.14
   \brief      
   
   \copyright  (c) Dr. Andrew C. R. Martin, University of Reading, 2002-14
   \author     Dr. Andrew C. R. Martin
   \par
               Institute of Structural & Molecular Biology,
               University College London,
               Gower Street,
               London.
               WC1E 6BT.
   \par
               andrew@bioinf.org.uk
               andrew.martin@ucl.ac.uk
               
**************************************************************************

   This code is NOT IN THE PUBLIC DOMAIN, but it may be copied
   according to the conditions laid out in the accompanying file
   COPYING.DOC.

   The code may be modified as required, but any modifications must be
   documented so that the person responsible can be identified.

   The code may not be sold commercially or included as part of a 
   commercial product except as described in the file COPYING.DOC.

**************************************************************************

   Description:
   ============


**************************************************************************

   Usage:
   ======

**************************************************************************

   Revision History:
   =================
-  V1.1  08.02.91 Added KillLine()
-  V1.2  10.02.91 Added setextn() and index()
-  V1.3  20.03.91 Added Word()
-  V1.4  28.05.92 ANSIed
-  V1.5  22.06.92 Added tab check to Word(). Improved setextn().
                  Added WordN(). Documented other routines.
-  V1.6  27.07.93 Corrected fsscanf() for double precision
-  V1.7  07.10.93 Checks made on case before toupper()/tolower()
                  for SysV compatibility. Also index() becomes
                  chindex()
-  V1.8  18.03.94 getc() -> fgetc()
-  V1.9  11.05.94 Added GetFilestem(), upstrcmp(), upstrncmp() &
                  GetWord()
-  V1.10 24.08.94 Added OpenStdFiles()
-  V1.11 08.03.95 Corrected OpenFile() for non-UNIX
-  V1.12 09.03.95 Added check on non-NULL filename in OpenFile()
-  V1.13 17.07.95 Added countchar()
-  V1.14 18.10.95 Moved YorN() to WindIO.c
-  V1.15 06.11.95 Added StoreString(), InStringList() and FreeStringList()
-  V1.16 22.11.95 Moved ftostr() to generam.c
-  V1.17 15.12.95 Added QueryStrStr()
-  V1.18 18.12.95 OpenStdFiles() treats filename of - as stdin/stdout
-  V1.19 05.02.96 OpenStdFiles() allows NULL pointers instead if filenames
-  V1.20 18.09.96 Added padchar()
-  V1.22 07.07.14 Use bl prefix for functions By: CTP

*************************************************************************/
/* Doxygen
   -------
   #GROUP    General Programming
   #SUBGROUP String handling
   #FUNCTION  blWordN()
   Removes leading spaces and extracts a space/tab delimited word. A 
   maximum of MaxChar characters will be copied into the word.
*/
/************************************************************************/
/* Includes
*/
#include <string.h>
#include "macros.h"

/************************************************************************/
/* Defines and macros
*/

/************************************************************************/
/* Globals
*/

/************************************************************************/
/* Prototypes
*/


/************************************************************************/
/*>void blWordN(char *string1, char *string2, int MaxChar)
   -------------------------------------------------------
*//**

   \param[in]     *string1       A string
   \param[in]     MaxChar        Max characters to copy
   \param[out]    *string2       A new string

   Removes leading spaces and extracts a space/tab delimited word. A 
   maximum of MaxChar characters will be copied into the word. If 
   necessary a terminating NULL will be added *after* MaxChar other 
   characters. Thus MaxChar should always be at least 1 smaller than the 
   size of string2.

-  22.06.92 Original based on Word()
-  29.03.01 Changed to use KILLLEADSPACES() macro
-  07.07.14 Use bl prefix for functions By: CTP
*/
void blWordN(char  *string1,
             char  *string2,
             int   MaxChar)
{
   int j;
   char *str;
   
   KILLLEADSPACES(str, string1);
   strncpy(string2,str,MaxChar);
   string2[MaxChar] = '\0';
   
   for(j=0; j<strlen(string2); j++)
   {
      if(string2[j] == ' ' || string2[j] == '\t')
      {
         string2[j] = '\0';
         break;
      }
   }
}