TextFile.h

Go to the documentation of this file.

#ifndef TextFile_h
#define TextFile_h
 
/* SPDX-License-Identifier: CC0-1.0 */
#include <fstream>
#include <vector>
 
#include <QString>
 
namespace Isis {
  class TextFile {
 
    protected:
      std::fstream p_stream;           
      int     p_openmode;              
      QString  p_filename;         
      QString  p_commentString;    
      QString  p_newLineString;    
      bool p_GetLine(QString &line, bool chkComment);
 
    public:
      // Constructors and destructors
      TextFile();
 
      // implied open file
      TextFile(const QString &filename, const char *openmode = "input",
               const char *extension = "");
 
      // implied getFile/putFile
      TextFile(const   char *filename, const char *openmode,
               std::vector<QString> &lines,
               const int &maxLinesToReadWrite = 0,
               const bool skipComments = true);
      TextFile(const QString &filename,
               const char *openmode, std::vector<QString> &lines,
               const int &maxLinesToReadWrite = 0,
               const bool skipComments = true);
      TextFile(const   char *filename,
               const char *openmode, QString *lines,
               const int &maxLinesToReadWrite, const bool skipComments = true);
      TextFile(const QString &filename,
               const char *openmode, QString *lines,
               const int &maxLinesToReadWrite, const bool skipComments = true);
 
      ~TextFile();
 
      void Open(const QString &filename, const char *openmode = "input",
                const char *extension = "");
      void Open(const char *filename, const char *openmode = "input",
                const char *extension = "");
 
      bool OpenChk(bool bailIfNotOpen = false);
 
      void Rewind();
      void Close();
 
      void GetFile(std::vector<QString> &lines, 
                   const int &maxLinesToRead = 0, 
                   const bool skipComments = true);
      void GetFile(QString *lines, const int &maxLinesToRead, 
                   const bool skipComments = true);
 
      void PutFile(std::vector<QString> &lines, 
                   const int &maxLinesToWrite = 0);
      void PutFile(const QString *lines, const int &maxLinesToWrite);
 
      bool GetLine(QString &line, const bool skipComments = true);
      bool GetLineNoFilter(QString &line);
 
      bool GetLine(const bool skipComments = true);
      bool GetLineNoFilter();
 
      void PutLine(const QString &line);
      void PutLine(const char *line = "");
 
      void PutLineComment(const QString &line);
      void PutLineComment(const char *line = "");
 
      QString GetComment();
      QString GetNewLine();
 
      void SetComment(const char *commentString = "#");
      void SetNewLine(const char *newLineString = "\n");
 
      int LineCount(const int &maxLinesToRead = 0);
      std::streamsize Size();
  };
};
 
#endif