Marked certain BPatch_edge functions as public (and locked) to agree with
[dyninst.git] / dyninstAPI / h / BPatch_edge.h
1 /*
2  * Copyright (c) 1996-2004 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  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 #ifndef _BPatch_edge_h_
43 #define _BPatch_edge_h_
44
45 #include <BPatch_dll.h>
46 #include <BPatch_eventLock.h>
47
48 class BPatch_flowGraph;
49 class BPatch_basicBlock;
50 class BPatch_point;
51
52
53 // XXX ignores indirect jumps
54 typedef enum { 
55     CondJumpTaken, CondJumpNottaken, UncondJump, NonJump 
56 } BPatch_edgeType;
57
58
59 #ifdef DYNINST_CLASS_NAME
60 #undef DYNINST_CLASS_NAME
61 #endif
62 #define DYNINST_CLASS_NAME BPatch_edge
63
64 /** An edge between two blocks
65  */
66 class BPATCH_DLL_EXPORT BPatch_edge : public BPatch_eventLock{
67
68  public:
69
70     // BPatch_edge::BPatch_edge
71     //
72     // constructor
73     API_EXPORT_CTOR(Int, (s,t,fg),
74
75     BPatch_edge,(BPatch_basicBlock *s, BPatch_basicBlock *t, 
76                  BPatch_flowGraph *fg));
77
78     // BPatch_edge::~BPatch_edge
79     //
80     // destructor
81     API_EXPORT_DTOR(_dtor, (),
82
83     ~,BPatch_edge,());
84
85     // BPatch_edge::dump
86     //
87     // print internal data
88     API_EXPORT_V(Int, (),
89     void,dump,());
90
91     API_EXPORT(Int, (), BPatch_basicBlock *, getSource, ());
92     API_EXPORT(Int, (), BPatch_basicBlock *, getTarget, ());
93     API_EXPORT(Int, (), BPatch_point *, getPoint, ());
94     API_EXPORT(Int, (), BPatch_edgeType, getType, ());
95
96     BPatch_edgeType type;
97
98     BPatch_basicBlock *source;
99
100     BPatch_basicBlock *target;
101
102     BPatch_flowGraph *flowGraph;
103
104     BPatch_point *point;
105
106  private:
107
108     BPatch_point *createInstPointAtEdge();
109
110 };
111
112
113 #endif /* _BPatch_edge_h_ */