output.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2015 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Copyright (c) 2013 Andreas Sandberg
 * Copyright (c) 2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Nathan Binkert
 *          Chris Emmons
 *          Andreas Sandberg
 *          Sascha Bischoff
 */

#ifndef __BASE_OUTPUT_HH__
#define __BASE_OUTPUT_HH__

#include <ios>
#include <map>
#include <string>

#include "base/compiler.hh"

class OutputDirectory;

class OutputStream
{
  public:
    virtual ~OutputStream();

    std::ostream *stream() const { return _stream; };

    virtual bool recreateable() const { return false; }

    const std::string &name() const { return _name; }

  protected:
    friend class OutputDirectory;

    OutputStream(const std::string &name,
                 std::ostream *stream);

    /* Prevent copying */
    OutputStream(const OutputStream &f);

    virtual void relocate(const OutputDirectory &dir);

    const std::string _name;

    std::ostream *const _stream;
};

template<class StreamType>
class OutputFile
    : public OutputStream
{
  public:
    typedef StreamType stream_type_t;

    virtual ~OutputFile();

    bool recreateable() const override { return _recreateable; }

  protected:
    friend class OutputDirectory;

    OutputFile(const OutputDirectory &dir,
               const std::string &name,
               std::ios_base::openmode mode,
               bool recreateable);

    /* Prevent copying */
    OutputFile(const OutputFile<StreamType> &f);

    void relocate(const OutputDirectory &dir) override;

    const std::ios_base::openmode _mode;

    const bool _recreateable;

    stream_type_t *const _fstream;
};

class OutputDirectory
{
  private:
    typedef std::map<std::string, OutputStream *> file_map_t;

    typedef std::map<std::string, OutputDirectory *> dir_map_t;

    file_map_t files;

    dir_map_t dirs;

    std::string dir;

    static const char PATH_SEPARATOR = '/';

    static OutputStream stdout;
    static OutputStream stderr;

  protected:
    static OutputStream *checkForStdio(const std::string &name);

  public:
    OutputDirectory();

    OutputDirectory(const std::string &name);

    ~OutputDirectory();

    std::string resolve(const std::string &name) const;

    void setDirectory(const std::string &dir);

    const std::string &directory() const;

    OutputStream *create(const std::string &name,
                         bool binary = false,
                         bool no_gz = false);

    OutputStream *open(const std::string &name,
                       std::ios_base::openmode mode,
                       bool recreateable = true,
                       bool no_gz = false);

    void close(OutputStream *file);

    OutputStream *find(const std::string &name) const;

    OutputStream *findOrCreate(const std::string &name, bool binary = false);

    bool isFile(const std::string &name) const;

    static inline bool isAbsolute(const std::string &name) {
        return name[0] == PATH_SEPARATOR;
    }

    OutputDirectory *createSubdirectory(const std::string &name);

    void remove(const std::string &name, bool recursive=false);
};

extern OutputDirectory simout;

#endif // __BASE_OUTPUT_HH__