lib/clean-temp-simple.h

   1 /* Temporary files with automatic cleanup.
   2    Copyright (C) 2006-2024 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2006.
   4
   5    This file is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU Lesser General Public License as
   7    published by the Free Software Foundation; either version 2.1 of the
   8    License, or (at your option) any later version.
   9
  10    This file 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 Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser 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 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25
  26 /* See clean-temp.h for a general discussion of this module.  */
  27
  28 /* Register the given ABSOLUTE_FILE_NAME as being a file that needs to be
  29    removed.
  30    Should be called before the file ABSOLUTE_FILE_NAME is created.
  31    Return 0 upon success, or -1 if there was a memory allocation problem.  */
  32 extern int register_temporary_file (const char *absolute_file_name);
  33
  34 /* Unregister the given ABSOLUTE_FILE_NAME as being a file that needs to be
  35    removed.
  36    Should be called when the file ABSOLUTE_FILE_NAME could not be created.  */
  37 extern void unregister_temporary_file (const char *absolute_file_name);
  38
  39 /* Remove the given ABSOLUTE_FILE_NAME and unregister it.
  40    CLEANUP_VERBOSE determines whether errors are reported to standard error.
  41    Return 0 upon success, or -1 if there was some problem.  */
  42 extern int cleanup_temporary_file (const char *absolute_file_name,
  43                                    bool cleanup_verbose);
  44
  45
  46 #ifdef __cplusplus
  47 }
  48 #endif
  49
  50 #endif /* _CLEAN_TEMP_SIMPLE_H */