Attachment #96569 for bug #183344

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 183344
Collapse All | Expand All




    <!-- ACTUAL CHANGES BEGIN HERE: -->

    <changes>
        <change id="GoToFile">
            <api name="general"/>
            <summary>Added SPI for Go to File dialog</summary>
            <version major="1" minor="15"/>
            <date day="5" month="4" year="2010"/>
            <author login="tzezula"/>
            <compatibility addition="yes">
            </compatibility>
            <description>
                 Added SPI to allow friend modules to participate on searching files
                 in the Go To File dialog. The supplied FileProvider can handle file
                 search in recognized source groups.
            </description>
            <class package="org.netbeans.spi.jumpto.file" name="FileProviderFactory"/>
            <class package="org.netbeans.spi.jumpto.file" name="FileProvider"/>
            <issue number="182884"/>
        </change>
        <change id="GoToSymbol">
            <api name="general"/>
            <summary>Added SPI for Go to Symbol dialog</summary>

                 Added SPI to provide content of the for Go to Symbol dialog.
            </description>
            <issue number="138345"/>
        </change>

        <change id="(Provider.Result.pendingResult">
            <api name="general"/>

Lines 2-6 Link Here

(-)a/jumpto/manifest.mf (-1 / +1 lines)
2	OpenIDE-Module: org.netbeans.modules.jumpto/1	2	OpenIDE-Module: org.netbeans.modules.jumpto/1
3	OpenIDE-Module-Layer: org/netbeans/modules/jumpto/resources/layer.xml	3	OpenIDE-Module-Layer: org/netbeans/modules/jumpto/resources/layer.xml
4	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/jumpto/resources/Bundle.properties	4	OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/jumpto/resources/Bundle.properties
5	OpenIDE-Module-Specification-Version: 1.14	5	OpenIDE-Module-Specification-Version: 1.15
6	AutoUpdate-Show-In-Client: false	6	AutoUpdate-Show-In-Client: false




            </test-dependencies>
            <friend-packages>
                <friend>org.netbeans.modules.cnd.gotodeclaration</friend>
                <friend>org.netbeans.modules.csl.api</friend>
                <friend>org.netbeans.modules.gsf</friend>
                <friend>org.netbeans.modules.java.sourceui</friend>
                <friend>org.netbeans.modules.javafx.editor</friend>
                <friend>org.netbeans.modules.spring.beans</friend>
                <friend>org.netbeans.modules.csl.api</friend>
                <package>org.netbeans.api.jumpto.type</package>
                <package>org.netbeans.spi.jumpto.file</package>
                <package>org.netbeans.spi.jumpto.symbol</package>
                <package>org.netbeans.spi.jumpto.type</package>
            </friend-packages>





package org.netbeans.modules.jumpto.file;

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Image;
import java.beans.BeanInfo;
import java.util.Comparator;
import javax.swing.DefaultListCellRenderer;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JViewport;
import javax.swing.SwingConstants;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectInformation;
import org.netbeans.api.project.ProjectUtils;
import org.openide.cookies.EditCookie;
import org.openide.cookies.OpenCookie;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.util.ImageUtilities;
import org.openide.util.NbBundle;

/** Contains interesting information about file found in the search.
 *
 * @author Petr Hrebejk
 * @author Tomas Zezula
 * todo: SPI interface if needed. Now FileObject added to result seems to be enough
 * and everyone will use the default impl anyway.
 */
public class FileDescription {

//    static long time;
    
    public static final String SEARCH_IN_PROGRES = NbBundle.getMessage(FileDescription.class, "TXT_SearchingOtherProjects"); // NOI18N
    /**
     * The icon used if unknown project, i.e. {@code project == null}.
     * In such case, we use {@code find.png} - "a file belongs to the find".
     */
    public static Icon UNKNOWN_PROJECT_ICON = ImageUtilities.loadImageIcon(
             "org/netbeans/modules/jumpto/resources/find.gif", false); // NOI18N
    
    private final FileObject fileObject;
    private final String ownerPath;
    private final Project project; // Project the file belongs to

    private Icon icon;
    private String projectName;
    private Icon projectIcon;
    private boolean prefered;

    public FileDescription(FileObject file, String ownerPath,
    
    public FileDescription(FileObject file, String relativePath, 
                           Project project, boolean prefered) {
        this.fileObject = file;
        this.ownerPath = ownerPath;
        this.project = project;
        this.prefered = prefered;
    }

    public String getFileName() {
        return fileObject.getNameExt(); // NOI18N
    }

    public synchronized Icon getIcon() {
                
        if ( icon == null ) {
            DataObject od = getDataObject();
            Image i = od.getNodeDelegate().getIcon(BeanInfo.ICON_COLOR_16x16);
            icon = new ImageIcon( i );
        }
        
        return icon;
    }

    public String getOwnerPath() {
        return ownerPath;
    }

    public synchronized String getProjectName() {
        if ( projectName == null ) {
            initProjectInfo();
        }
        return projectName;
    }

    public synchronized Icon getProjectIcon() {
        if ( projectIcon == null ) {
            initProjectInfo();
        }
        return projectIcon;
    }

    public boolean isFromCurrentProject() {
        return prefered;
    }

//        if ( fileObject == null ) {
//            fileObject = FileUtil.toFileObject(file);
//        }
//        boolean visible = fileObject == null ? false : VisibilityQuery.getDefault().isVisible(fileObject);
//        if ( !visible ) {
//            addTime( t );
//            return false;
//        }
//
//        // XXX PERF needs to cache parents.
//        while( fileObject.getParent() != null ) {
//            fileObject = fileObject.getParent();
//            if ( fileObject.equals(sourceGroup.getRootFolder() ) ) {
//                addTime( t );
//                return true;
//            }
//            if ( !VisibilityQuery.getDefault().isVisible(fileObject)  ) {
//                addTime( t );
//                return false;
//            }
//        }
//        addTime( t );
//        return true;
//    }
//
//    private void addTime( long t ) {
////        time += System.currentTimeMillis() - t;
////        System.out.println("isVisible time " + time);
//    }
    
    public void open() {
        
        DataObject od = getDataObject();
        
        if ( od != null ) {
        
            EditCookie ec = (EditCookie) od.getCookie(EditCookie.class);

            if (ec != null) {
                ec.edit();
            }

        }

    }

    public FileObject getFileObject() {
        return fileObject;
    }

    private DataObject getDataObject() {
        try     {
            org.openide.filesystems.FileObject fo = getFileObject();

            return null;
        }
    }

    private void initProjectInfo() {
        // Issue #167198: A file may not belong to any project.
        // Hence, FileOwnerQuery.getOwner(file) can return null as a project,

            projectIcon = pi.getIcon();
        }
        else {
            projectName = "";   //NOI18N
            projectIcon = UNKNOWN_PROJECT_ICON;
        }
    }
    
    // Innerclasses ------------------------------------------------------------
    
    public static class FDComarator implements Comparator<FileDescription> {

        private boolean usePrefered;
        private boolean caseSensitive;
                
        public FDComarator(boolean usePrefered, boolean caseSensitive ) {
            this.usePrefered = usePrefered;
            this.caseSensitive = caseSensitive;
        }
        
        public int compare(FileDescription o1, FileDescription o2) {
            
            // If prefered prefer prefered
            if ( usePrefered ) {
                if ( o1.prefered && !o2.prefered ) {
                    return -1;
                }
                if ( !o1.prefered && o2.prefered ) {
                    return 1;
                }
            }
            
            // File name
            int cmpr = compareStrings( o1.getName(), o2.getName(), caseSensitive );
            if ( cmpr != 0 ) {
                return cmpr;
            }
            
            // Project name
            cmpr = compareStrings( o1.getProjectName(), o2.getProjectName(), caseSensitive );            
            if ( cmpr != 0 ) {
                return cmpr;
            }
            
            // Relative location
            cmpr = compareStrings( o1.getRelativePath(), o2.getRelativePath(), caseSensitive );
                        
            return cmpr;
           
        }
        
        private int compareStrings(String s1, String s2, boolean caseSensitive) {
            if( s1 == null ) {
                s1 = EMPTY_STRING;
            }
            if ( s2 == null ) {
                s2 = EMPTY_STRING;
            }
            
            
            return caseSensitive ? s1.compareTo( s2 ) : s1.compareToIgnoreCase( s2 );
        }        
    }

    private static class RendererComponent extends JPanel {
	private FileDescription fd;

	void setDescription(FileDescription fd) {
	    this.fd = fd;
	    putClientProperty(TOOL_TIP_TEXT_KEY, null);
	}

	@Override
	public String getToolTipText() {
	    String text = (String) getClientProperty(TOOL_TIP_TEXT_KEY);
	    if( text == null ) {
                if( fd != null) {
                    text = FileUtil.getFileDisplayName(fd.getFileObject());
                }
                putClientProperty(TOOL_TIP_TEXT_KEY, text);
	    }
	    return text;
	}
    }

    public static class Renderer extends DefaultListCellRenderer implements ChangeListener {
        
        public static Icon WAIT_ICON = ImageUtilities.loadImageIcon("org/netbeans/modules/jumpto/resources/wait.gif", false); // NOI18N
        
        
        private RendererComponent rendererComponent;
        private JLabel jlName = new JLabel();
        private JLabel jlPath = new JLabel();
        private JLabel jlPrj = new JLabel();
        private int DARKER_COLOR_COMPONENT = 5;
        private int LIGHTER_COLOR_COMPONENT = 80;        
        private Color fgColor;
        private Color fgColorLighter;
        private Color bgColor;
        private Color bgColorDarker;
        private Color bgSelectionColor;
        private Color fgSelectionColor;
        private Color bgColorGreener;
        private Color bgColorDarkerGreener;
        
        private JList jList;
    
        private boolean colorPrefered;
        
        public Renderer( JList list ) {
            
            jList = list;
            
            Container container = list.getParent();
            if ( container instanceof JViewport ) {
                ((JViewport)container).addChangeListener(this);
                stateChanged(new ChangeEvent(container));
            }
            
            rendererComponent = new RendererComponent();
            rendererComponent.setLayout(new BorderLayout());
            rendererComponent.add( jlName, BorderLayout.WEST );
            rendererComponent.add( jlPath, BorderLayout.CENTER);
            rendererComponent.add( jlPrj, BorderLayout.EAST );
            
            
            jlName.setOpaque(false);
            jlPath.setOpaque(false);
            jlPrj.setOpaque(false);
            
            jlName.setFont(list.getFont());
            jlPath.setFont(list.getFont());
            jlPrj.setFont(list.getFont());
            
            
            jlPrj.setHorizontalAlignment(RIGHT);
            jlPrj.setHorizontalTextPosition(LEFT);
            
            // setFont( list.getFont() );            
            fgColor = list.getForeground();
            fgColorLighter = new Color( 
                                   Math.min( 255, fgColor.getRed() + LIGHTER_COLOR_COMPONENT),
                                   Math.min( 255, fgColor.getGreen() + LIGHTER_COLOR_COMPONENT),
                                   Math.min( 255, fgColor.getBlue() + LIGHTER_COLOR_COMPONENT)
                                  );
                            
            bgColor = list.getBackground();
            bgColorDarker = new Color(
                                    Math.abs(bgColor.getRed() - DARKER_COLOR_COMPONENT),
                                    Math.abs(bgColor.getGreen() - DARKER_COLOR_COMPONENT),
                                    Math.abs(bgColor.getBlue() - DARKER_COLOR_COMPONENT)
                            );
            bgSelectionColor = list.getSelectionBackground();
            fgSelectionColor = list.getSelectionForeground();
            
            
            bgColorGreener = new Color( 
                                    Math.abs(bgColor.getRed() - 20),
                                    Math.min(255, bgColor.getGreen() + 10 ),
                                    Math.abs(bgColor.getBlue() - 20) );
                    
                    
            bgColorDarkerGreener = new Color( 
                                    Math.abs(bgColorDarker.getRed() - 35),
                                    Math.min(255, bgColorDarker.getGreen() + 5 ),
                                    Math.abs(bgColorDarker.getBlue() - 35) );
        }
        
        public @Override Component getListCellRendererComponent( JList list,
                                                       Object value,
                                                       int index,
                                                       boolean isSelected,
                                                       boolean hasFocus) {
            
            // System.out.println("Renderer for index " + index );
            
            int height = list.getFixedCellHeight();
            int width = list.getFixedCellWidth() - 1;
            
            width = width < 200 ? 200 : width;
            
            // System.out.println("w, h " + width + ", " + height );
            
            Dimension size = new Dimension( width, height );
            rendererComponent.setMaximumSize(size);
            rendererComponent.setPreferredSize(size);
                        
            if ( isSelected ) {
                jlName.setForeground(fgSelectionColor);
                jlPath.setForeground(fgSelectionColor);
                jlPrj.setForeground(fgSelectionColor);
                rendererComponent.setBackground(bgSelectionColor);
            }
            else {
                jlName.setForeground(fgColor);
                jlPath.setForeground(fgColorLighter);
                jlPrj.setForeground(fgColor);                
                rendererComponent.setBackground( index % 2 == 0 ? bgColor : bgColorDarker );
            }
            
            if ( value instanceof FileDescription ) {
                FileDescription fd = (FileDescription)value;
                jlName.setIcon(fd.getIcon());
                jlName.setText(fd.getName());
                jlPath.setIcon(null);
                jlPath.setHorizontalAlignment(SwingConstants.LEFT);
                jlPath.setText(fd.getRelativePath().length() > 0 ? " (" + fd.getRelativePath() + ")" : " ()"); //NOI18N
                jlPrj.setText(fd.getProjectName());
                jlPrj.setIcon(fd.getProjectIcon());
                if ( !isSelected ) {
                    rendererComponent.setBackground( index % 2 == 0 ? 
                        ( fd.prefered && colorPrefered ? bgColorGreener : bgColor ) : 
                        ( fd.prefered && colorPrefered ? bgColorDarkerGreener : bgColorDarker ) );
                }
                rendererComponent.setDescription(fd);
            }
            else {
                jlName.setText( "" ); // NOI18M
                jlName.setIcon(null);
                jlPath.setIcon(Renderer.WAIT_ICON);
                jlPath.setHorizontalAlignment(SwingConstants.CENTER);
                jlPath.setText( value.toString() );
                jlPrj.setIcon(null);
                jlPrj.setText( "" ); // NOI18N
            }
            
            return rendererComponent;
        }
        
        public void stateChanged(ChangeEvent event) {
            
            JViewport jv = (JViewport)event.getSource();
            
            jlName.setText( "Sample" ); // NOI18N
            jlName.setIcon( new ImageIcon() );
            
            jList.setFixedCellHeight(jlName.getPreferredSize().height);
            jList.setFixedCellWidth(jv.getExtentSize().width);
        }
        
        public void setColorPrefered( boolean colorPrefered ) {
            this.colorPrefered = colorPrefered;
        }

     }
        

}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2010 Sun Microsystems, Inc.
 */

package org.netbeans.modules.jumpto.file;

import java.util.List;
import org.netbeans.api.project.Project;
import org.netbeans.spi.jumpto.file.FileProvider;
import org.netbeans.spi.jumpto.type.SearchType;
import org.openide.filesystems.FileObject;
import org.openide.util.Exceptions;

/**
 *
 * @author Tomas Zezula
 */
public abstract class FileProviderAccessor {

    private static volatile FileProviderAccessor instance;

    public static synchronized FileProviderAccessor getInstance() {
        if (instance == null) {
            try {
                Class.forName(FileProvider.Context.class.getName(), true, FileProviderAccessor.class.getClassLoader());
                assert instance != null;
            } catch (ClassNotFoundException cnf) {
                Exceptions.printStackTrace(cnf);
            }
        }
        assert instance != null;
        return instance;
    }

    public static void setInstance(final FileProviderAccessor theInstance) {
        assert theInstance != null;
        instance = theInstance;
    }

    public abstract FileProvider.Context createContext(String text, SearchType searchType, Project currentProject);

    public abstract void setRoot(FileProvider.Context ctx, FileObject root);

    public abstract FileProvider.Result createResult(List<? super FileDescription> result, String[] message, FileProvider.Context ctx);

    public abstract int getRetry(FileProvider.Result result);
}

Lines 45-50 Link Here

(-)a/jumpto/src/org/netbeans/modules/jumpto/file/FileSearchAction.java (-85 / +348 lines)
45		45
46	package org.netbeans.modules.jumpto.file;	46	package org.netbeans.modules.jumpto.file;
47		47
		48	import java.awt.BorderLayout;
		49	import java.awt.Color;
		50	import java.awt.Component;
		51	import java.awt.Container;
48	import java.awt.Dialog;	52	import java.awt.Dialog;
49	import java.awt.Dimension;	53	import java.awt.Dimension;
50	import java.awt.Rectangle;	54	import java.awt.Rectangle;
Lines 56-62 Link Here
56	import java.util.ArrayList;	60	import java.util.ArrayList;
57	import java.util.Collection;	61	import java.util.Collection;
58	import java.util.Collections;	62	import java.util.Collections;
		63	import java.util.Comparator;
59	import java.util.Enumeration;	64	import java.util.Enumeration;
		65	import java.util.LinkedList;
60	import java.util.List;	66	import java.util.List;
61	import java.util.logging.Level;	67	import java.util.logging.Level;
62	import java.util.logging.Logger;	68	import java.util.logging.Logger;
Lines 64-75 Link Here
64	import java.util.regex.Pattern;	70	import java.util.regex.Pattern;
65	import java.util.regex.PatternSyntaxException;	71	import java.util.regex.PatternSyntaxException;
66	import javax.swing.AbstractAction;	72	import javax.swing.AbstractAction;
		73	import javax.swing.DefaultListCellRenderer;
67	import javax.swing.DefaultListModel;	74	import javax.swing.DefaultListModel;
		75	import javax.swing.Icon;
		76	import javax.swing.ImageIcon;
68	import javax.swing.JButton;	77	import javax.swing.JButton;
		78	import javax.swing.JLabel;
69	import javax.swing.JList;	79	import javax.swing.JList;
		80	import javax.swing.JPanel;
		81	import javax.swing.JViewport;
70	import javax.swing.ListCellRenderer;	82	import javax.swing.ListCellRenderer;
71	import javax.swing.ListModel;	83	import javax.swing.ListModel;
		84	import javax.swing.SwingConstants;
72	import javax.swing.SwingUtilities;	85	import javax.swing.SwingUtilities;
		86	import javax.swing.event.ChangeEvent;
		87	import javax.swing.event.ChangeListener;
73	import org.netbeans.api.project.FileOwnerQuery;	88	import org.netbeans.api.project.FileOwnerQuery;
74	import org.netbeans.api.project.Project;	89	import org.netbeans.api.project.Project;
75	import org.netbeans.api.project.ProjectUtils;	90	import org.netbeans.api.project.ProjectUtils;
Lines 80-85 Link Here
80	import org.netbeans.modules.jumpto.type.Models;	95	import org.netbeans.modules.jumpto.type.Models;
81	import org.netbeans.modules.parsing.spi.indexing.support.IndexResult;	96	import org.netbeans.modules.parsing.spi.indexing.support.IndexResult;
82	import org.netbeans.modules.parsing.spi.indexing.support.QuerySupport;	97	import org.netbeans.modules.parsing.spi.indexing.support.QuerySupport;
		98	import org.netbeans.spi.jumpto.file.FileProvider;
		99	import org.netbeans.spi.jumpto.file.FileProviderFactory;
		100	import org.netbeans.spi.jumpto.type.SearchType;
83	import org.openide.DialogDescriptor;	101	import org.openide.DialogDescriptor;
84	import org.openide.DialogDisplayer;	102	import org.openide.DialogDisplayer;
85	import org.openide.awt.Mnemonics;	103	import org.openide.awt.Mnemonics;
Lines 87-92 Link Here
87	import org.openide.filesystems.FileUtil;	105	import org.openide.filesystems.FileUtil;
88	import org.openide.loaders.DataObject;	106	import org.openide.loaders.DataObject;
89	import org.openide.util.HelpCtx;	107	import org.openide.util.HelpCtx;
		108	import org.openide.util.ImageUtilities;
90	import org.openide.util.Lookup;	109	import org.openide.util.Lookup;
91	import org.openide.util.NbBundle;	110	import org.openide.util.NbBundle;
92	import org.openide.util.RequestProcessor;	111	import org.openide.util.RequestProcessor;
Lines 109-114 Link Here
109	private JButton openBtn;	128	private JButton openBtn;
110	private FileSearchPanel panel;	129	private FileSearchPanel panel;
111	private Dimension initialDimension;	130	private Dimension initialDimension;
		131	private Iterable<? extends FileProvider> providers;
112		132
113	public FileSearchAction() {	133	public FileSearchAction() {
114	super( NbBundle.getMessage(FileSearchAction.class, "CTL_FileSearchAction") );	134	super( NbBundle.getMessage(FileSearchAction.class, "CTL_FileSearchAction") );
Lines 135-141 Link Here
135		155
136		156
137	public ListCellRenderer getListCellRenderer( JList list ) {	157	public ListCellRenderer getListCellRenderer( JList list ) {
138	return new FileDescription.Renderer( list );	158	return new Renderer( list );
139	}	159	}
140		160
141		161
Lines 205-235 Link Here
205		225
206	private FileDescription[] getSelectedFiles() {	226	private FileDescription[] getSelectedFiles() {
207	FileDescription[] result = null;	227	FileDescription[] result = null;
208	// try {	228	panel = new FileSearchPanel(this, findCurrentProject());
209	panel = new FileSearchPanel(this, findCurrentProject());	229	dialog = createDialog(panel);
210	dialog = createDialog(panel);	230	dialog.setVisible(true);
211		231	result = panel.getSelectedFiles();
212	// Node[] arr = TopComponent.getRegistry ().getActivatedNodes();
213	// String initSearchText = null;
214	// if (arr.length > 0) {
215	// EditorCookie ec = arr[0].getCookie (EditorCookie.class);
216	// if (ec != null) {
217	// JEditorPane[] openedPanes = ec.getOpenedPanes ();
218	// if (openedPanes != null) {
219	// initSearchText = org.netbeans.editor.Utilities.getSelectionOrIdentifier(openedPanes [0]);
220	// if (initSearchText != null && org.openide.util.Utilities.isJavaIdentifier(initSearchText)) {
221	// panel.setInitialText(initSearchText);
222	// }
223	// }
224	// }
225	// }
226
227	dialog.setVisible(true);
228	result = panel.getSelectedFiles();
229
230	// } catch (IOException ex) {
231	// ErrorManager.getDefault().notify(ex);
232	// }
233	return result;	232	return result;
234	}	233	}
235		234
Lines 306-316 Link Here
306	// }	305	// }
307		306
308	private void cleanup() {	307	private void cleanup() {
309	//System.out.println("CLEANUP");
310	//Thread.dumpStack();
311		308
312	if ( dialog != null ) { // Closing event for some reson sent twice	309	if ( dialog != null ) { // Closing event for some reson sent twice
313		310	//Free SPI
		311	synchronized (this) {
		312	providers = null;
		313	}
314	// Save dialog size only when changed	314	// Save dialog size only when changed
315	final int currentWidth = dialog.getWidth();	315	final int currentWidth = dialog.getWidth();
316	final int currentHeight = dialog.getHeight();	316	final int currentHeight = dialog.getHeight();
Lines 323-330 Link Here
323	dialog.dispose();	323	dialog.dispose();
324	this.dialog = null;	324	this.dialog = null;
325	//GoToTypeAction.this.cache = null;	325	//GoToTypeAction.this.cache = null;
326
327	FileSearchOptions.flush();	326	FileSearchOptions.flush();
		327	}
		328	}
		329
		330	private Iterable<? extends FileProvider> getProviders() {
		331	synchronized (this) {
		332	if (providers != null) {
		333	return providers;
		334	}
		335	}
		336	final List<FileProvider> result = new LinkedList<FileProvider>();
		337	for (FileProviderFactory fpf : Lookup.getDefault().lookupAll(FileProviderFactory.class)) {
		338	result.add(fpf.createFileProvider());
		339	}
		340	synchronized (this) {
		341	if (providers == null) {
		342	providers = Collections.unmodifiableList(result);
		343	}
		344	return providers;
328	}	345	}
329	}	346	}
330		347
Lines 339-344 Link Here
339	private class Worker implements Runnable {	356	private class Worker implements Runnable {
340		357
341	private volatile boolean isCanceled = false;	358	private volatile boolean isCanceled = false;
		359	private volatile FileProvider currentProvider;
342		360
343	private final String text;	361	private final String text;
344	private final QuerySupport.Kind searchType;	362	private final QuerySupport.Kind searchType;
Lines 391-398 Link Here
391	if ( panel.time != -1 ) {	409	if ( panel.time != -1 ) {
392	LOGGER.fine( "Worker for text " + text + " canceled after " + ( System.currentTimeMillis() - createTime ) + " ms." );	410	LOGGER.fine( "Worker for text " + text + " canceled after " + ( System.currentTimeMillis() - createTime ) + " ms." );
393	}	411	}
		412	FileProvider provider;
394	synchronized (this) {	413	synchronized (this) {
395	isCanceled = true;	414	isCanceled = true;
		415	provider = currentProvider;
		416	}
		417	if (provider != null) {
		418	provider.cancel();
396	}	419	}
397	}	420	}
398		421
Lines 402-413 Link Here
402	case CASE_INSENSITIVE_PREFIX:	425	case CASE_INSENSITIVE_PREFIX:
403	case CASE_INSENSITIVE_REGEXP:	426	case CASE_INSENSITIVE_REGEXP:
404	searchField = FileIndexer.FIELD_CASE_INSENSITIVE_NAME; break;	427	searchField = FileIndexer.FIELD_CASE_INSENSITIVE_NAME; break;
405
406	default:	428	default:
407	searchField = FileIndexer.FIELD_NAME; break;	429	searchField = FileIndexer.FIELD_NAME; break;
408	}	430	}
409		431
410	Collection<? extends FileObject> roots = QuerySupport.findRoots((Project) null, null, Collections.<String>emptyList(), Collections.<String>emptyList());	432	final Collection<FileObject> roots = new ArrayList<FileObject>(QuerySupport.findRoots((Project) null, null, Collections.<String>emptyList(), Collections.<String>emptyList()));
411	try {	433	try {
412	QuerySupport q = QuerySupport.forRoots(FileIndexer.ID, FileIndexer.VERSION, roots.toArray(new FileObject [roots.size()]));	434	QuerySupport q = QuerySupport.forRoots(FileIndexer.ID, FileIndexer.VERSION, roots.toArray(new FileObject [roots.size()]));
413	Collection<? extends IndexResult> results = q.query(searchField, text, searchType);	435	Collection<? extends IndexResult> results = q.query(searchField, text, searchType);
Lines 430-447 Link Here
430	files.add(fd);	452	files.add(fd);
431	LOGGER.finer("Found: " + file.getPath() + ", project=" + project + ", currentProject=" + currentProject + ", preferred=" + preferred);	453	LOGGER.finer("Found: " + file.getPath() + ", project=" + project + ", currentProject=" + currentProject + ", preferred=" + preferred);
432	}	454	}
		455	if (isCanceled) {
		456	return files;
		457	}
		458
		459	final Project[] projects = OpenProjects.getDefault().getOpenProjects();
		460	final List<FileObject> sgRoots = new LinkedList<FileObject>();
		461	for (Project p : projects) {
		462	for (SourceGroup group: ProjectUtils.getSources(p).getSourceGroups(Sources.TYPE_GENERIC)) {
		463	sgRoots.add(group.getRootFolder());
		464	}
		465	}
		466	//Ask GTF providers
		467	final FileProvider.Context ctx = FileProviderAccessor.getInstance().createContext(text, toJumpToSearchType(searchType), currentProject);
		468	final FileProvider.Result fpR = FileProviderAccessor.getInstance().createResult(files,new String[1], ctx);
		469	for (FileProvider provider : getProviders()) {
		470	currentProvider = provider;
		471	try {
		472	for (FileObject root : sgRoots) {
		473	FileProviderAccessor.getInstance().setRoot(ctx, root);
		474	boolean recognized = provider.computeFiles(ctx, fpR);
		475	if (recognized) {
		476	roots.add(root);
		477	}
		478	}
		479	} finally {
		480	currentProvider = null;
		481	if (isCanceled) {
		482	return files;
		483	}
		484	}
		485	}
		486
433	//PENDING Now we have to search folders which not included in Search API	487	//PENDING Now we have to search folders which not included in Search API
434	Project[] projects = OpenProjects.getDefault().getOpenProjects();	488	Collection <FileObject> allFolders = new ArrayList<FileObject>();
435	Enumeration <? extends FileObject> projectFolders;
436	Collection <? extends FileObject> allFolders = new ArrayList<FileObject>();
437	final FileObjectFilter[] filters = new FileObjectFilter[]{SearchInfoFactory.VISIBILITY_FILTER, SearchInfoFactory.SHARABILITY_FILTER};	489	final FileObjectFilter[] filters = new FileObjectFilter[]{SearchInfoFactory.VISIBILITY_FILTER, SearchInfoFactory.SHARABILITY_FILTER};
438	for (Project p : projects) {	490	for (FileObject root : sgRoots) {
439	Sources s = ProjectUtils.getSources(p);	491	allFolders = searchSources(root, allFolders, roots, filters);
440	SourceGroup[] groups = s.getSourceGroups(Sources.TYPE_GENERIC);
441	for (SourceGroup group: groups) {
442	FileObject root = group.getRootFolder();
443	allFolders = searchSources(root, allFolders, roots, filters);
444	}
445	}	492	}
446	//Looking for matching files in all found folders	493	//Looking for matching files in all found folders
447	for (FileObject folder: allFolders) {	494	for (FileObject folder: allFolders) {
Lines 467-473 Link Here
467	}	514	}
468	}	515	}
469	}	516	}
470	Collections.sort(files, new FileDescription.FDComarator(panel.isPreferedProject(), panel.isCaseSensitive()));	517	Collections.sort(files, new FDComarator(panel.isPreferedProject(), panel.isCaseSensitive()));
471	return files;	518	return files;
472	} catch (PatternSyntaxException pse) {	519	} catch (PatternSyntaxException pse) {
473	return Collections.<FileDescription>emptyList();	520	return Collections.<FileDescription>emptyList();
Lines 475-528 Link Here
475	LOGGER.log(Level.WARNING, null, ioe);	522	LOGGER.log(Level.WARNING, null, ioe);
476	return Collections.<FileDescription>emptyList();	523	return Collections.<FileDescription>emptyList();
477	}	524	}
		525	}
478		526
479		527	private SearchType toJumpToSearchType(final QuerySupport.Kind searchType) {
480	// // TODO: Search twice, first for current project, then for all projects	528	switch (searchType) {
481	// List<TypeDescriptor> items;	529	case CAMEL_CASE:
482	// // Multiple providers: merge results	530	case CASE_INSENSITIVE_CAMEL_CASE:
483	// items = new ArrayList<TypeDescriptor>(128);	531	return org.netbeans.spi.jumpto.type.SearchType.CAMEL_CASE;
484	// String[] message = new String[1];	532	case CASE_INSENSITIVE_PREFIX:
485	// TypeProvider.Context context = TypeProviderAccessor.DEFAULT.createContext(null, text, nameKind);	533	return org.netbeans.spi.jumpto.type.SearchType.CASE_INSENSITIVE_PREFIX;
486	// TypeProvider.Result result = TypeProviderAccessor.DEFAULT.createResult(items, message);	534	case CASE_INSENSITIVE_REGEXP:
487	// if (typeProviders == null) {	535	return org.netbeans.spi.jumpto.type.SearchType.CASE_INSENSITIVE_REGEXP;
488	// typeProviders = Lookup.getDefault().lookupAll(TypeProvider.class);	536	case EXACT:
489	// }	537	return org.netbeans.spi.jumpto.type.SearchType.EXACT_NAME;
490	// for (TypeProvider provider : typeProviders) {	538	case PREFIX:
491	// if (isCanceled) {	539	return org.netbeans.spi.jumpto.type.SearchType.PREFIX;
492	// return null;	540	case REGEXP:
493	// }	541	return org.netbeans.spi.jumpto.type.SearchType.REGEXP;
494	// current = provider;	542	default:
495	// long start = System.currentTimeMillis();	543	throw new IllegalArgumentException();
496	// try {	544	}
497	// LOGGER.fine("Calling TypeProvider: " + provider);
498	// provider.computeTypeNames(context, result);
499	// } finally {
500	// current = null;
501	// }
502	// long delta = System.currentTimeMillis() - start;
503	// LOGGER.fine("Provider '" + provider.getDisplayName() + "' took " + delta + " ms.");
504	//
505	// }
506	// if ( !isCanceled ) {
507	// //time = System.currentTimeMillis();
508	// Collections.sort(items, new TypeComparator());
509	// panel.setWarning(message[0]);
510	// //sort += System.currentTimeMillis() - time;
511	// //LOGGER.fine("PERF - " + " GSS: " + gss + " GSB " + gsb + " CP: " + cp + " SFB: " + sfb + " GTN: " + gtn + " ADD: " + add + " SORT: " + sort );
512	// return items;
513	// }
514	// else {
515	// return null;
516	// }
517	}	545	}
518	} // End of Worker class	546	} // End of Worker class
519		547
520	private Collection<? extends FileObject> searchSources(FileObject root, Collection<? extends FileObject> result, Collection<? extends FileObject> exclude, FileObjectFilter[] filters) {	548	private Collection<FileObject> searchSources(FileObject root, Collection<FileObject> result, Collection<? extends FileObject> exclude, FileObjectFilter[] filters) {
521	if (root.getChildren().length == 0 \|\| exclude.contains(root) \|\| !checkAgainstFilters(root, filters)) {	549	if (root.getChildren().length == 0 \|\| exclude.contains(root) \|\| !checkAgainstFilters(root, filters)) {
522	return result;	550	return result;
523	} else {	551	} else {
524	// if (!exclude.contains(root)) {	552	// if (!exclude.contains(root)) {
525	((Collection<FileObject>)result).add(root);	553	result.add(root);
526	Enumeration<? extends FileObject> subFolders = root.getFolders(false);	554	Enumeration<? extends FileObject> subFolders = root.getFolders(false);
527	while (subFolders.hasMoreElements()) {	555	while (subFolders.hasMoreElements()) {
528	searchSources(subFolders.nextElement(), result, exclude, filters);	556	searchSources(subFolders.nextElement(), result, exclude, filters);
Lines 681-687 Link Here
681	panel.setSelectedFile();	709	panel.setSelectedFile();
682	}	710	}
683	}	711	}
684
685	}	712	}
686		713
		714	//Inner classes
		715	public static class FDComarator implements Comparator<FileDescription> {
		716
		717	private boolean usePrefered;
		718	private boolean caseSensitive;
		719
		720	public FDComarator(boolean usePrefered, boolean caseSensitive ) {
		721	this.usePrefered = usePrefered;
		722	this.caseSensitive = caseSensitive;
		723	}
		724
		725	public int compare(FileDescription o1, FileDescription o2) {
		726
		727	// If prefered prefer prefered
		728	if ( usePrefered ) {
		729	if ( o1.isFromCurrentProject() && !o2.isFromCurrentProject()) {
		730	return -1;
		731	}
		732	if ( !o1.isFromCurrentProject() && o2.isFromCurrentProject()) {
		733	return 1;
		734	}
		735	}
		736
		737	// File name
		738	int cmpr = compareStrings( o1.getFileName(), o2.getFileName(), caseSensitive );
		739	if ( cmpr != 0 ) {
		740	return cmpr;
		741	}
		742
		743	// Project name
		744	cmpr = compareStrings( o1.getProjectName(), o2.getProjectName(), caseSensitive );
		745	if ( cmpr != 0 ) {
		746	return cmpr;
		747	}
		748
		749	// Relative location
		750	cmpr = compareStrings( o1.getOwnerPath(), o2.getOwnerPath(), caseSensitive );
		751
		752	return cmpr;
		753
		754	}
		755
		756	private int compareStrings(String s1, String s2, boolean caseSensitive) {
		757	if( s1 == null ) {
		758	s1 = ""; //NOI18N
		759	}
		760	if ( s2 == null ) {
		761	s2 = ""; //NOI18N
		762	}
		763
		764
		765	return caseSensitive ? s1.compareTo( s2 ) : s1.compareToIgnoreCase( s2 );
		766	}
		767	}
		768
		769	private static class RendererComponent extends JPanel {
		770	private FileDescription fd;
		771
		772	void setDescription(FileDescription fd) {
		773	this.fd = fd;
		774	putClientProperty(TOOL_TIP_TEXT_KEY, null);
		775	}
		776
		777	@Override
778	public String getToolTipText() {
779	String text = (String) getClientProperty(TOOL_TIP_TEXT_KEY);
780	if( text == null ) {
781	if( fd != null) {
782	text = FileUtil.getFileDisplayName(fd.getFileObject());
783	}
784	putClientProperty(TOOL_TIP_TEXT_KEY, text);
785	}
786	return text;
787	}
788	}
789
790	public static class Renderer extends DefaultListCellRenderer implements ChangeListener {
791
792	public static Icon WAIT_ICON = ImageUtilities.loadImageIcon("org/netbeans/modules/jumpto/resources/wait.gif", false); // NOI18N
793
794	private RendererComponent rendererComponent;
795	private JLabel jlName = new JLabel();
796	private JLabel jlPath = new JLabel();
797	private JLabel jlPrj = new JLabel();
798	private int DARKER_COLOR_COMPONENT = 5;
799	private int LIGHTER_COLOR_COMPONENT = 80;
800	private Color fgColor;
801	private Color fgColorLighter;
802	private Color bgColor;
803	private Color bgColorDarker;
804	private Color bgSelectionColor;
805	private Color fgSelectionColor;
806	private Color bgColorGreener;
807	private Color bgColorDarkerGreener;
808
809	private JList jList;
810
811	private boolean colorPrefered;
812
813	public Renderer( JList list ) {
814
815	jList = list;
816
817	Container container = list.getParent();
818	if ( container instanceof JViewport ) {
819	((JViewport)container).addChangeListener(this);
820	stateChanged(new ChangeEvent(container));
821	}
822
823	rendererComponent = new RendererComponent();
824	rendererComponent.setLayout(new BorderLayout());
825	rendererComponent.add( jlName, BorderLayout.WEST );
826	rendererComponent.add( jlPath, BorderLayout.CENTER);
827	rendererComponent.add( jlPrj, BorderLayout.EAST );
828
829
830	jlName.setOpaque(false);
831	jlPath.setOpaque(false);
832	jlPrj.setOpaque(false);
833
834	jlName.setFont(list.getFont());
835	jlPath.setFont(list.getFont());
836	jlPrj.setFont(list.getFont());
837
838
839	jlPrj.setHorizontalAlignment(RIGHT);
840	jlPrj.setHorizontalTextPosition(LEFT);
841
842	// setFont( list.getFont() );
843	fgColor = list.getForeground();
844	fgColorLighter = new Color(
845	Math.min( 255, fgColor.getRed() + LIGHTER_COLOR_COMPONENT),
846	Math.min( 255, fgColor.getGreen() + LIGHTER_COLOR_COMPONENT),
847	Math.min( 255, fgColor.getBlue() + LIGHTER_COLOR_COMPONENT)
848	);
849
850	bgColor = list.getBackground();
851	bgColorDarker = new Color(
852	Math.abs(bgColor.getRed() - DARKER_COLOR_COMPONENT),
853	Math.abs(bgColor.getGreen() - DARKER_COLOR_COMPONENT),
854	Math.abs(bgColor.getBlue() - DARKER_COLOR_COMPONENT)
855	);
856	bgSelectionColor = list.getSelectionBackground();
857	fgSelectionColor = list.getSelectionForeground();
858
859
860	bgColorGreener = new Color(
861	Math.abs(bgColor.getRed() - 20),
862	Math.min(255, bgColor.getGreen() + 10 ),
863	Math.abs(bgColor.getBlue() - 20) );
864
865
866	bgColorDarkerGreener = new Color(
867	Math.abs(bgColorDarker.getRed() - 35),
868	Math.min(255, bgColorDarker.getGreen() + 5 ),
869	Math.abs(bgColorDarker.getBlue() - 35) );
870	}
871
872	public @Override Component getListCellRendererComponent( JList list,
873	Object value,
874	int index,
875	boolean isSelected,
876	boolean hasFocus) {
877
878	// System.out.println("Renderer for index " + index );
879
880	int height = list.getFixedCellHeight();
881	int width = list.getFixedCellWidth() - 1;
882
883	width = width < 200 ? 200 : width;
884
885	// System.out.println("w, h " + width + ", " + height );
886
887	Dimension size = new Dimension( width, height );
888	rendererComponent.setMaximumSize(size);
889	rendererComponent.setPreferredSize(size);
890
891	if ( isSelected ) {
892	jlName.setForeground(fgSelectionColor);
893	jlPath.setForeground(fgSelectionColor);
894	jlPrj.setForeground(fgSelectionColor);
895	rendererComponent.setBackground(bgSelectionColor);
896	}
897	else {
898	jlName.setForeground(fgColor);
899	jlPath.setForeground(fgColorLighter);
900	jlPrj.setForeground(fgColor);
901	rendererComponent.setBackground( index % 2 == 0 ? bgColor : bgColorDarker );
902	}
903
904	if ( value instanceof FileDescription ) {
905	FileDescription fd = (FileDescription)value;
906	jlName.setIcon(fd.getIcon());
907	jlName.setText(fd.getFileName());
908	jlPath.setIcon(null);
909	jlPath.setHorizontalAlignment(SwingConstants.LEFT);
910	jlPath.setText(fd.getOwnerPath().length() > 0 ? " (" + fd.getOwnerPath() + ")" : " ()"); //NOI18N
911	jlPrj.setText(fd.getProjectName());
912	jlPrj.setIcon(fd.getProjectIcon());
913	if ( !isSelected ) {
914	rendererComponent.setBackground( index % 2 == 0 ?
915	( fd.isFromCurrentProject() && colorPrefered ? bgColorGreener : bgColor ) :
916	( fd.isFromCurrentProject() && colorPrefered ? bgColorDarkerGreener : bgColorDarker ) );
917	}
918	rendererComponent.setDescription(fd);
919	}
920	else {
921	jlName.setText( "" ); // NOI18M
922	jlName.setIcon(null);
923	jlPath.setIcon(Renderer.WAIT_ICON);
924	jlPath.setHorizontalAlignment(SwingConstants.CENTER);
925	jlPath.setText( value.toString() );
926	jlPrj.setIcon(null);
927	jlPrj.setText( "" ); // NOI18N
928	}
929
930	return rendererComponent;
931	}
932
933	@Override
934	public void stateChanged(ChangeEvent event) {
935
936	JViewport jv = (JViewport)event.getSource();
937
938	jlName.setText( "Sample" ); // NOI18N
939	jlName.setIcon( new ImageIcon() );
940
941	jList.setFixedCellHeight(jlName.getPreferredSize().height);
942	jList.setFixedCellWidth(jv.getExtentSize().width);
943	}
944
945	public void setColorPrefered( boolean colorPrefered ) {
946	this.colorPrefered = colorPrefered;
947	}
948
949	}
687	}	950	}




 * @author  Petr Hrebejk, Andrei Badea
 */
public class FileSearchPanel extends javax.swing.JPanel implements ActionListener {

    public static final String SEARCH_IN_PROGRES = NbBundle.getMessage(FileSearchPanel.class, "TXT_SearchingOtherProjects"); // NOI18N
    private static final int BRIGHTER_COLOR_COMPONENT = 10;
    private final ContentProvider contentProvider;
    private final Project currentProject;
    private boolean containsScrollPane;

               if (model.getSize() > 0 || getText() == null || getText().trim().length() == 0 ) {
                   resultList.setModel(model);
                   resultList.setSelectedIndex(0);
                   ((FileSearchAction.Renderer) resultList.getCellRenderer()).setColorPrefered(isPreferedProject());
                   setListPanelContent(null,false);
                   if ( time != -1 ) {
                       FileSearchAction.LOGGER.fine("Real search time " + (System.currentTimeMillis() - time) + " ms.");

        else if ( message != null ) { 
           jTextFieldLocation.setText(""); 
           messageLabel.setText(message);
           messageLabel.setIcon( waitIcon ? FileSearchAction.Renderer.WAIT_ICON : null);
           if ( containsScrollPane ) {
               listPanel.remove( resultScrollPane );
               listPanel.add( messageLabel );

        if ( "selectNextRow".equals(actionKey) && 
              ( selectedIndex == modelSize - 1 ||
                ( selectedIndex == modelSize - 2 && 
                  model.getElementAt(modelSize - 1) == SEARCH_IN_PROGRES )
             ) ) {
            resultList.setSelectedIndex(0);
            resultList.ensureIndexIsVisible(0);

                   selectedIndex == 0 ) {
            int last = modelSize - 1;
            
            if ( model.getElementAt(last) == SEARCH_IN_PROGRES ) {
                last--;
            } 
            

    }        
    
    public void setSelectedFile() {
        List<FileDescription> list = new ArrayList<FileDescription>(Arrays.asList((FileDescription[])resultList.getSelectedValues()));
        selectedFile = list.toArray(new FileDescription[0]);
    }





/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2010 Sun Microsystems, Inc.
 */

package org.netbeans.spi.jumpto.file;

import java.util.List;
import org.netbeans.api.project.FileOwnerQuery;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.SourceGroup;
import org.netbeans.modules.jumpto.file.FileDescription;
import org.netbeans.modules.jumpto.file.FileProviderAccessor;
import org.netbeans.spi.jumpto.type.SearchType;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.util.Lookup;
import org.openide.util.Parameters;

/**
 * A FileProvider participates in the Goto File dialog by providing matched files
 * for given {@link SourceGroup}.
 * The FileProviders are registered in global {@link Lookup}
 *
 * @since 1.15
 * @author Tomas Zezula
 */
public interface FileProvider {

    /**
     * Compute a list of files that match the given search text for the given
     * search type. This might be a slow operation, and the infrastructure may end
     * up calling {@link #cancel} on the file provider during the operation, in which
     * case the method can return incomplete results.
     * <p>
     * Note that a useful performance optimization is for the FileProvider to cache
     * a few of its most recent search results, and if the next search (e.g. more user
     * keystrokes) is a simple narrowing of the search, just filter the previous search
     * result. The same {@link FileProvider} instance is used during the GoTo File session and
     * it's freed when the GoTo File dialog is closed.
     *
     * @param context search context containg search text, type, project and {@link SourceGroup} root
     * @param result  filled with files and optional message
     * @return returns true if the root was handled by this FileProvider. When false
     * next provider is used.
     */
    boolean computeFiles(Context context, Result result);

    /**
     * Cancel the current operation, if possible. This might be called if the user
     * has typed something (including the backspace key) which makes the current
     * search obsolete and a new one should be initiated.
     */
    void cancel();

    /**
     * Represents search context.
     * Contains search type (such as prefix, regexp), search text,
     * {@link SourceGroup} root and project where to search.
     *
     */
    public static final class Context {

        //<editor-fold defaultstate="collapsed" desc="Private data">
        private final String text;
        private final SearchType type;
        private final Project currentProject;
        private FileObject sourceGroupRoot;
        private Project project;
        //</editor-fold>

        /**
         * Returns project owning the {@link SourceGroup} root
         * @return project to search in.
         */
        public Project getProject() {
            if (project == null) {
                project = FileOwnerQuery.getOwner(this.sourceGroupRoot);
            }
            return project;
        }

        /**
         * Returns the {@link SourceGroup} root to search files in.
         * @return root to search in.
         */
        public FileObject getRoot() { return sourceGroupRoot;}

        /**
          * Return the text used for search.
          *
          * @return The text used for the search; e.g. when getSearchType() == SearchType.PREFIX,
          *   text is the prefix that all returned types should start with.
          */
        public String getText() { return text; }

        /**
         * Return the type of search.
         *
         * @return Type of search performed, such as prefix, regexp or camel case.
         */
        public SearchType getSearchType() { return type; }

        //<editor-fold defaultstate="collapsed" desc="Private methods">
        private Context(String text, SearchType type, Project currentProject) {
            Parameters.notNull("text", text);   //NOI18N
            Parameters.notNull("type", type);   //NOI18N
            this.text = text;
            this.type = type;
            this.currentProject = currentProject;
        }

        private Project getCurrentProject() {
            return currentProject;
        }

        static {
            FileProviderAccessor.setInstance(new FileProviderAccessor() {
                @Override
                public Context createContext(String text, SearchType searchType, Project currentProject) {
                    return new Context(text, searchType,currentProject);
                }
                @Override
                public Result createResult(List<? super FileDescription> result, String[] message, Context ctx) {
                    return new Result(result, message, ctx);
                }
                @Override
                public int getRetry(Result result) {
                    return result.retry;
                }

                @Override
                public void setRoot(Context ctx, FileObject root) {
                    ctx.sourceGroupRoot = root;
                    ctx.project = null;
                }
            });
        }
        //</editor-fold>
    }

    /**
     * Represents a collection of files that match
     * the given search criteria. Moreover, it can contain message
     * for the user, such as an incomplete search result.
     *
     */
    public static final class Result {

        //<editor-fold defaultstate="collapsed" desc="Private data">
        private final List<? super FileDescription> result;
        private final String[] message;
        private final Context ctx;
        private int retry;
        //</editor-fold>

        /**
         * Optional message. It can inform the user about result, e.g.
         * that result can be incomplete etc.
         *
         * @param  msg  message
         */
        public void setMessage(String msg) {
            message[0] = msg;
        }

        /**
         * Adds a file into the result
         * When the file is under processed {@link  SourceGroup} relative path
         * is displayed in the dialog. If the file is not under
         * {@link SourceGroup} absolute path is used. Never add a file owned by
         * other {@link SourceGroup}.
         * @param file The file to be added into result
         */
        public void addFile (final FileObject file) {
            Parameters.notNull("file", file);   //NOI18N

            String path = FileUtil.getRelativePath(ctx.getRoot(), file);
            if (path == null) {
                path = FileUtil.getFileDisplayName(file);
            }
            final Project prj = ctx.getProject();
            final Project curPrj = ctx.getCurrentProject();
            result.add(new FileDescription(file, path, prj,
                curPrj != null && prj != null && curPrj.getProjectDirectory() == prj.getProjectDirectory()));
        }

        /**
         * Notify caller that a provider should be called again because
         * of incomplete or inaccurate results.
         *
         * Method can be used when long running task blocks the provider
         * to complete the data.
         *
         */
        public void pendingResult() {
            retry = 2000;
        }

        //<editor-fold defaultstate="collapsed" desc="Private constructor">
        private Result(final List<? super FileDescription> result, final String[] message, final Context ctx) {
            Parameters.notNull("result", result);   //NOI18N
            Parameters.notNull("message", message); //NOI18N
            Parameters.notNull("ctx", ctx);
            this.result = result;
            this.message = message;
            this.ctx = ctx;
        }
        //</editor-fold>
    }

}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2010 Sun Microsystems, Inc.
 */

package org.netbeans.spi.jumpto.file;

/**
 * Factory to create {@link FileProvider}s
 * @since 1.15
 * @author Tomas Zezula
 */
public interface FileProviderFactory {
    /**
     * Describe this provider with an internal name, used by logging.
     * @return An internal String uniquely identifying {@link FileProvider}, such as
     * "java"
     */
    String name();

    /**
     * Describe this provider for the user, used by logging.
     * @return A display name describing the {@link FileProvider}
     */
    String getDisplayName();


    /**
     * Reurns a {@link FileProvider} used in one session of Go To File action.
     * The returned provider is freed when the Go To File dialog is closed.
     * The {@link FileProvider} may cache some data to improve performance.
     * @return a new {@link FileProvider}
     */
    FileProvider createFileProvider();
}




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2010 Sun Microsystems, Inc.
 */

package org.netbeans.spi.jumpto.file;


import java.io.File;
import java.util.LinkedList;
import java.util.List;
import org.netbeans.junit.NbTestCase;
import org.netbeans.modules.jumpto.file.FileDescription;
import org.netbeans.modules.jumpto.file.FileProviderAccessor;
import org.netbeans.spi.jumpto.type.SearchType;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;

/**
 *
 * @author Tomas Zezula
 */
public class FileProviderTest extends NbTestCase {

    private FileObject root;
    private FileObject dataFile;
    private FileObject externalDataFile;

    public FileProviderTest(final String name) {
        super(name);
    }

    @Override
    protected void setUp() throws Exception {
        super.setUp();
        clearWorkDir();
        final File cwd = getWorkDir();
        root = FileUtil.createFolder(new File(cwd,"test"));     //NOI18N
        dataFile = FileUtil.createData(root, "foo/test.txt");   //NOI18N
        externalDataFile = FileUtil.createData(FileUtil.toFileObject(cwd), "external.txt");   //NOI18N
    }

    public void testFileInSourceGroup() {
        final FileProvider.Context ctx = FileProviderAccessor.getInstance().createContext("foo", SearchType.EXACT_NAME, null);  //NOI18N
        final List<FileDescription> data = new LinkedList<FileDescription>();
        final String[] msg = new String[1];
        final FileProvider.Result result = FileProviderAccessor.getInstance().createResult(data, msg, ctx);
        FileProviderAccessor.getInstance().setRoot(ctx, root);
        final String testMsg = "Test Message";  //NOI18N
        result.addFile(dataFile);
        result.setMessage(testMsg);
        assertEquals(1, data.size());
        assertEquals(dataFile, data.iterator().next().getFileObject());
        assertEquals(dataFile.getNameExt(), data.iterator().next().getFileName());
        assertEquals(FileUtil.getRelativePath(root, dataFile), data.iterator().next().getOwnerPath());
        assertEquals(testMsg, msg[0]);

    }

    public void testExtenralFile() {
        final FileProvider.Context ctx = FileProviderAccessor.getInstance().createContext("foo", SearchType.EXACT_NAME, null);  //NOI18N
        final List<FileDescription> data = new LinkedList<FileDescription>();
        final String[] msg = new String[1];
        final FileProvider.Result result = FileProviderAccessor.getInstance().createResult(data, msg, ctx);
        FileProviderAccessor.getInstance().setRoot(ctx, root);
        final String testMsg = "Test Message";  //NOI18N
        result.addFile(externalDataFile);
        result.setMessage(testMsg);
        assertEquals(1, data.size());
        assertEquals(externalDataFile, data.iterator().next().getFileObject());
        assertEquals(externalDataFile.getNameExt(), data.iterator().next().getFileName());
        assertEquals(FileUtil.getFileDisplayName(externalDataFile), data.iterator().next().getOwnerPath());
        assertEquals(testMsg, msg[0]);
    }

}

Return to bug 183344

Lines 105-112 Link Here

(-)a/jumpto/apichanges.xml (-3 / +18 lines)
105	<!-- ACTUAL CHANGES BEGIN HERE: -->	105	<!-- ACTUAL CHANGES BEGIN HERE: -->
106		106
107	<changes>	107	<changes>
108		108	<change id="GoToFile">
109		109	<api name="general"/>
		110	<summary>Added SPI for Go to File dialog</summary>
		111	<version major="1" minor="15"/>
		112	<date day="5" month="4" year="2010"/>
		113	<author login="tzezula"/>
		114	<compatibility addition="yes">
		115	</compatibility>
		116	<description>
		117	Added SPI to allow friend modules to participate on searching files
		118	in the Go To File dialog. The supplied FileProvider can handle file
		119	search in recognized source groups.
		120	</description>
		121	<class package="org.netbeans.spi.jumpto.file" name="FileProviderFactory"/>
		122	<class package="org.netbeans.spi.jumpto.file" name="FileProvider"/>
		123	<issue number="182884"/>
		124	</change>
110	<change id="GoToSymbol">	125	<change id="GoToSymbol">
111	<api name="general"/>	126	<api name="general"/>
112	<summary>Added SPI for Go to Symbol dialog</summary>	127	<summary>Added SPI for Go to Symbol dialog</summary>
Lines 119-125 Link Here
119	Added SPI to provide content of the for Go to Symbol dialog.	134	Added SPI to provide content of the for Go to Symbol dialog.
120	</description>	135	</description>
121	<issue number="138345"/>	136	<issue number="138345"/>
122	</change>	137	</change>
123		138
124	<change id="(Provider.Result.pendingResult">	139	<change id="(Provider.Result.pendingResult">
125	<api name="general"/>	140	<api name="general"/>

Lines 215-226 Link Here

(-)a/jumpto/nbproject/project.xml (-1 / +2 lines)
215	</test-dependencies>	215	</test-dependencies>
216	<friend-packages>	216	<friend-packages>
217	<friend>org.netbeans.modules.cnd.gotodeclaration</friend>	217	<friend>org.netbeans.modules.cnd.gotodeclaration</friend>
		218	<friend>org.netbeans.modules.csl.api</friend>
218	<friend>org.netbeans.modules.gsf</friend>	219	<friend>org.netbeans.modules.gsf</friend>
219	<friend>org.netbeans.modules.java.sourceui</friend>	220	<friend>org.netbeans.modules.java.sourceui</friend>
220	<friend>org.netbeans.modules.javafx.editor</friend>	221	<friend>org.netbeans.modules.javafx.editor</friend>
221	<friend>org.netbeans.modules.spring.beans</friend>	222	<friend>org.netbeans.modules.spring.beans</friend>
222	<friend>org.netbeans.modules.csl.api</friend>
223	<package>org.netbeans.api.jumpto.type</package>	223	<package>org.netbeans.api.jumpto.type</package>
		224	<package>org.netbeans.spi.jumpto.file</package>
224	<package>org.netbeans.spi.jumpto.symbol</package>	225	<package>org.netbeans.spi.jumpto.symbol</package>
225	<package>org.netbeans.spi.jumpto.type</package>	226	<package>org.netbeans.spi.jumpto.type</package>
226	</friend-packages>	227	</friend-packages>

Line 0 Link Here

(-)a/jumpto/src/org/netbeans/modules/jumpto/file/FileProviderAccessor.java (+82 lines)
		1	/*
		2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
		3	*
		4	* Copyright 2010 Sun Microsystems, Inc. All rights reserved.
		5	*
		6	* The contents of this file are subject to the terms of either the GNU
		7	* General Public License Version 2 only ("GPL") or the Common
		8	* Development and Distribution License("CDDL") (collectively, the
		9	* "License"). You may not use this file except in compliance with the
		10	* License. You can obtain a copy of the License at
		11	* http://www.netbeans.org/cddl-gplv2.html
		12	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
		13	* specific language governing permissions and limitations under the
		14	* License. When distributing the software, include this License Header
		15	* Notice in each file and include the License file at
		16	* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
		17	* particular file as subject to the "Classpath" exception as provided
		18	* by Sun in the GPL Version 2 section of the License file that
		19	* accompanied this code. If applicable, add the following below the
		20	* License Header, with the fields enclosed by brackets [] replaced by
		21	* your own identifying information:
		22	* "Portions Copyrighted [year] [name of copyright owner]"
		23	*
		24	* If you wish your version of this file to be governed by only the CDDL
		25	* or only the GPL Version 2, indicate your decision by adding
		26	* "[Contributor] elects to include this software in this distribution
		27	* under the [CDDL or GPL Version 2] license." If you do not indicate a
		28	* single choice of license, a recipient has the option to distribute
		29	* your version of this file under either the CDDL, the GPL Version 2 or
		30	* to extend the choice of license to its licensees as provided above.
		31	* However, if you add GPL Version 2 code and therefore, elected the GPL
		32	* Version 2 license, then the option applies only if the new code is
		33	* made subject to such option by the copyright holder.
		34	*
		35	* Contributor(s):
		36	*
		37	* Portions Copyrighted 2010 Sun Microsystems, Inc.
		38	*/
		39
		40	package org.netbeans.modules.jumpto.file;
		41
		42	import java.util.List;
		43	import org.netbeans.api.project.Project;
		44	import org.netbeans.spi.jumpto.file.FileProvider;
		45	import org.netbeans.spi.jumpto.type.SearchType;
		46	import org.openide.filesystems.FileObject;
		47	import org.openide.util.Exceptions;
		48
		49	/**
		50	*
		51	* @author Tomas Zezula
		52	*/
		53	public abstract class FileProviderAccessor {
		54
		55	private static volatile FileProviderAccessor instance;
		56
		57	public static synchronized FileProviderAccessor getInstance() {
		58	if (instance == null) {
		59	try {
		60	Class.forName(FileProvider.Context.class.getName(), true, FileProviderAccessor.class.getClassLoader());
		61	assert instance != null;
		62	} catch (ClassNotFoundException cnf) {
		63	Exceptions.printStackTrace(cnf);
		64	}
65	}
66	assert instance != null;
67	return instance;
68	}
69
70	public static void setInstance(final FileProviderAccessor theInstance) {
71	assert theInstance != null;
72	instance = theInstance;
73	}
74
75	public abstract FileProvider.Context createContext(String text, SearchType searchType, Project currentProject);
76
77	public abstract void setRoot(FileProvider.Context ctx, FileObject root);
78
79	public abstract FileProvider.Result createResult(List<? super FileDescription> result, String[] message, FileProvider.Context ctx);
80
81	public abstract int getRetry(FileProvider.Result result);
82	}

Lines 75-82 Link Here

(-)a/jumpto/src/org/netbeans/modules/jumpto/file/FileSearchPanel.java (-7 / +8 lines)
75	* @author Petr Hrebejk, Andrei Badea	75	* @author Petr Hrebejk, Andrei Badea
76	*/	76	*/
77	public class FileSearchPanel extends javax.swing.JPanel implements ActionListener {	77	public class FileSearchPanel extends javax.swing.JPanel implements ActionListener {
78		78
79	private static final int BRIGHTER_COLOR_COMPONENT = 10;	79	public static final String SEARCH_IN_PROGRES = NbBundle.getMessage(FileSearchPanel.class, "TXT_SearchingOtherProjects"); // NOI18N
		80	private static final int BRIGHTER_COLOR_COMPONENT = 10;
80	private final ContentProvider contentProvider;	81	private final ContentProvider contentProvider;
81	private final Project currentProject;	82	private final Project currentProject;
82	private boolean containsScrollPane;	83	private boolean containsScrollPane;
Lines 160-166 Link Here
160	if (model.getSize() > 0 \|\| getText() == null \|\| getText().trim().length() == 0 ) {	161	if (model.getSize() > 0 \|\| getText() == null \|\| getText().trim().length() == 0 ) {
161	resultList.setModel(model);	162	resultList.setModel(model);
162	resultList.setSelectedIndex(0);	163	resultList.setSelectedIndex(0);
163	((FileDescription.Renderer) resultList.getCellRenderer()).setColorPrefered(isPreferedProject());	164	((FileSearchAction.Renderer) resultList.getCellRenderer()).setColorPrefered(isPreferedProject());
164	setListPanelContent(null,false);	165	setListPanelContent(null,false);
165	if ( time != -1 ) {	166	if ( time != -1 ) {
166	FileSearchAction.LOGGER.fine("Real search time " + (System.currentTimeMillis() - time) + " ms.");	167	FileSearchAction.LOGGER.fine("Real search time " + (System.currentTimeMillis() - time) + " ms.");
Lines 219-225 Link Here
219	else if ( message != null ) {	220	else if ( message != null ) {
220	jTextFieldLocation.setText("");	221	jTextFieldLocation.setText("");
221	messageLabel.setText(message);	222	messageLabel.setText(message);
222	messageLabel.setIcon( waitIcon ? FileDescription.Renderer.WAIT_ICON : null);	223	messageLabel.setIcon( waitIcon ? FileSearchAction.Renderer.WAIT_ICON : null);
223	if ( containsScrollPane ) {	224	if ( containsScrollPane ) {
224	listPanel.remove( resultScrollPane );	225	listPanel.remove( resultScrollPane );
225	listPanel.add( messageLabel );	226	listPanel.add( messageLabel );
Lines 445-451 Link Here
445	if ( "selectNextRow".equals(actionKey) &&	446	if ( "selectNextRow".equals(actionKey) &&
446	( selectedIndex == modelSize - 1 \|\|	447	( selectedIndex == modelSize - 1 \|\|
447	( selectedIndex == modelSize - 2 &&	448	( selectedIndex == modelSize - 2 &&
448	model.getElementAt(modelSize - 1) == FileDescription.SEARCH_IN_PROGRES )	449	model.getElementAt(modelSize - 1) == SEARCH_IN_PROGRES )
449	) ) {	450	) ) {
450	resultList.setSelectedIndex(0);	451	resultList.setSelectedIndex(0);
451	resultList.ensureIndexIsVisible(0);	452	resultList.ensureIndexIsVisible(0);
Lines 455-461 Link Here
455	selectedIndex == 0 ) {	456	selectedIndex == 0 ) {
456	int last = modelSize - 1;	457	int last = modelSize - 1;
457		458
458	if ( model.getElementAt(last) == FileDescription.SEARCH_IN_PROGRES ) {	459	if ( model.getElementAt(last) == SEARCH_IN_PROGRES ) {
459	last--;	460	last--;
460	}	461	}
461		462
Lines 513-519 Link Here
513	}	514	}
514		515
515	public void setSelectedFile() {	516	public void setSelectedFile() {
516	List<FileDescription> list = new ArrayList(Arrays.asList(resultList.getSelectedValues()));	517	List<FileDescription> list = new ArrayList<FileDescription>(Arrays.asList((FileDescription[])resultList.getSelectedValues()));
517	selectedFile = list.toArray(new FileDescription[0]);	518	selectedFile = list.toArray(new FileDescription[0]);
518	}	519	}
519		520

Line 0 Link Here

(-)a/jumpto/src/org/netbeans/spi/jumpto/file/FileProvider.java (+246 lines)
		1	/*
		2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
		3	*
		4	* Copyright 2010 Sun Microsystems, Inc. All rights reserved.
		5	*
		6	* The contents of this file are subject to the terms of either the GNU
		7	* General Public License Version 2 only ("GPL") or the Common
		8	* Development and Distribution License("CDDL") (collectively, the
		9	* "License"). You may not use this file except in compliance with the
		10	* License. You can obtain a copy of the License at
		11	* http://www.netbeans.org/cddl-gplv2.html
		12	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
		13	* specific language governing permissions and limitations under the
		14	* License. When distributing the software, include this License Header
		15	* Notice in each file and include the License file at
		16	* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
		17	* particular file as subject to the "Classpath" exception as provided
		18	* by Sun in the GPL Version 2 section of the License file that
		19	* accompanied this code. If applicable, add the following below the
		20	* License Header, with the fields enclosed by brackets [] replaced by
		21	* your own identifying information:
		22	* "Portions Copyrighted [year] [name of copyright owner]"
		23	*
		24	* If you wish your version of this file to be governed by only the CDDL
		25	* or only the GPL Version 2, indicate your decision by adding
		26	* "[Contributor] elects to include this software in this distribution
		27	* under the [CDDL or GPL Version 2] license." If you do not indicate a
		28	* single choice of license, a recipient has the option to distribute
		29	* your version of this file under either the CDDL, the GPL Version 2 or
		30	* to extend the choice of license to its licensees as provided above.
		31	* However, if you add GPL Version 2 code and therefore, elected the GPL
		32	* Version 2 license, then the option applies only if the new code is
		33	* made subject to such option by the copyright holder.
		34	*
		35	* Contributor(s):
		36	*
		37	* Portions Copyrighted 2010 Sun Microsystems, Inc.
		38	*/
		39
		40	package org.netbeans.spi.jumpto.file;
		41
		42	import java.util.List;
		43	import org.netbeans.api.project.FileOwnerQuery;
		44	import org.netbeans.api.project.Project;
		45	import org.netbeans.api.project.SourceGroup;
		46	import org.netbeans.modules.jumpto.file.FileDescription;
		47	import org.netbeans.modules.jumpto.file.FileProviderAccessor;
		48	import org.netbeans.spi.jumpto.type.SearchType;
		49	import org.openide.filesystems.FileObject;
		50	import org.openide.filesystems.FileUtil;
		51	import org.openide.util.Lookup;
		52	import org.openide.util.Parameters;
		53
		54	/**
		55	* A FileProvider participates in the Goto File dialog by providing matched files
		56	* for given {@link SourceGroup}.
		57	* The FileProviders are registered in global {@link Lookup}
		58	*
		59	* @since 1.15
		60	* @author Tomas Zezula
		61	*/
		62	public interface FileProvider {
		63
		64	/**
65	* Compute a list of files that match the given search text for the given
66	* search type. This might be a slow operation, and the infrastructure may end
67	* up calling {@link #cancel} on the file provider during the operation, in which
68	* case the method can return incomplete results.
69	* <p>
70	* Note that a useful performance optimization is for the FileProvider to cache
71	* a few of its most recent search results, and if the next search (e.g. more user
72	* keystrokes) is a simple narrowing of the search, just filter the previous search
73	* result. The same {@link FileProvider} instance is used during the GoTo File session and
74	* it's freed when the GoTo File dialog is closed.
75	*
76	* @param context search context containg search text, type, project and {@link SourceGroup} root
77	* @param result filled with files and optional message
78	* @return returns true if the root was handled by this FileProvider. When false
79	* next provider is used.
80	*/
81	boolean computeFiles(Context context, Result result);
82
83	/**
84	* Cancel the current operation, if possible. This might be called if the user
85	* has typed something (including the backspace key) which makes the current
86	* search obsolete and a new one should be initiated.
87	*/
88	void cancel();
89
90	/**
91	* Represents search context.
92	* Contains search type (such as prefix, regexp), search text,
93	* {@link SourceGroup} root and project where to search.
94	*
95	*/
96	public static final class Context {
97
98	//<editor-fold defaultstate="collapsed" desc="Private data">
99	private final String text;
100	private final SearchType type;
101	private final Project currentProject;
102	private FileObject sourceGroupRoot;
103	private Project project;
104	//</editor-fold>
105
106	/**
107	* Returns project owning the {@link SourceGroup} root
108	* @return project to search in.
109	*/
110	public Project getProject() {
111	if (project == null) {
112	project = FileOwnerQuery.getOwner(this.sourceGroupRoot);
113	}
114	return project;
115	}
116
117	/**
118	* Returns the {@link SourceGroup} root to search files in.
119	* @return root to search in.
120	*/
121	public FileObject getRoot() { return sourceGroupRoot;}
122
123	/**
124	* Return the text used for search.
125	*
126	* @return The text used for the search; e.g. when getSearchType() == SearchType.PREFIX,
127	* text is the prefix that all returned types should start with.
128	*/
129	public String getText() { return text; }
130
131	/**
132	* Return the type of search.
133	*
134	* @return Type of search performed, such as prefix, regexp or camel case.
135	*/
136	public SearchType getSearchType() { return type; }
137
138	//<editor-fold defaultstate="collapsed" desc="Private methods">
139	private Context(String text, SearchType type, Project currentProject) {
140	Parameters.notNull("text", text); //NOI18N
141	Parameters.notNull("type", type); //NOI18N
142	this.text = text;
143	this.type = type;
144	this.currentProject = currentProject;
145	}
146
147	private Project getCurrentProject() {
148	return currentProject;
149	}
150
151	static {
152	FileProviderAccessor.setInstance(new FileProviderAccessor() {
153	@Override
154	public Context createContext(String text, SearchType searchType, Project currentProject) {
155	return new Context(text, searchType,currentProject);
156	}
157	@Override
158	public Result createResult(List<? super FileDescription> result, String[] message, Context ctx) {
159	return new Result(result, message, ctx);
160	}
161	@Override
162	public int getRetry(Result result) {
163	return result.retry;
164	}
165
166	@Override
167	public void setRoot(Context ctx, FileObject root) {
168	ctx.sourceGroupRoot = root;
169	ctx.project = null;
170	}
171	});
172	}
173	//</editor-fold>
174	}
175
176	/**
177	* Represents a collection of files that match
178	* the given search criteria. Moreover, it can contain message
179	* for the user, such as an incomplete search result.
180	*
181	*/
182	public static final class Result {
183
184	//<editor-fold defaultstate="collapsed" desc="Private data">
185	private final List<? super FileDescription> result;
186	private final String[] message;
187	private final Context ctx;
188	private int retry;
189	//</editor-fold>
190
191	/**
192	* Optional message. It can inform the user about result, e.g.
193	* that result can be incomplete etc.
194	*
195	* @param msg message
196	*/
197	public void setMessage(String msg) {
198	message[0] = msg;
199	}
200
201	/**
202	* Adds a file into the result
203	* When the file is under processed {@link SourceGroup} relative path
204	* is displayed in the dialog. If the file is not under
205	* {@link SourceGroup} absolute path is used. Never add a file owned by
206	* other {@link SourceGroup}.
207	* @param file The file to be added into result
208	*/
209	public void addFile (final FileObject file) {
210	Parameters.notNull("file", file); //NOI18N
211
212	String path = FileUtil.getRelativePath(ctx.getRoot(), file);
213	if (path == null) {
214	path = FileUtil.getFileDisplayName(file);
215	}
216	final Project prj = ctx.getProject();
217	final Project curPrj = ctx.getCurrentProject();
218	result.add(new FileDescription(file, path, prj,
219	curPrj != null && prj != null && curPrj.getProjectDirectory() == prj.getProjectDirectory()));
220	}
221
222	/**
223	* Notify caller that a provider should be called again because
224	* of incomplete or inaccurate results.
225	*
226	* Method can be used when long running task blocks the provider
227	* to complete the data.
228	*
229	*/
230	public void pendingResult() {
231	retry = 2000;
232	}
233
234	//<editor-fold defaultstate="collapsed" desc="Private constructor">
235	private Result(final List<? super FileDescription> result, final String[] message, final Context ctx) {
236	Parameters.notNull("result", result); //NOI18N
237	Parameters.notNull("message", message); //NOI18N
238	Parameters.notNull("ctx", ctx);
239	this.result = result;
240	this.message = message;
241	this.ctx = ctx;
242	}
243	//</editor-fold>
244	}
245
246	}

Line 0 Link Here

(-)a/jumpto/test/unit/src/org/netbeans/spi/jumpto/file/FileProviderTest.java (+110 lines)
		1	/*
		2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
		3	*
		4	* Copyright 2010 Sun Microsystems, Inc. All rights reserved.
		5	*
		6	* The contents of this file are subject to the terms of either the GNU
		7	* General Public License Version 2 only ("GPL") or the Common
		8	* Development and Distribution License("CDDL") (collectively, the
		9	* "License"). You may not use this file except in compliance with the
		10	* License. You can obtain a copy of the License at
		11	* http://www.netbeans.org/cddl-gplv2.html
		12	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
		13	* specific language governing permissions and limitations under the
		14	* License. When distributing the software, include this License Header
		15	* Notice in each file and include the License file at
		16	* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
		17	* particular file as subject to the "Classpath" exception as provided
		18	* by Sun in the GPL Version 2 section of the License file that
		19	* accompanied this code. If applicable, add the following below the
		20	* License Header, with the fields enclosed by brackets [] replaced by
		21	* your own identifying information:
		22	* "Portions Copyrighted [year] [name of copyright owner]"
		23	*
		24	* If you wish your version of this file to be governed by only the CDDL
		25	* or only the GPL Version 2, indicate your decision by adding
		26	* "[Contributor] elects to include this software in this distribution
		27	* under the [CDDL or GPL Version 2] license." If you do not indicate a
		28	* single choice of license, a recipient has the option to distribute
		29	* your version of this file under either the CDDL, the GPL Version 2 or
		30	* to extend the choice of license to its licensees as provided above.
		31	* However, if you add GPL Version 2 code and therefore, elected the GPL
		32	* Version 2 license, then the option applies only if the new code is
		33	* made subject to such option by the copyright holder.
		34	*
		35	* Contributor(s):
		36	*
		37	* Portions Copyrighted 2010 Sun Microsystems, Inc.
		38	*/
		39
		40	package org.netbeans.spi.jumpto.file;
		41
		42
		43	import java.io.File;
		44	import java.util.LinkedList;
		45	import java.util.List;
		46	import org.netbeans.junit.NbTestCase;
		47	import org.netbeans.modules.jumpto.file.FileDescription;
		48	import org.netbeans.modules.jumpto.file.FileProviderAccessor;
		49	import org.netbeans.spi.jumpto.type.SearchType;
		50	import org.openide.filesystems.FileObject;
		51	import org.openide.filesystems.FileUtil;
		52
		53	/**
		54	*
		55	* @author Tomas Zezula
		56	*/
		57	public class FileProviderTest extends NbTestCase {
		58
		59	private FileObject root;
		60	private FileObject dataFile;
		61	private FileObject externalDataFile;
		62
		63	public FileProviderTest(final String name) {
		64	super(name);
65	}
66
67	@Override
68	protected void setUp() throws Exception {
69	super.setUp();
70	clearWorkDir();
71	final File cwd = getWorkDir();
72	root = FileUtil.createFolder(new File(cwd,"test")); //NOI18N
73	dataFile = FileUtil.createData(root, "foo/test.txt"); //NOI18N
74	externalDataFile = FileUtil.createData(FileUtil.toFileObject(cwd), "external.txt"); //NOI18N
75	}
76
77	public void testFileInSourceGroup() {
78	final FileProvider.Context ctx = FileProviderAccessor.getInstance().createContext("foo", SearchType.EXACT_NAME, null); //NOI18N
79	final List<FileDescription> data = new LinkedList<FileDescription>();
80	final String[] msg = new String[1];
81	final FileProvider.Result result = FileProviderAccessor.getInstance().createResult(data, msg, ctx);
82	FileProviderAccessor.getInstance().setRoot(ctx, root);
83	final String testMsg = "Test Message"; //NOI18N
84	result.addFile(dataFile);
85	result.setMessage(testMsg);
86	assertEquals(1, data.size());
87	assertEquals(dataFile, data.iterator().next().getFileObject());
88	assertEquals(dataFile.getNameExt(), data.iterator().next().getFileName());
89	assertEquals(FileUtil.getRelativePath(root, dataFile), data.iterator().next().getOwnerPath());
90	assertEquals(testMsg, msg[0]);
91
92	}
93
94	public void testExtenralFile() {
95	final FileProvider.Context ctx = FileProviderAccessor.getInstance().createContext("foo", SearchType.EXACT_NAME, null); //NOI18N
96	final List<FileDescription> data = new LinkedList<FileDescription>();
97	final String[] msg = new String[1];
98	final FileProvider.Result result = FileProviderAccessor.getInstance().createResult(data, msg, ctx);
99	FileProviderAccessor.getInstance().setRoot(ctx, root);
100	final String testMsg = "Test Message"; //NOI18N
101	result.addFile(externalDataFile);
102	result.setMessage(testMsg);
103	assertEquals(1, data.size());
104	assertEquals(externalDataFile, data.iterator().next().getFileObject());
105	assertEquals(externalDataFile.getNameExt(), data.iterator().next().getFileName());
106	assertEquals(FileUtil.getFileDisplayName(externalDataFile), data.iterator().next().getOwnerPath());
107	assertEquals(testMsg, msg[0]);
108	}
109
110	}