gecko/nsprpub/lib/prstreams/prstrms.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Netscape Portable Runtime (NSPR).
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998-2000
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/*
 * Robin J. Maxwell 11-22-96
 * Fredrik Roubert <roubert@google.com> 2010-07-23
 * Matt Austern <austern@google.com> 2010-07-23
 */

#ifndef _PRSTRMS_H
#define _PRSTRMS_H

#include <cstddef>
#include <istream>
#include <ostream>
#include <streambuf>

#include "prio.h"

#ifdef _MSC_VER
// http://support.microsoft.com/kb/q168958/
class PR_IMPLEMENT(std::_Mutex);
class PR_IMPLEMENT(std::ios_base);
#endif


class PR_IMPLEMENT(PRfilebuf): public std::streambuf
{
public:
    PRfilebuf();
    PRfilebuf(PRFileDesc *fd);
    PRfilebuf(PRFileDesc *fd, char_type *ptr, std::streamsize len);
    virtual ~PRfilebuf();

    bool is_open() const { return _fd != NULL; }

    PRfilebuf *open(
                  const char *name,
                  std::ios_base::openmode flags,
                  PRIntn mode);
    PRfilebuf *attach(PRFileDesc *fd);
    PRfilebuf *close();

protected:
    virtual std::streambuf *setbuf(char_type *ptr, std::streamsize len);
    virtual pos_type seekoff(
                         off_type offset,
                         std::ios_base::seekdir dir,
                         std::ios_base::openmode flags);
    virtual pos_type seekpos(
                         pos_type pos,
                         std::ios_base::openmode flags) {
        return seekoff(pos, std::ios_base::beg, flags);
    }
    virtual int sync();
    virtual int_type underflow();
    virtual int_type overflow(int_type c = traits_type::eof());

    // TODO: Override pbackfail(), showmanyc(), uflow(), xsgetn(), and xsputn().

private:
    bool allocate();
    void setb(char_type *buf_base, char_type *buf_end, bool user_buf);

    PRFileDesc *_fd;
    bool _opened;
    bool _allocated;
    bool _unbuffered;
    bool _user_buf;
    char_type *_buf_base;
    char_type *_buf_end;
};


class PR_IMPLEMENT(PRifstream): public std::istream
{
public:
    PRifstream();
    PRifstream(PRFileDesc *fd);
    PRifstream(PRFileDesc *fd, char_type *ptr, std::streamsize len);
    PRifstream(const char *name, openmode flags = in, PRIntn mode = 0);
    virtual ~PRifstream();

    PRfilebuf *rdbuf() const { return &_filebuf; }
    bool is_open() const { return _filebuf.is_open(); }

    void open(const char *name, openmode flags = in, PRIntn mode = 0);
    void attach(PRFileDesc *fd);
    void close();

private:
    mutable PRfilebuf _filebuf;
};


class PR_IMPLEMENT(PRofstream): public std::ostream
{
public:
    PRofstream();
    PRofstream(PRFileDesc *fd);
    PRofstream(PRFileDesc *fd, char_type *ptr, std::streamsize len);
    PRofstream(const char *name, openmode flags = out, PRIntn mode = 0);
    virtual ~PRofstream();

    PRfilebuf *rdbuf() const { return &_filebuf; }
    bool is_open() const { return _filebuf.is_open(); }

    void open(const char *name, openmode flags = out, PRIntn mode = 0);
    void attach(PRFileDesc *fd);
    void close();

private:
    mutable PRfilebuf _filebuf;
};


class PR_IMPLEMENT(PRfstream): public std::iostream
{
public:
    PRfstream();
    PRfstream(PRFileDesc *fd);
    PRfstream(PRFileDesc *fd, char_type *ptr, std::streamsize len);
    PRfstream(const char *name, openmode flags = in | out, PRIntn mode = 0);
    virtual ~PRfstream();

    PRfilebuf *rdbuf() const { return &_filebuf; }
    bool is_open() const { return _filebuf.is_open(); }

    void open(const char *name, openmode flags = in | out, PRIntn mode = 0);
    void attach(PRFileDesc *fd);
    void close();

private:
    mutable PRfilebuf _filebuf;
};


#endif /* _PRSTRMS_H */