1) Moved net.sourceforge.phpeclipse.ui\src\net\sourceforge\phpdt back to net.sourcefo...

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / text / java / IInvocationContext.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/java/IInvocationContext.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/java/IInvocationContext.java
new file mode 100644 (file)
index 0000000..ca5dec2
--- /dev/null
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/text/java/IInvocationContext.java
@@ -0,0 +1,69 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package net.sourceforge.phpdt.internal.ui.text.java;
+
+import net.sourceforge.phpdt.core.ICompilationUnit;
+import net.sourceforge.phpdt.core.dom.CompilationUnit;
+
+/**
+ * Context information for quick fix and quick assist processors.
+ * <p>
+ * Note: this interface is not intended to be implemented.
+ * </p>
+ * 
+ * @since 3.0
+ */
+public interface IInvocationContext {
+
+       /**
+        * @return Returns the current compilation unit.
+        */
+       ICompilationUnit getCompilationUnit();
+
+       /**
+        * @return Returns the offset of the current selection
+        */
+       int getSelectionOffset();
+
+       /**
+        * @return Returns the length of the current selection
+        */
+       int getSelectionLength();
+
+       /**
+        * Returns an AST of the compilation unit, possibly only a partial AST
+        * focused on the selection offset (see
+        * {@link net.sourceforge.phpdt.core.dom.ASTParser#setFocalPosition(int)}).
+        * The returned AST is shared and therefore protected and cannot be
+        * modified. The client must check the AST API level and do nothing if they
+        * are given an AST they can't handle. (see
+        * {@link net.sourceforge.phpdt.core.dom.AST#apiLevel()}).
+        * 
+        * @return Returns the root of the AST corresponding to the current
+        *         compilation unit.
+        */
+       CompilationUnit getASTRoot();
+
+       /**
+        * Convenience method to evaluate the AST node covering the current
+        * selection.
+        * 
+        * @return Returns the node that covers the location of the problem
+        */
+       // ASTNode getCoveringNode();
+       /**
+        * Convenience method to evaluate the AST node that is covered by the
+        * current selection.
+        * 
+        * @return Returns the node that is covered by the location of the problem
+        */
+       // ASTNode getCoveredNode();
+}