pstreams-1.0.3/pstream.h0000664000175000017530000022420713670232352015112 0ustar jwakelyjwakely// PStreams - POSIX Process I/O for C++ // Copyright (C) 2001 - 2020 Jonathan Wakely // Distributed under the Boost Software License, Version 1.0. // (See accompanying file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) // // SPDX-License-Identifier: BSL-1.0 /** * @file pstream.h * @brief Declares all PStreams classes. * @author Jonathan Wakely * * Defines classes redi::ipstream, redi::opstream, redi::pstream * and redi::rpstream. */ #ifndef REDI_PSTREAM_H_SEEN #define REDI_PSTREAM_H_SEEN #include #include #include #include #include #include #include // for min() #include // for errno #include // for size_t, NULL #include // for exit() #include // for pid_t #include // for waitpid() #include // for ioctl() and FIONREAD #if defined(__sun) # include // for FIONREAD on Solaris 2.5 #endif #include // for pipe() fork() exec() and filedes functions #include // for kill() #include // for fcntl() #if REDI_EVISCERATE_PSTREAMS # include // for FILE, fdopen() #endif /// The library version. #define PSTREAMS_VERSION 0x0103 // 1.0.3 /** * @namespace redi * @brief All PStreams classes are declared in namespace redi. * * Like the standard iostreams, PStreams is a set of class templates, * taking a character type and traits type. As with the standard streams * they are most likely to be used with @c char and the default * traits type, so typedefs for this most common case are provided. * * The @c pstream_common class template is not intended to be used directly, * it is used internally to provide the common functionality for the * other stream classes. */ namespace redi { /// Common base class providing constants and typenames. struct pstreams { /// Type used to specify how to connect to the process. typedef std::ios_base::openmode pmode; /// Type used to hold the arguments for a command. typedef std::vector argv_type; /// Type used for file descriptors. typedef int fd_type; static const pmode pstdin = std::ios_base::out; ///< Write to stdin static const pmode pstdout = std::ios_base::in; ///< Read from stdout static const pmode pstderr = std::ios_base::app; ///< Read from stderr /// Create a new process group for the child process. static const pmode newpg = std::ios_base::trunc; protected: enum { bufsz = 32 }; ///< Size of pstreambuf buffers. enum { pbsz = 2 }; ///< Number of putback characters kept. #if __cplusplus >= 201103L template using stringable = decltype((void)std::string(std::declval())); #endif }; /// Class template for stream buffer. template > class basic_pstreambuf : public std::basic_streambuf , public pstreams { public: // Type definitions for dependent types typedef CharT char_type; typedef Traits traits_type; typedef typename traits_type::int_type int_type; typedef typename traits_type::off_type off_type; typedef typename traits_type::pos_type pos_type; /** @deprecated use pstreams::fd_type instead. */ typedef fd_type fd_t; /// Default constructor. basic_pstreambuf(); /// Constructor that initialises the buffer with @a cmd. basic_pstreambuf(const std::string& cmd, pmode mode); /// Constructor that initialises the buffer with @a file and @a argv. basic_pstreambuf( const std::string& file, const argv_type& argv, pmode mode ); #if __cplusplus >= 201103L basic_pstreambuf(basic_pstreambuf&&) noexcept; basic_pstreambuf& operator=(basic_pstreambuf&&) noexcept; void swap(basic_pstreambuf&) noexcept; #endif /// Destructor. ~basic_pstreambuf(); /// Initialise the stream buffer with @a cmd. basic_pstreambuf* open(const std::string& cmd, pmode mode); /// Initialise the stream buffer with @a file and @a argv. basic_pstreambuf* open(const std::string& file, const argv_type& argv, pmode mode); /// Close the stream buffer and wait for the process to exit. basic_pstreambuf* close(); /// Send a signal to the process. basic_pstreambuf* kill(int signal = SIGTERM); /// Send a signal to the process' process group. basic_pstreambuf* killpg(int signal = SIGTERM); /// Close the pipe connected to the process' stdin. void peof(); /// Change active input source. bool read_err(bool readerr = true); /// Report whether the stream buffer has been initialised. bool is_open() const; /// Report whether the process has exited. bool exited(); #if REDI_EVISCERATE_PSTREAMS /// Obtain FILE pointers for each of the process' standard streams. std::size_t fopen(FILE*& in, FILE*& out, FILE*& err); #endif /// Return the exit status of the process. int status() const; /// Return the error number (errno) for the most recent failed operation. int error() const; protected: /// Transfer characters to the pipe when character buffer overflows. int_type overflow(int_type c); /// Transfer characters from the pipe when the character buffer is empty. int_type underflow(); /// Make a character available to be returned by the next extraction. int_type pbackfail(int_type c = traits_type::eof()); /// Write any buffered characters to the stream. int sync(); /// Insert multiple characters into the pipe. std::streamsize xsputn(const char_type* s, std::streamsize n); /// Insert a sequence of characters into the pipe. std::streamsize write(const char_type* s, std::streamsize n); /// Extract a sequence of characters from the pipe. std::streamsize read(char_type* s, std::streamsize n); /// Report how many characters can be read from active input without blocking. std::streamsize showmanyc(); protected: /// Enumerated type to indicate whether stdout or stderr is to be read. enum buf_read_src { rsrc_out = 0, rsrc_err = 1 }; /// Initialise pipes and fork process. pid_t fork(pmode mode); /// Wait for the child process to exit. int wait(bool nohang = false); /// Return the file descriptor for the output pipe. fd_type& wpipe(); /// Return the file descriptor for the active input pipe. fd_type& rpipe(); /// Return the file descriptor for the specified input pipe. fd_type& rpipe(buf_read_src which); void create_buffers(pmode mode); void destroy_buffers(pmode mode); /// Writes buffered characters to the process' stdin pipe. bool empty_buffer(); bool fill_buffer(bool non_blocking = false); /// Return the active input buffer. char_type* rbuffer(); buf_read_src switch_read_buffer(buf_read_src); private: #if __cplusplus >= 201103L using basic_streambuf = std::basic_streambuf; #else basic_pstreambuf(const basic_pstreambuf&); basic_pstreambuf& operator=(const basic_pstreambuf&); #endif void init_rbuffers(); pid_t ppid_; // pid of process fd_type wpipe_; // pipe used to write to process' stdin fd_type rpipe_[2]; // two pipes to read from, stdout and stderr char_type* wbuffer_; char_type* rbuffer_[2]; char_type* rbufstate_[3]; /// Index into rpipe_[] to indicate active source for read operations. buf_read_src rsrc_; int status_; // hold exit status of child process int error_; // hold errno if fork() or exec() fails }; /// Class template for common base class. template > class pstream_common : virtual public std::basic_ios , virtual public pstreams { protected: typedef basic_pstreambuf streambuf_type; typedef std::basic_ios ios_type; typedef pstreams::pmode pmode; typedef pstreams::argv_type argv_type; /// Default constructor. pstream_common(); /// Constructor that initialises the stream by starting a process. pstream_common(const std::string& cmd, pmode mode); /// Constructor that initialises the stream by starting a process. pstream_common(const std::string& file, const argv_type& argv, pmode mode); /// Pure virtual destructor. virtual ~pstream_common() = 0; #if __cplusplus >= 201103L pstream_common(pstream_common&& rhs) noexcept : command_(std::move(rhs.command_)) , buf_(std::move(rhs.buf_)) { /* derived class is responsible for ios_type::move(rhs) happening */ } pstream_common& operator=(pstream_common&& rhs) noexcept { command_ = std::move(rhs.command_); buf_ = std::move(rhs.buf_); return *this; } void swap(pstream_common& rhs) noexcept { /* derived class is responsible for ios_type::swap(rhs) happening */ command_.swap(rhs.command_); buf_.swap(rhs.buf_); } #endif // C++11 /// Start a process. void do_open(const std::string& cmd, pmode mode); /// Start a process. void do_open(const std::string& file, const argv_type& argv, pmode mode); public: /// Close the pipe, returning the program's exit status, as /// pclose(3) does. int close(); /// Report whether the stream's buffer has been initialised. bool is_open() const; /// Return the command used to initialise the stream. const std::string& command() const; /// Return a pointer to the stream buffer. streambuf_type* rdbuf() const; #if REDI_EVISCERATE_PSTREAMS /// Obtain FILE pointers for each of the process' standard streams. std::size_t fopen(FILE*& in, FILE*& out, FILE*& err); #endif protected: std::string command_; ///< The command used to start the process. streambuf_type buf_; ///< The stream buffer. }; /** * @class basic_ipstream * @brief Class template for Input PStreams. * * Reading from an ipstream reads the command's standard output and/or * standard error (depending on how the ipstream is opened) * and the command's standard input is the same as that of the process * that created the object, unless altered by the command itself. */ template > class basic_ipstream : public std::basic_istream , public pstream_common , virtual public pstreams { typedef std::basic_istream istream_type; typedef pstream_common pbase_type; using pbase_type::buf_; // declare name in this scope // Ensure a basic_ipstream will read from at least one pipe pmode readable(pmode mode) { if (!(mode & (pstdout|pstderr))) mode |= pstdout; return mode; } public: /// Type used to specify how to connect to the process. typedef typename pbase_type::pmode pmode; /// Type used to hold the arguments for a command. typedef typename pbase_type::argv_type argv_type; /// Default constructor, creates an uninitialised stream. basic_ipstream() : istream_type(NULL), pbase_type() { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ explicit basic_ipstream(const std::string& cmd, pmode mode = pstdout) : istream_type(NULL), pbase_type(cmd, readable(mode)) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ basic_ipstream( const std::string& file, const argv_type& argv, pmode mode = pstdout ) : istream_type(NULL), pbase_type(file, argv, readable(mode)) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling * @c do_open(argv[0],argv,mode|pstdout) * * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ explicit basic_ipstream(const argv_type& argv, pmode mode = pstdout) : istream_type(NULL), pbase_type(argv.at(0), argv, readable(mode)) { } #if __cplusplus >= 201103L template> explicit basic_ipstream(std::initializer_list args, pmode mode = pstdout) : basic_ipstream(argv_type(args.begin(), args.end()), mode) { } basic_ipstream(basic_ipstream&& rhs) : istream_type(std::move(rhs)) , pbase_type(std::move(rhs)) { istream_type::set_rdbuf(std::addressof(pbase_type::buf_)); } basic_ipstream& operator=(basic_ipstream&& rhs) { istream_type::operator=(std::move(rhs)); pbase_type::operator=(std::move(rhs)); return *this; } void swap(basic_ipstream& rhs) { istream_type::swap(rhs); pbase_type::swap(rhs); } #endif // C++11 /** * @brief Destructor. * * Closes the stream and waits for the child to exit. */ ~basic_ipstream() { } /** * @brief Start a process. * * Calls do_open( @a cmd , @a mode|pstdout ). * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ void open(const std::string& cmd, pmode mode = pstdout) { this->do_open(cmd, readable(mode)); } /** * @brief Start a process. * * Calls do_open( @a file , @a argv , @a mode|pstdout ). * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ void open( const std::string& file, const argv_type& argv, pmode mode = pstdout ) { this->do_open(file, argv, readable(mode)); } /** * @brief Set streambuf to read from process' @c stdout. * @return @c *this */ basic_ipstream& out() { this->buf_.read_err(false); return *this; } /** * @brief Set streambuf to read from process' @c stderr. * @return @c *this */ basic_ipstream& err() { this->buf_.read_err(true); return *this; } }; /** * @class basic_opstream * @brief Class template for Output PStreams. * * Writing to an open opstream writes to the standard input of the command; * the command's standard output is the same as that of the process that * created the pstream object, unless altered by the command itself. */ template > class basic_opstream : public std::basic_ostream , public pstream_common , virtual public pstreams { typedef std::basic_ostream ostream_type; typedef pstream_common pbase_type; using pbase_type::buf_; // declare name in this scope public: /// Type used to specify how to connect to the process. typedef typename pbase_type::pmode pmode; /// Type used to hold the arguments for a command. typedef typename pbase_type::argv_type argv_type; /// Default constructor, creates an uninitialised stream. basic_opstream() : ostream_type(NULL), pbase_type() { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ explicit basic_opstream(const std::string& cmd, pmode mode = pstdin) : ostream_type(NULL), pbase_type(cmd, mode|pstdin) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ basic_opstream( const std::string& file, const argv_type& argv, pmode mode = pstdin ) : ostream_type(NULL), pbase_type(file, argv, mode|pstdin) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling * @c do_open(argv[0],argv,mode|pstdin) * * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ explicit basic_opstream(const argv_type& argv, pmode mode = pstdin) : ostream_type(NULL), pbase_type(argv.at(0), argv, mode|pstdin) { } #if __cplusplus >= 201103L /** * @brief Constructor that initialises the stream by starting a process. * * @param args a list of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ template> explicit basic_opstream(std::initializer_list args, pmode mode = pstdin) : basic_opstream(argv_type(args.begin(), args.end()), mode) { } basic_opstream(basic_opstream&& rhs) : ostream_type(std::move(rhs)) , pbase_type(std::move(rhs)) { ostream_type::set_rdbuf(std::addressof(pbase_type::buf_)); } basic_opstream& operator=(basic_opstream&& rhs) { ostream_type::operator=(std::move(rhs)); pbase_type::operator=(std::move(rhs)); return *this; } void swap(basic_opstream& rhs) { ostream_type::swap(rhs); pbase_type::swap(rhs); } #endif // C++11 /** * @brief Destructor * * Closes the stream and waits for the child to exit. */ ~basic_opstream() { } /** * @brief Start a process. * * Calls do_open( @a cmd , @a mode|pstdin ). * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ void open(const std::string& cmd, pmode mode = pstdin) { this->do_open(cmd, mode|pstdin); } /** * @brief Start a process. * * Calls do_open( @a file , @a argv , @a mode|pstdin ). * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ void open( const std::string& file, const argv_type& argv, pmode mode = pstdin) { this->do_open(file, argv, mode|pstdin); } }; /** * @class basic_pstream * @brief Class template for Bidirectional PStreams. * * Writing to a pstream opened with @c pmode @c pstdin writes to the * standard input of the command. * Reading from a pstream opened with @c pmode @c pstdout and/or @c pstderr * reads the command's standard output and/or standard error. * Any of the process' @c stdin, @c stdout or @c stderr that is not * connected to the pstream (as specified by the @c pmode) * will be the same as the process that created the pstream object, * unless altered by the command itself. */ template > class basic_pstream : public std::basic_iostream , public pstream_common , virtual public pstreams { typedef std::basic_iostream iostream_type; typedef pstream_common pbase_type; using pbase_type::buf_; // declare name in this scope public: /// Type used to specify how to connect to the process. typedef typename pbase_type::pmode pmode; /// Type used to hold the arguments for a command. typedef typename pbase_type::argv_type argv_type; /// Default constructor, creates an uninitialised stream. basic_pstream() : iostream_type(NULL), pbase_type() { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ explicit basic_pstream(const std::string& cmd, pmode mode = pstdout|pstdin) : iostream_type(NULL), pbase_type(cmd, mode) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ basic_pstream( const std::string& file, const argv_type& argv, pmode mode = pstdout|pstdin ) : iostream_type(NULL), pbase_type(file, argv, mode) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling * @c do_open(argv[0],argv,mode) * * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ explicit basic_pstream(const argv_type& argv, pmode mode = pstdout|pstdin) : iostream_type(NULL), pbase_type(argv.at(0), argv, mode) { } #if __cplusplus >= 201103L /** * @brief Constructor that initialises the stream by starting a process. * * @param l a list of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ template> explicit basic_pstream(std::initializer_list l, pmode mode = pstdout|pstdin) : basic_pstream(argv_type(l.begin(), l.end()), mode) { } basic_pstream(basic_pstream&& rhs) : iostream_type(std::move(rhs)) , pbase_type(std::move(rhs)) { iostream_type::set_rdbuf(std::addressof(pbase_type::buf_)); } basic_pstream& operator=(basic_pstream&& rhs) { iostream_type::operator=(std::move(rhs)); pbase_type::operator=(std::move(rhs)); return *this; } void swap(basic_pstream& rhs) { iostream_type::swap(rhs); pbase_type::swap(rhs); } #endif // C++11 /** * @brief Destructor * * Closes the stream and waits for the child to exit. */ ~basic_pstream() { } /** * @brief Start a process. * * Calls do_open( @a cnd , @a mode ). * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ void open(const std::string& cmd, pmode mode = pstdout|pstdin) { this->do_open(cmd, mode); } /** * @brief Start a process. * * Calls do_open( @a file , @a argv , @a mode ). * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ void open( const std::string& file, const argv_type& argv, pmode mode = pstdout|pstdin ) { this->do_open(file, argv, mode); } /** * @brief Set streambuf to read from process' @c stdout. * @return @c *this */ basic_pstream& out() { this->buf_.read_err(false); return *this; } /** * @brief Set streambuf to read from process' @c stderr. * @return @c *this */ basic_pstream& err() { this->buf_.read_err(true); return *this; } }; /** * @class basic_rpstream * @brief Class template for Restricted PStreams. * * Writing to an rpstream opened with @c pmode @c pstdin writes to the * standard input of the command. * It is not possible to read directly from an rpstream object, to use * an rpstream as in istream you must call either basic_rpstream::out() * or basic_rpstream::err(). This is to prevent accidental reads from * the wrong input source. If the rpstream was not opened with @c pmode * @c pstderr then the class cannot read the process' @c stderr, and * basic_rpstream::err() will return an istream that reads from the * process' @c stdout, and vice versa. * Reading from an rpstream opened with @c pmode @c pstdout and/or * @c pstderr reads the command's standard output and/or standard error. * Any of the process' @c stdin, @c stdout or @c stderr that is not * connected to the pstream (as specified by the @c pmode) * will be the same as the process that created the pstream object, * unless altered by the command itself. */ template > class basic_rpstream : public std::basic_ostream , private std::basic_istream , private pstream_common , virtual public pstreams { typedef std::basic_ostream ostream_type; typedef std::basic_istream istream_type; typedef pstream_common pbase_type; using pbase_type::buf_; // declare name in this scope public: /// Type used to specify how to connect to the process. typedef typename pbase_type::pmode pmode; /// Type used to hold the arguments for a command. typedef typename pbase_type::argv_type argv_type; /// Default constructor, creates an uninitialised stream. basic_rpstream() : ostream_type(NULL), istream_type(NULL), pbase_type() { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ explicit basic_rpstream(const std::string& cmd, pmode mode = pstdout|pstdin) : ostream_type(NULL) , istream_type(NULL) , pbase_type(cmd, mode) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling do_open() with the supplied * arguments. * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ basic_rpstream( const std::string& file, const argv_type& argv, pmode mode = pstdout|pstdin ) : ostream_type(NULL), istream_type(NULL), pbase_type(file, argv, mode) { } /** * @brief Constructor that initialises the stream by starting a process. * * Initialises the stream buffer by calling * @c do_open(argv[0],argv,mode) * * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ explicit basic_rpstream(const argv_type& argv, pmode mode = pstdout|pstdin) : ostream_type(NULL), istream_type(NULL) , pbase_type(argv.at(0), argv, mode) { } #if __cplusplus >= 201103L /** * @brief Constructor that initialises the stream by starting a process. * * @param l a list of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ template> explicit basic_rpstream(std::initializer_list l, pmode mode = pstdout|pstdin) : basic_rpstream(argv_type(l.begin(), l.end()), mode) { } // TODO: figure out how to move istream and ostream bases separately, // but so the virtual basic_ios base is only modified once. #if 0 basic_rpstream(basic_rpstream&& rhs) : iostream_type(std::move(rhs)) , pbase_type(std::move(rhs)) { iostream_type::set_rdbuf(std::addressof(pbase_type::buf_)); } basic_rpstream& operator=(basic_rpstream&& rhs) { iostream_type::operator=(std::move(rhs)); pbase_type::operator=(std::move(rhs)); return *this; } void swap(basic_rpstream& rhs) { iostream_type::swap(rhs); pbase_type::swap(rhs); } #endif #endif // C++11 /// Destructor ~basic_rpstream() { } /** * @brief Start a process. * * Calls do_open( @a cmd , @a mode ). * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ void open(const std::string& cmd, pmode mode = pstdout|pstdin) { this->do_open(cmd, mode); } /** * @brief Start a process. * * Calls do_open( @a file , @a argv , @a mode ). * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ void open( const std::string& file, const argv_type& argv, pmode mode = pstdout|pstdin ) { this->do_open(file, argv, mode); } /** * @brief Obtain a reference to the istream that reads * the process' @c stdout. * @return @c *this */ istream_type& out() { this->buf_.read_err(false); return *this; } /** * @brief Obtain a reference to the istream that reads * the process' @c stderr. * @return @c *this */ istream_type& err() { this->buf_.read_err(true); return *this; } }; /// Type definition for common template specialisation. typedef basic_pstreambuf pstreambuf; /// Type definition for common template specialisation. typedef basic_ipstream ipstream; /// Type definition for common template specialisation. typedef basic_opstream opstream; /// Type definition for common template specialisation. typedef basic_pstream pstream; /// Type definition for common template specialisation. typedef basic_rpstream rpstream; /** * When inserted into an output pstream the manipulator calls * basic_pstreambuf::peof() to close the output pipe, * causing the child process to receive the end-of-file indicator * on subsequent reads from its @c stdin stream. * * @brief Manipulator to close the pipe connected to the process' stdin. * @param s An output PStream class. * @return The stream object the manipulator was invoked on. * @see basic_pstreambuf::peof() * @relates basic_opstream basic_pstream basic_rpstream */ template inline std::basic_ostream& peof(std::basic_ostream& s) { typedef basic_pstreambuf pstreambuf_type; if (pstreambuf_type* p = dynamic_cast(s.rdbuf())) p->peof(); return s; } /* * member definitions for pstreambuf */ /** * @class basic_pstreambuf * Provides underlying streambuf functionality for the PStreams classes. */ /** Creates an uninitialised stream buffer. */ template inline basic_pstreambuf::basic_pstreambuf() : ppid_(-1) // initialise to -1 to indicate no process run yet. , wpipe_(-1) , wbuffer_() , rbuffer_() , rbufstate_() , rsrc_(rsrc_out) , status_(-1) , error_(0) { rpipe_[rsrc_out] = rpipe_[rsrc_err] = -1; } /** * Initialises the stream buffer by calling open() with the supplied * arguments. * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see open() */ template inline basic_pstreambuf::basic_pstreambuf(const std::string& cmd, pmode mode) : ppid_(-1) // initialise to -1 to indicate no process run yet. , wpipe_(-1) , wbuffer_() , rbuffer_() , rbufstate_() , rsrc_(rsrc_out) , status_(-1) , error_(0) { rpipe_[rsrc_out] = rpipe_[rsrc_err] = -1; open(cmd, mode); } /** * Initialises the stream buffer by calling open() with the supplied * arguments. * * @param file a string containing the name of a program to execute. * @param argv a vector of argument strings passsed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see open() */ template inline basic_pstreambuf::basic_pstreambuf( const std::string& file, const argv_type& argv, pmode mode ) : ppid_(-1) // initialise to -1 to indicate no process run yet. , wpipe_(-1) , wbuffer_() , rbuffer_() , rbufstate_() , rsrc_(rsrc_out) , status_(-1) , error_(0) { rpipe_[rsrc_out] = rpipe_[rsrc_err] = -1; open(file, argv, mode); } /** * Closes the stream by calling close(). * @see close() */ template inline basic_pstreambuf::~basic_pstreambuf() { close(); } #if __cplusplus >= 201103L /** * Move constructor. */ template inline basic_pstreambuf::basic_pstreambuf( basic_pstreambuf&& rhs ) noexcept : basic_streambuf(static_cast(rhs)) , ppid_(rhs.ppid_) , wpipe_(rhs.wpipe_) , rpipe_{rhs.rpipe_[0], rhs.rpipe_[1]} , wbuffer_(rhs.wbuffer_) , rbuffer_{rhs.rbuffer_[0], rhs.rbuffer_[1]} , rbufstate_{rhs.rbufstate_[0], rhs.rbufstate_[1], rhs.rbufstate_[2]} , rsrc_(rhs.rsrc_) , status_(rhs.status_) , error_(rhs.error_) { rhs.ppid_ = -1; rhs.wpipe_ = -1; rhs.rpipe_[0] = rhs.rpipe_[1] = -1; rhs.wbuffer_ = nullptr; rhs.rbuffer_[0] = rhs.rbuffer_[1] = nullptr; rhs.rbufstate_[0] = rhs.rbufstate_[1] = rhs.rbufstate_[2] = nullptr; rhs.rsrc_ = rsrc_out; rhs.status_ = -1; rhs.error_ = 0; rhs.setg(nullptr, nullptr, nullptr); rhs.setp(nullptr, nullptr); } template inline basic_pstreambuf& basic_pstreambuf::operator=( basic_pstreambuf&& rhs ) noexcept { close(); basic_streambuf::operator=(static_cast(rhs)); swap(rhs); return *this; } template inline void basic_pstreambuf::swap( basic_pstreambuf& rhs ) noexcept { basic_streambuf::swap(static_cast(rhs)); std::swap(ppid_, rhs.ppid_); std::swap(wpipe_, rhs.wpipe_); std::swap(rpipe_, rhs.rpipe_); std::swap(wbuffer_, rhs.wbuffer_); std::swap(rbuffer_, rhs.rbuffer_); std::swap(rbufstate_, rhs.rbufstate_); std::swap(rsrc_, rhs.rsrc_); std::swap(status_, rhs.status_); std::swap(error_, rhs.error_); } #endif // C++11 /** * Starts a new process by passing @a command to the shell (/bin/sh) * and opens pipes to the process with the specified @a mode. * * If @a mode contains @c pstdout the initial read source will be * the child process' stdout, otherwise if @a mode contains @c pstderr * the initial read source will be the child's stderr. * * Will duplicate the actions of the shell in searching for an * executable file if the specified file name does not contain a slash (/) * character. * * @warning * There is no way to tell whether the shell command succeeded, this * function will always succeed unless resource limits (such as * memory usage, or number of processes or open files) are exceeded. * This means is_open() will return true even if @a command cannot * be executed. * Use pstreambuf::open(const std::string&, const argv_type&, pmode) * if you need to know whether the command failed to execute. * * @param command a string containing a shell command. * @param mode a bitwise OR of one or more of @c out, @c in, @c err. * @return NULL if the shell could not be started or the * pipes could not be opened, @c this otherwise. * @see execl(3) */ template basic_pstreambuf* basic_pstreambuf::open(const std::string& command, pmode mode) { const char * shell_path = "/bin/sh"; #if 0 const std::string argv[] = { "sh", "-c", command }; return this->open(shell_path, argv_type(argv, argv+3), mode); #else basic_pstreambuf* ret = NULL; if (!is_open()) { switch(fork(mode)) { case 0 : // this is the new process, exec command ::execl(shell_path, "sh", "-c", command.c_str(), (char*)NULL); // can only reach this point if exec() failed // parent can get exit code from waitpid() ::_exit(errno); // using std::exit() would make static dtors run twice case -1 : // couldn't fork, error already handled in pstreambuf::fork() break; default : // this is the parent process // activate buffers create_buffers(mode); ret = this; } } return ret; #endif } /** * @brief Helper function to close a file descriptor. * * Inspects @a fd and calls close(3) if it has a non-negative value. * * @param fd a file descriptor. * @relates basic_pstreambuf */ inline void close_fd(pstreams::fd_type& fd) { if (fd >= 0 && ::close(fd) == 0) fd = -1; } /** * @brief Helper function to close an array of file descriptors. * * Calls @c close_fd() on each member of the array. * The length of the array is determined automatically by * template argument deduction to avoid errors. * * @param fds an array of file descriptors. * @relates basic_pstreambuf */ template inline void close_fd_array(pstreams::fd_type (&fds)[N]) { for (std::size_t i = 0; i < N; ++i) close_fd(fds[i]); } /** * Starts a new process by executing @a file with the arguments in * @a argv and opens pipes to the process with the specified @a mode. * * By convention @c argv[0] should be the file name of the file being * executed. * * If @a mode contains @c pstdout the initial read source will be * the child process' stdout, otherwise if @a mode contains @c pstderr * the initial read source will be the child's stderr. * * Will duplicate the actions of the shell in searching for an * executable file if the specified file name does not contain a slash (/) * character. * * Iff @a file is successfully executed then is_open() will return true. * Otherwise, pstreambuf::error() can be used to obtain the value of * @c errno that was set by execvp(3) in the child process. * * The exit status of the new process will be returned by * pstreambuf::status() after pstreambuf::exited() returns true. * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode a bitwise OR of one or more of @c out, @c in and @c err. * @return NULL if a pipe could not be opened or if the program could * not be executed, @c this otherwise. * @see execvp(3) */ template basic_pstreambuf* basic_pstreambuf::open( const std::string& file, const argv_type& argv, pmode mode ) { basic_pstreambuf* ret = NULL; if (!is_open()) { // constants for read/write ends of pipe enum { RD, WR }; // open another pipe and set close-on-exec fd_type ck_exec[] = { -1, -1 }; if (-1 == ::pipe(ck_exec) || -1 == ::fcntl(ck_exec[RD], F_SETFD, FD_CLOEXEC) || -1 == ::fcntl(ck_exec[WR], F_SETFD, FD_CLOEXEC)) { error_ = errno; close_fd_array(ck_exec); } else { switch(fork(mode)) { case 0 : // this is the new process, exec command { char** arg_v = new char*[argv.size()+1]; for (std::size_t i = 0; i < argv.size(); ++i) { const std::string& src = argv[i]; char*& dest = arg_v[i]; dest = new char[src.size()+1]; dest[ src.copy(dest, src.size()) ] = '\0'; } arg_v[argv.size()] = NULL; ::execvp(file.c_str(), arg_v); // can only reach this point if exec() failed // parent can get error code from ck_exec pipe error_ = errno; while (::write(ck_exec[WR], &error_, sizeof(error_)) == -1 && errno == EINTR) { } ::close(ck_exec[WR]); ::close(ck_exec[RD]); ::_exit(error_); // using std::exit() would make static dtors run twice } case -1 : // couldn't fork, error already handled in pstreambuf::fork() close_fd_array(ck_exec); break; default : // this is the parent process // check child called exec() successfully ::close(ck_exec[WR]); switch (::read(ck_exec[RD], &error_, sizeof(error_))) { case 0: // activate buffers create_buffers(mode); ret = this; break; case -1: error_ = errno; break; default: // error_ contains error code from child // call wait() to clean up and set ppid_ to 0 this->wait(); break; } ::close(ck_exec[RD]); } } } return ret; } /** * Creates pipes as specified by @a mode and calls @c fork() to create * a new process. If the fork is successful the parent process stores * the child's PID and the opened pipes and the child process replaces * its standard streams with the opened pipes. * * If an error occurs the error code will be set to one of the possible * errors for @c pipe() or @c fork(). * See your system's documentation for these error codes. * * @param mode an OR of pmodes specifying which of the child's * standard streams to connect to. * @return On success the PID of the child is returned in the parent's * context and zero is returned in the child's context. * On error -1 is returned and the error code is set appropriately. */ template pid_t basic_pstreambuf::fork(pmode mode) { pid_t pid = -1; // Three pairs of file descriptors, for pipes connected to the // process' stdin, stdout and stderr // (stored in a single array so close_fd_array() can close all at once) fd_type fd[] = { -1, -1, -1, -1, -1, -1 }; fd_type* const pin = fd; fd_type* const pout = fd+2; fd_type* const perr = fd+4; // constants for read/write ends of pipe enum { RD, WR }; // N.B. // For the pstreambuf pin is an output stream and // pout and perr are input streams. if (!error_ && mode&pstdin && ::pipe(pin)) error_ = errno; if (!error_ && mode&pstdout && ::pipe(pout)) error_ = errno; if (!error_ && mode&pstderr && ::pipe(perr)) error_ = errno; if (!error_) { pid = ::fork(); switch (pid) { case 0 : { // this is the new process // for each open pipe close one end and redirect the // respective standard stream to the other end if (*pin >= 0) { ::close(pin[WR]); ::dup2(pin[RD], STDIN_FILENO); ::close(pin[RD]); } if (*pout >= 0) { ::close(pout[RD]); ::dup2(pout[WR], STDOUT_FILENO); ::close(pout[WR]); } if (*perr >= 0) { ::close(perr[RD]); ::dup2(perr[WR], STDERR_FILENO); ::close(perr[WR]); } #ifdef _POSIX_JOB_CONTROL if (mode&newpg) ::setpgid(0, 0); // Change to a new process group #endif break; } case -1 : { // couldn't fork for some reason error_ = errno; // close any open pipes close_fd_array(fd); break; } default : { // this is the parent process, store process' pid ppid_ = pid; // store one end of open pipes and close other end if (*pin >= 0) { wpipe_ = pin[WR]; ::close(pin[RD]); } if (*pout >= 0) { rpipe_[rsrc_out] = pout[RD]; ::close(pout[WR]); } if (*perr >= 0) { rpipe_[rsrc_err] = perr[RD]; ::close(perr[WR]); } } } } else { // close any pipes we opened before failure close_fd_array(fd); } return pid; } /** * Closes all pipes and calls wait() to wait for the process to finish. * If an error occurs the error code will be set to one of the possible * errors for @c waitpid(). * See your system's documentation for these errors. * * @return @c this on successful close or @c NULL if there is no * process to close or if an error occurs. */ template basic_pstreambuf* basic_pstreambuf::close() { const bool running = is_open(); sync(); // this might call wait() and reap the child process // rather than trying to work out whether or not we need to clean up // just do it anyway, all cleanup functions are safe to call twice. destroy_buffers(pstdin|pstdout|pstderr); // close pipes before wait() so child gets EOF/SIGPIPE close_fd(wpipe_); close_fd_array(rpipe_); do { error_ = 0; } while (wait() == -1 && error() == EINTR); return running ? this : NULL; } /** * Used to be called on construction to initialise the arrays for reading. * No longer used. */ template #if __cplusplus >= 201402L && __has_cpp_attribute(deprecated) [[deprecated]] #elif __GNUC__ __attribute__((deprecated)) #endif inline void basic_pstreambuf::init_rbuffers() { rpipe_[rsrc_out] = rpipe_[rsrc_err] = -1; rbuffer_[rsrc_out] = rbuffer_[rsrc_err] = NULL; rbufstate_[0] = rbufstate_[1] = rbufstate_[2] = NULL; } template void basic_pstreambuf::create_buffers(pmode mode) { if (mode & pstdin) { delete[] wbuffer_; wbuffer_ = new char_type[bufsz]; this->setp(wbuffer_, wbuffer_ + bufsz); } if (mode & pstdout) { delete[] rbuffer_[rsrc_out]; rbuffer_[rsrc_out] = new char_type[bufsz]; rsrc_ = rsrc_out; this->setg(rbuffer_[rsrc_out] + pbsz, rbuffer_[rsrc_out] + pbsz, rbuffer_[rsrc_out] + pbsz); } if (mode & pstderr) { delete[] rbuffer_[rsrc_err]; rbuffer_[rsrc_err] = new char_type[bufsz]; if (!(mode & pstdout)) { rsrc_ = rsrc_err; this->setg(rbuffer_[rsrc_err] + pbsz, rbuffer_[rsrc_err] + pbsz, rbuffer_[rsrc_err] + pbsz); } } } template void basic_pstreambuf::destroy_buffers(pmode mode) { if (mode & pstdin) { this->setp(NULL, NULL); delete[] wbuffer_; wbuffer_ = NULL; } if (mode & pstdout) { if (rsrc_ == rsrc_out) this->setg(NULL, NULL, NULL); delete[] rbuffer_[rsrc_out]; rbuffer_[rsrc_out] = NULL; } if (mode & pstderr) { if (rsrc_ == rsrc_err) this->setg(NULL, NULL, NULL); delete[] rbuffer_[rsrc_err]; rbuffer_[rsrc_err] = NULL; } } template typename basic_pstreambuf::buf_read_src basic_pstreambuf::switch_read_buffer(buf_read_src src) { if (rsrc_ != src) { char_type* tmpbufstate[] = {this->eback(), this->gptr(), this->egptr()}; this->setg(rbufstate_[0], rbufstate_[1], rbufstate_[2]); for (std::size_t i = 0; i < 3; ++i) rbufstate_[i] = tmpbufstate[i]; rsrc_ = src; } return rsrc_; } /** * Suspends execution and waits for the associated process to exit, or * until a signal is delivered whose action is to terminate the current * process or to call a signal handling function. If the process has * already exited (i.e. it is a "zombie" process) then wait() returns * immediately. Waiting for the child process causes all its system * resources to be freed. * * error() will return EINTR if wait() is interrupted by a signal. * * @param nohang true to return immediately if the process has not exited. * @return 1 if the process has exited and wait() has not yet been called. * 0 if @a nohang is true and the process has not exited yet. * -1 if no process has been started or if an error occurs, * in which case the error can be found using error(). */ template int basic_pstreambuf::wait(bool nohang) { int child_exited = -1; if (is_open()) { int exit_status; switch(::waitpid(ppid_, &exit_status, nohang ? WNOHANG : 0)) { case 0 : // nohang was true and process has not exited child_exited = 0; break; case -1 : error_ = errno; break; default : // process has exited ppid_ = 0; status_ = exit_status; child_exited = 1; // Close wpipe, would get SIGPIPE if we used it. destroy_buffers(pstdin); close_fd(wpipe_); // Must free read buffers and pipes on destruction // or next call to open()/close() break; } } return child_exited; } /** * Sends the specified signal to the process. A signal can be used to * terminate a child process that would not exit otherwise. * * If an error occurs the error code will be set to one of the possible * errors for @c kill(). See your system's documentation for these errors. * * @param signal A signal to send to the child process. * @return @c this or @c NULL if @c kill() fails. */ template inline basic_pstreambuf* basic_pstreambuf::kill(int signal) { basic_pstreambuf* ret = NULL; if (is_open()) { if (::kill(ppid_, signal)) error_ = errno; else { #if 0 // TODO call exited() to check for exit and clean up? leave to user? if (signal==SIGTERM || signal==SIGKILL) this->exited(); #endif ret = this; } } return ret; } /** * Sends the specified signal to the process group of the child process. * A signal can be used to terminate a child process that would not exit * otherwise, or to kill the process and its own children. * * If an error occurs the error code will be set to one of the possible * errors for @c getpgid() or @c kill(). See your system's documentation * for these errors. If the child is in the current process group then * NULL will be returned and the error code set to EPERM. * * @param signal A signal to send to the child process. * @return @c this on success or @c NULL on failure. */ template inline basic_pstreambuf* basic_pstreambuf::killpg(int signal) { basic_pstreambuf* ret = NULL; #ifdef _POSIX_JOB_CONTROL if (is_open()) { pid_t pgid = ::getpgid(ppid_); if (pgid == -1) error_ = errno; else if (pgid == ::getpgrp()) error_ = EPERM; // Don't commit suicide else if (::killpg(pgid, signal)) error_ = errno; else ret = this; } #else error_ = ENOTSUP; #endif return ret; } /** * This function can call pstreambuf::wait() and so may change the * object's state if the child process has already exited. * * @return True if the associated process has exited, false otherwise. * @see basic_pstreambuf::wait() */ template inline bool basic_pstreambuf::exited() { return ppid_ == 0 || wait(true)==1; } /** * @return The exit status of the child process, or -1 if wait() * has not yet been called to wait for the child to exit. * @see basic_pstreambuf::wait() */ template inline int basic_pstreambuf::status() const { return status_; } /** * @return The error code of the most recently failed operation, or zero. */ template inline int basic_pstreambuf::error() const { return error_; } /** * Closes the output pipe, causing the child process to receive the * end-of-file indicator on subsequent reads from its @c stdin stream. */ template inline void basic_pstreambuf::peof() { sync(); destroy_buffers(pstdin); close_fd(wpipe_); } /** * Unlike pstreambuf::exited(), this function will not call wait() and * so will not change the object's state. This means that once a child * process is executed successfully this function will continue to * return true even after the process exits (until wait() is called.) * * @return true if a previous call to open() succeeded and wait() has * not been called and determined that the process has exited, * false otherwise. */ template inline bool basic_pstreambuf::is_open() const { return ppid_ > 0; } /** * Toggle the stream used for reading. If @a readerr is @c true then the * process' @c stderr output will be used for subsequent extractions, if * @a readerr is false the the process' stdout will be used. * @param readerr @c true to read @c stderr, @c false to read @c stdout. * @return @c true if the requested stream is open and will be used for * subsequent extractions, @c false otherwise. */ template inline bool basic_pstreambuf::read_err(bool readerr) { buf_read_src src = readerr ? rsrc_err : rsrc_out; if (rpipe_[src]>=0) { switch_read_buffer(src); return true; } return false; } /** * Called when the internal character buffer is not present or is full, * to transfer the buffer contents to the pipe. * * @param c a character to be written to the pipe. * @return @c traits_type::eof() if an error occurs, otherwise if @a c * is not equal to @c traits_type::eof() it will be buffered and * a value other than @c traits_type::eof() returned to indicate * success. */ template typename basic_pstreambuf::int_type basic_pstreambuf::overflow(int_type c) { if (!empty_buffer()) return traits_type::eof(); else if (!traits_type::eq_int_type(c, traits_type::eof())) return this->sputc(c); else return traits_type::not_eof(c); } template int basic_pstreambuf::sync() { return !exited() && empty_buffer() ? 0 : -1; } /** * @param s character buffer. * @param n buffer length. * @return the number of characters written. */ template std::streamsize basic_pstreambuf::xsputn(const char_type* s, std::streamsize n) { std::streamsize done = 0; while (done < n) { if (std::streamsize nbuf = this->epptr() - this->pptr()) { nbuf = std::min(nbuf, n - done); traits_type::copy(this->pptr(), s + done, nbuf); this->pbump(nbuf); done += nbuf; } else if (!empty_buffer()) break; } return done; } /** * @return true if the buffer was emptied, false otherwise. */ template bool basic_pstreambuf::empty_buffer() { const std::streamsize count = this->pptr() - this->pbase(); if (count > 0) { const std::streamsize written = this->write(this->wbuffer_, count); if (written > 0) { if (const std::streamsize unwritten = count - written) traits_type::move(this->pbase(), this->pbase()+written, unwritten); this->pbump(-written); return true; } } return false; } /** * Called when the internal character buffer is is empty, to re-fill it * from the pipe. * * @return The first available character in the buffer, * or @c traits_type::eof() in case of failure. */ template typename basic_pstreambuf::int_type basic_pstreambuf::underflow() { if (this->gptr() < this->egptr() || fill_buffer()) return traits_type::to_int_type(*this->gptr()); else return traits_type::eof(); } /** * Attempts to make @a c available as the next character to be read by * @c sgetc(). * * @param c a character to make available for extraction. * @return @a c if the character can be made available, * @c traits_type::eof() otherwise. */ template typename basic_pstreambuf::int_type basic_pstreambuf::pbackfail(int_type c) { if (this->gptr() != this->eback()) { this->gbump(-1); if (!traits_type::eq_int_type(c, traits_type::eof())) *this->gptr() = traits_type::to_char_type(c); return traits_type::not_eof(c); } else return traits_type::eof(); } template std::streamsize basic_pstreambuf::showmanyc() { int avail = 0; if (sizeof(char_type) == 1) avail = fill_buffer(true) ? this->egptr() - this->gptr() : -1; #ifdef FIONREAD else { if (::ioctl(rpipe(), FIONREAD, &avail) == -1) avail = -1; else if (avail) avail /= sizeof(char_type); } #endif return std::streamsize(avail); } /** * @return true if the buffer was filled, false otherwise. */ template bool basic_pstreambuf::fill_buffer(bool non_blocking) { const std::streamsize pb1 = this->gptr() - this->eback(); const std::streamsize pb2 = pbsz; const std::streamsize npb = std::min(pb1, pb2); char_type* const rbuf = rbuffer(); if (npb) traits_type::move(rbuf + pbsz - npb, this->gptr() - npb, npb); std::streamsize rc = -1; if (non_blocking) { const int flags = ::fcntl(rpipe(), F_GETFL); if (flags != -1) { const bool blocking = !(flags & O_NONBLOCK); if (blocking) ::fcntl(rpipe(), F_SETFL, flags | O_NONBLOCK); // set non-blocking error_ = 0; rc = read(rbuf + pbsz, bufsz - pbsz); if (rc == -1 && error_ == EAGAIN) // nothing available rc = 0; else if (rc == 0) // EOF rc = -1; if (blocking) ::fcntl(rpipe(), F_SETFL, flags); // restore } } else rc = read(rbuf + pbsz, bufsz - pbsz); if (rc > 0 || (rc == 0 && non_blocking)) { this->setg( rbuf + pbsz - npb, rbuf + pbsz, rbuf + pbsz + rc ); return true; } else { this->setg(NULL, NULL, NULL); return false; } } /** * Writes up to @a n characters to the pipe from the buffer @a s. * * @param s character buffer. * @param n buffer length. * @return the number of characters written. */ template inline std::streamsize basic_pstreambuf::write(const char_type* s, std::streamsize n) { std::streamsize nwritten = 0; if (wpipe() >= 0) { nwritten = ::write(wpipe(), s, n * sizeof(char_type)); if (nwritten == -1) error_ = errno; else nwritten /= sizeof(char_type); } return nwritten; } /** * Reads up to @a n characters from the pipe to the buffer @a s. * * @param s character buffer. * @param n buffer length. * @return the number of characters read. */ template inline std::streamsize basic_pstreambuf::read(char_type* s, std::streamsize n) { std::streamsize nread = 0; if (rpipe() >= 0) { nread = ::read(rpipe(), s, n * sizeof(char_type)); if (nread == -1) error_ = errno; else nread /= sizeof(char_type); } return nread; } /** @return a reference to the output file descriptor */ template inline pstreams::fd_type& basic_pstreambuf::wpipe() { return wpipe_; } /** @return a reference to the active input file descriptor */ template inline pstreams::fd_type& basic_pstreambuf::rpipe() { return rpipe_[rsrc_]; } /** @return a reference to the specified input file descriptor */ template inline pstreams::fd_type& basic_pstreambuf::rpipe(buf_read_src which) { return rpipe_[which]; } /** @return a pointer to the start of the active input buffer area. */ template inline typename basic_pstreambuf::char_type* basic_pstreambuf::rbuffer() { return rbuffer_[rsrc_]; } /* * member definitions for pstream_common */ /** * @class pstream_common * Abstract Base Class providing common functionality for basic_ipstream, * basic_opstream and basic_pstream. * pstream_common manages the basic_pstreambuf stream buffer that is used * by the derived classes to initialise an iostream class. */ /** Creates an uninitialised stream. */ template inline pstream_common::pstream_common() : std::basic_ios(NULL) , command_() , buf_() { this->std::basic_ios::rdbuf(&buf_); } /** * Initialises the stream buffer by calling * do_open( @a command , @a mode ) * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, pmode) */ template inline pstream_common::pstream_common(const std::string& cmd, pmode mode) : std::basic_ios(NULL) , command_(cmd) , buf_() { this->std::basic_ios::rdbuf(&buf_); do_open(cmd, mode); } /** * Initialises the stream buffer by calling * do_open( @a file , @a argv , @a mode ) * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see do_open(const std::string&, const argv_type&, pmode) */ template inline pstream_common::pstream_common( const std::string& file, const argv_type& argv, pmode mode ) : std::basic_ios(NULL) , command_(file) , buf_() { this->std::basic_ios::rdbuf(&buf_); do_open(file, argv, mode); } /** * This is a pure virtual function to make @c pstream_common abstract. * Because it is the destructor it will be called by derived classes * and so must be defined. It is also protected, to discourage use of * the PStreams classes through pointers or references to the base class. * * @sa If defining a pure virtual seems odd you should read * http://www.gotw.ca/gotw/031.htm (and the rest of the site as well!) */ template inline pstream_common::~pstream_common() { } /** * Calls rdbuf()->open( @a command , @a mode ) * and sets @c failbit on error. * * @param cmd a string containing a shell command. * @param mode the I/O mode to use when opening the pipe. * @see basic_pstreambuf::open(const std::string&, pmode) */ template inline void pstream_common::do_open(const std::string& cmd, pmode mode) { if (!buf_.open((command_=cmd), mode)) this->setstate(std::ios_base::failbit); } /** * Calls rdbuf()->open( @a file, @a argv, @a mode ) * and sets @c failbit on error. * * @param file a string containing the pathname of a program to execute. * @param argv a vector of argument strings passed to the new program. * @param mode the I/O mode to use when opening the pipe. * @see basic_pstreambuf::open(const std::string&, const argv_type&, pmode) */ template inline void pstream_common::do_open( const std::string& file, const argv_type& argv, pmode mode ) { if (!buf_.open((command_=file), argv, mode)) this->setstate(std::ios_base::failbit); } /** Calls rdbuf->close() and sets @c failbit on error. Returns * process's exit status, as pclose(3) does. */ template inline int pstream_common::close() { if (!buf_.close()) this->setstate(std::ios_base::failbit); return buf_.status(); } /** * @return rdbuf()->is_open(). * @see basic_pstreambuf::is_open() */ template inline bool pstream_common::is_open() const { return buf_.is_open(); } /** @return a string containing the command used to initialise the stream. */ template inline const std::string& pstream_common::command() const { return command_; } /** @return a pointer to the private stream buffer member. */ // TODO document behaviour if buffer replaced. template inline typename pstream_common::streambuf_type* pstream_common::rdbuf() const { return const_cast(&buf_); } #if REDI_EVISCERATE_PSTREAMS /** * @def REDI_EVISCERATE_PSTREAMS * If this macro has a non-zero value then certain internals of the * @c basic_pstreambuf template class are exposed. In general this is * a Bad Thing, as the internal implementation is largely undocumented * and may be subject to change at any time, so this feature is only * provided because it might make PStreams useful in situations where * it is necessary to do Bad Things. */ /** * @warning This function exposes the internals of the stream buffer and * should be used with caution. It is the caller's responsibility * to flush streams etc. in order to clear any buffered data. * The POSIX.1 function fdopen(3) is used to obtain the * @c FILE pointers from the streambuf's private file descriptor * members so consult your system's documentation for * fdopen(3). * * @param in A FILE* that will refer to the process' stdin. * @param out A FILE* that will refer to the process' stdout. * @param err A FILE* that will refer to the process' stderr. * @return An OR of zero or more of @c pstdin, @c pstdout, @c pstderr. * * For each open stream shared with the child process a @c FILE* is * obtained and assigned to the corresponding parameter. For closed * streams @c NULL is assigned to the parameter. * The return value can be tested to see which parameters should be * @c !NULL by masking with the corresponding @c pmode value. * * @see fdopen(3) */ template std::size_t basic_pstreambuf::fopen(FILE*& in, FILE*& out, FILE*& err) { in = out = err = NULL; std::size_t open_files = 0; if (wpipe() > -1) { if ((in = ::fdopen(wpipe(), "w"))) { open_files |= pstdin; } } if (rpipe(rsrc_out) > -1) { if ((out = ::fdopen(rpipe(rsrc_out), "r"))) { open_files |= pstdout; } } if (rpipe(rsrc_err) > -1) { if ((err = ::fdopen(rpipe(rsrc_err), "r"))) { open_files |= pstderr; } } return open_files; } /** * @warning This function exposes the internals of the stream buffer and * should be used with caution. * * @param in A FILE* that will refer to the process' stdin. * @param out A FILE* that will refer to the process' stdout. * @param err A FILE* that will refer to the process' stderr. * @return A bitwise-or of zero or more of @c pstdin, @c pstdout, @c pstderr. * @see basic_pstreambuf::fopen() */ template inline std::size_t pstream_common::fopen(FILE*& fin, FILE*& fout, FILE*& ferr) { return buf_.fopen(fin, fout, ferr); } #endif // REDI_EVISCERATE_PSTREAMS } // namespace redi /** * @mainpage PStreams Reference * @htmlinclude mainpage.html */ #endif // REDI_PSTREAM_H_SEEN // vim: ts=2 sw=2 expandtab pstreams-1.0.3/ChangeLog0000664000175000017530000014516613670241503015044 0ustar jwakelyjwakelyAuthor: Jonathan Wakely Date: Wed Jun 10 21:30:51 2020 +0100 Fix spec file for rawhide Author: Jonathan Wakely Date: Wed Jun 10 21:19:01 2020 +0100 Adjust Makefile for GNU Make 4.3 compatibility Since GNU Make 4.3 a '#' in a function invocation should not be escaped. Author: Jonathan Wakely Date: Wed Jun 10 20:32:44 2020 +0100 Update version in spec file Author: Jonathan Wakely Date: Wed Jun 10 20:25:09 2020 +0100 Add SPDX license identifiers and update copyright dates Author: Jonathan Wakely Date: Wed Jun 10 20:22:46 2020 +0100 Regenerate HTML for 1.0.3 release Author: Jonathan Wakely Date: Wed Jun 10 20:21:38 2020 +0100 Update filename to INSTALL.md Author: Jonathan Wakely Date: Thu Mar 5 15:58:38 2020 +0000 pstream.h: Add move semantics Update version to 1.0.3 due to API change. TODO: moving rpstream objects isn't supported yet. Author: Jonathan Wakely Date: Thu Mar 5 15:57:16 2020 +0000 INSTALL.md: Actually use markdown this time Author: Jonathan Wakely Date: Thu Mar 5 12:53:11 2020 +0000 pstream.h: Avoid -Wc++14-extensions warning from clang Author: Jonathan Wakely Date: Thu Mar 5 12:48:15 2020 +0000 INSTALL: Rename to INSTALL.md and use markdown Resolves #5 in github pull requests. Author: Jonathan Wakely Date: Thu Mar 5 12:28:28 2020 +0000 Makefile: always rebuild test files Author: Jonathan Wakely Date: Thu Mar 5 12:25:55 2020 +0000 pstream.h: Deprecate basic_pstreambuf::init_rbuffers() Update version to 1.0.2 (without making a release). Author: Jonathan Wakely Date: Thu Mar 5 12:25:47 2020 +0000 pstream.h: Constrain initializer_list constructors Author: Jonathan Wakely Date: Thu Mar 5 12:18:18 2020 +0000 test_pstreams.cc: Fix for explicit operator bool in C++11 Author: Jonathan Wakely Date: Thu Mar 5 12:00:17 2020 +0000 pstream.h: format ctor-initializer consistently Author: Warren Young Date: Thu Feb 14 21:00:12 2019 +0000 pstream::close() should return program exit status as pclose This patch makes it so, and updates the test program to make use of the feature, simplifying its code in all cases. It results in no test output diffs other than to timestamps and to the "Nothing to read NN times" lines. Author: Warren Young Date: Thu Feb 14 20:56:38 2019 +0000 Makefile top-level target canonicalization The current makefile mixes the actions of "all", "check" and "clean" in ways that violate my expectations. The attached patch fixes the following problems: 1. "make ; make" no longer builds the test programs twice 2. -Werror is no longer the default build: you have to ask for it with "make check-werror" 3. redundant targets are collected together Author: Jonathan Wakely Date: Thu Feb 14 20:50:43 2019 +0000 Fix -Wshadow warning from GCC 4.1.2 Author: Jonathan Wakely Date: Fri Oct 19 10:52:37 2018 +0100 Update email address Author: Jonathan Wakely Date: Thu Feb 15 21:55:26 2018 +0000 Remove unnecessary Group tag and cleanup Author: Jonathan Wakely Date: Thu Feb 2 13:29:54 2017 +0000 Change name in README Author: Jonathan Wakely Date: Thu Feb 2 13:21:17 2017 +0000 Fix licensing info in README Author: Jonathan Wakely Date: Thu Feb 2 13:04:40 2017 +0000 Change licence and release version 1.0.1 Modify makefile 'dist' and 'all' targets. Author: Jonathan Wakely Date: Thu Dec 1 18:40:21 2016 +0000 Release version 1.0.0 Author: Jonathan Wakely Date: Thu Dec 1 16:28:12 2016 +0000 Doxyfile: Update to Doxygen 1.8.11 Author: Jonathan Wakely Date: Thu Jul 14 14:07:20 2016 +0100 test_pstreams.cc: Qualify names from std Author: Jonathan Wakely Date: Tue Jan 26 12:25:22 2016 +0000 Fix %changelog entry Author: Jonathan Wakely Date: Tue Jan 26 12:09:46 2016 +0000 Remove redundant %defattr Author: Jonathan Wakely Date: Tue Jan 5 21:31:05 2016 +0000 Replace packagename macro and remove BuildRoot tag Author: Jonathan Wakely Date: Sun Aug 23 22:47:17 2015 +0100 README: Fix typo. Author: Jonathan Wakely Date: Sun Aug 23 22:26:29 2015 +0100 Doxyfile: Update. Author: Jonathan Wakely Date: Sun Aug 23 22:14:28 2015 +0100 pstream.h: Don't call char_traits::move() when npb==0. Debian bug #796730. Author: Jonathan Wakely Date: Fri Jul 11 12:58:06 2014 +0100 pstreams-devel.spec: Fix package description. Author: Jonathan Wakely Date: Thu Jul 10 17:30:13 2014 +0100 Makefile: Add srpm target. Author: Jonathan Wakely Date: Sat Mar 29 13:48:51 2014 +0000 Fix -Wshadow warnings (SourceForge feature request #5). Makefile: Add -Wshadow to CFLAGS. pstream.h: Fix -Wshadow warnings. Author: Jonathan Wakely Date: Sat Mar 29 13:47:57 2014 +0000 Doxyfile: Update to Doxygen 1.8.6 format. Author: Jonathan Wakely Date: Sat Mar 29 13:46:06 2014 +0000 README: Update. Author: Jonathan Wakely Date: Fri Feb 7 13:07:07 2014 +0000 Version 0.8.1 release. Author: Jonathan Wakely Date: Fri Feb 7 00:55:18 2014 +0000 pstream.h (basic_ipstream::basic_ipstream(argv_type, pmode): Use basic_ipstream::readable(pmode) to correctly set input mode. test_pstreams.cc: Test execve-style construction for ipstream. Author: Jonathan Wakely Date: Fri Sep 13 14:42:58 2013 +0000 .gitignore: Ignore all dist files. Author: Jonathan Wakely Date: Fri Jul 12 00:20:21 2013 +0100 pstream.h: Add initializer-list constructors. Make unary constructors explicit. Author: Jonathan Wakely Date: Thu Jul 11 23:27:43 2013 +0100 pstream.h: Add newpg pmode flag. Version 0.8.1. test_pstreams.cc: Test newpg flag. Author: Jonathan Wakely Date: Thu Jul 11 23:17:23 2013 +0100 test_pstreams.cc: Re-indent and update copyright date. Author: Jonathan Wakely Date: Fri Mar 29 19:07:19 2013 +0000 Makefile: Fix rule to not fail if no .git dir Author: Jonathan Wakely Date: Fri Mar 29 17:50:32 2013 +0000 .gitignore: Add dist files Author: Jonathan Wakely Date: Fri Mar 29 17:42:22 2013 +0000 pstream.h: Doc tweak Author: Jonathan Wakely Date: Fri Mar 29 15:48:29 2013 +0000 Makefile: Generate ChangeLog from Git Author: Jonathan Wakely Date: Fri Mar 29 15:16:39 2013 +0000 README: Note another improvement. Author: Jonathan Wakely Date: Wed Jan 23 00:43:11 2013 +0000 pstream.h: Put child in new process group and define pstreambuf::killpg() Thanks to Hein-Pieter van Braam for the suggestion. Author: Jonathan Wakely Date: Sun Jan 20 19:15:41 2013 +0000 pstream.h: Retry interrupted writes Author: Jonathan Wakely Date: Sun Jan 20 18:23:49 2013 +0000 Makefile: remove unused variable Author: Jonathan Wakely Date: Sun Jan 20 17:11:27 2013 +0000 pstream.h: Overload constructors for convenience. Bump version to 0.7.3 Author: Jonathan Wakely Date: Mon Jun 25 22:57:26 2012 +0100 pstream.h: Update copyright years and remove RCSID. Author: Jonathan Wakely Date: Mon Jun 25 22:48:53 2012 +0100 pstream.h (pstreambuf::xsputn): Optimize. Author: Jonathan Wakely Date: Mon Jun 25 22:20:48 2012 +0100 Remove outdated TODO comments. Author: Jonathan Wakely Date: Mon Jun 25 10:39:29 2012 +0000 Makefile: use order-only prerequisite to generate test file. Author: Jonathan Wakely Date: Sun Jun 24 13:03:43 2012 +0100 pstream.h (basic_pstreambuf::open): Work with _FORTIFY_SOURCE. Author: Jonathan Wakely Date: Sun Jun 24 13:02:03 2012 +0100 mainpage.html: Bump version. .gitignore: Add. Author: Jonathan Wakely Date: Sat Apr 14 14:23:51 2012 +0100 * Makefile: Fix typo in comment. Author: Jonathan Wakely Date: Tue Nov 15 11:12:10 2011 +0000 (basic_pstreambuf::wpipe, basic_pstreambuf::rpipe): Fix for clang. (PSTREAMS_VERSION): Bump to 0.7.2 Author: Jonathan Wakely Date: Thu Oct 14 21:38:38 2010 +0000 * pstreams-devel.spec: Update version and change make variable. Author: Jonathan Wakely Date: Thu Oct 14 21:35:22 2010 +0000 * Makefile: Extract version from header. * mainpage.html: Update version. Author: Jonathan Wakely Date: Thu Oct 14 19:57:41 2010 +0000 * pstream.h, test_pstreams.cc: Update copyright dates. Author: Jonathan Wakely Date: Thu Oct 14 19:55:19 2010 +0000 * pstream.h (pstreams_common::pstreams_common): Use basic_ios::rdbuf to set the streambuf, basic_ios::init(0) has already been called. Author: Jonathan Wakely Date: Wed May 12 15:45:21 2010 +0000 Add spec file to tarball Author: Jonathan Wakely Date: Wed May 12 15:37:34 2010 +0000 Fix spec file Author: Jonathan Wakely Date: Wed May 12 13:36:17 2010 +0000 Update. Author: Jonathan Wakely Date: Wed May 12 13:33:54 2010 +0000 Update version to 0.7.0 for release. Author: Jonathan Wakely Date: Wed May 12 13:17:14 2010 +0000 Use new name for cvs2cl script. Author: Jonathan Wakely Date: Wed May 12 12:45:25 2010 +0000 Add spec file from Fedora 12 Author: Jonathan Wakely Date: Sat Mar 20 14:54:35 2010 +0000 Test initial mode set correctly for ipstream. Author: Jonathan Wakely Date: Sat Mar 20 14:50:47 2010 +0000 Improve documentation for semantics of overflow. Author: Jonathan Wakely Date: Sat Mar 20 14:47:09 2010 +0000 Remove preprocessor check for Sun CC and define typedefs unconditionally. Author: Jonathan Wakely Date: Sat Mar 20 14:40:59 2010 +0000 Document previous change to initial read source. Author: Jonathan Wakely Date: Sat Mar 20 14:36:50 2010 +0000 Don't add pstdout to ipstream mode if pstderr given. Set initial mode correctly on open. Bump version to 0.7.0 due to change in behaviour. Author: Jonathan Wakely Date: Wed Sep 23 15:53:09 2009 +0000 Remove std qualifiers on FILE as is included and not . Author: Jonathan Wakely Date: Wed Sep 23 15:50:34 2009 +0000 Add 'check' target and make 'test' a synonym. Author: Jonathan Wakely Date: Mon Dec 15 00:02:04 2008 +0000 Add optimization to CXXFLAGS to get uninitialized warnings from gcc. Author: Jonathan Wakely Date: Mon Dec 15 00:00:18 2008 +0000 Replace 'whoami' with 'id -un' for Solaris portability. Author: Jonathan Wakely Date: Fri Nov 21 01:26:17 2008 +0000 Follow GNU make conventions. Author: Jonathan Wakely Date: Fri Nov 21 01:05:44 2008 +0000 Support DESTDIR and preserve timestamps, thanks to Till Maas. Author: Jonathan Wakely Date: Mon Sep 22 20:04:38 2008 +0000 Bug 2118980: Use more portable UTF-32 as iconv target. Author: Jonathan Wakely Date: Mon Sep 22 19:58:58 2008 +0000 Fix bug 2118980: generate dependency for test_pstreams Author: Jonathan Wakely Date: Sat Jul 12 17:25:07 2008 +0000 Change capitalistion. Author: Jonathan Wakely Date: Wed Jul 9 22:39:41 2008 +0000 Mention licence change! Author: Jonathan Wakely Date: Wed Jul 9 22:12:08 2008 +0000 Tweak comments. Author: Jonathan Wakely Date: Wed Jul 9 22:05:08 2008 +0000 Add example. Author: Jonathan Wakely Date: Mon Jul 7 22:33:17 2008 +0000 Only show trunk in ChangeLog. Author: Jonathan Wakely Date: Mon Jul 7 22:25:47 2008 +0000 Version to 0.6.0 Author: Jonathan Wakely Date: Mon Jul 7 22:24:14 2008 +0000 Fix typo. Author: Jonathan Wakely Date: Mon Jul 7 22:15:14 2008 +0000 Combine rules, set VERS=0.6.0 Author: Jonathan Wakely Date: Mon Jul 7 22:12:17 2008 +0000 Release notes for 0.6.0 Author: Jonathan Wakely Date: Mon Jul 7 21:38:14 2008 +0000 Change licence to LGPLv3. Author: Jonathan Wakely Date: Mon Dec 17 00:02:47 2007 +0000 Adjust copyright date. Author: Jonathan Wakely Date: Mon Dec 17 00:00:28 2007 +0000 Get rid of CONDITIONAL_SLEEP. Author: Jonathan Wakely Date: Sun Dec 16 23:49:21 2007 +0000 Remove extra tests left in from debugging. Author: Jonathan Wakely Date: Sun Dec 16 23:34:22 2007 +0000 (pstreambuf::fill_buffer): Option to work in non-blocking mode. (pstreambuf::showmanyc): New implementation using non-blocking fill_buffer. Author: Jonathan Wakely Date: Sun Dec 16 23:32:29 2007 +0000 Test streambuf::in_avail() and wide chars. Author: Jonathan Wakely Date: Sun Jul 15 16:39:08 2007 +0000 Fix missing qualification in example code (bug 1754057 - thanks to Brian Ray) Author: Jonathan Wakely Date: Sat Aug 19 16:37:21 2006 +0000 Replace memcpy/memmove with equivalent char_traits operations. Author: Jonathan Wakely Date: Sat Jul 22 01:24:18 2006 +0000 Update copyright year. Author: Jonathan Wakely Date: Sat Jul 22 01:20:43 2006 +0000 (pstreambuf::empty_buffer()): Adjust buffer on incomplete writes. (pstreambuf::write(),pstreambuf::read()): Adjust return value for wide chars. Author: Jonathan Wakely Date: Fri Jul 21 20:30:12 2006 +0000 (pstreambuf::fill_buffer()): Only call rbuffer() once. Author: Jonathan Wakely Date: Fri Jul 21 16:07:24 2006 +0000 Remove misleading comments, there are worse problems when sizeof(char_type)!=1 Author: Jonathan Wakely Date: Fri Jul 21 15:21:53 2006 +0000 (pstreambuf::showmanyc()): Fix overflow error. Author: Jonathan Wakely Date: Fri Jul 21 15:00:19 2006 +0000 Typo in comment. Author: Jonathan Wakely Date: Wed Jun 21 20:56:27 2006 +0000 Support Sun CC compiler (bug 1509533) Author: Jonathan Wakely Date: Sat Jan 21 21:02:06 2006 +0000 (pstreambuf::showmanyc()): Adjust result for sizeof(char_type) > 1 Author: Jonathan Wakely Date: Mon Jan 9 23:58:30 2006 +0000 Repeat file descriptor tests for vector open. Remove assumptions about what fd values will be found because pstreambuf can use extra pipes. Author: Jonathan Wakely Date: Sun Jan 8 23:08:19 2006 +0000 Update copyright date and fix signed/unsigned comparison warning. Author: Jonathan Wakely Date: Tue Sep 20 19:48:25 2005 +0000 Fix incorrect test numbering, caused by unintended template specialisations being created. Fix by keeping the counters with the labels. (Bug 650883) Author: Jonathan Wakely Date: Mon Sep 19 21:06:49 2005 +0000 Signal handler must have C linkage. Author: Jonathan Wakely Date: Mon Sep 5 01:15:27 2005 +0000 Use typedef name. Author: Jonathan Wakely Date: Mon Sep 5 00:39:27 2005 +0000 Use execl("/bin/sh", "sh", "-c", cmd) instead of execlp("sh", "sh", "-c", cmd) to avoid executing some other "sh" found in PATH (potential security hole). Version to 0.5.3 as this could change the behaviour of some programs. Author: Jonathan Wakely Date: Mon Sep 5 00:28:17 2005 +0000 Update fd leak test to match new behaviour (read pipes not closed right away). Test signal safety and exception-safety. Author: Jonathan Wakely Date: Mon Sep 5 00:18:21 2005 +0000 Delay cleaning up read buffers and pipes so that it is still possible to read from the pipes after the child has exited. Previously, sending peof could reap a zombie child and discard any unread data in the read buffers and/or pipes. Now the child is still reaped but the unread data is still available (bug 1163001). Clarify docs for wait() and exited(). Author: Jonathan Wakely Date: Sun Sep 4 15:31:41 2005 +0000 (pstreambuf::showmanyc): Fix broken logic (bug 1232564). Author: Jonathan Wakely Date: Tue Jul 19 08:24:29 2005 +0000 Apply improvements suggested by Antonio S. de A. Terceiro. Author: Jonathan Wakely Date: Sat Jul 16 01:21:59 2005 +0000 Update FSF postal address. Author: Jonathan Wakely Date: Sat Jul 16 01:07:42 2005 +0000 Return number of failed tests from main(). Author: Jonathan Wakely Date: Sat Jul 16 00:04:10 2005 +0000 Update copyright date to 2005. Author: Jonathan Wakely Date: Sat Jun 11 10:06:59 2005 +0000 Fix typo. Author: Jonathan Wakely Date: Sat Jun 11 09:59:20 2005 +0000 Release notes for 0.5.2. Author: Jonathan Wakely Date: Sat Jun 11 09:45:47 2005 +0000 Add note about performance. Author: Jonathan Wakely Date: Sat Jun 11 09:38:40 2005 +0000 Update version and rename "packages" target to more conventional "dist". Author: Jonathan Wakely Date: Sat Jun 11 09:36:42 2005 +0000 Update version number and use KBD.man_page style. Author: Jonathan Wakely Date: Sat Jun 11 09:25:06 2005 +0000 (pstreambuf::showmanyc()): New function to make streambuf::in_avail() work when FIONREAD supported by ioctl(). Author: Jonathan Wakely Date: Sat Jun 11 09:20:03 2005 +0000 Conditionally sleep depending on platform. Author: Jonathan Wakely Date: Sat Jun 11 09:18:53 2005 +0000 Add test for streambuf::in_avail(). Author: Jonathan Wakely Date: Sat Jun 11 09:17:53 2005 +0000 Use LDFLAGS when linking so it can be overridden on command line. Author: Jonathan Wakely Date: Wed Mar 16 02:12:16 2005 +0000 (pstreambuf::write()): Take pointer to const data. Author: Jonathan Wakely Date: Thu Dec 9 21:15:08 2004 +0000 Workarounds to make tests pass on Darwin (don't assume next fd is 3). Author: Jonathan Wakely Date: Thu Dec 9 20:57:18 2004 +0000 Workarounds to make tests pass on Solaris. Author: Jonathan Wakely Date: Thu Oct 21 00:17:09 2004 +0000 Doxygen comment corrections and formatting fixes. Author: Jonathan Wakely Date: Wed Oct 20 23:43:32 2004 +0000 Added install target and INSTALL_PREFIX variable. Author: Jonathan Wakely Date: Wed Oct 20 23:36:01 2004 +0000 (pstreambuf::open): Use close-on-exec pipe to detect execvp() failure. Author: Jonathan Wakely Date: Wed Oct 20 14:36:35 2004 +0000 (close_fd_array): Use template argument deduction to find array length. (close_fd): New helper to close single file descriptors. Author: Jonathan Wakely Date: Wed Oct 20 00:42:14 2004 +0000 Add tests for is_open() on bad commands. Author: Jonathan Wakely Date: Mon Oct 18 09:49:02 2004 +0000 Use constant for array length. Formatting fixes. Author: Jonathan Wakely Date: Sun Oct 17 16:12:19 2004 +0000 Fix URL of FAQ. Author: Jonathan Wakely Date: Sun Oct 17 16:07:32 2004 +0000 Don't generate ChangeLog if no CVS/Root file. Note about version numbers. Author: Jonathan Wakely Date: Sun Oct 17 15:46:05 2004 +0000 Update with "doxygen -u". Author: Jonathan Wakely Date: Sun Oct 17 15:44:05 2004 +0000 Add MANIFEST. Author: Jonathan Wakely Date: Sun Oct 17 15:43:16 2004 +0000 Version to 0.5.0 Author: Jonathan Wakely Date: Sun Oct 17 15:36:19 2004 +0000 Add INLINE_INHERITED_MEMB. Author: Jonathan Wakely Date: Sun Oct 3 05:01:40 2004 +0000 Whitespace change to comments. Author: Jonathan Wakely Date: Sun Oct 3 04:56:43 2004 +0000 Tidy up docs, be more consistent and remove duplication. Author: Jonathan Wakely Date: Sun Oct 3 04:15:21 2004 +0000 Cast execlp() sentinel to avoid problems where sizeof(int) != sizeof(void*). Use NULL instead of 0 where null pointer intended. Author: Jonathan Wakely Date: Fri Oct 1 19:00:43 2004 +0000 Ensure ipstreams always open for reading and opstreams always open for writing. Inherit from pstreams and use pmode names not ios_base::openmode names. Author: Jonathan Wakely Date: Wed Sep 29 08:29:25 2004 +0000 POSIX sed doesn't support "-" to mean stdin, use "cat -" instead. Author: Jonathan Wakely Date: Sun Sep 26 19:26:24 2004 +0000 Use argv_type typedef. Author: Jonathan Wakely Date: Sun Sep 26 19:25:51 2004 +0000 (pstreams::argv_type): New typedef for argument vector. (pstreams::fd_type,pstreams::fd_t): Rename fd_t to fd_type. Author: Jonathan Wakely Date: Sun Sep 26 19:12:16 2004 +0000 (pbsz,bufsz): Use enums for constants so no storage needed. Author: Jonathan Wakely Date: Fri Sep 24 23:44:56 2004 +0000 Test pstreambuf::exited() behaves sensibly. Author: Jonathan Wakely Date: Fri Sep 24 23:38:37 2004 +0000 (pstreambuf::exited): Return sensible values, bug #1014183. Author: Jonathan Wakely Date: Fri Sep 24 23:11:24 2004 +0000 Use "-" in tests, "/dev/stdin" may not be mounted (thanks to Jez Bromley). Author: Jonathan Wakely Date: Mon Sep 20 23:41:03 2004 +0000 (pstream_common::pmode): Remove unnecessary typedef. (pstreambuf::fopen): Surround assignments in parentheses. Author: Jonathan Wakely Date: Mon Sep 20 22:53:01 2004 +0000 Use /etc/hosts instead of /etc/motd, which may not exist. Author: Jonathan Wakely Date: Fri Jun 11 08:36:11 2004 +0000 Improve comment. Author: Jonathan Wakely Date: Fri Jun 11 00:08:12 2004 +0000 Add note about alpha compiler, thanks to Jez Bromley. Author: Jonathan Wakely Date: Thu Jun 10 23:57:29 2004 +0000 Qualify FILE and size_t with std:: namespace. Include stdio.h for FILE. Author: Jonathan Wakely Date: Thu Jun 10 15:21:53 2004 +0000 (pstreambuf::read_err()): use switch_read_buffer() to update stream position. (PSTREAMS_VERSION()): increment to 0.49, should make new release. Author: Jonathan Wakely Date: Thu Jun 10 15:14:48 2004 +0000 New test for read position. Author: Jonathan Wakely Date: Thu Jun 10 14:18:48 2004 +0000 Add extra testing that reading from terminated process fails. Author: Jonathan Wakely Date: Thu Jun 10 14:16:45 2004 +0000 Fix a test, add more tests for kill()/wait(), test for resource leaks. Author: Jonathan Wakely Date: Thu Jun 10 14:15:34 2004 +0000 (pstreambuf::wait()): Fix resource leaks when wait() called before close(). (pstreambuf::sync()): Use exited() to avoid writing to exited process. Author: Jonathan Wakely Date: Thu Jun 10 11:32:58 2004 +0000 Change formatting of comment. Author: Jonathan Wakely Date: Fri May 21 13:44:58 2004 +0000 Make some vars const. Author: Jonathan Wakely Date: Fri May 21 13:30:14 2004 +0000 Fix buggy test that raised SIGPIPE on FreeBSD: Stream was opened with all 3 pipes but process didn't read from stdin. By the time sync() was called the process had exited and closed its stdin. Author: Jonathan Wakely Date: Fri May 21 11:52:51 2004 +0000 Document that seeks will fail. Author: Jonathan Wakely Date: Fri May 21 10:52:27 2004 +0000 Clear stream state after reading to EOF. Include stack trace of FreeBSD failure. Add tests to check that seeking fails. Author: Jonathan Wakely Date: Fri Apr 30 19:30:27 2004 +0000 More release notes. Author: Jonathan Wakely Date: Fri Apr 30 19:13:14 2004 +0000 Add release notes for 0.48. Author: Jonathan Wakely Date: Fri Apr 30 18:39:12 2004 +0000 Append "_SEEN" to include guard macros. Version to 0.48. Author: Jonathan Wakely Date: Fri Apr 30 18:38:19 2004 +0000 Add some TODOs. Author: Jonathan Wakely Date: Fri Apr 30 18:37:01 2004 +0000 Fix typo. Author: Jonathan Wakely Date: Fri Apr 30 18:32:19 2004 +0000 Qualify more dependent names, needed for Comeau compiler. Author: Jonathan Wakely Date: Fri Apr 30 11:47:51 2004 +0000 Fix punctuation in some comments, no code changes. Author: Jonathan Wakely Date: Thu Apr 8 13:52:24 2004 +0000 Update version number. Author: Jonathan Wakely Date: Thu Apr 8 13:48:46 2004 +0000 (pstreambuf::read(char&)): Remove redundant function overload. (pstreambuf::write(char&)): Remove redundant function overload. (pstream_common::open()): Make non-virtual and rename to do_open(). (pstream_common): Make various functions and typedefs protected not public. (rpstream): Define all functions in class body. (PSTREAMS_VERSION): Increase to 0.47. Author: Jonathan Wakely Date: Tue Mar 30 11:51:26 2004 +0000 Merge with old_popen-branch. Author: Jonathan Wakely Date: Tue Mar 30 11:14:51 2004 +0000 Merge changes from old_popen-branch. Author: Jonathan Wakely Date: Sun Mar 28 13:27:31 2004 +0000 (peof()): Use dynamic_cast not static_cast. Version to 0.46. Author: Jonathan Wakely Date: Tue Mar 23 13:09:44 2004 +0000 Version to 0.45. Author: Jonathan Wakely Date: Tue Mar 23 13:09:14 2004 +0000 (pstreambuf::open()): Use ::_exit() instead of std::exit(). (pstreambuf::fill_buffer()): Use local vars instead of a cast and a temporary. (peof()): Add missing inline keyword. Version to 0.45, reformat some long lines. Author: Jonathan Wakely Date: Fri Mar 19 16:36:01 2004 +0000 (pstreambuf:empty_buffer()): More type fixes, 64-bit pointer bigger than int. Update copyright date, fix comments and version to 0.44. Author: Jonathan Wakely Date: Fri Mar 19 15:56:42 2004 +0000 (basic_pstreambuf::xsputn()): Qualify std::memcpy. (basic_pstreambuf::fill_buffer()): Fix problem with different sized types. Author: Jonathan Wakely Date: Fri Mar 19 15:54:52 2004 +0000 (clean): New target to remove test binaries. Author: Jonathan Wakely Date: Wed Mar 17 14:06:44 2004 +0000 Don't use typedef names for explicit instantiation. Author: Jonathan Wakely Date: Wed Feb 4 22:56:06 2004 +0000 (basic_pstreambuf): Default Traits to std::char_traits. Author: Jonathan Wakely Date: Sun Jan 25 03:21:36 2004 +0000 Add -W for extra warnings. Author: Jonathan Wakely Date: Wed Sep 3 23:56:28 2003 +0000 Don't use type-def names for explicit instantiations of templates. (test_type()): Remove names of unused parameters. Author: Jonathan Wakely Date: Wed Sep 3 23:53:16 2003 +0000 Qualify basic_streambuf members with "this->". Author: Jonathan Wakely Date: Thu Jul 17 23:45:37 2003 +0000 More doxygen. Author: Jonathan Wakely Date: Thu Jul 17 23:39:09 2003 +0000 Minor doxygen improvements. Author: Jonathan Wakely Date: Thu Jul 17 23:23:04 2003 +0000 Remove rpstream.h Author: Jonathan Wakely Date: Mon Apr 28 10:57:41 2003 +0000 Fix call to base class ctor for bidirectional pstream. Author: Jonathan Wakely Date: Sun Apr 20 13:29:42 2003 +0000 Compile test_pstreams with -pedantic and fix missing const qual. Author: Jonathan Wakely Date: Fri Mar 14 16:19:36 2003 +0000 Update copyright year. Author: Jonathan Wakely Date: Tue Mar 11 01:55:18 2003 +0000 Remove reference to old rpstream.h file. Author: Jonathan Wakely Date: Tue Mar 11 01:28:23 2003 +0000 Fix failing tests, eofbit is set when getline() reaches EOF. Author: Jonathan Wakely Date: Mon Mar 10 18:02:10 2003 +0000 Use more portable arguments to tr, works for Solaris now. Author: Jonathan Wakely Date: Mon Mar 10 01:42:07 2003 +0000 Explicitly instantiate all template classes in both test programs. Author: Jonathan Wakely Date: Mon Mar 10 01:34:53 2003 +0000 Don't #include rpstream.h, file removed. Author: Jonathan Wakely Date: Mon Mar 10 01:31:10 2003 +0000 Move rpstream definition into pstream.h and remove rpstream.h Author: Jonathan Wakely Date: Mon Mar 10 01:13:54 2003 +0000 (streambuf_type): remove unused typedef from concrete stream classes. Author: Jonathan Wakely Date: Mon Mar 10 01:12:33 2003 +0000 Remove TEST_RPSTREAM macro and always test rpstreams. Author: Jonathan Wakely Date: Wed Mar 5 23:52:06 2003 +0000 Fix typo in sed command. Author: Jonathan Wakely Date: Wed Mar 5 23:49:47 2003 +0000 Qualify dependent names with "this->" to delay lookup. Author: Jonathan Wakely Date: Thu Feb 27 17:51:40 2003 +0000 (rpstream::rpstream()): Remove redundant call to std::basic_ios::init(). Author: Jonathan Wakely Date: Thu Feb 27 17:35:58 2003 +0000 (pstream_common::open()): Use "this->" to prevent lookup finding ::setstate. Author: Jonathan Wakely Date: Thu Feb 27 17:29:42 2003 +0000 (pstream_common::buf_): Add using decls to access buf_ in derived class. (rpstream::pmode): Make typedef public, matches other classes. Author: Jonathan Wakely Date: Sat Dec 14 21:36:36 2002 +0000 Solaris sh(1) exit status is 1 when command not found (POSIX says 127). Author: Jonathan Wakely Date: Sat Dec 14 21:03:20 2002 +0000 Improve regex so empty lines prefixed with STDIN. Author: Jonathan Wakely Date: Sat Dec 14 20:55:40 2002 +0000 Fix some bugs in the tests due to portability issues. Author: Jonathan Wakely Date: Sat Dec 14 19:19:49 2002 +0000 Mention that Makefile doesn't work on Solaris (bug #650887) Author: Jonathan Wakely Date: Tue Dec 3 20:23:07 2002 +0000 Document that I/O is buffered now. Author: Jonathan Wakely Date: Wed Nov 13 01:40:48 2002 +0000 Add tests for rpstream. Author: Jonathan Wakely Date: Fri Nov 8 02:53:04 2002 +0000 Version 0.42, fully buffered now. Author: Jonathan Wakely Date: Fri Nov 8 02:51:51 2002 +0000 Version to 0.42, all I/O buffered. Move static constants into common base. Replace take_from_buf_ and char_buf_ with wbuffer_ and two rbuffer_ arrays. Remove take_from_buf(), char_buf(), uflow(). Add rbuffer(), switch_read_buffer(), fill_buffer(), create_buffers(), destroy_buffers(). read() and write() use multibyte strings now. Author: Jonathan Wakely Date: Thu Nov 7 01:20:40 2002 +0000 Rename COPYING to COPYING.LIB Author: Jonathan Wakely Date: Tue Oct 22 23:23:53 2002 +0000 Formatting changes: removed some braces, moved some functions. Author: Jonathan Wakely Date: Tue Oct 22 23:10:18 2002 +0000 (init_rbuffers()): New function called at construction to zero arrays. Fix bad variable name from copy'n'paste error. Author: Jonathan Wakely Date: Tue Oct 22 01:30:27 2002 +0000 Rename pstream_base class template to pstream_common. Author: Jonathan Wakely Date: Tue Oct 22 01:03:22 2002 +0000 Increase version number to match CVS HEAD. Author: Jonathan Wakely Date: Tue Oct 22 00:59:19 2002 +0000 (pstreambuf::readerr(bool)): Use ternary op for conditional, easier to read. Author: Jonathan Wakely Date: Tue Oct 22 00:56:33 2002 +0000 Remove verbose "this->" from member function calls. Author: Jonathan Wakely Date: Tue Oct 22 00:40:03 2002 +0000 Fix bad variable name from copy'n'paste error. Author: Jonathan Wakely Date: Sun Sep 22 01:05:15 2002 +0000 Add buffering for writes. Currently disabled. Author: Jonathan Wakely Date: Sat Sep 21 23:49:14 2002 +0000 Notes on new wait(), exited() and status() members. Author: Jonathan Wakely Date: Sat Sep 21 23:27:32 2002 +0000 Tidy up calls totest functions, use check_pass/check_fail where possible. Remove block of old, unused code. Author: Jonathan Wakely Date: Sat Sep 21 22:02:03 2002 +0000 New wait()-related functions are standard on pstreambuf now. Remove unnecessary static_casts. Author: Jonathan Wakely Date: Sat Sep 21 21:53:03 2002 +0000 (pstreambuf::wait(),pstreambuf::exited(),pstreambuf::status()): Use new functions. Version to 0.40 Author: Jonathan Wakely Date: Sat Sep 21 21:44:54 2002 +0000 Fix typo in comment. Author: Jonathan Wakely Date: Sat Sep 14 02:55:48 2002 +0000 Test pstreambuf::wait(), fixes last failure. Author: Jonathan Wakely Date: Sat Sep 14 02:54:50 2002 +0000 (pstream_base::rdbuf()): Return pointer to stream buffer. (pstreambuf::wait()): Experimental, -DPSTREAMS_WAIT. Wait for child exit. (pstreambuf::exited()): Experimental, -DPSTREAMS_WAIT. Check for child exit. Documentation improvements. Author: Jonathan Wakely Date: Sat Sep 14 02:52:05 2002 +0000 New variables to make it easier to give extra options to g++ Author: Jonathan Wakely Date: Tue Sep 10 00:10:59 2002 +0000 Fix test_minimum and run from Makefile again. Author: Jonathan Wakely Date: Mon Sep 9 22:44:14 2002 +0000 Give shell time to exit on bad command and don't write (causes SIGPIPE). Author: Jonathan Wakely Date: Mon Sep 9 22:40:44 2002 +0000 Fix missing '$' in shell cmd. Author: Jonathan Wakely Date: Mon Sep 9 00:28:12 2002 +0000 Lots of new and improved tests. Author: Jonathan Wakely Date: Mon Sep 9 00:27:29 2002 +0000 Mention kill() function. Author: Jonathan Wakely Date: Mon Sep 9 00:26:41 2002 +0000 (pstreambuf::fork()): Save errno instead of printing error message. (pstreambuf::kill()): New function to send a signal to child. (pstreambuf::error(),pstreambuf::error_): Report errno from system calls. (pstreambuf::status(),pstreambuf::status_): Report exit status of child process. (pstreambuf::peof(),peof): New function and manipulator to close pstdin pipe. (close_fd_array()): Make non-member. (iostream,cstring): Remove unnecesssary headers. Version to 0.39 Author: Jonathan Wakely Date: Mon Sep 9 00:11:43 2002 +0000 Ignore lots of files I have in my sandbox. Author: Jonathan Wakely Date: Sun Sep 8 22:39:22 2002 +0000 (docs): Automatically update version number in mainpage.html (OPTIM): New variable, can be overridden on command line. Author: Jonathan Wakely Date: Fri Aug 30 16:46:01 2002 +0000 Move standard headers to ensure pstream.h #incudes everything it needs. Author: Jonathan Wakely Date: Fri Aug 30 16:36:44 2002 +0000 Document errno=ESPIPE side effect of pstreambuf::fopen(). Author: Jonathan Wakely Date: Fri Aug 30 16:27:57 2002 +0000 (pstreambuf::fork(),pstreambuf::open()): Save errno instead of reporting to stderr. (pstreambuf::error_, pstreambuf::error()): New member for errors from sys calls. (pstreambuf::open(string, vector)): Make copies of args. (pstreambuf::close()): Don't use WNOHANG, wait for child to finish. (close_fd_array()): Make non-member, doesn't need special privileges. (PSTREAMS_VERSION): Increment to 0.39 Author: Jonathan Wakely Date: Fri Aug 30 16:17:48 2002 +0000 Ignore test binaries Author: Jonathan Wakely Date: Tue Aug 27 19:54:25 2002 +0000 (pstreambuf::rpipe(which)): Unnecessary enum keyword confuses Doxygen Author: Jonathan Wakely Date: Tue Aug 27 19:47:51 2002 +0000 Version to 0.38 (tag RELEASE_0_38) Author: Jonathan Wakely Date: Tue Aug 27 19:43:01 2002 +0000 Revert pstreambuf::fopen() to using FILE* parameters. Test properly. Author: Jonathan Wakely Date: Tue Aug 27 19:38:28 2002 +0000 (pstreambuf::fopen()): Revert to using FILE*s - it works now :-) Author: Jonathan Wakely Date: Tue Aug 27 02:11:00 2002 +0000 Version to 0.37 Author: Jonathan Wakely Date: Tue Aug 27 02:07:35 2002 +0000 (pstreambuf::fopen()): Expose file descriptors, not FILE*s as fdopen() fails. Author: Jonathan Wakely Date: Tue Aug 27 01:43:45 2002 +0000 (out(),err()): Move from opstream to ipstream (were on wrong class!) (pstreambuf::fopen()): Fix stupid copy'n'paste error, used same variable 3 times Author: Jonathan Wakely Date: Tue Aug 27 01:41:36 2002 +0000 Use sed not cat for better test. Author: Jonathan Wakely Date: Mon Aug 19 00:37:35 2002 +0000 Add test for REDI_EVISCERATE_PSTREAMS mode. Author: Jonathan Wakely Date: Mon Aug 19 00:36:40 2002 +0000 (pstreambuf::rpipe): Add missing definition of overloaded function. Author: Jonathan Wakely Date: Wed Jul 24 23:02:50 2002 +0000 (pstream_base::streambuf_type): Make protected so subclasses can access. Author: Jonathan Wakely Date: Wed Jul 24 23:00:21 2002 +0000 (distro): Remove target, didn't work right anyway. (MANIFEST): New target for list of files in releases. Author: Jonathan Wakely Date: Wed Jul 24 21:06:03 2002 +0000 (basic_pstreambuf::fork): Close other ends of pipes after dup2'ing them. Relicense under LGPL. Write stuff in README and INSTALL. Author: Jonathan Wakely Date: Wed May 15 01:27:47 2002 +0000 (pstreambuf::fork()): Open all pipes when pmode specifies more than one. Author: Jonathan Wakely Date: Mon Apr 29 23:44:52 2002 +0000 (pstream_base::~pstream_base()): Make pure virtual so class is abstract. Author: Jonathan Wakely Date: Mon Apr 29 23:03:03 2002 +0000 Typo in comment. Author: Jonathan Wakely Date: Mon Apr 29 22:58:48 2002 +0000 (pstreambuf): make copy ctor and operator= private again (oops) Some more doxygen comments. Author: Jonathan Wakely Date: Mon Apr 29 21:40:26 2002 +0000 (REDI_EVISCERATE_PSTREAMS): Macro to activate evil member functions. (pstreambuf::fopen()): Add evil function to expose FILE pointers. (pstream_base::fopen()): Add function to call evil function on streambuf Author: Jonathan Wakely Date: Mon Apr 29 21:27:48 2002 +0000 (pstreambuf::buf_read_src): Give enum a name. (pstreambuf::rpipe()): Add overload of function. (pstreambuf): Make private member functions protected. #include and add std:: to calls to strerror() Version to 0.35 Author: Jonathan Wakely Date: Sat Apr 27 14:58:29 2002 +0000 (pstreambuf::fdclose()): Rename to close_fd_array(), describes purpose better Author: Jonathan Wakely Date: Sat Apr 27 14:56:36 2002 +0000 Disable execution of test_minimum, doesn't work. Still compile it though. Author: Jonathan Wakely Date: Sat Apr 27 04:24:23 2002 +0000 Add link to pstreams home page. Author: Jonathan Wakely Date: Sat Apr 27 03:51:46 2002 +0000 Replace pstreams.html with mainpage.html and remove lots of text that is more relevant to PStreams home page than to the API reference. Author: Jonathan Wakely Date: Sat Apr 27 03:18:34 2002 +0000 Correct credit for ChildReader class. Author: Jonathan Wakely Date: Fri Apr 26 01:48:23 2002 +0000 Add a space Author: Jonathan Wakely Date: Fri Apr 26 01:39:30 2002 +0000 Link to archives of latest version and older (maybe more stable?) version. Author: Jonathan Wakely Date: Fri Apr 26 01:25:36 2002 +0000 brief README file (far too brief) Author: Jonathan Wakely Date: Fri Apr 26 01:23:36 2002 +0000 Add rpstream.h to SOURCES Author: Jonathan Wakely Date: Fri Apr 26 01:22:14 2002 +0000 Mention "make docs" Author: Jonathan Wakely Date: Fri Apr 26 01:17:57 2002 +0000 Add Id keyword Author: Jonathan Wakely Date: Fri Apr 26 01:16:47 2002 +0000 More stupid typos Author: Jonathan Wakely Date: Thu Apr 25 02:12:50 2002 +0000 (pstreambuf::fork()): Swap pstdin and pstdout AGAIN! Author: Jonathan Wakely Date: Thu Apr 25 02:00:32 2002 +0000 Fix several stupid typos and copy&paste errors. Compiles now. Fails tests. Author: Jonathan Wakely Date: Thu Apr 25 01:59:25 2002 +0000 Remove options that aren't available in g++ 3.1 Author: Jonathan Wakely Date: Wed Apr 24 23:23:33 2002 +0000 (pstream_base): New base class providing common functionality. (rpstream): Move restricted pstream class to separate file, rpstream.h Up version to 0.32 and update docs. Author: Jonathan Wakely Date: Wed Apr 24 22:00:17 2002 +0000 New file giving installation instructions (such as they are) Author: Jonathan Wakely Date: Sun Apr 21 01:40:30 2002 +0000 (rpstream::pmode, rpstream::istream_type): Add required typename keyword. Author: Jonathan Wakely Date: Sat Apr 20 20:33:52 2002 +0000 Merge with replace_popen-branch Author: Jonathan Wakely Date: Mon Jan 28 02:43:50 2002 +0000 (OUTPUT_DIRECTORY): change absolute path to relative Author: Jonathan Wakely Date: Mon Jan 28 02:41:36 2002 +0000 Add required typename specifiers Author: Jonathan Wakely Date: Sun Jan 27 13:16:26 2002 +0000 New file Author: Jonathan Wakely Date: Sun Jan 27 13:00:32 2002 +0000 New file Author: Jonathan Wakely Date: Sun Jan 27 13:00:17 2002 +0000 New tests Author: Jonathan Wakely Date: Sun Jan 27 12:36:18 2002 +0000 Use HTML entity for ampersands in URIs Author: Jonathan Wakely Date: Sun Jan 27 12:35:19 2002 +0000 Test writing to closed steam Author: Jonathan Wakely Date: Sun Jan 27 12:33:31 2002 +0000 (test_bidip, test_minimum): Add new tests (distro): Use DISTFILES variable Author: Jonathan Wakely Date: Sun Jan 13 05:01:16 2002 +0000 (read(),write()): Fix stupid mistake where int_type used instead of char_type (read(),write()): Overloads for writing character sequences Version to 0.17 Author: Jonathan Wakely Date: Sun Jan 13 04:53:23 2002 +0000 Refer to doxygen docs in usage secion. Note about upcoming version. Author: Jonathan Wakely Date: Sun Jan 13 04:30:37 2002 +0000 New file. Author: Jonathan Wakely Date: Wed Jan 9 03:39:03 2002 +0000 Removed file as it is not used anywhere. Author: Jonathan Wakely Date: Wed Jan 9 03:28:41 2002 +0000 (istream,ostream): Add required headers. (basic_pstreambuf::open): Fix typo. Version to 0.16 Author: Jonathan Wakely Date: Tue Jan 8 11:53:28 2002 +0000 (open,close): Add error checking. Version to 0.15 Author: Jonathan Wakely Date: Tue Jan 8 03:41:27 2002 +0000 Formatting changes, moved all function defs and docs out of class body. Version to 0.14 Author: Jonathan Wakely Date: Tue Jan 8 01:35:06 2002 +0000 (basic_pstream): Fix missing std:: qualifiers. Author: Jonathan Wakely Date: Tue Jan 8 00:35:44 2002 +0000 (openmode2str): Add inline keyword to prevent multiple definitions. Author: Jonathan Wakely Date: Mon Jan 7 20:35:32 2002 +0000 (BACK_COMPAT): Move non-standard versions from pstream.h to pstream_compat.h Author: Jonathan Wakely Date: Mon Jan 7 20:28:38 2002 +0000 (pbackfail): Fix missing '!' in condition. (basic_pstream): Fix typos in ctor/dtor names. (command_,buf_): Make protected member variables private in stream classes. (string,ios_base): remove typedefs and explicitly qualify each use with std:: (openmode2str): Make non-member function. (REDI_PSTREAMS_POPEN_USES_BIDIRECTIONAL_PIPE): only define if !defined Add comments for Doxygen. Version to 0.12 Author: Jonathan Wakely Date: Mon Jan 7 11:43:47 2002 +0000 Minor formatting change. Author: Jonathan Wakely Date: Mon Jan 7 11:36:54 2002 +0000 (test): Slight changes to test targets. Author: Jonathan Wakely Date: Mon Jan 7 11:35:58 2002 +0000 New file. Author: Jonathan Wakely Date: Mon Jan 7 11:33:09 2002 +0000 (command(),command_): Moved members from streambuf class to stream classes. (read(),write()): Check for null FILE* to prevent segfaults. Author: Jonathan Wakely Date: Mon Dec 31 22:02:33 2001 +0000 Added description and keywords tags for search engines and a TODO. Author: Jonathan Wakely Date: Mon Dec 31 21:57:46 2001 +0000 (command): member function added to all classes. minor format and comment changes Author: Jonathan Wakely Date: Sat Dec 15 19:50:21 2001 +0000 (ChangeLog) new target Author: Jonathan Wakely Date: Sat Dec 15 19:36:52 2001 +0000 New file Author: Jonathan Wakely Date: Sat Dec 15 19:05:12 2001 +0000 Correct version number to 0.11 Author: Jonathan Wakely Date: Sat Dec 15 19:03:58 2001 +0000 (MODE_MASK) remove this constant, only used in one place. (BACK_COMPAT GCC_BACK_COMPAT) #defines for backward compatible versions, standard conforming version now default. Update version to 0.11 Author: Jonathan Wakely Date: Sat Dec 15 18:53:47 2001 +0000 Updated to cover version 0.11 Validated HTML and CSS. Author: Jonathan Wakely Date: Sat Dec 15 18:00:19 2001 +0000 Updated version number to 0.10 Author: Jonathan Wakely Date: Sat Dec 15 17:44:24 2001 +0000 Updated documentation. Author: Jonathan Wakely Date: Sat Dec 15 17:37:21 2001 +0000 Added standard-conforming versions of (i|o|)pstream classes. Author: Jonathan Wakely Date: Thu Dec 13 03:27:44 2001 +0000 New file, currently unused. Author: Jonathan Wakely Date: Thu Dec 13 03:27:03 2001 +0000 Update to describe v0.02 Add usage section. Author: Jonathan Wakely Date: Thu Dec 13 03:23:11 2001 +0000 Move functionality into class pstreambase. Added pstream for bidirectional IO. Author: Jonathan Wakely Date: Thu Dec 13 02:15:11 2001 +0000 Added file back, with -kb option for binary file. Author: Jonathan Wakely Date: Thu Dec 13 02:14:21 2001 +0000 Removed file to re-add it with -kb binary option. Author: Jonathan Wakely Date: Thu Dec 13 00:39:16 2001 +0000 Initial revision pstreams-1.0.3/MANIFEST0000664000175000017530000000053713670241503014413 0ustar jwakelyjwakelypstreams-1.0.3/pstream.h pstreams-1.0.3/ChangeLog pstreams-1.0.3/MANIFEST pstreams-1.0.3/AUTHORS pstreams-1.0.3/LICENSE_1_0.txt pstreams-1.0.3/Doxyfile pstreams-1.0.3/INSTALL.md pstreams-1.0.3/Makefile pstreams-1.0.3/README pstreams-1.0.3/mainpage.html pstreams-1.0.3/test_pstreams.cc pstreams-1.0.3/test_minimum.cc pstreams-1.0.3/pstreams-devel.spec pstreams-1.0.3/AUTHORS0000664000175000017530000000004613431345645014334 0ustar jwakelyjwakelyJonathan Wakely pstreams-1.0.3/LICENSE_1_0.txt0000664000175000017530000000247213044631054015543 0ustar jwakelyjwakelyBoost Software License - Version 1.0 - August 17th, 2003 Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following: The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. pstreams-1.0.3/Doxyfile0000664000175000017530000031521113020071351014755 0ustar jwakelyjwakely# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = PStreams # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = doc/ # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = YES # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 8 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = pstream.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = . # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = NO # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /