IBM Corporation - Initial implementation
Klaus Hartlage - www.eclipseproject.de
**********************************************************************/
+import net.sourceforge.phpdt.internal.ui.actions.CompositeActionGroup;
+import net.sourceforge.phpdt.internal.ui.text.PHPPairMatcher;
+import net.sourceforge.phpdt.ui.actions.GenerateActionGroup;
+import net.sourceforge.phpdt.ui.actions.GotoMatchingBracketAction;
+import net.sourceforge.phpeclipse.IPreferenceConstants;
import net.sourceforge.phpeclipse.PHPeclipsePlugin;
import net.sourceforge.phpeclipse.phpeditor.php.PHPCodeScanner;
-import net.sourceforge.phpeclipse.phpeditor.php.PHPWordExtractor;
+import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
+
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.help.IHelp;
-import org.eclipse.help.IHelpResource;
+import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.jface.preference.PreferenceConverter;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
-import org.eclipse.jface.text.ITextSelection;
+import org.eclipse.jface.text.IRegion;
+import org.eclipse.jface.text.ITextOperationTarget;
+import org.eclipse.jface.text.ITextViewer;
+import org.eclipse.jface.text.ITextViewerExtension3;
+import org.eclipse.jface.text.Region;
+import org.eclipse.jface.text.source.AnnotationRulerColumn;
+import org.eclipse.jface.text.source.CompositeRuler;
import org.eclipse.jface.text.source.ISourceViewer;
+import org.eclipse.jface.text.source.IVerticalRuler;
+import org.eclipse.jface.text.source.IVerticalRulerColumn;
+import org.eclipse.jface.text.source.LineNumberRulerColumn;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
+import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.graphics.Point;
+import org.eclipse.swt.graphics.RGB;
import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.actions.ActionContext;
+import org.eclipse.ui.actions.ActionGroup;
import org.eclipse.ui.editors.text.TextEditor;
-import org.eclipse.ui.help.WorkbenchHelp;
+import org.eclipse.ui.texteditor.ContentAssistAction;
import org.eclipse.ui.texteditor.DefaultRangeIndicator;
+import org.eclipse.ui.texteditor.IEditorStatusLine;
+import org.eclipse.ui.texteditor.ITextEditorActionConstants;
import org.eclipse.ui.texteditor.TextOperationAction;
import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
/**
- * Java specific text editor.
+ * PHP specific text editor.
*/
public class PHPEditor extends TextEditor {
+// extends StatusTextEditor implements IViewPartInputProvider { // extends TextEditor {
+ // protected PHPActionGroup fActionGroups;
/** The outline page */
private PHPContentOutlinePage fOutlinePage;
+ private IPreferenceStore phpPrefStore;
+
+ /** The editor's bracket matcher */
+ private PHPPairMatcher fBracketMatcher;
+ /** The line number ruler column */
+ private LineNumberRulerColumn fLineNumberRulerColumn;
+ protected CompositeActionGroup fActionGroups;
+ /** The standard action groups added to the menu */
+ private GenerateActionGroup fGenerateActionGroup;
+ private CompositeActionGroup fContextMenuGroup;
/**
* Default constructor.
*/
public PHPEditor() {
super();
+ setEditorContextMenuId("#PHPEditorContext"); //$NON-NLS-1$
+ setRulerContextMenuId("#PHPRulerContext"); //$NON-NLS-1$
+ }
+ //
+ // /**
+ // * @see IMember#getCompilationUnit()
+ // */
+ // public ICompilationUnit getCompilationUnit() {
+ // return this;
+ // }
+ // /**
+ // * @see org.phpeclipse.phpdt.internal.compiler.env.ICompilationUnit#getContents()
+ // */
+ // public char[] getContents() {
+ // IDocument doc = this.getDocumentProvider().getDocument(this.getEditorInput());
+ //
+ // return doc.get().toCharArray();
+ // }
+
+ /**
+ * Returns this document's complete text.
+ *
+ * @return the document's complete text
+ */
+ public String get() {
+ IDocument doc =
+ this.getDocumentProvider().getDocument(this.getEditorInput());
+ return doc.get();
}
- /** The <code>JavaEditor</code> implementation of this
+ /**
+ * Returns the standard action group of this editor.
+ */
+ protected ActionGroup getActionGroup() {
+ return fActionGroups;
+ }
+
+ public PHPContentOutlinePage getfOutlinePage() {
+ return fOutlinePage;
+ }
+
+ /** The <code>PHPEditor</code> implementation of this
* <code>AbstractTextEditor</code> method extend the
* actions to add those specific to the receiver
*/
protected void createActions() {
super.createActions();
- setAction(
- "ContentAssistProposal",
- new TextOperationAction(
- PHPEditorMessages.getResourceBundle(),
- "ContentAssistProposal.",
- this,
- ISourceViewer.CONTENTASSIST_PROPOSALS));
+
+ Action action;
+ // setAction(
+ // "ContentAssistProposal",
+ // new TextOperationAction(
+ // PHPEditorMessages.getResourceBundle(),
+ // "ContentAssistProposal.",
+ // this,
+ // ISourceViewer.CONTENTASSIST_PROPOSALS));
+ action = new ContentAssistAction(PHPEditorMessages.getResourceBundle(), "ContentAssistProposal.", this); //$NON-NLS-1$
+ action.setActionDefinitionId(
+ PHPEditorActionDefinitionIds.CONTENT_ASSIST_PROPOSALS);
+ setAction("ContentAssistProposal", action); //$NON-NLS-1$
+
setAction(
"ContentAssistTip",
new TextOperationAction(
"ContentAssistTip.",
this,
ISourceViewer.CONTENTASSIST_CONTEXT_INFORMATION));
+
+ action =
+ new TextOperationAction(
+ PHPEditorMessages.getResourceBundle(),
+ "Comment.",
+ this,
+ ITextOperationTarget.PREFIX);
+ action.setActionDefinitionId(PHPEditorActionDefinitionIds.COMMENT);
+ setAction("Comment", action);
+
+ action =
+ new TextOperationAction(
+ PHPEditorMessages.getResourceBundle(),
+ "Uncomment.",
+ this,
+ ITextOperationTarget.STRIP_PREFIX);
+ action.setActionDefinitionId(PHPEditorActionDefinitionIds.UNCOMMENT);
+ setAction("Uncomment", action);
+
+ action = new TextOperationAction(PHPEditorMessages.getResourceBundle(), "Format.", this, ISourceViewer.FORMAT); //$NON-NLS-1$
+ action.setActionDefinitionId(PHPEditorActionDefinitionIds.FORMAT);
+ setAction("Format", action); //$NON-NLS-1$
+
+ markAsStateDependentAction("ContentAssistProposal", true); //$NON-NLS-1$
+ markAsStateDependentAction("Comment", true); //$NON-NLS-1$
+ markAsStateDependentAction("Uncomment", true); //$NON-NLS-1$
+ markAsStateDependentAction("Format", true); //$NON-NLS-1$
+
+ action = new GotoMatchingBracketAction(this);
+ action.setActionDefinitionId(
+ PHPEditorActionDefinitionIds.GOTO_MATCHING_BRACKET);
+ setAction(GotoMatchingBracketAction.GOTO_MATCHING_BRACKET, action);
+
+ fGenerateActionGroup =
+ new GenerateActionGroup(this, ITextEditorActionConstants.GROUP_EDIT);
+
+ fActionGroups =
+ new CompositeActionGroup(new ActionGroup[] { fGenerateActionGroup });
+
+ // We have to keep the context menu group separate to have better control over positioning
+ fContextMenuGroup =
+ new CompositeActionGroup(new ActionGroup[] { fGenerateActionGroup });
+ // rg,
+ // new LocalHistoryActionGroup(this, ITextEditorActionConstants.GROUP_EDIT)});
}
- /** The <code>JavaEditor</code> implementation of this
+ /** The <code>PHPEditor</code> implementation of this
* <code>AbstractTextEditor</code> method performs any extra
- * disposal actions required by the java editor.
+ * disposal actions required by the php editor.
*/
public void dispose() {
PHPEditorEnvironment.disconnect(this);
if (fOutlinePage != null)
fOutlinePage.setInput(null);
+
+ if (fActionGroups != null)
+ fActionGroups.dispose();
+
super.dispose();
}
public void doSave(IProgressMonitor monitor) {
super.doSave(monitor);
// compile or not, according to the user preferences
- IPreferenceStore store = PHPeclipsePlugin.getDefault().getPreferenceStore();
+ IPreferenceStore store = phpPrefStore;
if (store.getBoolean(PHPeclipsePlugin.PHP_PARSE_ON_SAVE)) {
IAction a = PHPParserAction.getInstance();
if (a != null)
fOutlinePage.setInput(input);
}
- /** The <code>JavaEditor</code> implementation of this
+ /*
+ * @see org.phpeclipse.phpdt.internal.ui.viewsupport.IViewPartInputProvider#getViewPartInput()
+ */
+// public Object getViewPartInput() {
+// return getEditorInput().getAdapter(IFile.class);
+// }
+
+ /** The <code>PHPEditor</code> implementation of this
* <code>AbstractTextEditor</code> method adds any
- * JavaEditor specific entries.
+ * PHPEditor specific entries.
*/
public void editorContextMenuAboutToShow(MenuManager menu) {
super.editorContextMenuAboutToShow(menu);
- addAction(menu, "ContentAssistProposal"); //$NON-NLS-1$
- addAction(menu, "ContentAssistTip"); //$NON-NLS-1$
+
+ addAction(menu, ITextEditorActionConstants.GROUP_EDIT, "Format"); //$NON-NLS-1$
+
+ ActionContext context =
+ new ActionContext(getSelectionProvider().getSelection());
+ fContextMenuGroup.setContext(context);
+ fContextMenuGroup.fillContextMenu(menu);
+ fContextMenuGroup.setContext(null);
+ }
+
+ protected void updateStateDependentActions() {
+ super.updateStateDependentActions();
+ fGenerateActionGroup.editorStateChanged();
}
- /** The <code>JavaEditor</code> implementation of this
+ /** The <code>PHPEditor</code> implementation of this
* <code>AbstractTextEditor</code> method performs gets
* the java content outline page if request is for a an
* outline page.
return super.getAdapter(required);
}
- public void openContextHelp() {
- IDocument doc = this.getDocumentProvider().getDocument(this.getEditorInput());
- ITextSelection selection = (ITextSelection) this.getSelectionProvider().getSelection();
- int pos = selection.getOffset();
- String word = getFunctionName(doc, pos);
- openContextHelp(word);
- }
+ // public void openContextHelp() {
+ // IDocument doc = this.getDocumentProvider().getDocument(this.getEditorInput());
+ // ITextSelection selection = (ITextSelection) this.getSelectionProvider().getSelection();
+ // int pos = selection.getOffset();
+ // String word = getFunctionName(doc, pos);
+ // openContextHelp(word);
+ // }
+ //
+ // private void openContextHelp(String word) {
+ // open(word);
+ // }
+ //
+ // public static void open(String word) {
+ // IHelp help = WorkbenchHelp.getHelpSupport();
+ // if (help != null) {
+ // IHelpResource helpResource = new PHPFunctionHelpResource(word);
+ // WorkbenchHelp.getHelpSupport().displayHelpResource(helpResource);
+ // } else {
+ // // showMessage(shell, dialogTitle, ActionMessages.getString("Open help not available"), false); //$NON-NLS-1$
+ // }
+ // }
- private void openContextHelp(String word) {
- open(word);
- }
+ // private String getFunctionName(IDocument doc, int pos) {
+ // Point word = PHPWordExtractor.findWord(doc, pos);
+ // if (word != null) {
+ // try {
+ // return doc.get(word.x, word.y).replace('_', '-');
+ // } catch (BadLocationException e) {
+ // }
+ // }
+ // return "";
+ // }
- public static void open(String word) {
- IHelp help = WorkbenchHelp.getHelpSupport();
- if (help != null) {
- IHelpResource helpResource = new PHPFunctionHelpResource(word);
- WorkbenchHelp.getHelpSupport().displayHelpResource(helpResource);
- } else {
- // showMessage(shell, dialogTitle, ActionMessages.getString("Open help not available"), false); //$NON-NLS-1$
+ /*
+ * @see AbstractTextEditor#handlePreferenceStoreChanged(PropertyChangeEvent)
+ */
+ protected void handlePreferenceStoreChanged(PropertyChangeEvent event) {
+
+ try {
+
+ ISourceViewer sourceViewer = getSourceViewer();
+ if (sourceViewer == null)
+ return;
+
+ String property = event.getProperty();
+
+ // if (JavaSourceViewerConfiguration.PREFERENCE_TAB_WIDTH.equals(property)) {
+ // Object value= event.getNewValue();
+ // if (value instanceof Integer) {
+ // sourceViewer.getTextWidget().setTabs(((Integer) value).intValue());
+ // } else if (value instanceof String) {
+ // sourceViewer.getTextWidget().setTabs(Integer.parseInt((String) value));
+ // }
+ // return;
+ // }
+
+ if (IPreferenceConstants.LINE_NUMBER_RULER.equals(property)) {
+ if (isLineNumberRulerVisible())
+ showLineNumberRuler();
+ else
+ hideLineNumberRuler();
+ return;
+ }
+
+ if (fLineNumberRulerColumn != null
+ && (IPreferenceConstants.LINE_NUMBER_COLOR.equals(property)
+ || PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT.equals(property)
+ || PREFERENCE_COLOR_BACKGROUND.equals(property))) {
+
+ initializeLineNumberRulerColumn(fLineNumberRulerColumn);
+ }
+
+ } finally {
+ super.handlePreferenceStoreChanged(event);
+ }
+ }
+ /**
+ * Shows the line number ruler column.
+ */
+ private void showLineNumberRuler() {
+ IVerticalRuler v = getVerticalRuler();
+ if (v instanceof CompositeRuler) {
+ CompositeRuler c = (CompositeRuler) v;
+ c.addDecorator(1, createLineNumberRulerColumn());
}
}
- private String getFunctionName(IDocument doc, int pos) {
- Point word = PHPWordExtractor.findWord(doc, pos);
- if (word != null) {
+ /**
+ * Return whether the line number ruler column should be
+ * visible according to the preference store settings.
+ * @return <code>true</code> if the line numbers should be visible
+ */
+ private boolean isLineNumberRulerVisible() {
+ // IPreferenceStore store= getPreferenceStore();
+ return phpPrefStore.getBoolean(IPreferenceConstants.LINE_NUMBER_RULER);
+ }
+ /**
+ * Hides the line number ruler column.
+ */
+ private void hideLineNumberRuler() {
+ IVerticalRuler v = getVerticalRuler();
+ if (v instanceof CompositeRuler) {
+ CompositeRuler c = (CompositeRuler) v;
try {
- return doc.get(word.x, word.y).replace('_', '-');
- } catch (BadLocationException e) {
+ c.removeDecorator(1);
+ } catch (Throwable e) {
+ }
+ }
+ }
+
+ /**
+ * Initializes the given line number ruler column from the preference store.
+ * @param rulerColumn the ruler column to be initialized
+ */
+ protected void initializeLineNumberRulerColumn(LineNumberRulerColumn rulerColumn) {
+ // JavaTextTools textTools= JavaPlugin.getDefault().getJavaTextTools();
+ PHPColorProvider manager = PHPEditorEnvironment.getPHPColorProvider();
+
+ if (phpPrefStore != null) {
+
+ RGB rgb = null;
+ // foreground color
+ if (phpPrefStore.contains(IPreferenceConstants.LINE_NUMBER_COLOR)) {
+ if (phpPrefStore.isDefault(IPreferenceConstants.LINE_NUMBER_COLOR))
+ rgb =
+ PreferenceConverter.getDefaultColor(
+ phpPrefStore,
+ IPreferenceConstants.LINE_NUMBER_COLOR);
+ else
+ rgb =
+ PreferenceConverter.getColor(
+ phpPrefStore,
+ IPreferenceConstants.LINE_NUMBER_COLOR);
+ }
+ rulerColumn.setForeground(manager.getColor(rgb));
+
+ rgb = null;
+ // background color
+ if (!phpPrefStore
+ .getBoolean(
+ IPreferenceConstants.PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT)) {
+ if (phpPrefStore
+ .contains(IPreferenceConstants.PREFERENCE_COLOR_BACKGROUND)) {
+ if (phpPrefStore
+ .isDefault(IPreferenceConstants.PREFERENCE_COLOR_BACKGROUND))
+ rgb =
+ PreferenceConverter.getDefaultColor(
+ phpPrefStore,
+ IPreferenceConstants.PREFERENCE_COLOR_BACKGROUND);
+ else
+ rgb =
+ PreferenceConverter.getColor(
+ phpPrefStore,
+ IPreferenceConstants.PREFERENCE_COLOR_BACKGROUND);
+ }
+ rulerColumn.setBackground(manager.getColor(rgb));
}
+
}
- return "";
+ }
+
+ /**
+ * Creates a new line number ruler column that is appropriately initialized.
+ */
+ protected IVerticalRulerColumn createLineNumberRulerColumn() {
+ fLineNumberRulerColumn = new LineNumberRulerColumn();
+ initializeLineNumberRulerColumn(fLineNumberRulerColumn);
+ return fLineNumberRulerColumn;
+ }
+
+ /*
+ * @see AbstractTextEditor#createVerticalRuler()
+ */
+ protected IVerticalRuler createVerticalRuler() {
+ CompositeRuler ruler = new CompositeRuler();
+ ruler.addDecorator(0, new AnnotationRulerColumn(VERTICAL_RULER_WIDTH));
+ if (isLineNumberRulerVisible())
+ ruler.addDecorator(1, createLineNumberRulerColumn());
+ return ruler;
}
/* (non-Javadoc)
- * Method declared on AbstractTextEditor
+ * Method declared on TextEditor
*/
protected void initializeEditor() {
-
PHPEditorEnvironment.connect(this);
- setSourceViewerConfiguration(new PHPSourceViewerConfiguration());
+ setSourceViewerConfiguration(new PHPSourceViewerConfiguration(this));
setRangeIndicator(new DefaultRangeIndicator());
setEditorContextMenuId("#PHPEditorContext"); //$NON-NLS-1$
setRulerContextMenuId("#PHPRulerContext"); //$NON-NLS-1$
// setDocumentProvider(PHPeclipsePlugin.getCompilationUnitDocumentProvider());
+ phpPrefStore = PHPeclipsePlugin.getDefault().getPreferenceStore();
- PHPeclipsePlugin.getDefault().getPreferenceStore().addPropertyChangeListener(new IPropertyChangeListener() {
+ phpPrefStore.addPropertyChangeListener(new IPropertyChangeListener() {
public void propertyChange(PropertyChangeEvent event) {
PHPCodeScanner scanner = PHPEditorEnvironment.getPHPCodeScanner();
if (scanner != null) {
if (getSourceViewer() != null) {
getSourceViewer().invalidateTextPresentation();
}
+
+ String property = event.getProperty();
+ if (IPreferenceConstants.LINE_NUMBER_RULER.equals(property)) {
+ if (isLineNumberRulerVisible())
+ showLineNumberRuler();
+ else
+ hideLineNumberRuler();
+ return;
+ }
}
});
}
+
+ private static IRegion getSignedSelection(ITextViewer viewer) {
+
+ StyledText text = viewer.getTextWidget();
+ int caretOffset = text.getCaretOffset();
+ Point selection = text.getSelection();
+
+ // caret left
+ int offset, length;
+ if (caretOffset == selection.x) {
+ offset = selection.y;
+ length = selection.x - selection.y;
+
+ // caret right
+ } else {
+ offset = selection.x;
+ length = selection.y - selection.x;
+ }
+
+ return new Region(offset, length);
+ }
+
+ private final static char[] BRACKETS = { '{', '}', '(', ')', '[', ']' };
+
+ private static boolean isBracket(char character) {
+ for (int i = 0; i != BRACKETS.length; ++i)
+ if (character == BRACKETS[i])
+ return true;
+ return false;
+ }
+
+ private static boolean isSurroundedByBrackets(
+ IDocument document,
+ int offset) {
+ if (offset == 0 || offset == document.getLength())
+ return false;
+
+ try {
+ return isBracket(document.getChar(offset - 1))
+ && isBracket(document.getChar(offset));
+
+ } catch (BadLocationException e) {
+ return false;
+ }
+ }
+ /**
+ * Jumps to the matching bracket.
+ */
+ public void gotoMatchingBracket() {
+
+ if (fBracketMatcher == null)
+ fBracketMatcher = new PHPPairMatcher(BRACKETS);
+
+ ISourceViewer sourceViewer = getSourceViewer();
+ IDocument document = sourceViewer.getDocument();
+ if (document == null)
+ return;
+
+ IRegion selection = getSignedSelection(sourceViewer);
+
+ int selectionLength = Math.abs(selection.getLength());
+ if (selectionLength > 1) {
+ setStatusLineErrorMessage(PHPEditorMessages.getString("GotoMatchingBracket.error.invalidSelection")); //$NON-NLS-1$
+ sourceViewer.getTextWidget().getDisplay().beep();
+ return;
+ }
+
+ // #26314
+ int sourceCaretOffset = selection.getOffset() + selection.getLength();
+ if (isSurroundedByBrackets(document, sourceCaretOffset))
+ sourceCaretOffset -= selection.getLength();
+
+ IRegion region = fBracketMatcher.match(document, sourceCaretOffset);
+ if (region == null) {
+ setStatusLineErrorMessage(PHPEditorMessages.getString("GotoMatchingBracket.error.noMatchingBracket")); //$NON-NLS-1$
+ sourceViewer.getTextWidget().getDisplay().beep();
+ return;
+ }
+
+ int offset = region.getOffset();
+ int length = region.getLength();
+
+ if (length < 1)
+ return;
+
+ int anchor = fBracketMatcher.getAnchor();
+ int targetOffset =
+ (PHPPairMatcher.RIGHT == anchor) ? offset : offset + length - 1;
+
+ boolean visible = false;
+ if (sourceViewer instanceof ITextViewerExtension3) {
+ ITextViewerExtension3 extension = (ITextViewerExtension3) sourceViewer;
+ visible = (extension.modelOffset2WidgetOffset(targetOffset) > -1);
+ } else {
+ IRegion visibleRegion = sourceViewer.getVisibleRegion();
+ visible =
+ (targetOffset >= visibleRegion.getOffset()
+ && targetOffset < visibleRegion.getOffset() + visibleRegion.getLength());
+ }
+
+ if (!visible) {
+ setStatusLineErrorMessage(PHPEditorMessages.getString("GotoMatchingBracket.error.bracketOutsideSelectedElement")); //$NON-NLS-1$
+ sourceViewer.getTextWidget().getDisplay().beep();
+ return;
+ }
+
+ if (selection.getLength() < 0)
+ targetOffset -= selection.getLength();
+
+ sourceViewer.setSelectedRange(targetOffset, selection.getLength());
+ sourceViewer.revealRange(targetOffset, selection.getLength());
+ }
+ /**
+ * Ses the given message as error message to this editor's status line.
+ * @param msg message to be set
+ */
+ protected void setStatusLineErrorMessage(String msg) {
+ IEditorStatusLine statusLine =
+ (IEditorStatusLine) getAdapter(IEditorStatusLine.class);
+ if (statusLine != null)
+ statusLine.setMessage(true, msg, null);
+ }
}
git://git.phpeclipse.com / phpeclipse.git / blobdiff