The manualView when the link is clicked it will show a error page. I have added a...
[phpeclipse.git] / net.sourceforge.phpeclipse.phpmanual / src / net / sourceforge / phpeclipse / phpmanual / views / PHPManualView.java
index 09233d3..37eadca 100644 (file)
@@ -18,6 +18,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 +26,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 +60,7 @@ import org.osgi.framework.Bundle;
  * <p>
  * @author scorphus
  */
-public class PHPManualView extends ViewPart implements ISelectionListener, ISelectionListenerWithAST {
+public class PHPManualView extends ViewPart implements INullSelectionListener, ISelectionListenerWithAST {
 
        /**
         * The ViewPart's browser
@@ -71,6 +74,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,12 +98,31 @@ 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];
+                                               showLinkReference(func);
+                                       }
+                               } else if (loc.startsWith("jar:")) {
+                                       // TODO find a better way of not showing the location error page. This is a cheap trick
+                                       // to keep the page from showing.
+                                       // ed_mann
+                                       browser.setText("<html></html>");
+                               }
+                       }
+               });
                parent.pack();
                if ((lastEditor = getJavaEditor()) != null) {
                        SelectionListenerWithASTManager.getDefault().addListener(lastEditor, this);
                }
                getSite().getWorkbenchWindow().getSelectionService()
-                               .addSelectionListener(PHPeclipsePlugin.EDITOR_ID, this);
+                               .addPostSelectionListener(PHPeclipsePlugin.EDITOR_ID, this);
        }
 
        /**
@@ -103,7 +130,7 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele
         */
        public void dispose() {
                getSite().getWorkbenchWindow().getSelectionService()
-                               .removeSelectionListener(PHPeclipsePlugin.EDITOR_ID, this);
+                               .removePostSelectionListener(PHPeclipsePlugin.EDITOR_ID, this);
        }
 
        /**
@@ -120,12 +147,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,9 +166,11 @@ 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;
+               } else {
+                       System.out.println(part);
                }
        }
 
@@ -146,7 +180,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,6 +191,24 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele
                        }
                }).start();
        }
+       
+       /**
+        * Updates the browser with the reference page for a given function
+        * 
+        * @param funcName Function name
+        */
+       private void showLinkReference(final String funcName) {
+               new Thread(new Runnable() {
+                       public void run() {
+                               Display.getDefault().asyncExec(new Runnable() {
+                                       public void run() {
+                                               String html = getLinkHtmlSource(funcName);
+                                               browser.setText(html);
+                                       }
+                               });
+                       }
+               }).start();
+       }
 
        /**
         * Filters the function's reference page extracting only parts of it
@@ -165,11 +216,120 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele
         * @param source HTML source of the reference page
         * @return HTML source of reference page
         */
+       private String filterIniHtmlSource(String source) {
+               try {
+                       Parser parser = new Parser(source);
+                       String [] tagsToBeFound = {"DIV"};
+                       ArrayList classList = new ArrayList(8);
+                       classList.add("section");
+                       classList.add("title");
+                       classList.add("refsect1 parameters");
+                       classList.add("refsect1 returnvalues");
+                       classList.add("refsect1 examples");
+                       classList.add("refsect1 seealso");
+                       classList.add("refsect1 u");
+                       TagFindingVisitor visitor = new TagFindingVisitor(tagsToBeFound);
+                       parser.visitAllNodesWith(visitor);
+                       Node [] allPTags = visitor.getTags(0);
+                       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().replaceAll("—", "-");
+                       //.replace("<h3 class=\"title\">Description</h3>", " ");
+               } catch (ParserException e) {
+                       e.printStackTrace();
+               }
+               return "";
+       }
+       
+       /**
+        * Filters the function's reference page extracting only parts of it
+        * 
+        * @param source HTML source of the reference page
+        * @return HTML source of reference page
+        */
+       private String filterLangHtmlSource(String source) {
+               try {
+                       Parser parser = new Parser(source);
+                       String [] tagsToBeFound = {"DIV"};
+                       ArrayList classList = new ArrayList(8);
+                       classList.add("sect1");
+                       classList.add("title");
+                       classList.add("refsect1 parameters");
+                       classList.add("refsect1 returnvalues");
+                       classList.add("refsect1 examples");
+                       classList.add("refsect1 seealso");
+                       classList.add("refsect1 u");
+                       TagFindingVisitor visitor = new TagFindingVisitor(tagsToBeFound);
+                       parser.visitAllNodesWith(visitor);
+                       Node [] allPTags = visitor.getTags(0);
+                       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().replaceAll("—", "-");
+                       //.replace("<h3 class=\"title\">Description</h3>", " ");
+               } catch (ParserException e) {
+                       e.printStackTrace();
+               }
+               return "";
+       }
+       
+       /**
+        * Filters the function's reference page extracting only parts of it
+        * 
+        * @param source HTML source of the reference page
+        * @return HTML source of reference page
+        */
+       private String filterRefHtmlSource(String source) {
+               try {
+                       Parser parser = new Parser(source);
+                       String [] tagsToBeFound = {"DIV"};
+                       ArrayList classList = new ArrayList(8);
+                       classList.add("partintro");
+                       classList.add("section");
+                       classList.add("title");
+                       classList.add("refsect1 parameters");
+                       classList.add("refsect1 returnvalues");
+                       classList.add("refsect1 examples");
+                       classList.add("refsect1 seealso");
+                       classList.add("refsect1 u");
+                       TagFindingVisitor visitor = new TagFindingVisitor(tagsToBeFound);
+                       parser.visitAllNodesWith(visitor);
+                       Node [] allPTags = visitor.getTags(0);
+                       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().replaceAll("—", "-");
+                       //.replace("<h3 class=\"title\">Description</h3>", " ");
+               } catch (ParserException e) {
+                       e.printStackTrace();
+               }
+               return "";
+       }
+       
+       /**
+        * Filters the function's reference page extracting only parts of it
+        * 
+        * @param source HTML source of the reference page
+        * @return HTML source of reference page
+        */
        private String filterHtmlSource(String source) {
                try {
                        Parser parser = new Parser(source);
                        String [] tagsToBeFound = {"DIV"};
-                       ArrayList<String> classList = new ArrayList<String>(6);
+                       ArrayList classList = new ArrayList(8);
                        classList.add("refnamediv");
                        classList.add("refsect1 description");
                        classList.add("refsect1 parameters");
@@ -180,21 +340,20 @@ public class PHPManualView extends ViewPart implements ISelectionListener, ISele
                        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("<h3 class=\"title\">Description</h3>", " ");
                } 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 +362,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,37 +392,117 @@ 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) {
                Bundle bundle = Platform.getBundle(PHPHelpPlugin.PLUGIN_ID);
-               URL fileURL = Platform.find(bundle, docPath);
+               URL fileURL = FileLocator.find(bundle, docPath, null);
+               ZipEntry entry;
                byte[] b = null;
                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");
+                       entry = docFile.getEntry("doc/function."+funcName.replace('_', '-')+".html");
+                       if(entry == null){
+                               entry = docFile.getEntry("doc/ini."+funcName.replace('_', '-')+".html");
+                       }
                        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 "<html></html>";
-               }
-               if (b != null) {
-                       String reference = filterHtmlSource(new String(b));
-                       String refPageTpl = getRefPageTemplate();
-                       refPageTpl = refPageTpl.replace("{title}", funcName);
-                       refPageTpl = refPageTpl.replace("{reference}", reference);
-                       return refPageTpl;
+               } catch (Exception e) {
+                       return null;
                }
                return "<html></html>";
        }
 
        /**
+        * 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 getLinkHtmlSource(String funcName) {
+               Bundle bundle = Platform.getBundle(PHPHelpPlugin.PLUGIN_ID);
+               URL fileURL = FileLocator.find(bundle, docPath, null);
+               ZipEntry entry;
+               byte[] b = null;
+               try {
+                       URL resolve = FileLocator.resolve(fileURL);
+                       ZipFile docFile = new ZipFile(resolve.getPath());
+                       entry = docFile.getEntry("doc/"+funcName);
+                       InputStream ref = docFile.getInputStream(entry);
+                       b = new byte[(int)entry.getSize()];
+                       ref.read(b, 0, (int)entry.getSize());
+                       if (b != null) {
+                               String reference = null;
+                               String aFuncName = funcName.toString();
+                               if(aFuncName.startsWith("function")){
+                                       reference = filterHtmlSource(new String(b));
+                               } else if (aFuncName.startsWith("ini")){
+                                       reference = filterIniHtmlSource(new String(b));
+                               } else if (aFuncName.startsWith("install")){
+                                       reference = filterIniHtmlSource(new String(b));
+                               } else if (aFuncName.startsWith("language")){
+                                       reference = filterLangHtmlSource(new String(b));
+                               } else if (aFuncName.startsWith("ref")){
+                                       reference = filterRefHtmlSource(new String(b));
+                               }
+                               String refPageTpl = getRefPageTemplate();
+                               refPageTpl = refPageTpl.replaceAll("%title%", funcName);
+                               refPageTpl = replace(refPageTpl, "%reference%", reference);
+                               return refPageTpl;
+                       }
+               } catch (IOException e) {
+                       return "<html></html>";
+               } catch (Exception e) {
+                       return null;
+               }
+               return "<html></html>";
+       }
+       /**
         * Returns the currently active java editor, or <code>null</code> if it
         * cannot be determined.
         *