output.cc revision 8229:78bf55f23338 
1/*
2 * Copyright (c) 2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 */
30
31#include <sys/stat.h>
32#include <sys/types.h>
33
34#include <cerrno>
35#include <climits>
36#include <cstdlib>
37#include <fstream>
38
39#include <gzstream.hh>
40
41#include "base/misc.hh"
42#include "base/output.hh"
43
44using namespace std;
45
46OutputDirectory simout;
47
48/**
49 *
50 */
51OutputDirectory::OutputDirectory()
52{}
53
54OutputDirectory::~OutputDirectory()
55{
56    for (map_t::iterator i = files.begin(); i != files.end(); i++) {
57        if (i->second)
58            delete i->second;
59    }
60}
61
62std::ostream *
63OutputDirectory::checkForStdio(const string &name) const
64{
65    if (name == "cerr" || name == "stderr")
66        return &cerr;
67
68    if (name == "cout" || name == "stdout")
69        return &cout;
70
71    return NULL;
72}
73
74ostream *
75OutputDirectory::openFile(const string &filename,
76                          ios_base::openmode mode) const
77{
78    if (filename.find(".gz", filename.length()-3) < filename.length()) {
79        ogzstream *file = new ogzstream(filename.c_str(), mode);
80
81        if (!file->is_open())
82            fatal("Cannot open file %s", filename);
83
84        return file;
85    } else {
86        ofstream *file = new ofstream(filename.c_str(), mode);
87
88        if (!file->is_open())
89            fatal("Cannot open file %s", filename);
90
91        return file;
92    }
93}
94
95void
96OutputDirectory::setDirectory(const string &d)
97{
98    if (!dir.empty())
99        panic("Output directory already set!\n");
100
101    dir = d;
102
103    // guarantee that directory ends with a '/'
104    if (dir[dir.size() - 1] != '/')
105        dir += "/";
106}
107
108const string &
109OutputDirectory::directory() const
110{
111    if (dir.empty())
112        panic("Output directory not set!");
113
114    return dir;
115}
116
117inline string
118OutputDirectory::resolve(const string &name) const
119{
120    return (name[0] != '/') ? dir + name : name;
121}
122
123ostream *
124OutputDirectory::create(const string &name, bool binary)
125{
126    ostream *file = checkForStdio(name);
127    if (file)
128        return file;
129
130    string filename = resolve(name);
131    ios_base::openmode mode =
132        ios::trunc | binary ?  ios::binary : (ios::openmode)0;
133    file = openFile(filename, mode);
134
135    return file;
136}
137
138ostream *
139OutputDirectory::find(const string &name)
140{
141    ostream *file = checkForStdio(name);
142    if (file)
143        return file;
144
145    string filename = resolve(name);
146    map_t::iterator i = files.find(filename);
147    if (i != files.end())
148        return (*i).second;
149
150    file = openFile(filename);
151    files[filename] = file;
152    return file;
153}
154
155bool
156OutputDirectory::isFile(const std::ostream *os)
157{
158    return os && os != &cerr && os != &cout;
159}
160