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 - 2022, 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  * SPDX-License-Identifier: curl
  24  *
  25  ***************************************************************************/
  26
  27 #include "curl_setup.h"
  28
  29 #ifndef CURL_DISABLE_FTP
  30 #include <curl/curl.h>
  31 #include "llist.h"
  32
  33 /* list of wildcard process states */
  34 typedef enum {
  35   CURLWC_CLEAR = 0,
  36   CURLWC_INIT = 1,
  37   CURLWC_MATCHING, /* library is trying to get list of addresses for
  38                       downloading */
  39   CURLWC_DOWNLOADING,
  40   CURLWC_CLEAN, /* deallocate resources and reset settings */
  41   CURLWC_SKIP,  /* skip over concrete file */
  42   CURLWC_ERROR, /* error cases */
  43   CURLWC_DONE   /* if is wildcard->state == CURLWC_DONE wildcard loop
  44                    will end */
  45 } wildcard_states;
  46
  47 typedef void (*wildcard_dtor)(void *ptr);
  48
  49 /* struct keeping information about wildcard download process */
  50 struct WildcardData {
  51   wildcard_states state;
  52   char *path; /* path to the directory, where we trying wildcard-match */
  53   char *pattern; /* wildcard pattern */
  54   struct Curl_llist filelist; /* llist with struct Curl_fileinfo */
  55   void *protdata; /* pointer to protocol specific temporary data */
  56   wildcard_dtor dtor;
  57   void *customptr;  /* for CURLOPT_CHUNK_DATA pointer */
  58 };
  59
  60 CURLcode Curl_wildcard_init(struct WildcardData *wc);
  61 void Curl_wildcard_dtor(struct WildcardData *wc);
  62
  63 struct Curl_easy;
  64
  65 #else
  66 /* FTP is disabled */
  67 #define Curl_wildcard_dtor(x)
  68 #endif
  69
  70 #endif /* HEADER_CURL_WILDCARD_H */