/*
 * See the dyninst/COPYRIGHT file for copyright information.
 * 
 * We provide the Paradyn Tools (below described as "Paradyn")
 * on an AS IS basis, and do not warrant its validity or performance.
 * We reserve the right to update, modify, or discontinue this
 * software at any time.  We shall have no obligation to supply such
 * updates or modifications or any other form of support to you.
 * 
 * By your use of Paradyn, you understand and agree that we (or any
 * other person or entity with proprietary rights in Paradyn) are
 * under no obligation to provide either maintenance services,
 * update services, notices of latent defects, or correction of
 * defects for Paradyn.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#if ! defined( LINE_INFORMATION_H )
#define LINE_INFORMATION_H

#include "symutil.h"
#include "RangeLookup.h"
#include "Serialization.h"
#include "Annotatable.h"
#include "Module.h"

#define NEW_GETSOURCELINES_INTERFACE

namespace Dyninst{
namespace SymtabAPI{

class SYMTAB_EXPORT LineInformation : 
                        private RangeLookupTypes< Statement >::type
{
public:
    typedef RangeLookupTypes< Statement> traits;
    typedef RangeLookupTypes< Statement >::type impl_t;
    typedef impl_t::index<Statement::addr_range>::type::const_iterator const_iterator;
    typedef impl_t::index<Statement::line_info>::type::const_iterator const_line_info_iterator;
    typedef traits::value_type Statement_t;
      LineInformation();

      /* You MAY freely deallocate the lineSource strings you pass in. */
      bool addLine( std::string lineSource,
            unsigned int lineNo, 
            unsigned int lineOffset, 
            Offset lowInclusiveAddr, 
            Offset highExclusiveAddr );
    bool addLine( unsigned int fileIndex,
                  unsigned int lineNo,
                  unsigned int lineOffset,
                  Offset lowInclusiveAddr,
                  Offset highExclusiveAddr );

      void addLineInfo(LineInformation *lineInfo);	      

      bool addAddressRange( Offset lowInclusiveAddr, 
            Offset highExclusiveAddr, 
            const char * lineSource, 
            unsigned int lineNo, 
            unsigned int lineOffset = 0 );

      /* You MUST NOT deallocate the strings returned. */
      bool getSourceLines(Offset addressInRange, std::vector<Statement_t> &lines);
    bool getSourceLines(Offset addressInRange, std::vector<Statement> &lines);

      bool getAddressRanges( const char * lineSource, unsigned int LineNo, std::vector< AddressRange > & ranges );
      const_line_info_iterator begin_by_source() const;
      const_line_info_iterator end_by_source() const;
      std::pair<const_line_info_iterator, const_line_info_iterator> range(std::string file,
                                                                                const unsigned int lineNo) const;
      std::pair<const_line_info_iterator, const_line_info_iterator> equal_range(std::string file) const;
      const_iterator begin() const;
      const_iterator end() const;
      const_iterator find(Offset addressInRange) const;
      const_iterator find(Offset addressInRange, const_iterator hint) const;

      unsigned getSize() const;

      void dump();

      virtual ~LineInformation();
        StringTablePtr strings_;
   protected:
public:
    StringTablePtr getStrings() ;

    void setStrings(StringTablePtr strings_);

protected:
    mutable int wasted_compares;
    mutable int num_queries;
};


    /* end class LineInformation */

}//namespace SymtabAPI
}//namespace Dyninst

#endif /* ! LINE_INFORMATION_H */
