Merge changes since Dyninst 5.2 beta 3 into trunk
[dyninst.git] / symtabAPI / h / LineInformation.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 #if ! defined( LINE_INFORMATION_H )
43 #define LINE_INFORMATION_H
44
45 #include "symutil.h"
46 #include "RangeLookup.h"
47
48 namespace Dyninst{
49 namespace SymtabAPI{
50
51 /* This is clumsy. */
52 namespace LineInformationImpl {
53         class LineNoTuple{
54            public:
55       DLLEXPORT LineNoTuple(const char *file_, unsigned int line_, unsigned int col_ = 0);
56            const char *first; // really file
57            unsigned int second; // really line
58            unsigned int column;
59       DLLEXPORT bool operator==(const LineNoTuple &cmp) const;
60         };
61         
62         /* Explicit comparison functors seems slightly less confusing than using
63            operator <() via an implicit Less<> template argument to the maps. */
64         struct LineNoTupleLess {
65                 bool operator () ( LineNoTuple lhs, LineNoTuple rhs ) const;
66         };
67 } /* end namespace LineInformationImpl */                       
68
69 DLLEXPORT typedef LineInformationImpl::LineNoTuple LineNoTuple;
70
71 class LineInformation : private RangeLookup< LineInformationImpl::LineNoTuple, LineInformationImpl::LineNoTupleLess > {
72         public:
73                 typedef LineInformationImpl::LineNoTuple LineNoTuple;
74                 typedef RangeLookup< LineInformationImpl::LineNoTuple, LineInformationImpl::LineNoTupleLess >::const_iterator const_iterator;
75                 typedef RangeLookup< LineInformationImpl::LineNoTuple, LineInformationImpl::LineNoTupleLess >::AddressRange AddressRange;
76                 
77                 DLLEXPORT LineInformation();
78
79                 /* You MAY freely deallocate the lineSource strings you pass in. */
80                 DLLEXPORT bool addLine( const char * lineSource, 
81                               unsigned int lineNo, 
82                               unsigned int lineOffset, 
83                               Offset lowInclusiveAddr, 
84                               Offset highExclusiveAddr );
85                 DLLEXPORT void addLineInfo(LineInformation *lineInfo);        
86                 DLLEXPORT bool addAddressRange( Offset lowInclusiveAddr, 
87                                       Offset highExclusiveAddr, 
88                                       const char * lineSource, 
89                                       unsigned int lineNo, 
90                                       unsigned int lineOffset = 0 );
91                 
92                 /* You MUST NOT deallocate the strings returned. */
93                 DLLEXPORT bool getSourceLines( Offset addressInRange, std::vector< LineNoTuple > & lines );
94                 DLLEXPORT bool getAddressRanges( const char * lineSource, unsigned int LineNo, std::vector< AddressRange > & ranges );
95                 
96                 DLLEXPORT const_iterator begin() const;
97                 DLLEXPORT const_iterator end() const;
98         DLLEXPORT unsigned getSize() const;
99                 
100                 DLLEXPORT ~LineInformation();
101                 
102         protected:
103                 /* We maintain internal copies of all the source file names.  Because
104                    both directions of the mapping include pointers to these names,
105                    maintain a separate list of them, and only ever deallocate those
106                    (in the destructor).  Note that it speeds and simplifies things
107                    to have the string pointers be the same. */
108
109 #if ! defined( _MSC_VER )                  
110                 struct SourceLineCompare {
111                         bool operator () ( const char * lhs, const char * rhs ) const;
112                         };
113                         
114                 typedef __gnu_cxx::hash_set< const char *, __gnu_cxx::hash< const char * >, SourceLineCompare > SourceLineInternTable;
115 #else
116
117                 struct SourceLineLess {
118                         bool operator () ( const char * lhs, const char * rhs ) const;
119                         };
120                         
121                 typedef std::set< const char *, SourceLineLess > SourceLineInternTable;
122 #endif 
123                 SourceLineInternTable sourceLineNames;
124         unsigned size_;
125         }; /* end class LineInformation */
126
127 }//namespace SymtabAPI
128 }//namespace Dyninst
129
130 #endif /* ! LINE_INFORMATION_H */