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 <vector>
  23 #include <string>
  24
  25 namespace ARDOUR {
  26
  27 /**
  28  * Attempt to create a backup copy of a file.
  29  *
  30  * A copy of the file is created in the same directory using
  31  * the same filename with the backup suffix appended.
  32  *
  33  * @return true if successful, false otherwise.
  34  */
  35 bool create_backup_file (const std::string & file_path);
  36
  37 /**
  38  * Get the absolute paths to all state files in the directory
  39  * at path directory_path.
  40  *
  41  * @param directory_path The absolute path to a directory.
  42  * @param result vector to contain resulting state files.
  43  */
  44 void get_state_files_in_directory (const std::string& directory_path,
  45                 std::vector<std::string>& result);
  46
  47 /**
  48  * Given a vector of paths to files, return a vector containing
  49  * the filenames without any extension.
  50  *
  51  * @param file_paths a vector containing the file paths
  52  * @return a vector containing a list of file names without any
  53  * filename extension.
  54  */
  55 std::vector<std::string> get_file_names_no_extension (const std::vector<std::string> & file_paths);
  56
  57 } // namespace ARDOUR
  58
  59 #endif