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