Update copyright to LGPL on all files
[dyninst.git] / depGraphAPI / h / PDG.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31
32 #if !defined(PDG_GRAPH_H)
33 #define PDG_GRAPH_H
34
35 #include "Node.h"
36 #include "Graph.h"
37
38 #include "dyn_detail/boost/shared_ptr.hpp"
39
40 class BPatch_function;
41
42 namespace Dyninst {
43
44 namespace DepGraphAPI {
45
46 // This class represents a Program Dependence Graph for a given function.
47 class PDG : public Graph {
48 public:
49     typedef dyn_detail::boost::shared_ptr<PDG> Ptr;
50
51 private:
52     typedef BPatch_function Function;
53
54 public:
55     // Creates and returns the PDG for the given function.
56     static PDG::Ptr analyze(Function *func);
57
58     virtual ~PDG() {};
59
60     // Returns the entry node for the PDG.
61     Node::Ptr virtualEntryNode() { return virtEntryNode_; }
62
63     // Creates an empty PDG and returns.
64     static Ptr createGraph() { return PDG::Ptr(new PDG()); }
65
66 private:
67     // default constructor.
68     PDG();
69
70     // Node to make sure everyone is reachable...
71     Node::Ptr virtEntryNode_;
72 };
73 };
74 }
75 #endif