perfsrv/analyzetool/commandlineengine/inc/iaddresstoline.h
author Andrew Haigh <andrew.haigh@nokia.com>
Mon, 25 Oct 2010 17:58:04 +0100
branchBUG 3869 Reference XTI device driver for Open System Trace
changeset 60 e54443a6878c
parent 51 98307c651589
permissions -rw-r--r--
start BUG 3869 Reference XTI device driver for Open System Trace
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
20
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Interface definition for locating code lines using memory addresses.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
#ifndef __IADDRESSTOLINE_H__
hgs
parents:
diff changeset
    18
#define __IADDRESSTOLINE_H__
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#include "ATCommonDefines.h"
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
class CATMemoryAddress;
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
/**
hgs
parents:
diff changeset
    25
* Codeline locating interface. Thru this interface CATModule2 locates code lines
hgs
parents:
diff changeset
    26
* using different implementations depending on platform.
hgs
parents:
diff changeset
    27
*/
hgs
parents:
diff changeset
    28
class IAddressToLine
hgs
parents:
diff changeset
    29
{
hgs
parents:
diff changeset
    30
public:
hgs
parents:
diff changeset
    31
	IAddressToLine() {};
hgs
parents:
diff changeset
    32
	virtual ~IAddressToLine() {};
hgs
parents:
diff changeset
    33
	/**
hgs
parents:
diff changeset
    34
	* Open binary.
hgs
parents:
diff changeset
    35
	* @sString
hgs
parents:
diff changeset
    36
	* @iNumber
hgs
parents:
diff changeset
    37
	* @return true if successful.
hgs
parents:
diff changeset
    38
	*/
hgs
parents:
diff changeset
    39
	virtual bool Open( const string& sString, const unsigned long iLong) = 0;
hgs
parents:
diff changeset
    40
	
hgs
parents:
diff changeset
    41
	/**
hgs
parents:
diff changeset
    42
	* Get error string. In case of any method failed use this to acquire details on error.
hgs
parents:
diff changeset
    43
	* @return error string.
hgs
parents:
diff changeset
    44
	*/
hgs
parents:
diff changeset
    45
	virtual string GetError( void ) = 0;
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
	/**
hgs
parents:
diff changeset
    48
	* Close binary.
hgs
parents:
diff changeset
    49
	* @return true if succesful.
hgs
parents:
diff changeset
    50
	*/
hgs
parents:
diff changeset
    51
	virtual bool Close( void ) = 0;
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
	/**
hgs
parents:
diff changeset
    54
	* Locate code line and file for given address.
hgs
parents:
diff changeset
    55
	* @result
hgs
parents:
diff changeset
    56
	* @return true if successful.
hgs
parents:
diff changeset
    57
	*/
hgs
parents:
diff changeset
    58
	virtual bool AddressToLine( CATMemoryAddress* result ) = 0;
hgs
parents:
diff changeset
    59
};
hgs
parents:
diff changeset
    60
#endif