EPIC - Eclipse Perl Integration

Update of /cvsroot/e-p-i-c/org.epic.perleditor/src/org/epic/perleditor/views
In directory sc8-pr-cvs5.sourceforge.net:/tmp/cvs-serv9316/src/org/epic/perleditor/views

Modified Files:
	PerlOutlinePage.java 
Log Message:
Fixed a bug which prevented the Outline view from updating while 'use' statements were being edited.

Index: PerlOutlinePage.java
===================================================================
RCS file: /cvsroot/e-p-i-c/org.epic.perleditor/src/org/epic/perleditor/views/PerlOutlinePage.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -d -r1.27 -r1.28
--- PerlOutlinePage.java	25 May 2006 16:28:03 -0000	1.27
+++ PerlOutlinePage.java	26 Jun 2006 16:41:27 -0000	1.28
@@ -1 +1 @@
-package org.epic.perleditor.views;

import java.util.*;

import org.eclipse.jface.viewers.*;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.views.contentoutline.ContentOutlinePage;
import org.epic.core.model.SourceFile;
import org.epic.core.model.Subroutine;

public class PerlOutlinePage extends ContentOutlinePage
{
    private SourceFile source;
    private List prevContent;
    
    /**
     * Subroutine in which the caret was during last call to updateSelection
     * We keep track of it to speed up outline synchronisations in the common
     * case (caret movements within a sub).
     */
    private Subroutine lastCaretSub;
    
    public PerlOutlinePage(SourceFile source)
    {
        this.source = source;
        this.prevContent = new ArrayList();
    }

    public void createControl(Composite parent)
    {
        super.createControl(parent);

        TreeViewer viewer = getTreeViewer();
        viewer.setContentProvider(new PerlOutlineContentProvider());
        viewer.setLabelProvider(new PerlOutlineLabelProvider());
        viewer.setInput(source);
        viewer.setSorter(new ViewerSorter());
        getTreeViewer().expandAll();
        rememberContent(source);
    }

    public void updateContent(SourceFile source)
    {
        lastCaretSub = null;
        if (!source.equals(this.source))
        {
            this.source = source;
            getTreeViewer().setInput(source);
        }
        if (contentChanged(source))
        {
            updateViewer();
            rememberContent(source);
        }
    }
    
    public void updateSelection(int caretLine)
    {
        // check lastCaretSub first to speed up things in the most common case
        if (lastCaretSub == null ||
            caretLine < lastCaretSub.getStartLine() ||
            caretLine > lastCaretSub.getEndLine())
        {
            lastCaretSub = null;
            for (Iterator i = source.getSubs(); i.hasNext();)
            {
                Subroutine sub = (Subroutine) i.next();
                if (caretLine >= sub.getStartLine() &&
                    caretLine <= sub.getEndLine())
                {
                    lastCaretSub = sub;
                    break;
                }
            }
        }
        if (lastCaretSub != null)
            setSelection(new StructuredSelection(lastCaretSub));
        else
            setSelection(StructuredSelection.EMPTY);
    }
    
    /**
     * @param source  SourceFile to be presented in the outline page
     * @return true if the outline page's content for <code>source</code>
     *         differs from the current content; false otherwise
     */
    private boolean contentChanged(SourceFile source)
    {
        Iterator j = prevContent.iterator();
        
        for (Iterator i = source.getSubs(); i.hasNext();)
        {
            if (!j.hasNext()) return true;
            
            Subroutine subI = (Subroutine) i.next();
            Subroutine subJ = (Subroutine) j.next();
            
            if (!subI.getName().equals(subJ.getName()) ||
                !subI.getParent().getName().equals(subJ.getParent().getName()))
            {
                return true;
            }
        }
        return false;
    }
    
    /**
     * Caches the content of the outline page derived from <code>source</code>.
     * This is necessary to avoid calling {@link #updateViewer} every time the
     * source file changes (yet the outline should stay unaffected).
     * 
     * @param source  SourceFile currently presented in the outline page
     */
    private void rememberContent(SourceFile source)
    {
        prevContent.clear();
        for (Iterator i = source.getSubs(); i.hasNext();)
            prevContent.add(i.next());
    }
    
    /**
     * Loads the current contents of the outline page into the tree viewer
     * and expands its nodes. This is an expensive operation, especially
     * under Windows where it results in a visible and annoying redrawing.
     */
    private void updateViewer()
    {
        getTreeViewer().getControl().getDisplay().asyncExec(new Runnable() {
            public void run() {
                getTreeViewer().refresh();
                getTreeViewer().expandToLevel(3);
            } });
    }
}
\ No newline at end of file
+package org.epic.perleditor.views;

import java.util.*;

import org.eclipse.jface.viewers.*;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.views.contentoutline.ContentOutlinePage;
import org.epic.core.model.*;

public class PerlOutlinePage extends ContentOutlinePage
{
    private SourceFile source;
    private List prevSubsContent;
    private List prevUsesContent;
    
    /**
     * Subroutine in which the caret was during last call to updateSelection
     * We keep track of it to speed up outline synchronisations in the common
     * case (caret movements within a sub).
     */
    private Subroutine lastCaretSub;
    
    public PerlOutlinePage(SourceFile source)
    {
        this.source = source;
        this.prevSubsContent = new ArrayList();
        this.prevUsesContent = new ArrayList();
    }

    public void createControl(Composite parent)
    {
        super.createControl(parent);

        TreeViewer viewer = getTreeViewer();
        viewer.setContentProvider(new PerlOutlineContentProvider());
        viewer.setLabelProvider(new PerlOutlineLabelProvider());
        viewer.setInput(source);
        viewer.setSorter(new ViewerSorter());
        getTreeViewer().expandAll();
        rememberContent(source);
    }

    public void updateContent(SourceFile source)
    {
        lastCaretSub = null;
        if (!source.equals(this.source))
        {
            this.source = source;
            getTreeViewer().setInput(source);
        }
        if (contentChanged(source))
        {
            updateViewer();
            rememberContent(source);
        }
    }
    
    public void updateSelection(int caretLine)
    {
        // check lastCaretSub first to speed up things in the most common case
        if (lastCaretSub == null ||
            caretLine < lastCaretSub.getStartLine() ||
            caretLine > lastCaretSub.getEndLine())
        {
            lastCaretSub = null;
            for (Iterator i = source.getSubs(); i.hasNext();)
            {
                Subroutine sub = (Subroutine) i.next();
                if (caretLine >= sub.getStartLine() &&
                    caretLine <= sub.getEndLine())
                {
                    lastCaretSub = sub;
                    break;
                }
            }
        }
        if (lastCaretSub != null)
            setSelection(new StructuredSelection(lastCaretSub));
        else
            setSelection(StructuredSelection.EMPTY);
    }
    
    /**
     * @param source  SourceFile to be presented in the outline page
     * @return true if the outline page's content for <code>source</code>
     *         differs from the current content; false otherwise
     */
    private boolean contentChanged(SourceFile source)
    {
        return subsChanged(source) || moduleUsesChanged(source);
    }
    
    private boolean moduleUsesChanged(SourceFile source)
    {
        Iterator j = prevUsesContent.iterator();
        
        for (Iterator i = source.getUses(); i.hasNext();)
        {
            if (!j.hasNext()) return true;
            
            ModuleUse useI = (ModuleUse) i.next();
            ModuleUse useJ = (ModuleUse) j.next();
            
            if (!useI.getName().equals(useJ.getName()) ||
                !useI.getParent().getName().equals(useJ.getParent().getName()))
            {
                return true;
            }
        }
        return false;
    }

    private boolean subsChanged(SourceFile source)
    {
        Iterator j = prevSubsContent.iterator();
        
        for (Iterator i = source.getSubs(); i.hasNext();)
        {
            if (!j.hasNext()) return true;
            
            Subroutine subI = (Subroutine) i.next();
            Subroutine subJ = (Subroutine) j.next();
            
            if (!subI.getName().equals(subJ.getName()) ||
                !subI.getParent().getName().equals(subJ.getParent().getName()))
            {
                return true;
            }
        }
        return false;
    }
    
    /**
     * Caches the content of the outline page derived from <code>source</code>.
     * This is necessary to avoid calling {@link #updateViewer} every time the
     * source file changes (yet the outline should stay unaffected).
     * 
     * @param source  SourceFile currently presented in the outline page
     */
    private void rememberContent(SourceFile source)
    {
        prevSubsContent.clear();
        for (Iterator i = source.getSubs(); i.hasNext();)
            prevSubsContent.add(i.next());
        
        prevUsesContent.clear();
        for (Iterator i = source.getUses(); i.hasNext();)
            prevUsesContent.add(i.next());
    }
    
    /**
     * Loads the current contents of the outline page into the tree viewer
     * and expands its nodes. This is an expensive operation, especially
     * under Windows where it results in a visible and annoying redrawing.
     */
    private void updateViewer()
    {
        getTreeViewer().getControl().getDisplay().asyncExec(new Runnable() {
            public void run() {
                getTreeViewer().refresh();
                getTreeViewer().expandToLevel(3);
            } });
    }
}
\ No newline at end of file

Update of /cvsroot/e-p-i-c/org.epic.perleditor/src/org/epic/core/model
In directory sc8-pr-cvs5.sourceforge.net:/tmp/cvs-serv9316/src/org/epic/core/model

Modified Files:
	SourceFile.java 
Log Message:
Fixed a bug which prevented the Outline view from updating while 'use' statements were being edited.

Index: SourceFile.java
===================================================================
RCS file: /cvsroot/e-p-i-c/org.epic.perleditor/src/org/epic/core/model/SourceFile.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- SourceFile.java	25 Dec 2005 14:03:43 -0000	1.2
+++ SourceFile.java	26 Jun 2006 16:41:26 -0000	1.3
@@ -76,6 +76,15 @@
         return new SubIterator();
     }
     
+    /**
+     * @return an iterator over {@link ModuleUse} instances representing
+     *         'use module' statements found in the source, in their original order  
+     */
+    public Iterator getUses()
+    {
+        return new ModuleUseIterator();
+    }
+    
     public synchronized void parse()
     {
         this.pods = new ArrayList();
@@ -330,4 +339,39 @@
             return subIterator.next();
         }
     }
+    
+    private class ModuleUseIterator implements Iterator
+    {
+        private Iterator pkgIterator;
+        private Iterator useIterator;
+        
+        public ModuleUseIterator()
+        {
+            pkgIterator = packages.iterator();
+        }
+        
+        public void remove()
+        {
+            throw new UnsupportedOperationException();
+        }
+
+        public boolean hasNext()
+        {
+            while (useIterator == null || !useIterator.hasNext())
+            {
+                if (pkgIterator.hasNext())
+                {
+                    Package pkg = (Package) pkgIterator.next();
+                    useIterator = pkg.getUses().iterator();
+                }
+                else return false;
+            }
+            return true;
+        }
+
+        public Object next()
+        {
+            return useIterator.next();
+        }
+    }
 }