Added -fvisibility=hidden to Linux builds, with export macros added in appropriate...
[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 : public AnnotationContainer<Statement>, 
46                         private RangeLookup< Statement, Statement::StatementLess > 
47 {
48         SYMTAB_EXPORT bool addItem_impl(Statement);
49         SYMTAB_EXPORT Serializable *ac_serialize_impl(SerializerBase *, const char * = "lineInformation") THROW_SPEC (SerializerError);
50    public:
51       typedef RangeLookup< Statement, Statement::StatementLess >::const_iterator const_iterator;
52       typedef RangeLookup< Statement, Statement::StatementLess >::AddressRange AddressRange;
53
54       SYMTAB_EXPORT LineInformation();
55
56       /* You MAY freely deallocate the lineSource strings you pass in. */
57       SYMTAB_EXPORT bool addLine( const char * lineSource, 
58             unsigned int lineNo, 
59             unsigned int lineOffset, 
60             Offset lowInclusiveAddr, 
61             Offset highExclusiveAddr );
62
63       SYMTAB_EXPORT void addLineInfo(LineInformation *lineInfo);              
64
65       SYMTAB_EXPORT bool addAddressRange( Offset lowInclusiveAddr, 
66             Offset highExclusiveAddr, 
67             const char * lineSource, 
68             unsigned int lineNo, 
69             unsigned int lineOffset = 0 );
70
71       /* You MUST NOT deallocate the strings returned. */
72       SYMTAB_EXPORT bool getSourceLines( Offset addressInRange, std::vector< Statement *> & lines );
73       SYMTAB_EXPORT bool getSourceLines( Offset addressInRange, std::vector< LineNoTuple > & lines);
74
75       SYMTAB_EXPORT bool getAddressRanges( const char * lineSource, unsigned int LineNo, std::vector< AddressRange > & ranges );
76
77       SYMTAB_EXPORT const_iterator begin() const;
78       SYMTAB_EXPORT const_iterator end() const;
79       SYMTAB_EXPORT unsigned getSize() const;
80
81       SYMTAB_EXPORT ~LineInformation();
82
83    protected:
84       /* We maintain internal copies of all the source file names.  Because
85          both directions of the mapping include pointers to these names,
86          maintain a separate list of them, and only ever deallocate those
87          (in the destructor).  Note that it speeds and simplifies things
88          to have the string pointers be the same. */
89
90       unsigned size_;
91 }; /* end class LineInformation */
92
93 }//namespace SymtabAPI
94 }//namespace Dyninst
95
96 #endif /* ! LINE_INFORMATION_H */