Menu
▾
▴
[Rubyeclipse-commit] org.rubypeople.rdt.core/src/org/rubypeople/rdt/core IRubyElementDelta.java,NONE,1.1 ElementChangedEvent.java,NONE,1.1 IElementChangedListener.java,NONE,1.1 IRubyModel.java,1.3,1.4 IRubyScript.java,1.7,1.8 IRubyProject.java,1.4,1.5
|
From: Christopher W. <caw...@us...> - 2005-12-13 19:59:35
|
Update of /cvsroot/rubyeclipse/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7305/src/org/rubypeople/rdt/core Modified Files: IRubyModel.java IRubyScript.java IRubyProject.java Added Files: IRubyElementDelta.java ElementChangedEvent.java IElementChangedListener.java Log Message: implement Ticket #46 (Update code folding on current working copy/editor) Index: IRubyModel.java =================================================================== RCS file: /cvsroot/rubyeclipse/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/IRubyModel.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** IRubyModel.java 5 Mar 2005 15:18:45 -0000 1.3 --- IRubyModel.java 13 Dec 2005 19:58:55 -0000 1.4 *************** *** 11,15 **** * */ ! public interface IRubyModel extends IParent { /** --- 11,15 ---- * */ ! public interface IRubyModel extends IParent, IRubyElement, IOpenable { /** Index: IRubyScript.java =================================================================== RCS file: /cvsroot/rubyeclipse/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/IRubyScript.java,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** IRubyScript.java 29 Nov 2005 19:38:00 -0000 1.7 --- IRubyScript.java 13 Dec 2005 19:58:55 -0000 1.8 *************** *** 88,92 **** * @since 3.0 */ ! void reconcile(WorkingCopyOwner owner, IProgressMonitor monitor) throws RubyModelException; /** --- 88,92 ---- * @since 3.0 */ ! void reconcile(boolean forceProblemDetection, WorkingCopyOwner owner, IProgressMonitor monitor) throws RubyModelException; /** *************** *** 359,361 **** --- 359,376 ---- */ IType[] getTypes() throws RubyModelException; + + /** + * Returns the smallest element within this compilation unit that + * includes the given source position (that is, a method, field, etc.), or + * <code>null</code> if there is no element other than the compilation + * unit itself at the given position, or if the given position is not + * within the source range of this compilation unit. + * + * @param position a source position inside the compilation unit + * @return the innermost Ruby element enclosing a given source position or <code>null</code> + * if none (excluding the compilation unit). + * @throws RubyModelException if the compilation unit does not exist or if an + * exception occurs while accessing its corresponding resource + */ + IRubyElement getElementAt(int position) throws RubyModelException; } \ No newline at end of file --- NEW FILE: IRubyElementDelta.java --- /******************************************************************************* * 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 Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.rubypeople.rdt.core; import org.eclipse.core.resources.IResourceDelta; import org.rubypeople.rdt.internal.core.RubyScript; /** * A Java element delta describes changes in Java element between two discrete * points in time. Given a delta, clients can access the element that has * changed, and any children that have changed. * <p> * Deltas have a different status depending on the kind of change they * represent. The list below summarizes each status (as returned by * <code>getKind</code>) and its meaning (see individual constants for a more * detailled description): * <ul> * <li><code>ADDED</code> - The element described by the delta has been * added.</li> * <li><code>REMOVED</code> - The element described by the delta has been * removed.</li> * <li><code>CHANGED</code> - The element described by the delta has been * changed in some way. Specification of the type of change is provided by * <code>getFlags</code> which returns the following values: * <ul> * <li><code>F_ADDED_TO_CLASSPATH</code> - A classpath entry corresponding to * the element has been added to the project's classpath. This flag is only * valid if the element is an <code>IPackageFragmentRoot</code>.</li> * <li><code>F_ARCHIVE_CONTENT_CHANGED</code> - The contents of an archive * has changed in some way. This flag is only valid if the element is an * <code>IPackageFragmentRoot</code> which is an archive.</li> * <li><code>F_CHILDREN</code> - A child of the element has changed in some * way. This flag is only valid if the element is an <code>IParent</code>.</li> * <li><code>F_CLASSPATH_REORDER</code> - A classpath entry corresponding to * the element has changed position in the project's classpath. This flag is * only valid if the element is an <code>IPackageFragmentRoot</code>.</li> * <li><code>F_CLOSED</code> - The underlying <code>IProject</code> has * been closed. This flag is only valid if the element is an * <code>IJavaProject</code>.</li> * <li><code>F_CONTENT</code> - The contents of the element have been * altered. This flag is only valid for elements which correspond to files.</li> * <li><code>F_FINE_GRAINED</code> - The delta is a fine-grained delta, that * is, an analysis down to the members level was done to determine if there were * structural changes to members of the element.</li> * <li><code>F_MODIFIERS</code> - The modifiers on the element have changed * in some way. This flag is only valid if the element is an * <code>IMember</code>.</li> * <li><code>F_OPENED</code> - The underlying <code>IProject</code> has * been opened. This flag is only valid if the element is an * <code>IJavaProject</code>.</li> * <li><code>F_REMOVED_FROM_CLASSPATH</code> - A classpath entry * corresponding to the element has been removed from the project's classpath. * This flag is only valid if the element is an * <code>IPackageFragmentRoot</code>.</li> * <li><code>F_SOURCEATTACHED</code> - The source attachment path or the * source attachment root path of a classpath entry corresponding to the element * was added. This flag is only valid if the element is an * <code>IPackageFragmentRoot</code>.</li> * <li><code>F_SOURCEDETACHED</code> - The source attachment path or the * source attachment root path of a classpath entry corresponding to the element * was removed. This flag is only valid if the element is an * <code>IPackageFragmentRoot</code>.</li> * <li><code>F_SUPER_TYPES</code> - One of the supertypes of an * <code>IType</code> has changed</li>. * </ul> * </li> * </ul> * </p> * <p> * Move operations are indicated by other change flags, layered on top of the * change flags described above. If element A is moved to become B, the delta * for the change in A will have status <code>REMOVED</code>, with change * flag <code>F_MOVED_TO</code>. In this case, <code>getMovedToElement</code> * on delta A will return the handle for B. The delta for B will have status * <code>ADDED</code>, with change flag <code>F_MOVED_FROM</code>, and * <code>getMovedFromElement</code> on delta B will return the handle for A. * (Note, the handle to A in this case represents an element that no longer * exists). * </p> * <p> * Note that the move change flags only describe the changes to a single * element, they do not imply anything about the parent or children of the * element. * </p> * <p> * The <code>F_ADDED_TO_CLASSPATH</code>, * <code>F_REMOVED_FROM_CLASSPATH</code> and <code>F_CLASSPATH_REORDER</code> * flags are triggered by changes to a project's classpath. They do not mean * that the underlying resource was added, removed or changed. For example, if a * project P already contains a folder src, then adding a classpath entry with * the 'P/src' path to the project's classpath will result in an * <code>IJavaElementDelta</code> with the <code>F_ADDED_TO_CLASSPATH</code> * flag for the <code>IPackageFragmentRoot</code> P/src. On the contrary, if a * resource is physically added, removed or changed and this resource * corresponds to a classpath entry of the project, then an * <code>IJavaElementDelta</code> with the <code>ADDED</code>, * <code>REMOVED</code>, or <code>CHANGED</code> kind will be fired. * </p> * <p> * Note that when a source attachment path or a source attachment root path is * changed, then the flags of the delta contain both * <code>F_SOURCEATTACHED</code> and <code>F_SOURCEDETTACHED</code>. * </p> * <p> * No assumptions should be made on whether the java element delta tree is * rooted at the <code>IJavaModel</code> level or not. * </p> * <p> * <code>IJavaElementDelta</code> object are not valid outside the dynamic * scope of the notification. * </p> * <p> * This interface is not intended to be implemented by clients. * </p> */ public interface IRubyElementDelta { /** * Status constant indicating that the element has been added. Note that an * added java element delta has no children, as they are all implicitely * added. */ public int ADDED = 1; /** * Status constant indicating that the element has been removed. Note that a * removed java element delta has no children, as they are all implicitely * removed. */ public int REMOVED = 2; /** * Status constant indicating that the element has been changed, as * described by the change flags. * * @see #getFlags() */ public int CHANGED = 4; /** * Change flag indicating that the content of the element has changed. This * flag is only valid for elements which correspond to files. */ public int F_CONTENT = 0x000001; /** * Change flag indicating that the modifiers of the element have changed. * This flag is only valid if the element is an <code>IMember</code>. */ public int F_MODIFIERS = 0x000002; /** * Change flag indicating that there are changes to the children of the * element. This flag is only valid if the element is an * <code>IParent</code>. */ public int F_CHILDREN = 0x000008; /** * Change flag indicating that the element was moved from another location. * The location of the old element can be retrieved using * <code>getMovedFromElement</code>. */ public int F_MOVED_FROM = 0x000010; /** * Change flag indicating that the element was moved to another location. * The location of the new element can be retrieved using * <code>getMovedToElement</code>. */ public int F_MOVED_TO = 0x000020; /** * Change flag indicating that a classpath entry corresponding to the * element has been added to the project's classpath. This flag is only * valid if the element is an <code>IPackageFragmentRoot</code>. */ public int F_ADDED_TO_CLASSPATH = 0x000040; /** * Change flag indicating that a classpath entry corresponding to the * element has been removed from the project's classpath. This flag is only * valid if the element is an <code>IPackageFragmentRoot</code>. */ public int F_REMOVED_FROM_CLASSPATH = 0x000080; /** * Change flag indicating that a classpath entry corresponding to the * element has changed position in the project's classpath. This flag is * only valid if the element is an <code>IPackageFragmentRoot</code>. * * @deprecated Use F_REORDER instead. */ public int F_CLASSPATH_REORDER = 0x000100; /** * Change flag indicating that the element has changed position relatively * to its siblings. If the element is an <code>IPackageFragmentRoot</code>, * a classpath entry corresponding to the element has changed position in * the project's classpath. * * @since 2.1 */ public int F_REORDER = 0x000100; /** * Change flag indicating that the underlying <code>IProject</code> has * been opened. This flag is only valid if the element is an * <code>IJavaProject</code>. */ public int F_OPENED = 0x000200; /** * Change flag indicating that the underlying <code>IProject</code> has * been closed. This flag is only valid if the element is an * <code>IJavaProject</code>. */ public int F_CLOSED = 0x000400; /** * Change flag indicating that one of the supertypes of an * <code>IType</code> has changed. */ public int F_SUPER_TYPES = 0x000800; /** * Change flag indicating that the source attachment path or the source * attachment root path of a classpath entry corresponding to the element * was added. This flag is only valid if the element is an * <code>IPackageFragmentRoot</code>. */ public int F_SOURCEATTACHED = 0x001000; /** * Change flag indicating that the source attachment path or the source * attachment root path of a classpath entry corresponding to the element * was removed. This flag is only valid if the element is an * <code>IPackageFragmentRoot</code>. */ public int F_SOURCEDETACHED = 0x002000; /** * Change flag indicating that this is a fine-grained delta, that is, an * analysis down to the members level was done to determine if there were * structural changes to members. * <p> * Clients can use this flag to find out if a compilation unit that have a * <code>F_CONTENT</code> change should assume that there are no finer * grained changes (<code>F_FINE_GRAINED</code> is set) or if finer * grained changes were not considered (<code>F_FINE_GRAINED</code> is * not set). * * @since 2.0 */ public int F_FINE_GRAINED = 0x004000; /** * Change flag indicating that the element's archive content on the * classpath has changed. This flag is only valid if the element is an * <code>IPackageFragmentRoot</code> which is an archive. * * @see IPackageFragmentRoot#isArchive() * @since 2.0 */ public int F_ARCHIVE_CONTENT_CHANGED = 0x008000; /** * Change flag indicating that a compilation unit has become a primary * working copy, or that a primary working copy has reverted to a * compilation unit. This flag is only valid if the element is an * <code>ICompilationUnit</code>. * * @since 3.0 */ public int F_PRIMARY_WORKING_COPY = 0x010000; /** * Change flag indicating that the raw classpath (or the output folder) of a * project has changed. This flag is only valid if the element is an * <code>IJavaProject</code>. * * @since 3.0 */ public int F_CLASSPATH_CHANGED = 0x020000; /** * Change flag indicating that the resource of a primary compilation unit * has changed. This flag is only valid if the element is a primary * <code>ICompilationUnit</code>. * * @since 3.0 */ public int F_PRIMARY_RESOURCE = 0x040000; /** * Change flag indicating that a reconcile operation has affected the * compilation unit AST created in a previous reconcile operation. Use * {@link #getCompilationUnitAST()} to retrieve the AST (if any is * available). This flag is only valid if the element is an * <code>ICompilationUnit</code> in working copy mode. * * @since 3.2 */ public int F_AST_AFFECTED = 0x080000; /** * Change flag indicating that the categories of the element have changed. * This flag is only valid if the element is an <code>IMember</code>. * * @since 3.2 */ public int F_CATEGORIES = 0x100000; /** * Returns deltas for the children that have been added. * * @return deltas for the children that have been added */ public IRubyElementDelta[] getAddedChildren(); /** * Returns deltas for the affected (added, removed, or changed) children. * * @return deltas for the affected (added, removed, or changed) children */ public IRubyElementDelta[] getAffectedChildren(); /** * Returns the compilation unit AST created by the last reconcile operation * on this delta's element. This returns a non-null value if and only if: * <ul> * <li>the last reconcile operation on this working copy requested an AST</li> * <li>this delta's element is an <code>ICompilationUnit</code> in * working copy mode</li> * <li>the delta comes from a <code>POST_RECONCILE</code> event * </ul> * * @return the AST created during the last reconcile operation * @see IRubyScript#reconcile(int, boolean, WorkingCopyOwner, * org.eclipse.core.runtime.IProgressMonitor) * @see #F_AST_AFFECTED * @since 3.2 */ public RubyScript getRubyScriptAST(); /** * Returns deltas for the children which have changed. * * @return deltas for the children which have changed */ public IRubyElementDelta[] getChangedChildren(); /** * Returns the element that this delta describes a change to. * * @return the element that this delta describes a change to */ public IRubyElement getElement(); /** * Returns flags that describe how an element has changed. Such flags should * be tested using the <code>&</code> operand. For example: * * <pre> * if ((delta.getFlags() & IRubyElementDelta.F_CONTENT) != 0) { * // the delta indicates a content change * } * </pre> * * @return flags that describe how an element has changed */ public int getFlags(); /** * Returns the kind of this delta - one of <code>ADDED</code>, * <code>REMOVED</code>, or <code>CHANGED</code>. * * @return the kind of this delta */ public int getKind(); /** * Returns an element describing this element before it was moved to its * current location, or <code>null</code> if the <code>F_MOVED_FROM</code> * change flag is not set. * * @return an element describing this element before it was moved to its * current location, or <code>null</code> if the * <code>F_MOVED_FROM</code> change flag is not set */ public IRubyElement getMovedFromElement(); /** * Returns an element describing this element in its new location, or * <code>null</code> if the <code>F_MOVED_TO</code> change flag is not * set. * * @return an element describing this element in its new location, or * <code>null</code> if the <code>F_MOVED_TO</code> change flag * is not set */ public IRubyElement getMovedToElement(); /** * Returns deltas for the children which have been removed. * * @return deltas for the children which have been removed */ public IRubyElementDelta[] getRemovedChildren(); /** * Returns the collection of resource deltas. * <p> * Note that resource deltas, like Ruby element deltas, are generally only * valid for the dynamic scope of an event notification. Clients must not * hang on to these objects. * </p> * * @return the underlying resource deltas, or <code>null</code> if none */ public IResourceDelta[] getResourceDeltas(); } --- NEW FILE: IElementChangedListener.java --- /******************************************************************************* * 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 Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.rubypeople.rdt.core; /** * An element changed listener receives notification of changes to Java elements * maintained by the Java model. * <p> * This interface may be implemented by clients. * </p> */ public interface IElementChangedListener { /** * Notifies that one or more attributes of one or more Java elements have changed. * The specific details of the change are described by the given event. * * @param event the change event */ public void elementChanged(ElementChangedEvent event); } --- NEW FILE: ElementChangedEvent.java --- /******************************************************************************* * 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 Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ package org.rubypeople.rdt.core; import java.util.EventObject; /** * An element changed event describes a change to the structure or contents * of a tree of Java elements. The changes to the elements are described by * the associated delta object carried by this event. * <p> * This class is not intended to be instantiated or subclassed by clients. * Instances of this class are automatically created by the Java model. * </p> * * @see IElementChangedListener * @see IJavaElementDelta */ public class ElementChangedEvent extends EventObject { /** * Event type constant (bit mask) indicating an after-the-fact * report of creations, deletions, and modifications * to one or more Java element(s) expressed as a hierarchical * java element delta as returned by <code>getDelta()</code>. * * Note: this notification occurs during the corresponding POST_CHANGE * resource change notification, and contains a full delta accounting for * any JavaModel operation and/or resource change. * * @see IJavaElementDelta * @see org.eclipse.core.resources.IResourceChangeEvent * @see #getDelta() * @since 2.0 */ public static final int POST_CHANGE = 1; /** * Event type constant (bit mask) indicating an after-the-fact * report of creations, deletions, and modifications * to one or more Java element(s) expressed as a hierarchical * java element delta as returned by <code>getDelta</code>. * * Note: this notification occurs during the corresponding PRE_AUTO_BUILD * resource change notification. The delta, which is notified here, only contains * information relative to the previous JavaModel operations (in other words, * it ignores the possible resources which have changed outside Java operations). * In particular, it is possible that the JavaModel be inconsistent with respect to * resources, which got modified outside JavaModel operations (it will only be * fully consistent once the POST_CHANGE notification has occurred). * * @see IJavaElementDelta * @see org.eclipse.core.resources.IResourceChangeEvent * @see #getDelta() * @since 2.0 * @deprecated - no longer used, such deltas are now notified during POST_CHANGE */ public static final int PRE_AUTO_BUILD = 2; /** * Event type constant (bit mask) indicating an after-the-fact * report of creations, deletions, and modifications * to one or more Java element(s) expressed as a hierarchical * java element delta as returned by <code>getDelta</code>. * * Note: this notification occurs as a result of a working copy reconcile * operation. * * @see IJavaElementDelta * @see org.eclipse.core.resources.IResourceChangeEvent * @see #getDelta() * @since 2.0 */ public static final int POST_RECONCILE = 4; private static final long serialVersionUID = -8947240431612844420L; // backward compatible /* * Event type indicating the nature of this event. * It can be a combination either: * - POST_CHANGE * - PRE_AUTO_BUILD * - POST_RECONCILE */ private int type; /** * Creates an new element changed event (based on a <code>IJavaElementDelta</code>). * * @param delta the Java element delta. * @param type the type of delta (ADDED, REMOVED, CHANGED) this event contains */ public ElementChangedEvent(IRubyElementDelta delta, int type) { super(delta); this.type = type; } /** * Returns the delta describing the change. * * @return the delta describing the change */ public IRubyElementDelta getDelta() { return (IRubyElementDelta) this.source; } /** * Returns the type of event being reported. * * @return one of the event type constants * @see #POST_CHANGE * @see #PRE_AUTO_BUILD * @see #POST_RECONCILE * @since 2.0 */ public int getType() { return this.type; } } Index: IRubyProject.java =================================================================== RCS file: /cvsroot/rubyeclipse/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/IRubyProject.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** IRubyProject.java 3 Sep 2005 19:05:02 -0000 1.4 --- IRubyProject.java 13 Dec 2005 19:58:55 -0000 1.5 *************** *** 26,29 **** --- 26,30 ---- import java.util.List; + import java.util.Map; import org.eclipse.core.resources.IProject; *************** *** 74,76 **** --- 75,106 ---- public boolean upgrade() throws CoreException; + /** + * Helper method for returning one option value only. Equivalent to <code>(String)this.getOptions(inheritRubyCoreOptions).get(optionName)</code> + * Note that it may answer <code>null</code> if this option does not exist, or if there is no custom value for it. + * <p> + * For a complete description of the configurable options, see <code>RubyCore#getDefaultOptions</code>. + * </p> + * + * @param optionName the name of an option + * @param inheritRubyCoreOptions - boolean indicating whether RubyCore options should be inherited as well + * @return the String value of a given option + * @see RubyCore#getDefaultOptions() + */ + String getOption(String optionName, boolean inheritRubyCoreOptions); + + /** + * Returns the table of the current custom options for this project. Projects remember their custom options, + * in other words, only the options different from the the RubyCore global options for the workspace. + * A boolean argument allows to directly merge the project options with global ones from <code>RubyCore</code>. + * <p> + * For a complete description of the configurable options, see <code>RubyCore#getDefaultOptions</code>. + * </p> + * + * @param inheritRubyCoreOptions - boolean indicating whether RubyCore options should be inherited as well + * @return table of current settings of all options + * (key type: <code>String</code>; value type: <code>String</code>) + * @see RubyCore#getDefaultOptions() + */ + Map getOptions(boolean inheritRubyCoreOptions); + } \ No newline at end of file |
