X-Git-Url: http://secure.phpeclipse.com diff --git a/net.sourceforge.phpeclipse.phpmanual/src/net/sourceforge/phpeclipse/phpmanual/views/PHPManualView.java b/net.sourceforge.phpeclipse.phpmanual/src/net/sourceforge/phpeclipse/phpmanual/views/PHPManualView.java index 09233d3..c9b5948 100644 --- a/net.sourceforge.phpeclipse.phpmanual/src/net/sourceforge/phpeclipse/phpmanual/views/PHPManualView.java +++ b/net.sourceforge.phpeclipse.phpmanual/src/net/sourceforge/phpeclipse/phpmanual/views/PHPManualView.java @@ -6,10 +6,13 @@ import java.io.FileReader; import java.io.IOException; import java.io.InputStream; import java.net.URL; +import java.util.Arrays; import java.util.ArrayList; import java.util.zip.ZipEntry; import java.util.zip.ZipFile; +import net.sourceforge.phpeclipse.phpmanual.PHPManualUiMessages; +//import net.sourceforge.phpdt.internal.debug.ui.PHPDebugUiMessages; import net.sourceforge.phpdt.internal.ui.text.JavaWordFinder; import net.sourceforge.phpdt.internal.ui.viewsupport.ISelectionListenerWithAST; import net.sourceforge.phpdt.internal.ui.viewsupport.SelectionListenerWithASTManager; @@ -18,6 +21,7 @@ import net.sourceforge.phpeclipse.PHPeclipsePlugin; import net.sourceforge.phpeclipse.phpeditor.PHPEditor; import net.sourceforge.phpeclipse.phpmanual.PHPManualUIPlugin; +import org.eclipse.core.runtime.FileLocator; import org.eclipse.core.runtime.Path; import org.eclipse.core.runtime.Platform; import org.eclipse.jface.text.IDocument; @@ -25,11 +29,13 @@ import org.eclipse.jface.text.IRegion; import org.eclipse.jface.text.ITextSelection; import org.eclipse.jface.viewers.ISelection; import org.eclipse.swt.SWT; +import org.eclipse.swt.browser.Browser; +import org.eclipse.swt.browser.LocationAdapter; +import org.eclipse.swt.browser.LocationEvent; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Display; -import org.eclipse.swt.browser.Browser; import org.eclipse.ui.IEditorPart; -import org.eclipse.ui.ISelectionListener; +import org.eclipse.ui.INullSelectionListener; import org.eclipse.ui.IWorkbenchPart; import org.eclipse.ui.part.ViewPart; import org.htmlparser.Node; @@ -57,7 +63,7 @@ import org.osgi.framework.Bundle; *

* @author scorphus */ -public class PHPManualView extends ViewPart implements ISelectionListener, ISelectionListenerWithAST { +public class PHPManualView extends ViewPart implements INullSelectionListener, ISelectionListenerWithAST { /** * The ViewPart's browser @@ -71,6 +77,11 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele private PHPEditor lastEditor; /** + * String that stores the last selected word + */ + private String lastOccurrence = null; + + /** * The path to the doc.zip file containing the PHP Manual * in HTML format */ @@ -90,20 +101,34 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele */ public void createPartControl(Composite parent) { browser = new Browser(parent, SWT.NONE); + browser.addLocationListener(new LocationAdapter() { + public void changing(LocationEvent event) { + String loc = event.location.toString(); + if(!loc.equalsIgnoreCase("about:blank") && !loc.startsWith("jar:")) { + String func = loc.replaceAll("file:///", ""); + func = func.replaceAll("#.+$", ""); + String[] afunc = loc.split("\\."); + if(!afunc[1].equalsIgnoreCase(lastOccurrence)) { + lastOccurrence = afunc[1]; + showReference(func); + event.doit = false; + } + } + } + }); parent.pack(); if ((lastEditor = getJavaEditor()) != null) { SelectionListenerWithASTManager.getDefault().addListener(lastEditor, this); } getSite().getWorkbenchWindow().getSelectionService() - .addSelectionListener(PHPeclipsePlugin.EDITOR_ID, this); + .addPostSelectionListener(PHPeclipsePlugin.EDITOR_ID, this); } - /** * Cleanup to remove the selection listener */ public void dispose() { getSite().getWorkbenchWindow().getSelectionService() - .removeSelectionListener(PHPeclipsePlugin.EDITOR_ID, this); + .removePostSelectionListener(PHPeclipsePlugin.EDITOR_ID, this); } /** @@ -120,12 +145,17 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele IDocument document = ((PHPEditor)part).getViewer().getDocument(); int offset = selection.getOffset(); IRegion iRegion = JavaWordFinder.findWord(document, offset); - try { - final String wordStr = document.get(iRegion.getOffset(), - iRegion.getLength()); - showReference(wordStr); - } catch (Exception e) { - e.printStackTrace(); + if (document != null && iRegion != null) { + try { + final String wordStr = document.get(iRegion.getOffset(), + iRegion.getLength()); + if (!wordStr.equalsIgnoreCase(lastOccurrence)) { + showReference(wordStr); + lastOccurrence = wordStr; + } + } catch (Exception e) { + e.printStackTrace(); + } } } @@ -134,7 +164,7 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele * instance of PHPEditor it gets a listener attached */ public void selectionChanged(IWorkbenchPart part, ISelection selection) { - if (!((PHPEditor)part).equals(lastEditor)) { + if (part != null && !((PHPEditor)part).equals(lastEditor)) { SelectionListenerWithASTManager.getDefault().addListener((PHPEditor)part, this); lastEditor = (PHPEditor)part; } @@ -146,7 +176,6 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele * @param funcName Function name */ private void showReference(final String funcName) { - System.out.println("Show reference for " + funcName); new Thread(new Runnable() { public void run() { Display.getDefault().asyncExec(new Runnable() { @@ -158,7 +187,7 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele } }).start(); } - + /** * Filters the function's reference page extracting only parts of it * @@ -168,33 +197,31 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele private String filterHtmlSource(String source) { try { Parser parser = new Parser(source); - String [] tagsToBeFound = {"DIV"}; - ArrayList classList = new ArrayList(6); - classList.add("refnamediv"); - classList.add("refsect1 description"); - classList.add("refsect1 parameters"); - classList.add("refsect1 returnvalues"); - classList.add("refsect1 examples"); - classList.add("refsect1 seealso"); - classList.add("refsect1 u"); + String[] tagsToBeFound = { "DIV" }; + // Common classes to be included for all page types + ArrayList classList = new ArrayList(Arrays.asList(new String[] { + "section", "sect1", "title", "partintro", "refnamediv", + "refsect1 description", "refsect1 parameters", + "refsect1 returnvalues", "refsect1 examples", + "refsect1 seealso", "refsect1 u", "example-contents" })); + // Grab all the tags for processing TagFindingVisitor visitor = new TagFindingVisitor(tagsToBeFound); parser.visitAllNodesWith(visitor); Node [] allPTags = visitor.getTags(0); - StringBuilder output = new StringBuilder(); + StringBuffer output = new StringBuffer(); for (int i = 0; i < allPTags.length; i++) { String tagClass = ((Div)allPTags[i]).getAttribute("class"); if (classList.contains(tagClass)) { output.append(allPTags[i].toHtml()); } } - return output.toString().replace("—", "-"); + return output.toString().replaceAll("—", "-"); //.replace("

Description

", " "); } catch (ParserException e) { e.printStackTrace(); } return ""; } - /** * Reads the template that defines the style of the reference page * shown inside the view's browser @@ -203,11 +230,11 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele */ public String getRefPageTemplate() { Bundle bundle = Platform.getBundle(PHPManualUIPlugin.PLUGIN_ID); - URL fileURL = Platform.find(bundle, new Path("templates")); + URL fileURL = FileLocator.find(bundle, new Path("templates"), null); StringBuffer contents = new StringBuffer(); BufferedReader input = null; try { - URL resolve = Platform.resolve(fileURL); + URL resolve = FileLocator.resolve(fileURL); input = new BufferedReader(new FileReader(resolve.getPath()+"/refpage.html")); String line = null; while ((line = input.readLine()) != null){ @@ -233,34 +260,83 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele } /** - * Looks for the function's reference page inside the doc.zip file - * and returns a filtered HTML source of it embedded in the template - * - * @param funcName Function name + * Replaces each substring of source string that matches the + * given pattern string with the given replace string + * + * @param source The source string + * @param pattern The pattern string + * @param replace The replace string + * @return The resulting String + */ + public static String replace(String source, String pattern, String replace) { + if (source != null) { + final int len = pattern.length(); + StringBuffer sb = new StringBuffer(); + int found = -1; + int start = 0; + while ((found = source.indexOf(pattern, start)) != -1) { + sb.append(source.substring(start, found)); + sb.append(replace); + start = found + len; + } + sb.append(source.substring(start)); + return sb.toString(); + } else { + return ""; + } + } + + /** + * Looks for the function's reference page inside the doc.zip file and + * returns a filtered HTML source of it embedded in the template + * + * @param funcName + * Function name * @return HTML source of reference page */ public String getHtmlSource(String funcName) { + if (funcName.length() == 0) { + // Don't bother ;-) + return null; + } Bundle bundle = Platform.getBundle(PHPHelpPlugin.PLUGIN_ID); - URL fileURL = Platform.find(bundle, docPath); + URL fileURL = FileLocator.find(bundle, docPath, null); + ZipEntry entry = null; + // List of prefixes to lookup HTML files by, ordered so that looping + // is as minimal as possible. The empty value matches links passed, + // rather than function + String[] prefixes = { "", "function", "control-structures", "ref", "http", "imagick", "ming" }; byte[] b = null; + if (funcName.matches("^[a-z-]+\\.[a-z-0-9]+\\.html$")) { + // funcName is actually a page reference, strip the prefix and suffix + funcName = funcName.substring(0, funcName.lastIndexOf('.')); + } try { - URL resolve = Platform.resolve(fileURL); + URL resolve = FileLocator.resolve(fileURL); ZipFile docFile = new ZipFile(resolve.getPath()); - ZipEntry entry = docFile.getEntry("doc/function."+funcName.replace('_', '-')+".html"); - InputStream ref = docFile.getInputStream(entry); - b = new byte[(int)entry.getSize()]; - ref.read(b, 0, (int)entry.getSize()); + for (int i = 0; i < prefixes.length; i++) { + if ((entry = docFile.getEntry("doc/" + prefixes[i] + + (prefixes[i].length() == 0 ? "" : ".") + + funcName.replace('_', '-') + ".html")) != null) { + // Document was matched + InputStream ref = docFile.getInputStream(entry); + b = new byte[(int)entry.getSize()]; + ref.read(b, 0, (int)entry.getSize()); + if (b != null) { + String reference = filterHtmlSource(new String(b)); + String refPageTpl = getRefPageTemplate(); + refPageTpl = refPageTpl.replaceAll("%title%", funcName); + refPageTpl = replace(refPageTpl, "%reference%", reference); + return refPageTpl; + } + } + } } catch (IOException e) { - return ""; - } - if (b != null) { - String reference = filterHtmlSource(new String(b)); - String refPageTpl = getRefPageTemplate(); - refPageTpl = refPageTpl.replace("{title}", funcName); - refPageTpl = refPageTpl.replace("{reference}", reference); - return refPageTpl; + return "" + PHPManualUIPlugin.getString("LookupException") + ""; + } catch (Exception e) { + return null; } - return ""; + return null; // Keeps the last reference } /**