Added DLL linkage specification to class declarations to support building
[dyninst.git] / dyninstAPI / h / BPatch_image.h
1 /*
2  * Copyright (c) 1996 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_image_h_
43 #define _BPatch_image_h_
44
45 #include "BPatch_dll.h"
46 #include "BPatch_sourceObj.h"
47 #include "BPatch_Vector.h"
48 #include "BPatch_point.h"
49 #include "BPatch_snippet.h"
50 #include "BPatch_module.h"
51 #include "BPatch_type.h"
52
53 class process;
54 class image;
55
56 class AddrToVarExprHash;
57
58 class BPATCH_DLL_EXPORT BPatch_image: public BPatch_sourceObj {
59     process     *proc;
60
61 public:
62 // The following functions are for internal use by  the library only:
63     BPatch_image(process *_proc);
64     BPatch_image();
65     virtual ~BPatch_image();
66
67     BPatch_Vector<BPatch_sourceObj *> *getSourceObj();
68     BPatch_sourceObj *getObjParent();
69
70     bool                 ModuleListExist();
71     void                 addModuleIfExist(BPatch_module *bpmod);
72 // End functions for internal use only
73   
74     BPatch_Vector<BPatch_function *> *getProcedures();
75     BPatch_Vector<BPatch_module *> *getModules();
76
77     BPatch_Vector<BPatch_variableExpr *> *getGlobalVariables();
78
79     BPatch_Vector<BPatch_point *> *findProcedurePoint(const char *name,
80             const BPatch_procedureLocation loc);
81
82     BPatch_point *createInstPointAtAddr(void *address);
83
84     BPatch_function     *findFunction(const char *name);
85     BPatch_function     *findBPFunction(const char *name);
86
87     BPatch_variableExpr *findVariable(const char *name, bool showError=true);
88     BPatch_variableExpr *findVariable(BPatch_point &scp, const char *nm); 
89
90     BPatch_type         *findType(const char *name);
91
92     //method to retrieve addresses corresponding to a line in a file
93     bool getLineToAddr(const char* fileName,unsigned short lineNo,
94                        BPatch_Vector<unsigned long>& buffer,
95                        bool exactMatch = true);
96 private:
97     BPatch_Vector<BPatch_module *> *modlist;
98     AddrToVarExprHash *AddrToVarExpr;
99 };
100
101 #endif /* _BPatch_image_h_ */