lib/backupfile.h

   1 /* backupfile.h -- declarations for making Emacs style backup file names
   2
   3    Copyright (C) 1990-1992, 1997-1999, 2003-2004, 2009-2020 Free Software
   4    Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef BACKUPFILE_H_
  20 #define BACKUPFILE_H_
  21
  22 #include <fcntl.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28
  29 /* When to make backup files. */
  30 enum backup_type
  31 {
  32   /* Never make backups. */
  33   no_backups,
  34
  35   /* Make simple backups of every file. */
  36   simple_backups,
  37
  38   /* Make numbered backups of files that already have numbered backups,
  39      and simple backups of the others. */
  40   numbered_existing_backups,
  41
  42   /* Make numbered backups of every file. */
  43   numbered_backups
  44 };
  45
  46 #define VALID_BACKUP_TYPE(Type) \
  47   ((unsigned int) (Type) <= numbered_backups)
  48
  49 extern char const *simple_backup_suffix;
  50
  51 void set_simple_backup_suffix (char const *);
  52 char *backup_file_rename (int, char const *, enum backup_type);
  53 char *find_backup_file_name (int, char const *, enum backup_type);
  54 enum backup_type get_version (char const *context, char const *arg);
  55 enum backup_type xget_version (char const *context, char const *arg);
  56
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif /* ! BACKUPFILE_H_ */