lib/clean-temp-simple.h

   1 /* Temporary files with automatic cleanup.
   2    Copyright (C) 2006-2021 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2006.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _CLEAN_TEMP_SIMPLE_H
  19 #define _CLEAN_TEMP_SIMPLE_H
  20
  21 #include <stdbool.h>
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27
  28 /* See clean-temp.h for a general discussion of this module.  */
  29
  30 /* Register the given ABSOLUTE_FILE_NAME as being a file that needs to be
  31    removed.
  32    Should be called before the file ABSOLUTE_FILE_NAME is created.
  33    Return 0 upon success, or -1 if there was a memory allocation problem.  */
  34 extern int register_temporary_file (const char *absolute_file_name);
  35
  36 /* Unregister the given ABSOLUTE_FILE_NAME as being a file that needs to be
  37    removed.
  38    Should be called when the file ABSOLUTE_FILE_NAME could not be created.  */
  39 extern void unregister_temporary_file (const char *absolute_file_name);
  40
  41 /* Remove the given ABSOLUTE_FILE_NAME and unregister it.
  42    CLEANUP_VERBOSE determines whether errors are reported to standard error.
  43    Return 0 upon success, or -1 if there was some problem.  */
  44 extern int cleanup_temporary_file (const char *absolute_file_name,
  45                                    bool cleanup_verbose);
  46
  47
  48 #ifdef __cplusplus
  49 }
  50 #endif
  51
  52 #endif /* _CLEAN_TEMP_SIMPLE_H */