Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / h / BPatch_edge.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_edge_h_
33 #define _BPatch_edge_h_
34
35 #include "BPatch_dll.h"
36 #include "BPatch_eventLock.h"
37
38 class BPatch_flowGraph;
39 class BPatch_basicBlock;
40 class BPatch_point;
41
42
43 // XXX ignores indirect jumps
44 typedef enum { 
45     CondJumpTaken, CondJumpNottaken, UncondJump, NonJump 
46 } BPatch_edgeType;
47
48
49 #ifdef DYNINST_CLASS_NAME
50 #undef DYNINST_CLASS_NAME
51 #endif
52 #define DYNINST_CLASS_NAME BPatch_edge
53
54 /** An edge between two blocks
55  */
56 class BPATCH_DLL_EXPORT BPatch_edge : public BPatch_eventLock{
57
58  public:
59
60     // BPatch_edge::BPatch_edge
61     //
62     // constructor
63     API_EXPORT_CTOR(Int, (s,t,fg),
64
65     BPatch_edge,(BPatch_basicBlock *s, BPatch_basicBlock *t, 
66                  BPatch_flowGraph *fg));
67
68     // BPatch_edge::~BPatch_edge
69     //
70     // destructor
71     API_EXPORT_DTOR(_dtor, (),
72
73     ~,BPatch_edge,());
74
75     // BPatch_edge::dump
76     //
77     // print internal data
78     API_EXPORT_V(Int, (),
79     void,dump,());
80
81     API_EXPORT(Int, (), BPatch_basicBlock *, getSource, ());
82     API_EXPORT(Int, (), BPatch_basicBlock *, getTarget, ());
83     API_EXPORT(Int, (), BPatch_point *, getPoint, ());
84     API_EXPORT(Int, (), BPatch_edgeType, getType, ());
85
86     BPatch_edgeType type;
87
88     BPatch_basicBlock *source;
89
90     BPatch_basicBlock *target;
91
92     BPatch_flowGraph *flowGraph;
93
94     BPatch_point *point;
95
96  private:
97
98     BPatch_point *createInstPointAtEdge();
99
100 };
101
102
103 #endif /* _BPatch_edge_h_ */