"privatize" LineInformation data structure class, add Statement class and accessors...
[dyninst.git] / dyninstAPI / h / BPatch_statement.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_STATEMENT_H_
43 #define _BPATCH_STATEMENT_H_
44
45 #include "BPatch_dll.h"
46 #include "BPatch_eventLock.h"
47
48 class BPatch_module;
49
50 namespace Dyninst {
51 namespace SymtabAPI {
52         class Statement;
53 }
54 }
55
56 class BPATCH_DLL_EXPORT BPatch_statement : public BPatch_eventLock
57 {
58   friend class BPatch_module;
59   friend class BPatch_image;
60
61   public:
62     //  BPatch_module * getModule()
63     //  Return the BPatch_module that contains this statement
64     BPatch_module * module(); 
65     
66     //  int getLineNumber()
67     //  return the line number of this statement
68     int lineNumber();
69
70     //  int getLineOffset()
71     //  return the line offset of this statement (its start column in the source file)
72     //  This may not be supported on all platforms.
73     //  Returns -1 if not supported.
74     int lineOffset();
75
76     //  const char * fileName()
77     //  return the name of the file that contains this statement
78     const char * fileName();
79
80     //  void * startAddr()
81     //  return the starting address of this statement
82     void *startAddr();
83
84     //  void * endAddr()
85     //  return the last address associated with this statement
86     //  (do we guarantee contiguity of addresses here?  not sure)
87     void *endAddr();
88
89     ~BPatch_statement() {}
90
91   private:
92
93     //  Full parameter ctor -- can only built by friend classes
94     BPatch_statement(BPatch_module *mod,  Dyninst::SymtabAPI::Statement *s);
95
96     BPatch_module *module_;
97         Dyninst::SymtabAPI::Statement *statement;
98 };
99
100 #endif 
101