Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlmemoryprofiler_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtQml module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef QQMLMEMORYPROFILER_H
43 #define QQMLMEMORYPROFILER_H
44
45 #include <private/qtqmlglobal_p.h>
46
47 QT_BEGIN_HEADER
48 QT_BEGIN_NAMESPACE
49
50 class QUrl;
51
52 class Q_QML_PRIVATE_EXPORT QQmlMemoryScope
53 {
54 public:
55     explicit QQmlMemoryScope(const QUrl &url);
56     explicit QQmlMemoryScope(const char *string);
57     ~QQmlMemoryScope();
58
59 private:
60     bool pushed;
61 };
62
63 class Q_QML_PRIVATE_EXPORT QQmlMemoryProfiler
64 {
65 public:
66     static void enable();
67     static void disable();
68     static bool isEnabled();
69
70     static void clear();
71     static void stats(int *allocCount, int *bytesAllocated);
72     static void save(const char *filename);
73 };
74
75 #define QML_MEMORY_SCOPE_URL(url)       QQmlMemoryScope _qml_memory_scope(url)
76 #define QML_MEMORY_SCOPE_STRING(s)      QQmlMemoryScope _qml_memory_scope(s)
77
78 QT_END_NAMESPACE
79 QT_END_HEADER
80
81 #endif // QQMLMEMORYPROFILER_H