fileio.h

/***************************************************************************
                          fileio.h  -  description
                             -------------------
    begin                : Fri Apr 6 2001
    copyright            : (C) 2000-2021 by Thies Jochimsen
    email                : thies@jochimsen.de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef FILEIO_H
#define FILEIO_H
 
//shortcut to check for type from string (templated function doesn work well with mingw - so we use macro)
#define IS_TYPE(type, name) (name==TypeTraits::type2label((type)0))
 
#include <odindata/data.h>
#include <odindata/fileio_opts.h>
 
 
#define AUTODETECTSTR "autodetect"
#define AUTOTDATAYPESTR "automatic"
 
 
enum                      dataDim { timeDim=0, sliceDim, phaseDim, readDim, n_dataDim };
static const char* dataDimLabel[]={"time",    "slice",  "phase",  "read"};
AVOID_CC_WARNING(dataDimLabel)
 
 
 
// helper class to enable/disable tracing
class FileIOTrace {
 
 public:
  static bool get_trace_status() {return do_trace;}
 
  static void set_trace_status(bool stat) {do_trace=stat;}
 
 
 protected:
  static logPriority loglevel() {if(get_trace_status()) return infoLog; else return normalDebug;}
 
 
 private:
  static bool do_trace;
 
};
 
 
 
class FileIO : public FileIOTrace {
 
 public:
 
  typedef STD_map<Protocol, Data<float,4> > ProtocolDataMap;
 
  static int autoread(ProtocolDataMap& pdmap, const STD_string& filename, const FileReadOpts& opts, const Protocol& protocol_template, ProgressMeter* progmeter=0);
 
  static int autowrite(const ProtocolDataMap& pdmap, const STD_string& filename, const FileWriteOpts& opts);
 
  static svector autoformats();
 
  static STD_string autoformats_str(const STD_string& indent="");
 
 
 
  static const char* get_compName(); // For debugging FilieIO component
 
 private:
 
  static int read_dir(ProtocolDataMap& pdmap, const STD_string& dirname, const FileReadOpts& opts, const Protocol& protocol_template,ProgressMeter* progmeter=0);
 
};
 
 
 
class FileFormat {
 
 public:
 
  void register_format();
 
  static svector create_unique_filenames(const STD_string& filename, const FileIO::ProtocolDataMap& pdmap, const STD_string& par);
 
  static float voxel_extent(const Geometry& geometry, direction direction, int size);
 
 
 
protected:
  virtual ~FileFormat() {} // avoid compiler warnings
 
  static STD_string select_write_datatype(const Protocol &prot,const FileWriteOpts& opts);
 
 private:
 
  // limit access
  friend class FileIO;
 
  virtual STD_string description() const = 0;
 
  virtual svector suffix() const = 0;
 
  virtual svector dialects() const = 0;
 
  virtual int read(Data<float,4>& data, const STD_string& filename, const FileReadOpts& opts, Protocol& prot);
  virtual int read(FileIO::ProtocolDataMap& pdmap, const STD_string& filename, const FileReadOpts& opts, const Protocol& protocol_template);
 
  virtual int write(const Data<float,4>& data, const STD_string& filename, const FileWriteOpts& opts, const Protocol& prot);
  virtual int write(const FileIO::ProtocolDataMap& pdmap, const STD_string& filename, const FileWriteOpts& opts);
 
  typedef STD_list<FileFormat*> FormatList;
  typedef STD_map<STD_string, FormatList> FormatMap;
  static FormatMap formats;
 
  static STD_string analyze_suffix(const STD_string& filename);
 
  static FileFormat* get_format(const STD_string& filename, const STD_string& override_suffix);
 
  static svector possible_formats();
 
  static STD_string formats_str(const STD_string& indent);
 
  static void format_error(const STD_string& filename);
 
};
 
 
 
#endif