libs/ardour/ardour/session_state_utils.h

   1 /*
   2         Copyright (C) 2007 Tim Mayberry
   3
   4         This program is free software; you can redistribute it and/or modify
   5         it under the terms of the GNU General Public License as published by
   6         the Free Software Foundation; either version 2 of the License, or
   7         (at your option) any later version.
   8
   9         This program is distributed in the hope that it will be useful,
  10         but WITHOUT ANY WARRANTY; without even the implied warranty of
  11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12         GNU General Public License for more details.
  13
  14         You should have received a copy of the GNU General Public License
  15         along with this program; if not, write to the Free Software
  16         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef ARDOUR_SESSION_STATE_UTILS_INCLUDED
  20 #define ARDOUR_SESSION_STATE_UTILS_INCLUDED
  21
  22 #include <pbd/filesystem.h>
  23
  24 namespace ARDOUR {
  25
  26 using namespace PBD;
  27
  28 /**
  29  * Attempt to create a backup copy of a file.
  30  *
  31  * A copy of the file is created in the same directory using
  32  * the same filename with the backup suffix appended.
  33  *
  34  * @return true if successful, false otherwise.
  35  */
  36 bool create_backup_file (const sys::path & file_path);
  37
  38 } // namespace ARDOUR
  39
  40 #endif