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 import java.util.Vector;
  16
  17 import net.sourceforge.phpeclipse.phpeditor.php.PHPWordExtractor;
  18
  19 import org.eclipse.jface.text.IRegion;
  20 import org.eclipse.jface.text.ITextHover;
  21 import org.eclipse.jface.text.ITextViewer;
  22 import org.eclipse.jface.text.Region;
  23 import org.eclipse.swt.graphics.Point;
  24
  25 import net.sourceforge.phpeclipse.phpeditor.php.PHPElement;
  26
  27 /**
  28  * Example implementation for an <code>ITextHover</code>
  29  * which hovers over PHP code.
  30  */
  31 public class PHPTextHover implements ITextHover {
  32   public static HashMap functionDescriptions = null;
  33
  34   private static PHPWordExtractor phpWordDetector = new PHPWordExtractor();
  35   /* (non-Javadoc)
  36    * Method declared on ITextHover
  37    */
  38   public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
  39     if (hoverRegion != null) {
  40       try {
  41         if (hoverRegion.getLength() > -1) {
  42           String word = textViewer.getDocument().get(hoverRegion.getOffset(), hoverRegion.getLength());
  43           if (functionDescriptions == null) {
  44             functionDescriptions = new HashMap();
  45             //                  PHPSyntaxRdr syntaxRdr = new PHPSyntaxRdr();
  46             //                  syntaxRdr.readInSyntax();
  47
  48             //                  Vector syntaxbuffer = syntaxRdr.getsyntaxdata();
  49             Vector syntaxbuffer = PHPSyntaxRdr.getsyntaxdata();
  50             String strbuffer = null;
  51             PHPElement elbuffer = null;
  52             while ((syntaxbuffer != null)
  53               && (!syntaxbuffer.isEmpty() && ((elbuffer = (PHPElement) syntaxbuffer.remove(0)) != null))) {
  54               functionDescriptions.put(elbuffer.getName(), elbuffer.getDescription());
  55             }
  56
  57             //            functionDescriptions = new HashMap(997);
  58             //            for (int i=0; i<PHPFunctionNames.FUNCTION_NAMES.length;i++) {
  59             //              functionDescriptions.put(PHPFunctionNames.FUNCTION_NAMES[i],PHPFunctionDescription.FUNCTION_DESCRIPTION[i]);
  60             //            }
  61           }
  62           return (String) functionDescriptions.get(word);
  63         }
  64         //      } catch (BadLocationException x) {
  65       } catch (Exception x) {
  66       }
  67     }
  68     return "empty selection";
  69   }
  70
  71   /* (non-Javadoc)
  72    * Method declared on ITextHover
  73    */
  74   public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
  75     Point selection = PHPWordExtractor.findWord(textViewer.getDocument(), offset);
  76     //  show the extracted word as a tooltip
  77     if (selection != null && selection.x <= offset && offset < selection.x + selection.y)
  78       return new Region(selection.x, selection.y);
  79     return new Region(offset, 0);
  80   }
  81 }