Remove gmx::File (except for File::exists())

[alexxy/gromacs.git] / src / gromacs / utility / filestream.h

diff --git a/src/gromacs/utility/filestream.h b/src/gromacs/utility/filestream.h
index 8a2d2a379f71c8df19cdcff788ce13d33caddf2b..23c354c344166f3928b97e02e937440db3b6af6a 100644 (file)
--- a/src/gromacs/utility/filestream.h
+++ b/src/gromacs/utility/filestream.h
@@ -59,17 +59,63 @@ class FileStreamImpl;
 }
 
 /*! \libinternal \brief
- * Text output stream implementation for writing to a file.
+ * Text input stream implementation for reading from `stdin`.
  *
- * Implementations for the TextOutputStream methods throw FileIOError on any
+ * Implementations for the TextInputStream methods throw FileIOError on any
  * I/O error.
  *
  * \inlibraryapi
  * \ingroup module_utility
  */
-class TextOutputFile : public TextOutputStream
+class StandardInputStream : public TextInputStream
 {
     public:
+        /*! \brief
+         * Returns whether `stdin` is an interactive terminal.
+         *
+         * Only works on Unix, otherwise always returns true.
+         *
+         * Does not throw.
+         */
+        bool isInteractive() const;
+
+        // From TextInputStream
+        virtual bool readLine(std::string *line);
+        virtual void close() {}
+
+        /*! \brief
+         * Returns a stream for accessing `stdin`.
+         *
+         * Does not throw.
+         */
+        static StandardInputStream &instance();
+};
+
+/*! \libinternal \brief
+ * Text input stream implementation for reading from a file.
+ *
+ * Implementations for the TextInputStream methods throw FileIOError on any
+ * I/O error.
+ *
+ * \inlibraryapi
+ * \ingroup module_utility
+ */
+class TextInputFile : public TextInputStream
+{
+    public:
+        /*! \brief
+         * Opens a file and returns a `FILE` handle.
+         *
+         * \param[in] filename  Path of the file to open.
+         * \throws    FileIOError on any I/O error.
+         *
+         * Instead of returning `NULL` on errors, throws an exception with
+         * additional details (including the file name and `errno`).
+         */
+        static FILE *openRawHandle(const char *filename);
+        //! \copydoc openRawHandle(const char *, const char *)
+        static FILE *openRawHandle(const std::string &filename);
+
         /*! \brief
          * Opens a text file as a stream.
          *
@@ -77,7 +123,7 @@ class TextOutputFile : public TextOutputStream
          * \throws     std::bad_alloc if out of memory.
          * \throws     FileIOError on any I/O error.
          */
-        explicit TextOutputFile(const std::string &filename);
+        explicit TextInputFile(const std::string &filename);
         /*! \brief
          * Initializes file object from an existing file handle.
          *
@@ -87,6 +133,39 @@ class TextOutputFile : public TextOutputStream
          * The caller is responsible of closing the file; close() does nothing
          * for an object constructed this way.
          */
+        explicit TextInputFile(FILE *fp);
+        virtual ~TextInputFile();
+
+        /*! \brief
+         * Returns a raw handle to the input file.
+         *
+         * This is provided for interoperability with older C-like code.
+         */
+        FILE *handle();
+
+        // From TextInputStream
+        virtual bool readLine(std::string *line);
+        virtual void close();
+
+    private:
+        PrivateImplPointer<internal::FileStreamImpl> impl_;
+};
+
+/*! \libinternal \brief
+ * Text output stream implementation for writing to a file.
+ *
+ * Implementations for the TextOutputStream methods throw FileIOError on any
+ * I/O error.
+ *
+ * \inlibraryapi
+ * \ingroup module_utility
+ */
+class TextOutputFile : public TextOutputStream
+{
+    public:
+        //! \copydoc TextInputFile::TextInputFile(const std::string &)
+        explicit TextOutputFile(const std::string &filename);
+        //! \copydoc TextInputFile::TextInputFile(FILE *)
         explicit TextOutputFile(FILE *fp);
         virtual ~TextOutputFile();