* The view listens to selection changes both in the (1)workbench, to * know when the user changes between the instances of the PHPEditor * or when a new instance is created; and in the (2)PHPEditor, to know * when the user changes the cursor position. This explains the need * to implement both ISelectionListener and ISelectionListenerWithAST. *
* Up to now, the ViewPart show reference pages from HTML stored in the * doc.zip file from the net.sourceforge.phpeclipse.phphelp plugin. It * also depends on net.sourceforge.phpeclipse.phpmanual.htmlparser to * parse these HTML files. *
* @author scorphus
*/
public class PHPManualView extends ViewPart implements ISelectionListener, ISelectionListenerWithAST {
/**
* The ViewPart's browser
*/
private Browser browser;
/**
* A reference to store last active editor to know when we've
* got a new instance of the PHPEditor
*/
private PHPEditor lastEditor;
/**
* The path to the doc.zip file containing the PHP Manual
* in HTML format
*/
private final Path docPath = new Path("doc.zip");
/**
* The constructor.
*/
public PHPManualView() {
}
/**
* This method initializes the ViewPart. It instantiates components
* and add listeners
*
* @param parent The parent control
*/
public void createPartControl(Composite parent) {
browser = new Browser(parent, SWT.NONE);
parent.pack();
if ((lastEditor = getJavaEditor()) != null) {
SelectionListenerWithASTManager.getDefault().addListener(lastEditor, this);
}
getSite().getWorkbenchWindow().getSelectionService()
.addSelectionListener(PHPeclipsePlugin.EDITOR_ID, this);
}
/**
* Cleanup to remove the selection listener
*/
public void dispose() {
getSite().getWorkbenchWindow().getSelectionService()
.removeSelectionListener(PHPeclipsePlugin.EDITOR_ID, this);
}
/**
* Passing the focus request to the viewer's control.
*/
public void setFocus() {
browser.setFocus();
}
/**
* Treats selection changes from the PHPEditor
*/
public void selectionChanged(IEditorPart part, ITextSelection selection) {
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();
}
}
/**
* Treats selection changes from the workbench. When part is new
* instance of PHPEditor it gets a listener attached
*/
public void selectionChanged(IWorkbenchPart part, ISelection selection) {
if (!((PHPEditor)part).equals(lastEditor)) {
SelectionListenerWithASTManager.getDefault().addListener((PHPEditor)part, this);
lastEditor = (PHPEditor)part;
}
}
/**
* Updates the browser with the reference page for a given function
*
* @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() {
public void run() {
String html = getHtmlSource(funcName);
browser.setText(html);
}
});
}
}).start();
}
/**
* 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"};
ArrayListDescription
", " ");
} catch (ParserException e) {
e.printStackTrace();
}
return "";
}
/**
* Reads the template that defines the style of the reference page
* shown inside the view's browser
*
* @return HTML source of the template
*/
public String getRefPageTemplate() {
Bundle bundle = Platform.getBundle(PHPManualUIPlugin.PLUGIN_ID);
URL fileURL = Platform.find(bundle, new Path("templates"));
StringBuffer contents = new StringBuffer();
BufferedReader input = null;
try {
URL resolve = Platform.resolve(fileURL);
input = new BufferedReader(new FileReader(resolve.getPath()+"/refpage.html"));
String line = null;
while ((line = input.readLine()) != null){
contents.append(line);
}
}
catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
finally {
try {
if (input!= null) {
input.close();
}
}
catch (IOException ex) {
ex.printStackTrace();
}
}
return contents.toString();
}
/**
* 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);
byte[] b = null;
try {
URL resolve = Platform.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());
} 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 "";
}
/**
* Returns the currently active java editor, or null if it
* cannot be determined.
*
* @return the currently active java editor, or null
*/
private PHPEditor getJavaEditor() {
try {
IEditorPart part = PHPeclipsePlugin.getActivePage().getActiveEditor();
if (part instanceof PHPEditor)
return (PHPEditor) part;
else
return null;
} catch (Exception e) {
return null;
}
}
}