1/*
2 * Copyright (c) 2019 Arm Limited
3 * All rights reserved.
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2004-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Nathan Binkert
41 */
42
43#ifndef __BASE_STATS_TEXT_HH__
44#define __BASE_STATS_TEXT_HH__
45
46#include <iosfwd>
47#include <stack>
48#include <string>
49
50#include "base/stats/output.hh"
51#include "base/stats/types.hh"
52#include "base/output.hh"
53
54namespace Stats {
55
56class Text : public Output
57{
58  protected:
59    bool mystream;
60    std::ostream *stream;
61
62    // Object/group path
63    std::stack<std::string> path;
64
65  protected:
66    bool noOutput(const Info &info);
67
68  public:
69    bool descriptions;
70
71  public:
72    Text();
73    Text(std::ostream &stream);
74    Text(const std::string &file);
75    ~Text();
76
77    void open(std::ostream &stream);
78    void open(const std::string &file);
79    std::string statName(const std::string &name) const;
80
81    // Implement Visit
82    void visit(const ScalarInfo &info) override;
83    void visit(const VectorInfo &info) override;
84    void visit(const DistInfo &info) override;
85    void visit(const VectorDistInfo &info) override;
86    void visit(const Vector2dInfo &info) override;
87    void visit(const FormulaInfo &info) override;
88    void visit(const SparseHistInfo &info) override;
89
90    // Group handling
91    void beginGroup(const char *name) override;
92    void endGroup() override;
93
94    // Implement Output
95    bool valid() const override;
96    void begin() override;
97    void end() override;
98};
99
100std::string ValueToString(Result value, int precision);
101
102Output *initText(const std::string &filename, bool desc);
103
104} // namespace Stats
105
106#endif // __BASE_STATS_TEXT_HH__
107