include/yaz/file_glob.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /** \file
  29     \brief File globbing (ala POSIX glob, but simpler)
  30 */
  31
  32 #ifndef YAZ_FILE_GLOB_H
  33 #define YAZ_FILE_GLOB_H
  34
  35 #include <yaz/yconfig.h>
  36 #include <stdio.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 /** \brief file glob handle */
  41 typedef struct glob_res *yaz_glob_res_t;
  42
  43 #define YAZ_FILE_GLOB_FAIL_NOTEXIST 1
  44
  45 /** \brief perform glob
  46     \param pattern glob pattern file spec
  47     \param res returned glob result
  48     \retval 0 OK
  49     \retval -1 ERROR
  50 */
  51 YAZ_EXPORT
  52 int yaz_file_glob(const char *pattern, yaz_glob_res_t *res);
  53
  54 /** \brief perform glob (with flags)
  55     \param pattern glob pattern file spec
  56     \param res returned glob result
  57     \param flags YAZ_FILE_GLOB_.. flags
  58     \retval 0 OK
  59     \retval -1 ERROR
  60 */
  61 YAZ_EXPORT
  62 int yaz_file_glob2(const char *pattern, yaz_glob_res_t *res, unsigned flags);
  63
  64 /** \brief release glob result
  65     \param res pointer to glob result
  66
  67     A value of *res == NULL is allowed. If *res != NULL, then
  68     *res is set to NULL
  69     */
  70 YAZ_EXPORT
  71 void yaz_file_globfree(yaz_glob_res_t *res);
  72
  73 /** \brief return resulting matching file
  74     \param res glob result
  75     \param idx index 0=first, .. N-1 (where N is yaz_file_glob_get_num)
  76     \returns file name or NULL if idx is out-of-range
  77 */
  78 YAZ_EXPORT
  79 const char *yaz_file_glob_get_file(yaz_glob_res_t res, size_t idx);
  80
  81 /** \brief return number of matching files
  82     \param res glob result
  83     \returns number of files
  84 */
  85 YAZ_EXPORT
  86 size_t yaz_file_glob_get_num(yaz_glob_res_t res);
  87
  88 YAZ_END_CDECL
  89
  90 #endif
  91 /*
  92  * Local variables:
  93  * c-basic-offset: 4
  94  * c-file-style: "Stroustrup"
  95  * indent-tabs-mode: nil
  96  * End:
  97  * vim: shiftwidth=4 tabstop=8 expandtab
  98  */
  99