cpl_csv.h

00001 /******************************************************************************
00002  * $Id: cpl_csv.h,v 1.4 2006/03/21 20:11:54 fwarmerdam Exp $
00003  *
00004  * Project:  Common Portability Library
00005  * Purpose:  Functions for reading and scaning CSV (comma separated,
00006  *           variable length text files holding tables) files.  
00007  * Author:   Frank Warmerdam, warmerdam@pobox.com
00008  *
00009  ******************************************************************************
00010  * Copyright (c) 1999, Frank Warmerdam
00011  *
00012  * Permission is hereby granted, free of charge, to any person obtaining a
00013  * copy of this software and associated documentation files (the "Software"),
00014  * to deal in the Software without restriction, including without limitation
00015  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00016  * and/or sell copies of the Software, and to permit persons to whom the
00017  * Software is furnished to do so, subject to the following conditions:
00018  *
00019  * The above copyright notice and this permission notice shall be included
00020  * in all copies or substantial portions of the Software.
00021  *
00022  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00023  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00024  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
00025  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00026  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
00027  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
00028  * DEALINGS IN THE SOFTWARE.
00029  ******************************************************************************
00030  *
00031  * $Log: cpl_csv.h,v $
00032  * Revision 1.4  2006/03/21 20:11:54  fwarmerdam
00033  * fixup headers a bit
00034  *
00035  * Revision 1.3  2005/11/08 15:29:11  fwarmerdam
00036  * DLL export CSVGetField.
00037  *
00038  * Revision 1.2  2003/06/27 16:14:22  warmerda
00039  * export CSV functions with CPL_DLL
00040  *
00041  * Revision 1.1  2000/04/05 21:55:59  warmerda
00042  * New
00043  *
00044  */
00045 
00046 #ifndef CPL_CSV_H_INCLUDED
00047 #define CPL_CSV_H_INCLUDED
00048 
00049 #include "cpl_conv.h"
00050 #include "cpl_string.h"
00051 #include "cpl_vsi.h"
00052 
00053 CPL_C_START
00054 
00055 typedef enum {
00056     CC_ExactString,
00057     CC_ApproxString,
00058     CC_Integer
00059 } CSVCompareCriteria;
00060 
00061 const char CPL_DLL *CSVFilename( const char * );
00062 
00063 char CPL_DLL  **CSVReadParseLine( FILE * );
00064 char CPL_DLL **CSVScanLines( FILE *, int, const char *, CSVCompareCriteria );
00065 char CPL_DLL **CSVScanFile( const char *, int, const char *,
00066                             CSVCompareCriteria );
00067 char CPL_DLL **CSVScanFileByName( const char *, const char *, const char *,
00068                                   CSVCompareCriteria );
00069 int CPL_DLL CSVGetFieldId( FILE *, const char * );
00070 int CPL_DLL CSVGetFileFieldId( const char *, const char * );
00071 
00072 void CPL_DLL CSVDeaccess( const char * );
00073 
00074 const char CPL_DLL *CSVGetField( const char *, const char *, const char *,
00075                                  CSVCompareCriteria, const char * );
00076 
00077 void CPL_DLL SetCSVFilenameHook( const char *(*)(const char *) );
00078 
00079 CPL_C_END
00080 
00081 #endif /* ndef CPL_CSV_H_INCLUDED */
00082 

Generated for GDAL by doxygen 1.5.1.