/******************************************************************************* * Copyright (c) 2000, 2003 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package net.sourceforge.phpdt.internal.debug.ui; import net.sourceforge.phpdt.internal.debug.core.model.PHPStackFrame; import net.sourceforge.phpdt.internal.debug.core.model.PHPValue; import net.sourceforge.phpdt.internal.ui.text.HTMLTextPresenter; import net.sourceforge.phpdt.internal.ui.text.JavaWordFinder; import net.sourceforge.phpdt.ui.PreferenceConstants; import net.sourceforge.phpdt.ui.text.java.hover.IJavaEditorTextHover; import net.sourceforge.phpeclipse.xdebug.php.model.XDebugAbstractValue; import net.sourceforge.phpeclipse.xdebug.php.model.XDebugStackFrame; import net.sourceforge.phpeclipse.xdebug.php.model.XDebugTarget; import net.sourceforge.phpeclipse.xdebug.php.model.XDebugValue; import org.eclipse.core.runtime.IAdaptable; import org.eclipse.debug.core.DebugException; import org.eclipse.debug.core.model.IValue; import org.eclipse.debug.core.model.IVariable; import org.eclipse.debug.ui.IDebugUIConstants; import org.eclipse.jface.text.BadLocationException; import org.eclipse.jface.text.DefaultInformationControl; import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.IInformationControl; import org.eclipse.jface.text.IInformationControlCreator; import org.eclipse.jface.text.IRegion; import org.eclipse.jface.text.ITextHoverExtension; import org.eclipse.jface.text.ITextViewer; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.viewers.ITreeSelection; import org.eclipse.jface.viewers.TreePath; //import org.eclipse.swt.SWT; import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.IEditorPart; import org.eclipse.ui.IPartListener; import org.eclipse.ui.ISelectionListener; import org.eclipse.ui.IWorkbenchPage; import org.eclipse.ui.IWorkbenchPart; public class PHPDebugHover implements IJavaEditorTextHover, ITextHoverExtension, ISelectionListener, IPartListener { protected IEditorPart fEditor; protected ISelection fSelection = null; /* * (non-Javadoc) * * @see org.eclipse.ui.IPartListener#partActivated(org.eclipse.ui.IWorkbenchPart) */ public void partActivated(IWorkbenchPart part) { } /* * (non-Javadoc) * * @see org.eclipse.ui.IPartListener#partBroughtToTop(org.eclipse.ui.IWorkbenchPart) */ public void partBroughtToTop(IWorkbenchPart part) { } /* * (non-Javadoc) * * @see org.eclipse.ui.IPartListener#partClosed(org.eclipse.ui.IWorkbenchPart) */ public void partClosed(IWorkbenchPart part) { if (part.equals(fEditor)) { IWorkbenchPage page = fEditor.getSite().getPage(); page.removeSelectionListener(IDebugUIConstants.ID_DEBUG_VIEW, this); page.removePartListener(this); fSelection = null; fEditor = null; } } /* * (non-Javadoc) * * @see org.eclipse.ui.IPartListener#partDeactivated(org.eclipse.ui.IWorkbenchPart) */ public void partDeactivated(IWorkbenchPart part) { } /* * (non-Javadoc) * * @see org.eclipse.ui.IPartListener#partOpened(org.eclipse.ui.IWorkbenchPart) */ public void partOpened(IWorkbenchPart part) { } /* * (non-Javadoc) * * @see org.eclipse.ui.ISelectionListener#selectionChanged(org.eclipse.ui.IWorkbenchPart, * org.eclipse.jface.viewers.ISelection) */ public void selectionChanged(IWorkbenchPart part, ISelection selection) { fSelection = selection; } public PHPDebugHover() { } /* * (non-Javadoc) * * @see org.eclipse.jdt.ui.text.java.hover.IJavaEditorTextHover#setEditor(org.eclipse.ui.IEditorPart) */ public void setEditor(IEditorPart editor) { if (editor != null) { fEditor = editor; final IWorkbenchPage page = editor.getSite().getPage(); page.addSelectionListener(IDebugUIConstants.ID_DEBUG_VIEW, this); page.addPartListener(this); // initialize selection Runnable r = new Runnable() { public void run() { fSelection = page .getSelection(IDebugUIConstants.ID_DEBUG_VIEW); } }; PHPDebugUiPlugin.getStandardDisplay().asyncExec(r); } } /* * (non-Javadoc) * * @see org.eclipse.jface.text.ITextHover#getHoverRegion(org.eclipse.jface.text.ITextViewer, * int) */ public IRegion getHoverRegion(ITextViewer textViewer, int offset) { return JavaWordFinder.findWord(textViewer.getDocument(), offset); } /** * Returns the stack frame in which to search for variables, or * null if none. * * @return the stack frame in which to search for variables, or * null if none */ protected PHPStackFrame getFrame() { if (fSelection instanceof IStructuredSelection) { IStructuredSelection selection = (IStructuredSelection) fSelection; if (selection.size() == 1) { Object el = selection.getFirstElement(); if (el instanceof IAdaptable) { return (PHPStackFrame) ((IAdaptable) el) .getAdapter(PHPStackFrame.class); } } } return null; } protected XDebugStackFrame getXDebugFrame() { if (fSelection instanceof IStructuredSelection) { IStructuredSelection selection = (IStructuredSelection) fSelection; if (selection.size() == 1) { Object el = selection.getFirstElement(); if (el instanceof IAdaptable) { return (XDebugStackFrame) ((IAdaptable) el) .getAdapter(XDebugStackFrame.class); } } } return null; } /* * (non-Javadoc) * * @see org.eclipse.jface.text.ITextHover#getHoverInfo(org.eclipse.jface.text.ITextViewer, * org.eclipse.jface.text.IRegion) */ public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) { IVariable variable = null; PHPStackFrame frameDBG = null; XDebugStackFrame frameXD = null; TreePath paths[] = ((ITreeSelection) fSelection).getPaths (); Object target = paths[0].getSegment (1); if (target.getClass().getName ().equals ("net.sourceforge.phpeclipse.xdebug.php.model.XDebugTarget") ) { frameXD = getXDebugFrame (); } else { frameDBG = getFrame(); } if ((frameDBG != null) || (frameXD != null)) { try { IDocument document = textViewer.getDocument(); if (document == null) return null; String variableName = document.get (hoverRegion.getOffset(), hoverRegion.getLength()); StringBuffer buffer = new StringBuffer(); try { if (frameDBG != null) { variable = frameDBG.findVariable (variableName); } else if (frameXD != null) { variable = frameXD.findVariable (variableName); } if (variable != null) { appendVariable(buffer, variable); } } catch (DebugException x) { // if (x.getStatus().getCode() != // IJavaThread.ERR_THREAD_NOT_SUSPENDED) { PHPDebugUiPlugin.log(x); // } } if (buffer.length() > 0) { return buffer.toString(); } } catch (BadLocationException x) { PHPDebugUiPlugin.log(x); } } return null; } /** * Append HTML for the given variable to the given buffer */ private static void appendVariable(StringBuffer buffer, IVariable variable) throws DebugException { buffer.append("

"); //$NON-NLS-1$ buffer.append("

").append(variable.getName()).append("
"); //$NON-NLS-1$ //$NON-NLS-2$ buffer.append(" ="); //$NON-NLS-1$ String type = getTypeName(variable); String value = "
" + variable.getValue().getValueString() + "
"; //$NON-NLS-1$ //$NON-NLS-2$ if (type == null) { buffer.append(" null"); //$NON-NLS-1$ } else if (type.equals("java.lang.String")) { //$NON-NLS-1$ buffer.append(" \""); //$NON-NLS-1$ buffer.append(value); buffer.append('"'); } else if (type.equals("boolean") || // in dbg it's boolean type.equals("bool")) { // in XDebug it's bool $NON-NLS-1$ buffer.append(' '); buffer.append(value); } else { buffer.append(" ("); //$NON-NLS-1$ buffer.append("
").append(type).append("
"); //$NON-NLS-1$ //$NON-NLS-2$ buffer.append(") "); //$NON-NLS-1$ buffer.append(value); } buffer.append("

"); //$NON-NLS-1$ } private static String getTypeName(IVariable variable) throws DebugException { IValue value = variable.getValue(); if (value instanceof PHPValue) return ((PHPValue) value).getReferenceTypeName(); if (value instanceof XDebugAbstractValue) return ((XDebugAbstractValue) value).getReferenceTypeName (); return null; } /* * (non-Javadoc) * * @see org.eclipse.jface.text.ITextHoverExtension#getInformationControlCreator() */ // public IInformationControlCreator getInformationControlCreator() { // // if // // (Platform.getPlugin("org.eclipse.jdt.ui").getPluginPreferences().getBoolean(PreferenceConstants.EDITOR_SHOW_TEXT_HOVER_AFFORDANCE)) // // { //$NON-NLS-1$ // return new IInformationControlCreator() { // public IInformationControl createInformationControl(Shell parent) { ////incastrix // // return new DefaultInformationControl(parent, SWT.NONE, //// new HTMLTextPresenter(true), PHPDebugUiMessages //// .getString("JavaDebugHover.16")); //$NON-NLS-1$ // return new DefaultInformationControl(parent, PHPDebugUiMessages.getString("JavaDebugHover.16"), // new HTMLTextPresenter(true)); // } // }; // // } // // return null; // } /* * (non-Javadoc) * * @see org.eclipse.jface.text.ITextHoverExtension#getHoverControlCreator() */ public IInformationControlCreator getHoverControlCreator() { if (PreferenceConstants.getPreferenceStore().getBoolean( PreferenceConstants.EDITOR_SHOW_TEXT_HOVER_AFFORDANCE)) { //$NON-NLS-1$ return new IInformationControlCreator() { public IInformationControl createInformationControl(Shell parent) { //incastrix // return new DefaultInformationControl(parent, SWT.NONE, // new HTMLTextPresenter(true), PHPDebugUiMessages // .getString("PHPDebugHover.16")); //$NON-NLS-1$ return new DefaultInformationControl(parent, PHPDebugUiMessages.getString("JavaDebugHover.16"), new HTMLTextPresenter(true)); } }; } return null; } }