Java tutorial
/* * Copyright (C) 2007 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.android.ddmuilib; import com.android.annotations.NonNull; import com.android.ddmlib.AndroidDebugBridge; import com.android.ddmlib.AndroidDebugBridge.IClientChangeListener; import com.android.ddmlib.AndroidDebugBridge.IDebugBridgeChangeListener; import com.android.ddmlib.AndroidDebugBridge.IDeviceChangeListener; import com.android.ddmlib.Client; import com.android.ddmlib.ClientData; import com.android.ddmlib.ClientData.DebuggerStatus; import com.android.ddmlib.DdmPreferences; import com.android.ddmlib.IDevice; import com.android.ddmlib.IDevice.DeviceState; import com.android.ddmuilib.vmtrace.VmTraceOptionsDialog; import com.google.common.base.Throwables; import org.eclipse.jface.dialogs.MessageDialog; import org.eclipse.jface.preference.IPreferenceStore; import org.eclipse.jface.viewers.ILabelProviderListener; import org.eclipse.jface.viewers.ITableLabelProvider; import org.eclipse.jface.viewers.ITreeContentProvider; import org.eclipse.jface.viewers.TreePath; import org.eclipse.jface.viewers.TreeSelection; import org.eclipse.jface.viewers.TreeViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.jface.window.Window; import org.eclipse.swt.SWT; import org.eclipse.swt.SWTException; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.graphics.Image; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Tree; import org.eclipse.swt.widgets.TreeColumn; import org.eclipse.swt.widgets.TreeItem; import java.io.IOException; import java.util.ArrayList; import java.util.Locale; import java.util.concurrent.TimeUnit; /** * A display of both the devices and their clients. */ public final class DevicePanel extends Panel implements IDebugBridgeChangeListener, IDeviceChangeListener, IClientChangeListener { private final static String PREFS_COL_NAME_SERIAL = "devicePanel.Col0"; //$NON-NLS-1$ private final static String PREFS_COL_PID_STATE = "devicePanel.Col1"; //$NON-NLS-1$ private final static String PREFS_COL_PORT_BUILD = "devicePanel.Col4"; //$NON-NLS-1$ private final static int DEVICE_COL_SERIAL = 0; private final static int DEVICE_COL_STATE = 1; // col 2, 3 not used. private final static int DEVICE_COL_BUILD = 4; private final static int CLIENT_COL_NAME = 0; private final static int CLIENT_COL_PID = 1; private final static int CLIENT_COL_THREAD = 2; private final static int CLIENT_COL_HEAP = 3; private final static int CLIENT_COL_PORT = 4; public final static int ICON_WIDTH = 16; public final static String ICON_THREAD = "thread.png"; //$NON-NLS-1$ public final static String ICON_HEAP = "heap.png"; //$NON-NLS-1$ public final static String ICON_HALT = "halt.png"; //$NON-NLS-1$ public final static String ICON_GC = "gc.png"; //$NON-NLS-1$ public final static String ICON_HPROF = "hprof.png"; //$NON-NLS-1$ public final static String ICON_TRACING_START = "tracing_start.png"; //$NON-NLS-1$ public final static String ICON_TRACING_STOP = "tracing_stop.png"; //$NON-NLS-1$ private IDevice mCurrentDevice; private Client mCurrentClient; private Tree mTree; private TreeViewer mTreeViewer; private Image mDeviceImage; private Image mEmulatorImage; private Image mThreadImage; private Image mHeapImage; private Image mWaitingImage; private Image mDebuggerImage; private Image mDebugErrorImage; private final ArrayList<IUiSelectionListener> mListeners = new ArrayList<IUiSelectionListener>(); private final ArrayList<IDevice> mDevicesToExpand = new ArrayList<IDevice>(); private boolean mAdvancedPortSupport; /** * A Content provider for the {@link TreeViewer}. * <p/> * The input is a {@link AndroidDebugBridge}. First level elements are {@link IDevice} objects, * and second level elements are {@link Client} object. */ private class ContentProvider implements ITreeContentProvider { @Override public Object[] getChildren(Object parentElement) { if (parentElement instanceof IDevice) { return ((IDevice) parentElement).getClients(); } return new Object[0]; } @Override public Object getParent(Object element) { if (element instanceof Client) { return ((Client) element).getDevice(); } return null; } @Override public boolean hasChildren(Object element) { if (element instanceof IDevice) { return ((IDevice) element).hasClients(); } // Clients never have children. return false; } @Override public Object[] getElements(Object inputElement) { if (inputElement instanceof AndroidDebugBridge) { return ((AndroidDebugBridge) inputElement).getDevices(); } return new Object[0]; } @Override public void dispose() { // pass } @Override public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { // pass } } /** * A Label Provider for the {@link TreeViewer} in {@link DevicePanel}. It provides * labels and images for {@link IDevice} and {@link Client} objects. */ private class LabelProvider implements ITableLabelProvider { @Override public Image getColumnImage(Object element, int columnIndex) { if (columnIndex == DEVICE_COL_SERIAL && element instanceof IDevice) { IDevice device = (IDevice) element; if (device.isEmulator()) { return mEmulatorImage; } return mDeviceImage; } else if (element instanceof Client) { Client client = (Client) element; ClientData cd = client.getClientData(); switch (columnIndex) { case CLIENT_COL_NAME: switch (cd.getDebuggerConnectionStatus()) { case DEFAULT: return null; case WAITING: return mWaitingImage; case ATTACHED: return mDebuggerImage; case ERROR: return mDebugErrorImage; } return null; case CLIENT_COL_THREAD: if (client.isThreadUpdateEnabled()) { return mThreadImage; } return null; case CLIENT_COL_HEAP: if (client.isHeapUpdateEnabled()) { return mHeapImage; } return null; } } return null; } @Override public String getColumnText(Object element, int columnIndex) { if (element instanceof IDevice) { IDevice device = (IDevice) element; switch (columnIndex) { case DEVICE_COL_SERIAL: return device.getName(); case DEVICE_COL_STATE: return getStateString(device); case DEVICE_COL_BUILD: { String version = device.getProperty(IDevice.PROP_BUILD_VERSION); if (version != null) { String debuggable = device.getProperty(IDevice.PROP_DEBUGGABLE); if (device.isEmulator()) { String avdName = device.getAvdName(); if (avdName == null) { avdName = "?"; // the device is probably not online yet, so // we don't know its AVD name just yet. } if (debuggable != null && debuggable.equals("1")) { //$NON-NLS-1$ return String.format("%1$s [%2$s, debug]", avdName, version); } else { return String.format("%1$s [%2$s]", avdName, version); //$NON-NLS-1$ } } else { if (debuggable != null && debuggable.equals("1")) { //$NON-NLS-1$ return String.format("%1$s, debug", version); } else { return String.format("%1$s", version); //$NON-NLS-1$ } } } else { return "unknown"; } } } } else if (element instanceof Client) { Client client = (Client) element; ClientData cd = client.getClientData(); switch (columnIndex) { case CLIENT_COL_NAME: String name = cd.getClientDescription(); if (name != null) { if (cd.isValidUserId() && cd.getUserId() != 0) { return String.format(Locale.US, "%s (%d)", name, cd.getUserId()); } else { return name; } } return "?"; case CLIENT_COL_PID: return Integer.toString(cd.getPid()); case CLIENT_COL_PORT: if (mAdvancedPortSupport) { int port = client.getDebuggerListenPort(); String portString = "?"; if (port != 0) { portString = Integer.toString(port); } if (client.isSelectedClient()) { return String.format("%1$s / %2$d", portString, //$NON-NLS-1$ DdmPreferences.getSelectedDebugPort()); } return portString; } } } return null; } @Override public void addListener(ILabelProviderListener listener) { // pass } @Override public void dispose() { // pass } @Override public boolean isLabelProperty(Object element, String property) { // pass return false; } @Override public void removeListener(ILabelProviderListener listener) { // pass } } /** * Classes which implement this interface provide methods that deals * with {@link IDevice} and {@link Client} selection changes coming from the ui. */ public interface IUiSelectionListener { /** * Sent when a new {@link IDevice} and {@link Client} are selected. * @param selectedDevice the selected device. If null, no devices are selected. * @param selectedClient The selected client. If null, no clients are selected. */ public void selectionChanged(IDevice selectedDevice, Client selectedClient); } /** * Creates the {@link DevicePanel} object. * @param advancedPortSupport if true the device panel will add support for selected client port * and display the ports in the ui. */ public DevicePanel(boolean advancedPortSupport) { mAdvancedPortSupport = advancedPortSupport; } public void addSelectionListener(IUiSelectionListener listener) { mListeners.add(listener); } public void removeSelectionListener(IUiSelectionListener listener) { mListeners.remove(listener); } @Override protected Control createControl(Composite parent) { loadImages(parent.getDisplay()); parent.setLayout(new FillLayout()); // create the tree and its column mTree = new Tree(parent, SWT.SINGLE | SWT.FULL_SELECTION); mTree.setHeaderVisible(true); mTree.setLinesVisible(true); IPreferenceStore store = DdmUiPreferences.getStore(); TableHelper.createTreeColumn(mTree, "Name", SWT.LEFT, "com.android.home", //$NON-NLS-2$ PREFS_COL_NAME_SERIAL, store); TableHelper.createTreeColumn(mTree, "", SWT.LEFT, //$NON-NLS-1$ "Offline", //$NON-NLS-1$ PREFS_COL_PID_STATE, store); TreeColumn col = new TreeColumn(mTree, SWT.NONE); col.setWidth(ICON_WIDTH + 8); col.setResizable(false); col = new TreeColumn(mTree, SWT.NONE); col.setWidth(ICON_WIDTH + 8); col.setResizable(false); TableHelper.createTreeColumn(mTree, "", SWT.LEFT, //$NON-NLS-1$ "9999-9999", //$NON-NLS-1$ PREFS_COL_PORT_BUILD, store); // create the tree viewer mTreeViewer = new TreeViewer(mTree); // make the device auto expanded. mTreeViewer.setAutoExpandLevel(TreeViewer.ALL_LEVELS); // set up the content and label providers. mTreeViewer.setContentProvider(new ContentProvider()); mTreeViewer.setLabelProvider(new LabelProvider()); mTree.addSelectionListener(new SelectionAdapter() { @Override public void widgetSelected(SelectionEvent e) { notifyListeners(); } }); return mTree; } /** * Sets the focus to the proper control inside the panel. */ @Override public void setFocus() { mTree.setFocus(); } @Override protected void postCreation() { // ask for notification of changes in AndroidDebugBridge (a new one is created when // adb is restarted from a different location), IDevice and Client objects. AndroidDebugBridge.addDebugBridgeChangeListener(this); AndroidDebugBridge.addDeviceChangeListener(this); AndroidDebugBridge.addClientChangeListener(this); } public void dispose() { AndroidDebugBridge.removeDebugBridgeChangeListener(this); AndroidDebugBridge.removeDeviceChangeListener(this); AndroidDebugBridge.removeClientChangeListener(this); } /** * Returns the selected {@link Client}. May be null. */ public Client getSelectedClient() { return mCurrentClient; } /** * Returns the selected {@link IDevice}. If a {@link Client} is selected, it returns the * IDevice object containing the client. */ public IDevice getSelectedDevice() { return mCurrentDevice; } /** * Kills the selected {@link Client} by sending its VM a halt command. */ public void killSelectedClient() { if (mCurrentClient != null) { Client client = mCurrentClient; // reset the selection to the device. TreePath treePath = new TreePath(new Object[] { mCurrentDevice }); TreeSelection treeSelection = new TreeSelection(treePath); mTreeViewer.setSelection(treeSelection); client.kill(); } } /** * Forces a GC on the selected {@link Client}. */ public void forceGcOnSelectedClient() { if (mCurrentClient != null) { mCurrentClient.executeGarbageCollector(); } } public void dumpHprof() { if (mCurrentClient != null) { mCurrentClient.dumpHprof(); } } public void toggleMethodProfiling() { if (mCurrentClient == null) { return; } try { toggleMethodProfiling(mCurrentClient); } catch (IOException e) { MessageDialog.openError(mTree.getShell(), "Method Profiling", "Unexpected I/O error while starting/stopping profiling: " + Throwables.getRootCause(e).getMessage()); } } private void toggleMethodProfiling(@NonNull Client client) throws IOException { ClientData cd = mCurrentClient.getClientData(); if (cd.getMethodProfilingStatus() == ClientData.MethodProfilingStatus.TRACER_ON) { mCurrentClient.stopMethodTracer(); } else if (cd.getMethodProfilingStatus() == ClientData.MethodProfilingStatus.SAMPLER_ON) { mCurrentClient.stopSamplingProfiler(); } else { boolean supportsSampling = cd.hasFeature(ClientData.FEATURE_SAMPLING_PROFILER); // default to tracing boolean shouldUseTracing = true; int samplingIntervalMicros = 1; // if client supports sampling, then ask the user to choose the method if (supportsSampling) { VmTraceOptionsDialog dialog = new VmTraceOptionsDialog(mTree.getShell()); if (dialog.open() == Window.CANCEL) { return; } shouldUseTracing = dialog.shouldUseTracing(); if (!shouldUseTracing) { samplingIntervalMicros = dialog.getSamplingIntervalMicros(); } } if (shouldUseTracing) { mCurrentClient.startMethodTracer(); } else { mCurrentClient.startSamplingProfiler(samplingIntervalMicros, TimeUnit.MICROSECONDS); } } } public void setEnabledHeapOnSelectedClient(boolean enable) { if (mCurrentClient != null) { mCurrentClient.setHeapUpdateEnabled(enable); } } public void setEnabledThreadOnSelectedClient(boolean enable) { if (mCurrentClient != null) { mCurrentClient.setThreadUpdateEnabled(enable); } } /** * Sent when a new {@link AndroidDebugBridge} is started. * <p/> * This is sent from a non UI thread. * @param bridge the new {@link AndroidDebugBridge} object. */ @Override public void bridgeChanged(final AndroidDebugBridge bridge) { if (mTree.isDisposed() == false) { exec(new Runnable() { @Override public void run() { if (mTree.isDisposed() == false) { // set up the data source. mTreeViewer.setInput(bridge); // notify the listener of a possible selection change. notifyListeners(); } else { // tree is disposed, we need to do something. // lets remove ourselves from the listener. AndroidDebugBridge.removeDebugBridgeChangeListener(DevicePanel.this); AndroidDebugBridge.removeDeviceChangeListener(DevicePanel.this); AndroidDebugBridge.removeClientChangeListener(DevicePanel.this); } } }); } // all current devices are obsolete synchronized (mDevicesToExpand) { mDevicesToExpand.clear(); } } /** * Sent when the a device is connected to the {@link AndroidDebugBridge}. * <p/> * This is sent from a non UI thread. * @param device the new device. * * @see IDeviceChangeListener#deviceConnected(IDevice) */ @Override public void deviceConnected(IDevice device) { exec(new Runnable() { @Override public void run() { if (mTree.isDisposed() == false) { // refresh all mTreeViewer.refresh(); // notify the listener of a possible selection change. notifyListeners(); } else { // tree is disposed, we need to do something. // lets remove ourselves from the listener. AndroidDebugBridge.removeDebugBridgeChangeListener(DevicePanel.this); AndroidDebugBridge.removeDeviceChangeListener(DevicePanel.this); AndroidDebugBridge.removeClientChangeListener(DevicePanel.this); } } }); // if it doesn't have clients yet, it'll need to be manually expanded when it gets them. if (device.hasClients() == false) { synchronized (mDevicesToExpand) { mDevicesToExpand.add(device); } } } /** * Sent when the a device is connected to the {@link AndroidDebugBridge}. * <p/> * This is sent from a non UI thread. * @param device the new device. * * @see IDeviceChangeListener#deviceDisconnected(IDevice) */ @Override public void deviceDisconnected(IDevice device) { deviceConnected(device); // just in case, we remove it from the list of devices to expand. synchronized (mDevicesToExpand) { mDevicesToExpand.remove(device); } } /** * Sent when a device data changed, or when clients are started/terminated on the device. * <p/> * This is sent from a non UI thread. * @param device the device that was updated. * @param changeMask the mask indicating what changed. * * @see IDeviceChangeListener#deviceChanged(IDevice,int) */ @Override public void deviceChanged(final IDevice device, int changeMask) { boolean expand = false; synchronized (mDevicesToExpand) { int index = mDevicesToExpand.indexOf(device); if (device.hasClients() && index != -1) { mDevicesToExpand.remove(index); expand = true; } } final boolean finalExpand = expand; exec(new Runnable() { @Override public void run() { if (mTree.isDisposed() == false) { // look if the current device is selected. This is done in case the current // client of this particular device was killed. In this case, we'll need to // manually reselect the device. IDevice selectedDevice = getSelectedDevice(); // refresh the device mTreeViewer.refresh(device); // if the selected device was the changed device and the new selection is // empty, we reselect the device. if (selectedDevice == device && mTreeViewer.getSelection().isEmpty()) { mTreeViewer.setSelection(new TreeSelection(new TreePath(new Object[] { device }))); } // notify the listener of a possible selection change. notifyListeners(); if (finalExpand) { mTreeViewer.setExpandedState(device, true); } } else { // tree is disposed, we need to do something. // lets remove ourselves from the listener. AndroidDebugBridge.removeDebugBridgeChangeListener(DevicePanel.this); AndroidDebugBridge.removeDeviceChangeListener(DevicePanel.this); AndroidDebugBridge.removeClientChangeListener(DevicePanel.this); } } }); } /** * Sent when an existing client information changed. * <p/> * This is sent from a non UI thread. * @param client the updated client. * @param changeMask the bit mask describing the changed properties. It can contain * any of the following values: {@link Client#CHANGE_INFO}, * {@link Client#CHANGE_DEBUGGER_STATUS}, {@link Client#CHANGE_THREAD_MODE}, * {@link Client#CHANGE_THREAD_DATA}, {@link Client#CHANGE_HEAP_MODE}, * {@link Client#CHANGE_HEAP_DATA}, {@link Client#CHANGE_NATIVE_HEAP_DATA} * * @see IClientChangeListener#clientChanged(Client, int) */ @Override public void clientChanged(final Client client, final int changeMask) { exec(new Runnable() { @Override public void run() { if (mTree.isDisposed() == false) { // refresh the client mTreeViewer.refresh(client); if ((changeMask & Client.CHANGE_DEBUGGER_STATUS) == Client.CHANGE_DEBUGGER_STATUS && client.getClientData().getDebuggerConnectionStatus() == DebuggerStatus.WAITING) { // make sure the device is expanded. Normally the setSelection below // will auto expand, but the children of device may not already exist // at this time. Forcing an expand will make the TreeViewer create them. IDevice device = client.getDevice(); if (mTreeViewer.getExpandedState(device) == false) { mTreeViewer.setExpandedState(device, true); } // create and set the selection TreePath treePath = new TreePath(new Object[] { device, client }); TreeSelection treeSelection = new TreeSelection(treePath); mTreeViewer.setSelection(treeSelection); if (mAdvancedPortSupport) { client.setAsSelectedClient(); } // notify the listener of a possible selection change. notifyListeners(device, client); } } else { // tree is disposed, we need to do something. // lets remove ourselves from the listener. AndroidDebugBridge.removeDebugBridgeChangeListener(DevicePanel.this); AndroidDebugBridge.removeDeviceChangeListener(DevicePanel.this); AndroidDebugBridge.removeClientChangeListener(DevicePanel.this); } } }); } private void loadImages(Display display) { ImageLoader loader = ImageLoader.getDdmUiLibLoader(); if (mDeviceImage == null) { mDeviceImage = loader.loadImage(display, "device.png", //$NON-NLS-1$ ICON_WIDTH, ICON_WIDTH, display.getSystemColor(SWT.COLOR_RED)); } if (mEmulatorImage == null) { mEmulatorImage = loader.loadImage(display, "emulator.png", ICON_WIDTH, ICON_WIDTH, //$NON-NLS-1$ display.getSystemColor(SWT.COLOR_BLUE)); } if (mThreadImage == null) { mThreadImage = loader.loadImage(display, ICON_THREAD, ICON_WIDTH, ICON_WIDTH, display.getSystemColor(SWT.COLOR_YELLOW)); } if (mHeapImage == null) { mHeapImage = loader.loadImage(display, ICON_HEAP, ICON_WIDTH, ICON_WIDTH, display.getSystemColor(SWT.COLOR_BLUE)); } if (mWaitingImage == null) { mWaitingImage = loader.loadImage(display, "debug-wait.png", ICON_WIDTH, ICON_WIDTH, //$NON-NLS-1$ display.getSystemColor(SWT.COLOR_RED)); } if (mDebuggerImage == null) { mDebuggerImage = loader.loadImage(display, "debug-attach.png", ICON_WIDTH, ICON_WIDTH, //$NON-NLS-1$ display.getSystemColor(SWT.COLOR_GREEN)); } if (mDebugErrorImage == null) { mDebugErrorImage = loader.loadImage(display, "debug-error.png", ICON_WIDTH, ICON_WIDTH, //$NON-NLS-1$ display.getSystemColor(SWT.COLOR_RED)); } } /** * Returns a display string representing the state of the device. * @param d the device */ private static String getStateString(IDevice d) { DeviceState deviceState = d.getState(); if (deviceState == DeviceState.ONLINE) { return "Online"; } else if (deviceState == DeviceState.OFFLINE) { return "Offline"; } else if (deviceState == DeviceState.BOOTLOADER) { return "Bootloader"; } return "??"; } /** * Executes the {@link Runnable} in the UI thread. * @param runnable the runnable to execute. */ private void exec(Runnable runnable) { try { Display display = mTree.getDisplay(); display.asyncExec(runnable); } catch (SWTException e) { // tree is disposed, we need to do something. lets remove ourselves from the listener. AndroidDebugBridge.removeDebugBridgeChangeListener(this); AndroidDebugBridge.removeDeviceChangeListener(this); AndroidDebugBridge.removeClientChangeListener(this); } } private void notifyListeners() { // get the selection TreeItem[] items = mTree.getSelection(); Client client = null; IDevice device = null; if (items.length == 1) { Object object = items[0].getData(); if (object instanceof Client) { client = (Client) object; device = client.getDevice(); } else if (object instanceof IDevice) { device = (IDevice) object; } } notifyListeners(device, client); } private void notifyListeners(IDevice selectedDevice, Client selectedClient) { if (selectedDevice != mCurrentDevice || selectedClient != mCurrentClient) { mCurrentDevice = selectedDevice; mCurrentClient = selectedClient; for (IUiSelectionListener listener : mListeners) { // notify the listener with a try/catch-all to make sure this thread won't die // because of an uncaught exception before all the listeners were notified. try { listener.selectionChanged(selectedDevice, selectedClient); } catch (Exception e) { } } } } }