// This file is part of AspectC++.
// Copyright (C) 1999-2015  The AspectC++ developer team.
//                                                                
// This program is free software;  you can redistribute it and/or 
// modify it under the terms of the GNU General Public License as 
// published by the Free Software Foundation; either version 2 of 
// the License, or (at your option) any later version.            
//                                                                
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of 
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
// GNU General Public License for more details.                   
//                                                                
// You should have received a copy of the GNU General Public      
// License along with this program; if not, write to the Free     
// Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
// MA  02111-1307  USA                                            

#ifndef ACBASE_SysCall_H
#define ACBASE_SysCall_H

/** \file
 * Encapsulation of system dependent file system operations. */

// System includes
#include <ctime>
#include <filesystem>

namespace ACBase {

class ErrorStream;

/** SysCall
 * Encapsulates system dependent file system operations. */

namespace SysCall {

  // TODO: avoid duplicated functionality: dos/unit conversion + canonical

  void printerror(ErrorStream *err, const char *cmd, const char *path = (const char *) 0);
  void printerror(ErrorStream *err, const char *cmd, int fd);

  /** Create a temporary file name, needs to be freed by the caller.
   * \param prefix The file name prefix.
   * \param err Optional error reporting stream.
   * \return path to the created file or empty string in case of error */
  std::string mktemp(const std::string &prefix, ErrorStream *err = (ErrorStream *) 0);

  // get the UNIX modification time of a file
  // returns 'false' on any error, otherwise result will be set
  // If a message should be printed in case of an error, pass 'err'
  bool file_modification_time(const std::filesystem::path &file, std::time_t &result, ErrorStream *err = nullptr);

  // create the specified directory hierarchy; return false on error
  bool make_directory_hierarchy(const std::filesystem::path &dir);

#if defined (WIN32)
  // replace all '\' in a string (filename path) with '/'
  void make_unix_path(std::string &path);
#endif

  // build a canonical representation of a file path
  // - the resulting path is absolute and contains neither ".", "..", nor soft links
  // - on Windows all '\' are replace by '/'
  // If 'weakly' is true, the file doesn't have to exist, only its directory
  // returns 'false' on any error, e.g. file does not exist
  bool make_canonical_path(const std::filesystem::path &path, std::string &result, bool weakly = false);

};

} // namespace ACBase

#endif /* ACBASE_SysCall_H */