blob: f97e7622ee58a12113473f238fc6d1f84cc9dde0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://www.qt.io/licensing. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef LIBVALGRIND_CALLGRIND_FUNCTION_H
#define LIBVALGRIND_CALLGRIND_FUNCTION_H
#include <QMetaType>
#include <QVector>
namespace Valgrind {
namespace Callgrind {
class FunctionCall;
class CostItem;
class ParseData;
class Function
{
public:
/// @p data the ParseData for the file this function was part of
/// required for the decompression of string data like function name etc.
explicit Function(const ParseData *data);
virtual ~Function();
/// @return the compressed function name id
qint64 nameId() const;
/// @return the function name.
QString name() const;
/**
* Set function name to internal string id @p id.
* @see ParseData::stringForFunction()
*/
void setName(qint64 id);
/// @return the compressed file id
qint64 fileId() const;
/// @return the file path where this function was defined
QString file() const;
/**
* Set function name to internal string id @p id.
* @see ParseData::stringForFunction()
*/
void setFile(qint64 id);
/// @return the compressed object id
qint64 objectId() const;
/// @return the object where this function was defined
QString object() const;
/**
* Set function name to internal string id @p id.
* @see ParseData::stringForFunction()
*/
void setObject(qint64 id);
/**
* @return a string representing the location of this function
* It is a combination of file, object and line of the first CostItem.
*/
QString location() const;
/**
* @return the line number of the function or -1 if not known
*/
int lineNumber() const;
/**
* total accumulated self cost of @p event
* @see ParseData::events()
*/
quint64 selfCost(int event) const;
QVector<quint64> selfCosts() const;
/**
* total accumulated inclusive cost of @p event
* @see ParseData::events()
*/
quint64 inclusiveCost(int event) const;
/// calls from other functions to this function
QVector<const FunctionCall *> incomingCalls() const;
void addIncomingCall(const FunctionCall *call);
/// @return how often this function was called in total
quint64 called() const;
/**
* The detailed list of cost items, which could e.g. be used for
* a detailed view of the function's source code annotated with
* cost per line.
*/
QVector<const CostItem *> costItems() const;
/**
* Add parsed @c CostItem @p item to this function.
*
* NOTE: The @c Function will take ownership.
*/
void addCostItem(const CostItem *item);
/**
* Function calls from this function to others.
*/
QVector<const FunctionCall *> outgoingCalls() const;
void addOutgoingCall(const FunctionCall *call);
/**
* Gets called after all functions where looked up, required
* to properly calculate inclusive cost of recursive functions
* for example
*/
void finalize();
protected:
class Private;
Private *d;
explicit Function(Private *d);
private:
Q_DISABLE_COPY(Function)
};
} // namespace Callgrind
} // namespace Valgrind
Q_DECLARE_METATYPE(const Valgrind::Callgrind::Function *);
#endif // LIBVALGRIND_CALLGRIND_FUNCTION_H
|
