new phpedit.gif
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / PHPTextHover.java
1 /**********************************************************************
2 Copyright (c) 2000, 2002 IBM Corp. and others.
3 All rights reserved. This program and the accompanying materials
4 are made available under the terms of the Common Public License v1.0
5 which accompanies this distribution, and is available at
6 http://www.eclipse.org/legal/cpl-v10.html
7
8 Contributors:
9     IBM Corporation - Initial implementation
10     Klaus Hartlage - www.eclipseproject.de
11 **********************************************************************/
12 package net.sourceforge.phpeclipse.phpeditor;
13
14 import java.util.HashMap;
15
16 import net.sourceforge.phpeclipse.phpeditor.php.PHPFunctionDescription;
17 import net.sourceforge.phpeclipse.phpeditor.php.PHPFunctionNames;
18 import net.sourceforge.phpeclipse.phpeditor.php.PHPWordExtractor;
19 import org.eclipse.jface.text.BadLocationException;
20 import org.eclipse.jface.text.IRegion;
21 import org.eclipse.jface.text.ITextHover;
22 import org.eclipse.jface.text.ITextViewer;
23 import org.eclipse.jface.text.Region;
24 import org.eclipse.swt.graphics.Point;
25
26 /**
27  * Example implementation for an <code>ITextHover</code> 
28  * which hovers over PHP code.
29  */
30 public class PHPTextHover implements ITextHover {
31   public static HashMap functionDescriptions = null;
32   
33   private static PHPWordExtractor phpWordDetector = new PHPWordExtractor();
34   /* (non-Javadoc)
35    * Method declared on ITextHover
36    */
37   public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
38     if (hoverRegion != null) {
39       try {
40         if (hoverRegion.getLength() > -1) {
41           String word = textViewer.getDocument().get(hoverRegion.getOffset(), hoverRegion.getLength());
42           if (functionDescriptions==null) {
43             functionDescriptions = new HashMap(997);
44             for (int i=0; i<PHPFunctionNames.FUNCTION_NAMES.length;i++) {
45               functionDescriptions.put(PHPFunctionNames.FUNCTION_NAMES[i],PHPFunctionDescription.FUNCTION_DESCRIPTION[i]);
46             }
47           }
48           return (String) functionDescriptions.get(word);
49         }
50       } catch (BadLocationException x) {
51       }
52     }
53     return "empty selection";
54   }
55
56   /* (non-Javadoc)
57    * Method declared on ITextHover
58    */
59   public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
60     Point selection = PHPWordExtractor.findWord(textViewer.getDocument(), offset);
61 //  show the extracted word as a tooltip
62     if (selection!=null && selection.x <= offset && offset < selection.x + selection.y)
63       return new Region(selection.x, selection.y);
64     return new Region(offset, 0);
65   }
66 }