diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/.settings/org.eclipse.core.resources.prefs b/plugins/org.eclipse.dd.dsf.debug.ui/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 00000000000..6f616043918 --- /dev/null +++ b/plugins/org.eclipse.dd.dsf.debug.ui/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,3 @@ +#Fri Jul 27 14:30:56 EDT 2007 +eclipse.preferences.version=1 +encoding//src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/messages.properties=8859_1 diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/plugin.xml b/plugins/org.eclipse.dd.dsf.debug.ui/plugin.xml index 3c72cc6419c..4d8023afd96 100644 --- a/plugins/org.eclipse.dd.dsf.debug.ui/plugin.xml +++ b/plugins/org.eclipse.dd.dsf.debug.ui/plugin.xml @@ -202,6 +202,12 @@ - + + + + diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/DetailPane.java b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/DetailPane.java new file mode 100644 index 00000000000..da6c3849eaf --- /dev/null +++ b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/DetailPane.java @@ -0,0 +1,1007 @@ +/******************************************************************************* + * Copyright (c) 2006, 2007 IBM Corporation and others. + * 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: + * IBM Corporation - initial API and implementation + * Randy Rohrbach (Wind River Systems, Inc.) - extended implementation + *******************************************************************************/ +package org.eclipse.dd.dsf.debug.ui.viewmodel.detailpanesupport; + +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + +import org.eclipse.core.commands.operations.IUndoContext; +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IAdaptable; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.Job; +import org.eclipse.dd.dsf.concurrent.DataRequestMonitor; +import org.eclipse.dd.dsf.datamodel.DMContexts; +import org.eclipse.dd.dsf.debug.service.IExpressions; +import org.eclipse.dd.dsf.debug.service.IFormattedValues; +import org.eclipse.dd.dsf.debug.service.IRegisters; +import org.eclipse.dd.dsf.debug.service.IExpressions.IExpressionDMContext; +import org.eclipse.dd.dsf.debug.service.IFormattedValues.FormattedValueDMContext; +import org.eclipse.dd.dsf.debug.service.IFormattedValues.FormattedValueDMData; +import org.eclipse.dd.dsf.debug.service.IFormattedValues.IFormattedDataDMContext; +import org.eclipse.dd.dsf.debug.service.IRegisters.IBitFieldDMContext; +import org.eclipse.dd.dsf.debug.service.IRegisters.IRegisterDMContext; +import org.eclipse.dd.dsf.debug.ui.DsfDebugUIPlugin; +import org.eclipse.dd.dsf.service.DsfServicesTracker; +import org.eclipse.dd.dsf.ui.viewmodel.dm.AbstractDMVMLayoutNode.DMVMContext; +import org.eclipse.debug.core.model.IDebugElement; +import org.eclipse.debug.core.model.IValue; +import org.eclipse.debug.internal.ui.DebugUIPlugin; +import org.eclipse.debug.internal.ui.IDebugHelpContextIds; +import org.eclipse.debug.internal.ui.IInternalDebugUIConstants; +import org.eclipse.debug.internal.ui.LazyModelPresentation; +import org.eclipse.debug.internal.ui.VariablesViewModelPresentation; +import org.eclipse.debug.internal.ui.actions.variables.details.DetailPaneMaxLengthAction; +import org.eclipse.debug.internal.ui.actions.variables.details.DetailPaneWordWrapAction; +import org.eclipse.debug.internal.ui.preferences.IDebugPreferenceConstants; +import org.eclipse.debug.internal.ui.views.variables.StatusLineContributionItem; +import org.eclipse.debug.internal.ui.views.variables.details.DetailMessages; +import org.eclipse.debug.ui.IDebugUIConstants; +import org.eclipse.debug.ui.IDebugView; +import org.eclipse.debug.ui.IDetailPane; +import org.eclipse.debug.ui.IValueDetailListener; +import org.eclipse.jface.action.IAction; +import org.eclipse.jface.action.IMenuListener; +import org.eclipse.jface.action.IMenuManager; +import org.eclipse.jface.action.IStatusLineManager; +import org.eclipse.jface.action.MenuManager; +import org.eclipse.jface.action.Separator; +import org.eclipse.jface.resource.JFaceResources; +import org.eclipse.jface.text.BadLocationException; +import org.eclipse.jface.text.Document; +import org.eclipse.jface.text.DocumentEvent; +import org.eclipse.jface.text.IDocument; +import org.eclipse.jface.text.IDocumentListener; +import org.eclipse.jface.text.IFindReplaceTarget; +import org.eclipse.jface.text.ITextOperationTarget; +import org.eclipse.jface.text.ITextViewer; +import org.eclipse.jface.text.IUndoManager; +import org.eclipse.jface.text.IUndoManagerExtension; +import org.eclipse.jface.text.source.SourceViewer; +import org.eclipse.jface.text.source.SourceViewerConfiguration; +import org.eclipse.jface.util.IPropertyChangeListener; +import org.eclipse.jface.util.PropertyChangeEvent; +import org.eclipse.jface.viewers.ISelectionChangedListener; +import org.eclipse.jface.viewers.IStructuredSelection; +import org.eclipse.jface.viewers.SelectionChangedEvent; +import org.eclipse.swt.SWT; +import org.eclipse.swt.custom.StyledText; +import org.eclipse.swt.events.FocusAdapter; +import org.eclipse.swt.events.FocusEvent; +import org.eclipse.swt.events.KeyEvent; +import org.eclipse.swt.events.KeyListener; +import org.eclipse.swt.events.MouseEvent; +import org.eclipse.swt.events.MouseListener; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Menu; +import org.eclipse.ui.IViewSite; +import org.eclipse.ui.IWorkbenchActionConstants; +import org.eclipse.ui.IWorkbenchPartSite; +import org.eclipse.ui.PlatformUI; +import org.eclipse.ui.actions.ActionFactory; +import org.eclipse.ui.operations.OperationHistoryActionHandler; +import org.eclipse.ui.operations.RedoActionHandler; +import org.eclipse.ui.operations.UndoActionHandler; +import org.eclipse.ui.progress.WorkbenchJob; +import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds; +import org.eclipse.ui.texteditor.ITextEditorActionConstants; +import org.eclipse.ui.texteditor.IUpdate; +import org.eclipse.ui.texteditor.IWorkbenchActionDefinitionIds; + +@SuppressWarnings("restriction") +public class DetailPane implements IDetailPane, IAdaptable, IPropertyChangeListener { + + /** + * The IWorkbenchPartSite that the details area (and the + * variables view) belongs to. + */ + private IWorkbenchPartSite fWorkbenchPartSite; + + /** + * Map of actions. Keys are strings, values + * are IAction. + */ + private Map fActionMap = new HashMap(); + + /** + * Collection to track actions that should be updated when selection occurs. + */ + private List fSelectionActions = new ArrayList(); + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#init(org.eclipse.ui.IWorkbenchPartSite) + */ + public void init(IWorkbenchPartSite workbench) { + fWorkbenchPartSite = workbench; + + } + + /** + * Adds an action to the Map storing actions. Removes it if action is null. + * + * @param actionID The ID of the action, used as the key in the Map + * @param action The action associated with the ID + */ + protected void setAction(String actionID, IAction action) { + if (action == null) { + fActionMap.remove(actionID); + } else { + fActionMap.put(actionID, action); + } + } + + /** + * Adds the given action to the global action handler for the ViewSite. + * A call to updateActionBars() must be called after changes + * to propagate changes through the workbench. + * + * @param actionID The ID of the action + * @param action The action to be set globally + */ + protected void setGlobalAction(String actionID, IAction action){ + getViewSite().getActionBars().setGlobalActionHandler(actionID, action); + } + + /** + * Adds the given action to the list of actions that will be updated when + * updateSelectionDependentActions() is called. If the string + * is null it will not be added to the list. + * + * @param actionID The ID of the action which should be updated + */ + protected void setSelectionDependantAction(String actionID){ + if (actionID != null) fSelectionActions.add(actionID); + } + + /** + * Gets the action out of the map, casts it to an IAction + * + * @param actionID The ID of the action to find + * @return The action associated with the ID or null if none is found. + */ + protected IAction getAction(String actionID) { + return fActionMap.get(actionID); + } + + /** + * Calls the update method of the action with the given action ID. + * The action must exist in the action map and must be an instance of + * IUpdate + * + * @param actionId The ID of the action to update + */ + protected void updateAction(String actionId) { + IAction action= getAction(actionId); + if (action instanceof IUpdate) { + ((IUpdate) action).update(); + } + } + + /** + * Iterates through the list of selection dependent actions and + * updates them. Use setSelectionDependentAction(String actionID) + * to add an action to the list. The action must have been added to the known + * actions map by calling setAction(String actionID, IAction action) + * before it can be updated by this method. + */ + protected void updateSelectionDependentActions() { + Iterator iterator= fSelectionActions.iterator(); + while (iterator.hasNext()) { + updateAction(iterator.next()); + } + } + + /** + * Gets the view site for this view. May be null if this detail pane + * is not part of a view. + * + * @return The site for this view or null + */ + protected IViewSite getViewSite(){ + if (fWorkbenchPartSite == null){ + return null; + } else { + return (IViewSite) fWorkbenchPartSite.getPart().getSite(); + } + } + + /** + * Gets the workbench part site for this view. May be null if this detail pane + * is not part of a view. + * + * @return The workbench part site or null + */ + protected IWorkbenchPartSite getWorkbenchPartSite() { + return fWorkbenchPartSite; + } + + /** + * Returns whether this detail pane is being displayed in a view with a workbench part site. + * + * @return whether this detail pane is being displayed in a view with a workbench part site. + */ + protected boolean isInView(){ + return fWorkbenchPartSite != null; + } + + /** + * These are the IDs for the actions in the context menu + */ + protected static final String DETAIL_COPY_ACTION = ActionFactory.COPY.getId() + ".SourceDetailPane"; //$NON-NLS-1$ + protected static final String DETAIL_SELECT_ALL_ACTION = IDebugView.SELECT_ALL_ACTION + ".SourceDetailPane"; //$NON-NLS-1$ + protected static final String DETAIL_WORD_WRAP_ACTION = IDebugPreferenceConstants.PREF_DETAIL_PANE_WORD_WRAP; + protected static final String DETAIL_MAX_LENGTH_ACTION = "MaxLength"; //$NON-NLS-1$ + + /** + * The ID, name and description of this pane are stored in constants so that the class + * does not have to be instantiated to access them. + */ + public static final String ID = DetailMessages.DefaultDetailPane_0; + public static final String NAME = DetailMessages.DefaultDetailPane_1; + public static final String DESCRIPTION = DetailMessages.DefaultDetailPane_57; + + /** + * Data structure for the position label value. + */ + private static class PositionLabelValue { + + public int fValue; + + @Override + public String toString() { + return String.valueOf(fValue); + } + } + + /** + * Internal interface for a cursor listener. I.e. aggregation + * of mouse and key listener. + * @since 3.0 + */ + interface ICursorListener extends MouseListener, KeyListener { + } + + /** + * Job to compute the details for a selection + */ + class DetailJob extends Job implements IValueDetailListener { + + private IStructuredSelection fElements; + private boolean fFirst = true; + private IProgressMonitor fMonitor; + + public DetailJob(IStructuredSelection elements) { + super("compute variable details"); //$NON-NLS-1$ + setSystem(true); + fElements = elements; + } + + /* (non-Javadoc) + * @see org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime.IProgressMonitor) + */ + @SuppressWarnings("unchecked") + @Override + protected IStatus run(IProgressMonitor monitor) { + fMonitor = monitor; + Iterator iterator = fElements.iterator(); + while (iterator.hasNext()) { + if (monitor.isCanceled()) { + break; + } + Object element = iterator.next(); + + /* + * Make sure this is an element we want to deal with. + */ + if ( element instanceof DMVMContext) { + IFormattedValues service = null; + IFormattedDataDMContext dmc = null ; + + /* + * We are specifically looking to support the following Data Model Contexts + * + * IRegisterDMContext + * IBitFieldDMContext + * IExpressionDMContext + * + * At first you might think that we should just use the service which is + * associated with the dmc. But there are implementations where the data + * model contexts are extended but the services do not extend each other + * ( this is the case with the WindRiver OCD extensions for example ). + * + * So here we specifically look for the service which knows how to deal + * with the formatted data. + */ + + DsfServicesTracker tracker = new DsfServicesTracker(DsfDebugUIPlugin.getBundleContext(), ((DMVMContext) element).getDMC().getSessionId()); + + IRegisterDMContext regDmc = DMContexts.getAncestorOfType(((DMVMContext) element).getDMC(), IRegisterDMContext.class); + + if ( regDmc != null ) { + dmc = regDmc ; + service = tracker.getService(IRegisters.class); + } + else { + IBitFieldDMContext bitfieldDmc = DMContexts.getAncestorOfType(((DMVMContext) element).getDMC(), IBitFieldDMContext.class); + + if ( bitfieldDmc != null ) { + dmc = bitfieldDmc ; + service = tracker.getService(IRegisters.class); + } + else { + IExpressionDMContext exprDmc = DMContexts.getAncestorOfType(((DMVMContext) element).getDMC(), IExpressionDMContext.class); + + if ( exprDmc != null ) { + dmc = exprDmc ; + service = tracker.getService(IExpressions.class); + } + } + } + + /* + * If the desired Data Model Context is null then we are not going to + * process this data. + */ + if ( dmc == null ) return Status.OK_STATUS; + + /* + * Now that we can process this one. Find out how many formats we can + * show this in. We will choose to show all of the supported formats. + * Since we are doing this in the background and the debug engines do + * typically cache the results so producing multiple formats will not + * typically be a burden. We should probably consider perhaps doing a + * preference where they can select what formats they want to show. + */ + final IFormattedDataDMContext finalDmc = dmc; + final IFormattedValues finalService = service; + + final DataRequestMonitor getAvailableFormatsDone = + new DataRequestMonitor(finalService.getSession().getExecutor(), null) { + @Override + protected void handleOK() { + /* + * Now we have a set of formats for each one fire up an independent + * asynchronous request to get the data in that format. We do not + * go through the cache manager here because when the values are + * edited and written the cache is bypassed. + */ + String[] formats = getData(); + for ( final String str : formats ) { + /* + * Format has been validated. Get the formatted value. + */ + final FormattedValueDMContext valueDmc = finalService.getFormattedValue(finalDmc, str); + finalService.getModelData( + valueDmc, + new DataRequestMonitor(finalService.getSession().getExecutor(), null) { + @Override + public void handleCompleted() { + if (getStatus().isOK()) { + /* + * Show the information indicating the format. + */ + if ( str == IFormattedValues.HEX_FORMAT) { + detailComputed(null, "Hex.... : " + getData().getFormattedValue()); //$NON-NLS-1$ + } + else if ( str == IFormattedValues.OCTAL_FORMAT) { + detailComputed(null, "Octal.. : " + getData().getFormattedValue()); //$NON-NLS-1$ + } + else if ( str == IFormattedValues.NATURAL_FORMAT) { + detailComputed(null, "Natural : " + getData().getFormattedValue()); //$NON-NLS-1$ + } + else if ( str == IFormattedValues.BINARY_FORMAT) { + detailComputed(null, "Binary. : " + getData().getFormattedValue()); //$NON-NLS-1$ + } + else { + detailComputed(null, "Other.. : " + getData().getFormattedValue()); //$NON-NLS-1$ + } + } + } + } + ); + } + } + }; + + /* + * Get the supported formats. + */ + finalService.getExecutor().submit(new Runnable() { + public void run() { + finalService.getAvailableFormattedValues(finalDmc, getAvailableFormatsDone); + } + } + ); + } + } + + return Status.OK_STATUS; + } + + /* (non-Javadoc) + * @see org.eclipse.core.runtime.jobs.Job#canceling() + */ + @Override + protected void canceling() { + super.canceling(); + synchronized (this) { + notifyAll(); + } + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IValueDetailListener#detailComputed(org.eclipse.debug.core.model.IValue, java.lang.String) + */ + public void detailComputed(IValue value, final String result) { + if (!fMonitor.isCanceled()) { + WorkbenchJob append = new WorkbenchJob("append details") { //$NON-NLS-1$ + @Override + public IStatus runInUIThread(IProgressMonitor monitor) { + if (!fMonitor.isCanceled()) { + String insert = result; + int length = 0; + if (!fFirst) { + length = getDetailDocument().getLength(); + } + if (length > 0) { + insert = "\n" + result; //$NON-NLS-1$ + } + try { + int max = DebugUIPlugin.getDefault().getPreferenceStore().getInt(IDebugUIConstants.PREF_MAX_DETAIL_LENGTH); + if (max > 0 && insert.length() > max) { + insert = insert.substring(0, max) + "..."; //$NON-NLS-1$ + } + if (fFirst) { + getDetailDocument().set(insert); + fFirst = false; + } else { + getDetailDocument().replace(length, 0,insert); + } + } catch (BadLocationException e) { + DebugUIPlugin.log(e); + } + } + return Status.OK_STATUS; + } + }; + append.setSystem(true); + append.schedule(); + } + synchronized (this) { + notifyAll(); + } + } + } + + /** + * The model presentation used to produce the string details for a + * selected variable. + */ + private VariablesViewModelPresentation fModelPresentation; + private String fDebugModelIdentifier; + + /** + * Controls the status line while the details area has focus. + * Displays the current cursor position in the text (line:character). + */ + private StatusLineContributionItem fStatusLineItem; + + /** + * The source viewer in which the computed string detail + * of selected variables will be displayed. + */ + private SourceViewer fSourceViewer; + + /** + * The last selection displayed in the source viewer. + */ + private IStructuredSelection fLastDisplayed = null; + + /** + * Variables used to create the detailed information for a selection + */ + private IDocument fDetailDocument; + private DetailJob fDetailJob = null; + private final String fPositionLabelPattern = DetailMessages.DefaultDetailPane_56; + private final PositionLabelValue fLineLabel = new PositionLabelValue(); + private final PositionLabelValue fColumnLabel = new PositionLabelValue(); + private final Object[] fPositionLabelPatternArguments = new Object[] {fLineLabel, fColumnLabel }; + private ICursorListener fCursorListener; + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#createControl(org.eclipse.swt.widgets.Composite) + */ + public Control createControl(Composite parent) { + + fModelPresentation = new VariablesViewModelPresentation(); + + createSourceViewer(parent); + + if (isInView()){ + createViewSpecificComponents(); + createActions(); + DebugUIPlugin.getDefault().getPreferenceStore().addPropertyChangeListener(this); + JFaceResources.getFontRegistry().addListener(this); + } + + return fSourceViewer.getControl(); + } + + /** + * Creates the source viewer in the given parent composite + * + * @param parent Parent composite to create the source viewer in + */ + private void createSourceViewer(Composite parent) { + + // Create & configure a SourceViewer + fSourceViewer = new SourceViewer(parent, null, SWT.V_SCROLL | SWT.H_SCROLL); + fSourceViewer.setDocument(getDetailDocument()); + fSourceViewer.getTextWidget().setFont(JFaceResources.getFont(IInternalDebugUIConstants.DETAIL_PANE_FONT)); + fSourceViewer.getTextWidget().setWordWrap(DebugUIPlugin.getDefault().getPreferenceStore().getBoolean(IDebugPreferenceConstants.PREF_DETAIL_PANE_WORD_WRAP)); + fSourceViewer.setEditable(false); + PlatformUI.getWorkbench().getHelpSystem().setHelp(fSourceViewer.getTextWidget(), IDebugHelpContextIds.DETAIL_PANE); + Control control = fSourceViewer.getControl(); + GridData gd = new GridData(GridData.FILL_BOTH); + control.setLayoutData(gd); + } + + /** + * Creates listeners and other components that should only be added to the + * source viewer when this detail pane is inside a view. + */ + private void createViewSpecificComponents(){ + + // Add a document listener so actions get updated when the document changes + getDetailDocument().addDocumentListener(new IDocumentListener() { + public void documentAboutToBeChanged(DocumentEvent event) {} + public void documentChanged(DocumentEvent event) { + updateSelectionDependentActions(); + } + }); + + // Add the selection listener so selection dependent actions get updated. + fSourceViewer.getSelectionProvider().addSelectionChangedListener(new ISelectionChangedListener() { + public void selectionChanged(SelectionChangedEvent event) { + updateSelectionDependentActions(); + } + }); + + // Add a focus listener to update actions when details area gains focus + fSourceViewer.getControl().addFocusListener(new FocusAdapter() { + @Override + public void focusGained(FocusEvent e) { + + getViewSite().setSelectionProvider(fSourceViewer.getSelectionProvider()); + + setGlobalAction(IDebugView.SELECT_ALL_ACTION, getAction(DETAIL_SELECT_ALL_ACTION)); + setGlobalAction(IDebugView.COPY_ACTION, getAction(DETAIL_COPY_ACTION)); + + getViewSite().getActionBars().updateActionBars(); + } + + @Override + public void focusLost(FocusEvent e) { + + getViewSite().setSelectionProvider(null); + + setGlobalAction(IDebugView.SELECT_ALL_ACTION, null); + setGlobalAction(IDebugView.COPY_ACTION, null); + + getViewSite().getActionBars().updateActionBars(); + } + }); + + // Create a status line item displaying the current cursor location + fStatusLineItem = new StatusLineContributionItem("ModeContributionItem"); //$NON-NLS-1$ + IStatusLineManager manager= getViewSite().getActionBars().getStatusLineManager(); + manager.add(fStatusLineItem); + fSourceViewer.getTextWidget().addMouseListener(getCursorListener()); + fSourceViewer.getTextWidget().addKeyListener(getCursorListener()); + + // Add a context menu to the detail area + createDetailContextMenu(fSourceViewer.getTextWidget()); + } + + /** + * Creates the actions to add to the context menu + */ + private void createActions() { + + TextViewerAction textAction= new TextViewerAction(fSourceViewer, ITextOperationTarget.SELECT_ALL); + textAction.configureAction(DetailMessages.DefaultDetailPane_Select__All_5, "", ""); //$NON-NLS-1$ //$NON-NLS-2$ + textAction.setActionDefinitionId(IWorkbenchActionDefinitionIds.SELECT_ALL); + PlatformUI.getWorkbench().getHelpSystem().setHelp(textAction, IDebugHelpContextIds.DETAIL_PANE_SELECT_ALL_ACTION); + setAction(DETAIL_SELECT_ALL_ACTION, textAction); + + textAction= new TextViewerAction(fSourceViewer, ITextOperationTarget.COPY); + textAction.configureAction(DetailMessages.DefaultDetailPane__Copy_8, "", ""); //$NON-NLS-1$ //$NON-NLS-2$ + textAction.setActionDefinitionId(IWorkbenchActionDefinitionIds.COPY); + PlatformUI.getWorkbench().getHelpSystem().setHelp(textAction, IDebugHelpContextIds.DETAIL_PANE_COPY_ACTION); + setAction(DETAIL_COPY_ACTION, textAction); + + setSelectionDependantAction(DETAIL_COPY_ACTION); + + updateSelectionDependentActions(); + + IAction action = new DetailPaneWordWrapAction(fSourceViewer); + setAction(DETAIL_WORD_WRAP_ACTION, action); + + action = new DetailPaneMaxLengthAction(fSourceViewer.getControl().getShell()); + setAction(DETAIL_MAX_LENGTH_ACTION,action); + } + + /** + * Create the context menu particular to the detail pane. Note that anyone + * wishing to contribute an action to this menu must use + * IDebugUIConstants.VARIABLE_VIEW_DETAIL_ID as the + * targetID in the extension XML. + */ + protected void createDetailContextMenu(Control menuControl) { + MenuManager menuMgr= new MenuManager(); + menuMgr.setRemoveAllWhenShown(true); + menuMgr.addMenuListener(new IMenuListener() { + public void menuAboutToShow(IMenuManager mgr) { + fillDetailContextMenu(mgr); + } + }); + Menu menu= menuMgr.createContextMenu(menuControl); + menuControl.setMenu(menu); + + getViewSite().registerContextMenu(IDebugUIConstants.VARIABLE_VIEW_DETAIL_ID, menuMgr, fSourceViewer.getSelectionProvider()); + } + + /** + * Adds items to the detail pane's context menu including any extension defined + * actions. + * + * @param menu The menu to add the item to. + */ + protected void fillDetailContextMenu(IMenuManager menu) { + + menu.add(new Separator(IDebugUIConstants.VARIABLE_GROUP)); + menu.add(new Separator()); + menu.add(getAction(DETAIL_COPY_ACTION)); + menu.add(getAction(DETAIL_SELECT_ALL_ACTION)); + menu.add(new Separator()); + menu.add(getAction(DETAIL_WORD_WRAP_ACTION)); + menu.add(getAction(DETAIL_MAX_LENGTH_ACTION)); + menu.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS)); + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#display(org.eclipse.jface.viewers.IStructuredSelection) + */ + public void display(IStructuredSelection selection) { + + if (selection == null){ + clearSourceViewer(); + return; + } + + fLastDisplayed = selection; + + if (selection.isEmpty()){ + clearSourceViewer(); + return; + } + + Object firstElement = selection.getFirstElement(); + if (firstElement != null && firstElement instanceof IDebugElement) { + String modelID = ((IDebugElement)firstElement).getModelIdentifier(); + setDebugModel(modelID); + } + + synchronized (this) { + if (fDetailJob != null) { + fDetailJob.cancel(); + } + fDetailJob = new DetailJob(selection); + fDetailJob.schedule(); + } + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#setFocus() + */ + public boolean setFocus(){ + if (fSourceViewer != null){ + fSourceViewer.getTextWidget().setFocus(); + return true; + } + return false; + } + + /* + * + */ + public void dispose(){ + fActionMap.clear(); + fSelectionActions.clear(); + + if (fDetailJob != null) fDetailJob.cancel(); + if (fModelPresentation != null) fModelPresentation.dispose(); + fDebugModelIdentifier = null; // Setting this to null makes sure the source viewer is reconfigured with the model presentation after disposal + if (fSourceViewer != null && fSourceViewer.getControl() != null) fSourceViewer.getControl().dispose(); + + if (isInView()){ + disposeUndoRedoAction(ITextEditorActionConstants.UNDO); + disposeUndoRedoAction(ITextEditorActionConstants.REDO); + + getViewSite().getActionBars().getStatusLineManager().remove(fStatusLineItem); + + DebugUIPlugin.getDefault().getPreferenceStore().removePropertyChangeListener(this); + JFaceResources.getFontRegistry().removeListener(this); + } + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#getDescription() + */ + public String getDescription() { + return DESCRIPTION; + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#getID() + */ + public String getID() { + return ID; + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPane#getName() + */ + public String getName() { + return NAME; + } + + /* (non-Javadoc) + * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class) + */ + @SuppressWarnings("unchecked") + public Object getAdapter(Class required) { + if (IFindReplaceTarget.class.equals(required)) { + return fSourceViewer.getFindReplaceTarget(); + } + if (ITextViewer.class.equals(required)) { + return fSourceViewer; + } + return null; + } + + /** + * Lazily instantiate and return a Document for the detail pane text viewer. + */ + protected IDocument getDetailDocument() { + if (fDetailDocument == null) { + fDetailDocument = new Document(); + } + return fDetailDocument; + } + + /** + * Clears the source viewer, removes all text. + */ + protected void clearSourceViewer(){ + if (fDetailJob != null) { + fDetailJob.cancel(); + } + fLastDisplayed = null; + fDetailDocument.set(""); //$NON-NLS-1$ + fSourceViewer.setEditable(false); + } + + /** + * Configures the details viewer for the debug model + * currently being displayed + */ + protected void configureDetailsViewer() { + LazyModelPresentation mp = (LazyModelPresentation)fModelPresentation.getPresentation(getDebugModel()); + SourceViewerConfiguration svc = null; + if (mp != null) { + try { + svc = mp.newDetailsViewerConfiguration(); + } catch (CoreException e) { + DebugUIPlugin.errorDialog(fSourceViewer.getControl().getShell(), DetailMessages.DefaultDetailPane_Error_1, DetailMessages.DefaultDetailPane_2, e); + } + } + + if (svc == null) { + svc = new SourceViewerConfiguration(); + fSourceViewer.setEditable(false); + } + fSourceViewer.unconfigure(); + fSourceViewer.configure(svc); + + if (isInView()){ + createUndoRedoActions(); + } + } + + /** + * @return The formatted string describing cursor position + */ + protected String getCursorPosition() { + + if (fSourceViewer == null) { + return ""; //$NON-NLS-1$ + } + + StyledText styledText= fSourceViewer.getTextWidget(); + int caret= styledText.getCaretOffset(); + IDocument document= fSourceViewer.getDocument(); + + if (document == null) { + return ""; //$NON-NLS-1$ + } + + try { + + int line= document.getLineOfOffset(caret); + + int lineOffset= document.getLineOffset(line); + int tabWidth= styledText.getTabs(); + int column= 0; + for (int i= lineOffset; i < caret; i++) + if ('\t' == document.getChar(i)) { + column += tabWidth - (tabWidth == 0 ? 0 : column % tabWidth); + } else { + column++; + } + + fLineLabel.fValue= line + 1; + fColumnLabel.fValue= column + 1; + return MessageFormat.format(fPositionLabelPattern, fPositionLabelPatternArguments); + + } catch (BadLocationException x) { + return ""; //$NON-NLS-1$ + } + } + + /** + * Returns this view's "cursor" listener to be installed on the view's + * associated details viewer. This listener is listening to key and mouse button events. + * It triggers the updating of the status line. + * + * @return the listener + */ + private ICursorListener getCursorListener() { + if (fCursorListener == null) { + fCursorListener= new ICursorListener() { + + public void keyPressed(KeyEvent e) { + fStatusLineItem.setText(getCursorPosition()); + } + + public void keyReleased(KeyEvent e) { + } + + public void mouseDoubleClick(MouseEvent e) { + } + + public void mouseDown(MouseEvent e) { + } + + public void mouseUp(MouseEvent e) { + fStatusLineItem.setText(getCursorPosition()); + } + }; + } + return fCursorListener; + } + + /** + * Returns the identifier of the debug model being displayed + * in this view, or null if none. + * + * @return debug model identifier + */ + protected String getDebugModel() { + return fDebugModelIdentifier; + } + + /** + * Sets the identifier of the debug model being displayed + * in this view, or null if none. + * + * @param id debug model identifier of the type of debug + * elements being displayed in this view + */ + protected void setDebugModel(String id) { + if (id != fDebugModelIdentifier) { + fDebugModelIdentifier = id; + configureDetailsViewer(); + } + } + + /** + * Creates this editor's undo/re-do actions. + *

+ * Subclasses may override or extend.

+ * + * @since 3.2 + */ + protected void createUndoRedoActions() { + disposeUndoRedoAction(ITextEditorActionConstants.UNDO); + disposeUndoRedoAction(ITextEditorActionConstants.REDO); + IUndoContext undoContext= getUndoContext(); + if (undoContext != null) { + // Use actions provided by global undo/re-do + + // Create the undo action + OperationHistoryActionHandler undoAction= new UndoActionHandler(getViewSite(), undoContext); + PlatformUI.getWorkbench().getHelpSystem().setHelp(undoAction, IAbstractTextEditorHelpContextIds.UNDO_ACTION); + undoAction.setActionDefinitionId(IWorkbenchActionDefinitionIds.UNDO); + setAction(ITextEditorActionConstants.UNDO, undoAction); + setGlobalAction(ITextEditorActionConstants.UNDO, undoAction); + + // Create the re-do action. + OperationHistoryActionHandler redoAction= new RedoActionHandler(getViewSite(), undoContext); + PlatformUI.getWorkbench().getHelpSystem().setHelp(redoAction, IAbstractTextEditorHelpContextIds.REDO_ACTION); + redoAction.setActionDefinitionId(IWorkbenchActionDefinitionIds.REDO); + setAction(ITextEditorActionConstants.REDO, redoAction); + setGlobalAction(ITextEditorActionConstants.REDO, redoAction); + + getViewSite().getActionBars().updateActionBars(); + } + } + + /** + * Disposes of the action with the specified ID + * + * @param actionId the ID of the action to disposed + */ + protected void disposeUndoRedoAction(String actionId) { + OperationHistoryActionHandler action = (OperationHistoryActionHandler) getAction(actionId); + if (action != null) { + action.dispose(); + setAction(actionId, null); + } + } + + /** + * Returns this editor's viewer's undo manager undo context. + * + * @return the undo context or null if not available + * @since 3.2 + */ + private IUndoContext getUndoContext() { + IUndoManager undoManager= fSourceViewer.getUndoManager(); + if (undoManager instanceof IUndoManagerExtension) + return ((IUndoManagerExtension)undoManager).getUndoContext(); + return null; + } + + /* (non-Javadoc) + * @see org.eclipse.jface.util.IPropertyChangeListener#propertyChange(org.eclipse.jface.util.PropertyChangeEvent) + */ + public void propertyChange(PropertyChangeEvent event) { + String propertyName= event.getProperty(); + if (propertyName.equals(IInternalDebugUIConstants.DETAIL_PANE_FONT)) { + fSourceViewer.getTextWidget().setFont(JFaceResources.getFont(IInternalDebugUIConstants.DETAIL_PANE_FONT)); + } else if (propertyName.equals(IDebugUIConstants.PREF_MAX_DETAIL_LENGTH)) { + display(fLastDisplayed); + } else if (propertyName.equals(IDebugPreferenceConstants.PREF_DETAIL_PANE_WORD_WRAP)) { + fSourceViewer.getTextWidget().setWordWrap(DebugUIPlugin.getDefault().getPreferenceStore().getBoolean(IDebugPreferenceConstants.PREF_DETAIL_PANE_WORD_WRAP)); + getAction(DETAIL_WORD_WRAP_ACTION).setChecked(DebugUIPlugin.getDefault().getPreferenceStore().getBoolean(IDebugPreferenceConstants.PREF_DETAIL_PANE_WORD_WRAP)); + } + } +} diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/DetailPaneFactory.java b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/DetailPaneFactory.java new file mode 100644 index 00000000000..d35cec533cd --- /dev/null +++ b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/DetailPaneFactory.java @@ -0,0 +1,76 @@ +/******************************************************************************* + * Copyright (c) 2007 Wind River Systems and others. + * 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: + * Randy Rohrbach (Wind River Systems, Inc.) - initial implementation + *******************************************************************************/ +package org.eclipse.dd.dsf.debug.ui.viewmodel.detailpanesupport; + +import java.util.HashSet; +import java.util.Set; + +import org.eclipse.debug.ui.IDetailPane; +import org.eclipse.debug.ui.IDetailPaneFactory; +import org.eclipse.jface.viewers.IStructuredSelection; + +/** + * This provides a simple Detail Pane Factory for the core debug views for DSF. + */ + +@SuppressWarnings("restriction") +public class DetailPaneFactory implements IDetailPaneFactory { + + public static final String DETAIL_PANE_ID = Messages.getString("DetailPaneFactory.0"); //$NON-NLS-1$ + public static final String DETAIL_PANE_NAME = Messages.getString("DetailPaneFactory.1"); //$NON-NLS-1$ + public static final String DETAIL_PANE_DESC = Messages.getString("DetailPaneFactory.2"); //$NON-NLS-1$ + + /* (non-Javadoc) + * @see org.eclipse.debug.internal.ui.views.variables.IDetailsFactory#createDetailsArea(java.lang.String) + */ + public IDetailPane createDetailPane(String id) { + return new DetailPane(); + } + + /* (non-Javadoc) + * @see org.eclipse.debug.internal.ui.views.variables.IDetailsFactory#getDetailsTypes(org.eclipse.jface.viewers.IStructuredSelection) + */ + @SuppressWarnings("unchecked") + public Set getDetailPaneTypes(IStructuredSelection selection) { + Set possibleIDs = new HashSet(1); + possibleIDs.add(DETAIL_PANE_ID); + return possibleIDs; + } + + /* (non-Javadoc) + * @see org.eclipse.debug.ui.IDetailPaneFactory#getDefaultDetailPane(java.util.Set, org.eclipse.jface.viewers.IStructuredSelection) + */ + public String getDefaultDetailPane(IStructuredSelection selection) { + return DETAIL_PANE_ID; + } + + /* (non-Javadoc) + * @see org.eclipse.debug.internal.ui.views.variables.IDetailsFactory#getName(java.lang.String) + */ + public String getDetailPaneName(String id) { + if (id.equals(DETAIL_PANE_ID)){ + return DETAIL_PANE_NAME; + } + return null; + } + + + /* (non-Javadoc) + * @see org.eclipse.debug.internal.ui.views.variables.IDetailsFactory#getDescription(java.lang.String) + */ + public String getDetailPaneDescription(String id) { + if (id.equals(DETAIL_PANE_ID)){ + return DETAIL_PANE_DESC; + } + return null; + } + +} diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/Messages.java b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/Messages.java new file mode 100644 index 00000000000..5d278c057f6 --- /dev/null +++ b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/Messages.java @@ -0,0 +1,32 @@ +/******************************************************************************* + * Copyright (c) 2007 Wind River Systems and others. + * 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: + * Randy Rohrbach (Wind River Systems, Inc.) - initial implementation + *******************************************************************************/ +package org.eclipse.dd.dsf.debug.ui.viewmodel.detailpanesupport; + +import java.util.MissingResourceException; +import java.util.ResourceBundle; + +public class Messages { + private static final String BUNDLE_NAME = "org.eclipse.dd.dsf.debug.ui.viewmodel.detailpanesupport.messages"; //$NON-NLS-1$ + + private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle + .getBundle(BUNDLE_NAME); + + private Messages() { + } + + public static String getString(String key) { + try { + return RESOURCE_BUNDLE.getString(key); + } catch (MissingResourceException e) { + return '!' + key + '!'; + } + } +} diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/TextViewerAction.java b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/TextViewerAction.java new file mode 100644 index 00000000000..7cd6bafbc15 --- /dev/null +++ b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/TextViewerAction.java @@ -0,0 +1,86 @@ +/******************************************************************************* + * Copyright (c) 2006, 2007 IBM Corporation and others. + * 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: + * IBM Corporation - initial API and implementation + * Randy Rohrbach (Wind River Systems, Inc.) - extended implementation + *******************************************************************************/ +package org.eclipse.dd.dsf.debug.ui.viewmodel.detailpanesupport; + +import org.eclipse.jface.action.Action; +import org.eclipse.jface.text.ITextOperationTarget; +import org.eclipse.jface.text.ITextViewer; +import org.eclipse.ui.texteditor.IUpdate; + +/** + * Common function for actions that operate on a text viewer. + *

+ * Clients may subclass this class. + *

+ * @since 3.0 + */ +public class TextViewerAction extends Action implements IUpdate { + + private int fOperationCode= -1; + private ITextOperationTarget fOperationTarget; + + /** + * Constructs a new action in the given text viewer with + * the specified operation code. + * + * @param viewer + * @param operationCode + */ + public TextViewerAction(ITextViewer viewer, int operationCode) { + fOperationCode= operationCode; + fOperationTarget= viewer.getTextOperationTarget(); + update(); + } + + /* (non-Javadoc) + * @see org.eclipse.ui.texteditor.IUpdate#update() + * + * Updates the enabled state of the action. + * Fires a property change if the enabled state changes. + * + * @see org.eclipse.jface.action.Action#firePropertyChange(String, Object, Object) + */ + public void update() { + + boolean wasEnabled= isEnabled(); + boolean isEnabled= (fOperationTarget != null && fOperationTarget.canDoOperation(fOperationCode)); + setEnabled(isEnabled); + + if (wasEnabled != isEnabled) { + firePropertyChange(ENABLED, wasEnabled ? Boolean.TRUE : Boolean.FALSE, isEnabled ? Boolean.TRUE : Boolean.FALSE); + } + } + + /* (non-Javadoc) + * @see org.eclipse.jface.action.IAction#run() + */ + @Override + public void run() { + if (fOperationCode != -1 && fOperationTarget != null) { + fOperationTarget.doOperation(fOperationCode); + } + } + + /** + * Configures this action with a label, tool tip, and description. + * + * @param text action label + * @param toolTipText action tool tip + * @param description action description + */ + public void configureAction(String text, String toolTipText, String description) { + setText(text); + setToolTipText(toolTipText); + setDescription(description); + } +} + diff --git a/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/messages.properties b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/messages.properties new file mode 100644 index 00000000000..5d99640c01d --- /dev/null +++ b/plugins/org.eclipse.dd.dsf.debug.ui/src/org/eclipse/dd/dsf/debug/ui/viewmodel/detailpanesupport/messages.properties @@ -0,0 +1,3 @@ +DetailPaneFactory.0=DSF Default Detail Pane +DetailPaneFactory.1=DSF Default Viewer +DetailPaneFactory.2=This is the default detail pane representation for DSF assisted views