File: dumpdotgraph.h

package info (click to toggle)
kdevelop 4%3A5.6.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 57,892 kB
  • sloc: cpp: 278,773; javascript: 3,558; python: 3,385; sh: 1,317; ansic: 689; xml: 273; php: 95; makefile: 40; lisp: 13; sed: 12
file content (52 lines) | stat: -rw-r--r-- 1,935 bytes parent folder | download
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
/***************************************************************************
   Copyright 2007 David Nolden <david.nolden.kdevelop@art-master.de>
***************************************************************************/

/***************************************************************************
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU General Public License as published by  *
*   the Free Software Foundation; either version 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
***************************************************************************/

#ifndef KDEVPLATFORM_DUMPDOTGRAPH_H
#define KDEVPLATFORM_DUMPDOTGRAPH_H

#include <QtGlobal>
#include <QScopedPointer>
#include <language/languageexport.h>

class QString;

namespace KDevelop {
class TopDUContext;
class DUContext;
class DumpDotGraphPrivate;


/**
 * A helper-class for debugging, that nicely visualizes the whole structure of a du-context.
 * */
class KDEVPLATFORMLANGUAGE_EXPORT DumpDotGraph
{
    Q_DISABLE_COPY(DumpDotGraph)

public:
    DumpDotGraph();
    ~DumpDotGraph();
    /**
     * The context, it's, and if it is not a top-context also all contexts importing it we be drawn.
     * Parent-contexts will not be respected, so if you want the whole structure, you will need to pass the top-context.
     * @param shortened if this is given sub-items like declarations, definitions, child-contexts, etc. will not be shown as separate nodes
     * */
    QString dotGraph(KDevelop::DUContext* context, bool shortened = false);

private:
    const QScopedPointer<class DumpDotGraphPrivate> d_ptr;
    Q_DECLARE_PRIVATE(DumpDotGraph)
};
}

#endif // KDEVPLATFORM_DUMPDOTGRAPH_H