Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 9a435b72b4841819252fa34201b1ee60e21096dc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*******************************************************************************
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * Freescale Semiconductor - Initial API
 *******************************************************************************/

package org.eclipse.cdt.debug.core.cdi.model;

import java.math.BigInteger;

import org.eclipse.cdt.debug.core.cdi.CDIException;

/**
 * The memory space manager provides varous memory-space related operations.
 * The backend implementation of ICDITarget should implement this interface   
 * as well if the target supports memory spaces.
 */
public interface ICDIMemorySpaceManagement extends ICDIObject {

	/**
	 * Optionally provides the string encoding of a memory space qualified address.
	 * CDT provides a default encoding of <memory-space-id>:<address(hex)>.
	 * If this is adequate, the client can return null from this function.
	 * 
	 * @param address - a numeric address
	 * @param memorySpaceID - a string which represents the memory space
	 * @return the encoded string representation of the address or null
	 */
	String addressToString(BigInteger address, String memorySpaceID);

	/**
	 * The inverse of addressToString
	 *
	 * @param str - the encoded string (contains memory space + hex address value)
	 * @param memorySpaceID_out the memory space ID
	 * @return the BigInteger part of str; client should return null if the default decoding provided
	 * by CDT is sufficient (<memory-space-id>:<address(hex)>)
	 */
	BigInteger stringToAddress(String str, StringBuffer memorySpaceID_out) throws CDIException;
	
	/**
	 * Provides the memory spaces available.
	 * 
	 * @return an array of memory space identifiers
	 */
	String [] getMemorySpaces();	

}

Back to the top