Update Examples in dataflowAPI (#700)
[dyninst.git] / symtabAPI / h / LineInformation.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #if ! defined( LINE_INFORMATION_H )
32 #define LINE_INFORMATION_H
33
34 #include "symutil.h"
35 #include "RangeLookup.h"
36 #include "Serialization.h"
37 #include "Annotatable.h"
38 #include "Module.h"
39
40 #define NEW_GETSOURCELINES_INTERFACE
41
42 namespace Dyninst{
43 namespace SymtabAPI{
44
45 class SYMTAB_EXPORT LineInformation : 
46                         private RangeLookupTypes< Statement >::type
47 {
48 public:
49     typedef RangeLookupTypes< Statement> traits;
50     typedef RangeLookupTypes< Statement >::type impl_t;
51     typedef impl_t::index<Statement::addr_range>::type::const_iterator const_iterator;
52     typedef impl_t::index<Statement::line_info>::type::const_iterator const_line_info_iterator;
53     typedef traits::value_type Statement_t;
54       LineInformation();
55
56       /* You MAY freely deallocate the lineSource strings you pass in. */
57       bool addLine( std::string lineSource,
58             unsigned int lineNo, 
59             unsigned int lineOffset, 
60             Offset lowInclusiveAddr, 
61             Offset highExclusiveAddr );
62     bool addLine( unsigned int fileIndex,
63                   unsigned int lineNo,
64                   unsigned int lineOffset,
65                   Offset lowInclusiveAddr,
66                   Offset highExclusiveAddr );
67
68       void addLineInfo(LineInformation *lineInfo);            
69
70       bool addAddressRange( Offset lowInclusiveAddr, 
71             Offset highExclusiveAddr, 
72             const char * lineSource, 
73             unsigned int lineNo, 
74             unsigned int lineOffset = 0 );
75
76       /* You MUST NOT deallocate the strings returned. */
77       bool getSourceLines(Offset addressInRange, std::vector<Statement_t> &lines);
78     bool getSourceLines(Offset addressInRange, std::vector<Statement> &lines);
79
80       bool getAddressRanges( const char * lineSource, unsigned int LineNo, std::vector< AddressRange > & ranges );
81       const_line_info_iterator begin_by_source() const;
82       const_line_info_iterator end_by_source() const;
83       std::pair<const_line_info_iterator, const_line_info_iterator> range(std::string file,
84                                                                                 const unsigned int lineNo) const;
85       std::pair<const_line_info_iterator, const_line_info_iterator> equal_range(std::string file) const;
86       const_iterator begin() const;
87       const_iterator end() const;
88       const_iterator find(Offset addressInRange) const;
89       const_iterator find(Offset addressInRange, const_iterator hint) const;
90
91       unsigned getSize() const;
92
93       void dump();
94
95       virtual ~LineInformation();
96         StringTablePtr strings_;
97    protected:
98 public:
99     StringTablePtr getStrings() ;
100
101     void setStrings(StringTablePtr strings_);
102
103 protected:
104     mutable int wasted_compares;
105     mutable int num_queries;
106 };
107
108
109     /* end class LineInformation */
110
111 }//namespace SymtabAPI
112 }//namespace Dyninst
113
114 #endif /* ! LINE_INFORMATION_H */