/**********************************************************************
-Copyright (c) 2000, 2002 IBM Corp. 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
+ Copyright (c) 2000, 2002 IBM Corp. 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 implementation
- Klaus Hartlage - www.eclipseproject.de
-**********************************************************************/
+ Contributors:
+ IBM Corporation - Initial implementation
+ www.phpeclipse.de
+ **********************************************************************/
package net.sourceforge.phpeclipse.phpeditor;
import java.io.FileReader;
-import java.io.IOException;
+import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
-import java.util.Vector;
+import net.sourceforge.phpdt.internal.corext.phpdoc.PHPDocUtil;
import net.sourceforge.phpeclipse.PHPeclipsePlugin;
import net.sourceforge.phpeclipse.builder.IdentifierIndexManager;
import net.sourceforge.phpeclipse.builder.PHPIdentifierLocation;
import net.sourceforge.phpeclipse.phpeditor.php.PHPElement;
+import net.sourceforge.phpeclipse.phpeditor.php.PHPFunction;
import net.sourceforge.phpeclipse.phpeditor.php.PHPWordExtractor;
import org.eclipse.core.resources.IProject;
import org.eclipse.swt.graphics.Point;
/**
- * Implementation for an <code>ITextHover</code>
- * which hovers over PHP code.
+ * Implementation for an <code>ITextHover</code> which hovers over PHP code.
*/
public class PHPTextHover implements ITextHover {
- public static HashMap functionDescriptions = null;
+ private static HashMap functionDescriptions = null;
- private static PHPWordExtractor phpWordDetector = new PHPWordExtractor();
- private IProject fProject;
+ private static HashMap identDescriptions = null;
- public PHPTextHover(IProject project) {
- fProject = project;
- }
- /* (non-Javadoc)
- * Method declared on ITextHover
- */
- public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
- if (hoverRegion != null) {
- try {
- if (hoverRegion.getLength() > -1) {
- String word = textViewer.getDocument().get(hoverRegion.getOffset(), hoverRegion.getLength());
- if (functionDescriptions == null) {
- functionDescriptions = new HashMap();
- // PHPSyntaxRdr syntaxRdr = new PHPSyntaxRdr();
- // syntaxRdr.readInSyntax();
+ /**
+ * The current project; maybe <code>null</code> for preference pages
+ */
+ private IProject fProject;
- // Vector syntaxbuffer = syntaxRdr.getsyntaxdata();
- Vector syntaxbuffer = PHPSyntaxRdr.getsyntaxdata();
- String strbuffer = null;
- PHPElement elbuffer = null;
- while ((syntaxbuffer != null)
- && (!syntaxbuffer.isEmpty() && ((elbuffer = (PHPElement) syntaxbuffer.remove(0)) != null))) {
- functionDescriptions.put(elbuffer.getName(), elbuffer.getHoverText());
- }
+ public PHPTextHover(IProject project) {
+ fProject = project;
+ }
- // functionDescriptions = new HashMap(997);
- // for (int i=0; i<PHPFunctionNames.FUNCTION_NAMES.length;i++) {
- // functionDescriptions.put(PHPFunctionNasmes.FUNCTION_NAMES[i],PHPFunctionDescription.FUNCTION_DESCRIPTION[i]);
- // }
- }
- String hoverInfo = (String) functionDescriptions.get(word);
- if (hoverInfo == null && fProject != null) {
- // get the possible PHPDoc information from the index file
- IdentifierIndexManager indexManager = PHPeclipsePlugin.getDefault().getIndexManager(fProject);
- List list = indexManager.getLocations(word);
- if (list.size() > 0) {
- try {
- PHPIdentifierLocation location;
- String filename;
- FileReader phpdocFileReader;
- StringBuffer hoverInfoBuffer = new StringBuffer();
- String workspaceLocation = PHPeclipsePlugin.getWorkspace().getRoot().getLocation().toString();
- boolean foundPHPdoc = false;
- for (int i = 0; i < list.size(); i++) {
- location = (PHPIdentifierLocation) list.get(0);
- if (location.getPHPDocOffset() >= 0) {
- foundPHPdoc = true;
- filename = workspaceLocation + location.getFilename();
- phpdocFileReader = new FileReader(filename);
- hoverInfoBuffer.append("PHPdoc found in file: ");
- hoverInfoBuffer.append(filename);
- hoverInfoBuffer.append('\n');
- char[] charArray = new char[location.getPHPDocLength()];
- phpdocFileReader.skip(location.getPHPDocOffset());
- phpdocFileReader.read(charArray, 0, location.getPHPDocLength());
- hoverInfoBuffer.append(charArray);
- hoverInfoBuffer.append('\n');
- }
- }
- if (foundPHPdoc) {
- hoverInfo = hoverInfoBuffer.toString();
- }
- } catch (Throwable e) {
- // ignore exceptions
- // e.printStackTrace();
- }
- }
- }
- return hoverInfo;
- }
- // } catch (BadLocationException x) {
- } catch (Exception x) {
- }
- }
- return "empty selection";
- }
+ /*
+ * (non-Javadoc) Method declared on ITextHover
+ */
+ public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
+ if (hoverRegion != null) {
+ try {
+ if (hoverRegion.getLength() > -1) {
+ String word = textViewer.getDocument().get(hoverRegion.getOffset(), hoverRegion.getLength());
+ if (functionDescriptions == null) {
+ functionDescriptions = new HashMap();
+ identDescriptions = new HashMap();
+ ArrayList syntaxbuffer = PHPSyntaxRdr.getSyntaxData();
+ String strbuffer = null;
+ PHPElement elbuffer = null;
+ if (syntaxbuffer != null) {
+ for (int i = 0; i < syntaxbuffer.size(); i++) {
+ elbuffer = (PHPElement) syntaxbuffer.get(i);
+ if (elbuffer instanceof PHPFunction) {
+ functionDescriptions.put(elbuffer.getName(), elbuffer.getHoverText());
+ } else {
+ identDescriptions.put(elbuffer.getName(), elbuffer.getHoverText());
+ }
+ }
+ }
+ //
+ // while ((syntaxbuffer != null)
+ // && (!syntaxbuffer.isEmpty() && ((elbuffer = (PHPElement)
+ // syntaxbuffer.remove(0)) != null))) {
+ // functionDescriptions.put(elbuffer.getName(),
+ // elbuffer.getHoverText());
+ // }
+ }
+ String hoverInfo = (String) identDescriptions.get(word);
+ if (hoverInfo == null & word.length() > 0) {
+ hoverInfo = (String) functionDescriptions.get(word.toLowerCase());
+ }
+ if (hoverInfo == null && fProject != null) {
+ // get the possible PHPDoc information from the index file
+ IdentifierIndexManager indexManager = PHPeclipsePlugin.getDefault().getIndexManager(fProject);
+ List list = indexManager.getLocations(word);
+ if (list.size() > 0) {
+ try {
+ PHPIdentifierLocation location;
+ String filename;
+ FileReader phpdocFileReader;
+ StringBuffer hoverInfoBuffer = new StringBuffer();
+ String workspaceLocation;
+ if (fProject != null) {
+ workspaceLocation = fProject.getLocation().toString() + '/';
+ } else {
+ // should never happen?
+ workspaceLocation = PHPeclipsePlugin.getWorkspace().getRoot().getLocation().toString();
+ }
+ // boolean foundPHPdoc = false;
+ for (int i = 0; i < list.size(); i++) {
+ location = (PHPIdentifierLocation) list.get(i);
+ filename = workspaceLocation + location.getFilename();
+ PHPDocUtil.appendPHPDoc(hoverInfoBuffer, filename, location);
+ }
+ hoverInfo = hoverInfoBuffer.toString();
+ } catch (Throwable e) {
+ // ignore exceptions
+ // e.printStackTrace();
+ }
+ }
+ }
+ return hoverInfo;
+ }
+ // } catch (BadLocationException x) {
+ } catch (Exception x) {
+ }
+ }
+ return null;
+ // don't show this annoying text
+ // return "empty selection";
+ }
- /* (non-Javadoc)
- * Method declared on ITextHover
- */
- public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
- Point selection = PHPWordExtractor.findWord(textViewer.getDocument(), offset);
- // show the extracted word as a tooltip
- if (selection != null && selection.x <= offset && offset < selection.x + selection.y)
- return new Region(selection.x, selection.y);
- return new Region(offset, 0);
- }
+ /*
+ * (non-Javadoc) Method declared on ITextHover
+ */
+ public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
+ Point selection = PHPWordExtractor.findWord(textViewer.getDocument(), offset);
+ // show the extracted word as a tooltip
+ if (selection != null && selection.x <= offset && offset < selection.x + selection.y)
+ return new Region(selection.x, selection.y);
+ return new Region(offset, 0);
+ }
}
git://git.phpeclipse.com / phpeclipse.git / blobdiff