FINAL ?? CVS commit -- adds Jeff & Matt's reworked annotations schema, completely...
[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 #include "Serialization.h"
48 #include "Annotatable.h"
49
50 namespace Dyninst{
51 namespace SymtabAPI{
52
53 /* This is clumsy. */
54 namespace LineInformationImpl {
55    class LineNoTuple{
56       public:
57          DLLEXPORT LineNoTuple(const char *file_, unsigned int line_, unsigned int col_ = 0);
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    };
63
64    /* Explicit comparison functors seems slightly less confusing than using
65       operator <() via an implicit Less<> template argument to the maps. */
66    struct LineNoTupleLess {
67       bool operator () ( LineNoTuple lhs, LineNoTuple rhs ) const;
68    };
69 } /* end namespace LineInformationImpl */                       
70
71 DLLEXPORT typedef LineInformationImpl::LineNoTuple LineNoTuple;
72
73 class LineInformation : public Serializable, 
74                         public AnnotatableSparse,
75                         private RangeLookup< LineInformationImpl::LineNoTuple, LineInformationImpl::LineNoTupleLess > 
76 {
77    public:
78       DLLEXPORT void serialize(SerializerBase *, const char * = "LineInformation");
79       typedef LineInformationImpl::LineNoTuple LineNoTuple;
80       typedef RangeLookup< LineInformationImpl::LineNoTuple, LineInformationImpl::LineNoTupleLess >::const_iterator const_iterator;
81       typedef RangeLookup< LineInformationImpl::LineNoTuple, LineInformationImpl::LineNoTupleLess >::AddressRange AddressRange;
82
83       DLLEXPORT LineInformation();
84
85       /* You MAY freely deallocate the lineSource strings you pass in. */
86       DLLEXPORT bool addLine( const char * lineSource, 
87             unsigned int lineNo, 
88             unsigned int lineOffset, 
89             Offset lowInclusiveAddr, 
90             Offset highExclusiveAddr );
91       DLLEXPORT void addLineInfo(LineInformation *lineInfo);          
92       DLLEXPORT bool addAddressRange( Offset lowInclusiveAddr, 
93             Offset highExclusiveAddr, 
94             const char * lineSource, 
95             unsigned int lineNo, 
96             unsigned int lineOffset = 0 );
97
98       /* You MUST NOT deallocate the strings returned. */
99       DLLEXPORT bool getSourceLines( Offset addressInRange, std::vector< LineNoTuple > & lines );
100       DLLEXPORT bool getAddressRanges( const char * lineSource, unsigned int LineNo, std::vector< AddressRange > & ranges );
101
102       DLLEXPORT const_iterator begin() const;
103       DLLEXPORT const_iterator end() const;
104       DLLEXPORT unsigned getSize() 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 dyn_hash_set< const char *, boost::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       unsigned size_;
131 }; /* end class LineInformation */
132
133 }//namespace SymtabAPI
134 }//namespace Dyninst
135
136 #endif /* ! LINE_INFORMATION_H */