git.sesse.net Git - casparcg/blob - dependencies64/cef/linux/include/capi/cef_file_util_capi.h

   1 // Copyright (c) 2017 Marshall A. Greenblatt. All rights reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // 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
  10 // copyright notice, this list of conditions and the following disclaimer
  11 // in the documentation and/or other materials provided with the
  12 // distribution.
  13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
  14 // Framework nor the names of its contributors may be used to endorse
  15 // or promote products derived from this software without specific prior
  16 // written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // ---------------------------------------------------------------------------
  31 //
  32 // This file was generated by the CEF translator tool and should not edited
  33 // by hand. See the translator.README.txt file in the tools directory for
  34 // more information.
  35 //
  36
  37 #ifndef CEF_INCLUDE_CAPI_CEF_FILE_UTIL_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_FILE_UTIL_CAPI_H_
  39 #pragma once
  40
  41 #include "include/capi/cef_base_capi.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 ///
  49 // Creates a directory and all parent directories if they don't already exist.
  50 // Returns true (1) on successful creation or if the directory already exists.
  51 // The directory is only readable by the current user. Calling this function on
  52 // the browser process UI or IO threads is not allowed.
  53 ///
  54 CEF_EXPORT int cef_create_directory(const cef_string_t* full_path);
  55
  56 ///
  57 // Get the temporary directory provided by the system.
  58 //
  59 // WARNING: In general, you should use the temp directory variants below instead
  60 // of this function. Those variants will ensure that the proper permissions are
  61 // set so that other users on the system can't edit them while they're open
  62 // (which could lead to security issues).
  63 ///
  64 CEF_EXPORT int cef_get_temp_directory(cef_string_t* temp_dir);
  65
  66 ///
  67 // Creates a new directory. On Windows if |prefix| is provided the new directory
  68 // name is in the format of "prefixyyyy". Returns true (1) on success and sets
  69 // |new_temp_path| to the full path of the directory that was created. The
  70 // directory is only readable by the current user. Calling this function on the
  71 // browser process UI or IO threads is not allowed.
  72 ///
  73 CEF_EXPORT int cef_create_new_temp_directory(const cef_string_t* prefix,
  74     cef_string_t* new_temp_path);
  75
  76 ///
  77 // Creates a directory within another directory. Extra characters will be
  78 // appended to |prefix| to ensure that the new directory does not have the same
  79 // name as an existing directory. Returns true (1) on success and sets |new_dir|
  80 // to the full path of the directory that was created. The directory is only
  81 // readable by the current user. Calling this function on the browser process UI
  82 // or IO threads is not allowed.
  83 ///
  84 CEF_EXPORT int cef_create_temp_directory_in_directory(
  85     const cef_string_t* base_dir, const cef_string_t* prefix,
  86     cef_string_t* new_dir);
  87
  88 ///
  89 // Returns true (1) if the given path exists and is a directory. Calling this
  90 // function on the browser process UI or IO threads is not allowed.
  91 ///
  92 CEF_EXPORT int cef_directory_exists(const cef_string_t* path);
  93
  94 ///
  95 // Deletes the given path whether it's a file or a directory. If |path| is a
  96 // directory all contents will be deleted.  If |recursive| is true (1) any sub-
  97 // directories and their contents will also be deleted (equivalent to executing
  98 // "rm -rf", so use with caution). On POSIX environments if |path| is a symbolic
  99 // link then only the symlink will be deleted. Returns true (1) on successful
 100 // deletion or if |path| does not exist. Calling this function on the browser
 101 // process UI or IO threads is not allowed.
 102 ///
 103 CEF_EXPORT int cef_delete_file(const cef_string_t* path, int recursive);
 104
 105 ///
 106 // Writes the contents of |src_dir| into a zip archive at |dest_file|. If
 107 // |include_hidden_files| is true (1) files starting with "." will be included.
 108 // Returns true (1) on success.  Calling this function on the browser process UI
 109 // or IO threads is not allowed.
 110 ///
 111 CEF_EXPORT int cef_zip_directory(const cef_string_t* src_dir,
 112     const cef_string_t* dest_file, int include_hidden_files);
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif
 117
 118 #endif  // CEF_INCLUDE_CAPI_CEF_FILE_UTIL_CAPI_H_