Utilities/cmcurl/lib/wildcard.h

   1 #ifndef HEADER_CURL_WILDCARD_H
   2 #define HEADER_CURL_WILDCARD_H
   3 /***************************************************************************
   4  *                                  _   _ ____  _
   5  *  Project                     ___| | | |  _ \| |
   6  *                             / __| | | | |_) | |
   7  *                            | (__| |_| |  _ <| |___
   8  *                             \___|\___/|_| \_\_____|
   9  *
  10  * Copyright (C) 2010 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
  11  *
  12  * This software is licensed as described in the file COPYING, which
  13  * you should have received as part of this distribution. The terms
  14  * are also available at https://curl.se/docs/copyright.html.
  15  *
  16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17  * copies of the Software, and permit persons to whom the Software is
  18  * furnished to do so, under the terms of the COPYING file.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ***************************************************************************/
  24
  25 #include "curl_setup.h"
  26
  27 #ifndef CURL_DISABLE_FTP
  28 #include "llist.h"
  29
  30 /* list of wildcard process states */
  31 typedef enum {
  32   CURLWC_CLEAR = 0,
  33   CURLWC_INIT = 1,
  34   CURLWC_MATCHING, /* library is trying to get list of addresses for
  35                       downloading */
  36   CURLWC_DOWNLOADING,
  37   CURLWC_CLEAN, /* deallocate resources and reset settings */
  38   CURLWC_SKIP,  /* skip over concrete file */
  39   CURLWC_ERROR, /* error cases */
  40   CURLWC_DONE   /* if is wildcard->state == CURLWC_DONE wildcard loop
  41                    will end */
  42 } wildcard_states;
  43
  44 typedef void (*wildcard_dtor)(void *ptr);
  45
  46 /* struct keeping information about wildcard download process */
  47 struct WildcardData {
  48   wildcard_states state;
  49   char *path; /* path to the directory, where we trying wildcard-match */
  50   char *pattern; /* wildcard pattern */
  51   struct Curl_llist filelist; /* llist with struct Curl_fileinfo */
  52   void *protdata; /* pointer to protocol specific temporary data */
  53   wildcard_dtor dtor;
  54   void *customptr;  /* for CURLOPT_CHUNK_DATA pointer */
  55 };
  56
  57 CURLcode Curl_wildcard_init(struct WildcardData *wc);
  58 void Curl_wildcard_dtor(struct WildcardData *wc);
  59
  60 struct Curl_easy;
  61
  62 #else
  63 /* FTP is disabled */
  64 #define Curl_wildcard_dtor(x)
  65 #endif
  66
  67 #endif /* HEADER_CURL_WILDCARD_H */