Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / h / BPatch_loopTreeNode.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 #ifndef _BPatch_loopTreeNode_h_
33 #define _BPatch_loopTreeNode_h_
34
35 #include "BPatch_dll.h"
36 #include "BPatch_Vector.h"
37 #include "BPatch_eventLock.h"
38 #include "BPatch_function.h"
39
40 class BPatch_basicBlockLoop;
41 class int_function;
42
43 /** A class to represent the tree of nested loops and 
44  *  callees (functions) in the control flow graph.
45  *  @see BPatch_basicBlockLoop
46  *  @see BPatch_flowGraph
47  */
48 #ifdef DYNINST_CLASS_NAME
49 #undef DYNINST_CLASS_NAME
50 #endif
51 #define DYNINST_CLASS_NAME BPatch_loopTreeNode
52
53 class BPATCH_DLL_EXPORT BPatch_loopTreeNode : public BPatch_eventLock {
54     friend class BPatch_flowGraph;
55
56  public:
57     // A loop node contains a single BPatch_basicBlockLoop instance
58     BPatch_basicBlockLoop *loop;
59
60     // The BPatch_loopTreeNode instances nested within this loop.
61     BPatch_Vector<BPatch_loopTreeNode *> children;
62
63     //  BPatch_loopTreeNode::BPatch_loopTreeNode
64     //  Create a loop tree node for BPatch_basicBlockLoop with name n 
65     API_EXPORT_CTOR(Ctor, (l,n),
66
67     BPatch_loopTreeNode,(BPatch_basicBlockLoop *l, const char *n));
68
69     //  BPatch_loopTreeNode::~BPatch_loopTreeNode
70     //  Destructor
71     API_EXPORT_DTOR(_dtor, (),
72
73     ~,BPatch_loopTreeNode,());
74
75     //  BPatch_loopTreeNode::name
76     //  Return the name of this loop. 
77     API_EXPORT(Int, (),
78
79     const char *,name,()); 
80
81     //  BPatch_loopTreeNode::getCalleeName
82     //  Return the function name of the ith callee. 
83     API_EXPORT(Int, (i),
84
85     const char *,getCalleeName,(unsigned int i));
86
87     //  BPatch_loopTreeNode::numCallees
88     //  Return the number of callees contained in this loop's body. 
89     API_EXPORT(Int, (),
90
91     unsigned int,numCallees,());
92
93     //Returns a vector of the functions called by this loop.
94     API_EXPORT(Int, (v, p),
95     bool, getCallees, (BPatch_Vector<BPatch_function *> &v, BPatch_addressSpace *p))
96
97     //  BPatch_loopTreeNode::findLoop
98     //  find loop by hierarchical name
99     API_EXPORT(Int, (name),
100
101     BPatch_basicBlockLoop *,findLoop,(const char *name));
102
103  private:
104
105     /** name which indicates this loop's relative nesting */
106     char *hierarchicalName;
107
108     // A vector of functions called within the body of this loop (and
109     // not the body of sub loops). 
110     BPatch_Vector<int_function *> callees;
111
112 };
113
114
115 #endif /* _BPatch_loopTreeNode_h_ */