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