file_util.h

// -*-c++-*-
#ifndef STORMM_FILE_UTIL_H
#define STORMM_FILE_UTIL_H
 
#include <fstream>
#include <iostream>
#include <string>
#include "copyright.h"
#include "Constants/behavior.h"
#include "Parsing/textfile.h"
#include "Topology/atomgraph_enumerators.h"
#include "Trajectory/trajectory_enumerators.h"
#include "file_enumerators.h"
 
namespace stormm {
namespace diskutil {
 
using constants::ExceptionResponse;
using parse::TextFile;
using topology::TopologyKind;
using trajectory::CoordinateFileKind;
  
const char default_amber_crd_extension[] = "crd";
const char default_amber_inpcrd_extension[] = "inpcrd";
const char default_amber_ascii_rst_extension[] = "rst";
const char default_amber_netcdf_extension[] = "cdf";
const char default_amber_netcdf_rst_extension[] = "rcdf";
const char default_sd_file_extension[] = "sdf";
const char default_pdb_file_extension[] = "pdb";

std::ofstream openOutputFile(const std::string &filename,
                             PrintSituation expectation = PrintSituation::OPEN_NEW,
                             const std::string &description = std::string(""),
                             DataFormat style = DataFormat::ASCII);

int removeFile(const std::string &filename, ExceptionResponse policy = ExceptionResponse::WARN);

DataFormat getTrajectoryFormat(CoordinateFileKind cfkind);

TextFile readFileSample(const std::string &file_name, const std::string &caller,
                        const size_t nchar);
  
CoordinateFileKind detectCoordinateFileKind(const TextFile &tf);
 
CoordinateFileKind detectCoordinateFileKind(const std::string &file_name,
                                            const std::string &caller = std::string(""));

TopologyKind detectTopologyKind(const TextFile &tf);
 
TopologyKind detectTopologyKind(const std::string &file_name,
                                const std::string &caller = std::string(""));
 
  
std::string getDefaultFileExtension(CoordinateFileKind kind);

CoordinateFileKind inferCoordinateFileKind(const std::string &file_name);

std::string assembleFilePath(const std::string &root_path, const std::string &base_path,
                             const std::string &extn);
  
} // namespace diskutil
} // namespace stormm
 
#endif