/*
    * Fsgrep is a simple Java application which allows a user to
    * search all files in a directory structure for lines matching
    * a given pattern.  Its functionality is a combination of the
    * Unix 'find' and 'grep' utilities.
    * Visit [http://fsgrep.sourceforge.net/] for more information.
    * 
    * Copyright (C) 2003-2006 Murali Krishnan [murali_ca_us@users.sourceforge.net]
    * 
   * Fsgrep is free software; you can redistribute it and/or modify
   * it under the terms of version 2 of the GNU General Public
   * License as published by the Free Software Foundation.
   * 
   * Fsgrep is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU General Public License
   * along with Fsgrep (see the file named LICENSE.txt); if not, write
   * to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
   * Boston, MA  02111-1307  USA
   */
  
  package mk.fsgrep.find;
  
  
  import java.io.*;
  import java.util.*;
  
  import mk.fsgrep.Fsgrep;
  import mk.fsgrep.util.output.OutputDestination;
  import mk.fsgrep.util.ResultCounter;
  import mk.fsgrep.util.TargetFile;
  import mk.fsgrep.util.Timer;
  
  
  /***
   * The agent which collects the list of files to search.
   * 
   * @author  Murali Krishnan
   *
   */
  public class Finder {
  
      //------------------------------------------------------------
      //- Class Variables
  
  
  
      //------------------------------------------------------------
      //- Class Functions
  
  
  
      //------------------------------------------------------------
      //- Instance Variables
  
      private Fsgrep _model = null;
      private ScanProfile _profile = null;
      private Collection<TargetFile> _fileList = new TreeSet<TargetFile>();
      private LinkedList<File> _remaining = new LinkedList<File>();
      private ResultCounter _fileCount = new ResultCounter();
  
  
  
      //------------------------------------------------------------
      //- Constructors
  
      public Finder(Fsgrep pModel, ScanProfile pProfile) {
          _model = pModel;
          _profile = pProfile;
      }
  
  
      protected Finder() {
      }
  
  
      //------------------------------------------------------------
      //- Accessors
  
      protected Fsgrep getModel() {return _model;}
      protected LinkedList<File> getRemaining() {return _remaining;}
      public Collection<TargetFile> getFileList() {return _fileList;}
      public ScanProfile getProfile() {return _profile;}
      public ResultCounter getFileCount() {return _fileCount;}
  
  
  
      //------------------------------------------------------------
      //- Settors
  
      public void setFileCount(ResultCounter val) {_fileCount=val;}
      public void setProfile(ScanProfile val) {_profile = val;}
  
  
  
      //------------------------------------------------------------
     //- Delegators
 
     public File getRoot() {return getProfile().getRoot();}
 
     protected FilenameFilter getFilter() {return getProfile().getFilter();}
 
     protected OutputDestination getReportOutput() {return getModel().getReportOutput();}
 
     protected OutputDestination getStatusOutput() {return getModel().getStatusOutput();}
 
 
     //------------------------------------------------------------
     //- Private/Protected Utility Functions
 
     protected synchronized void addFiles(File[] files) {
         if (files != null) {
             for (File file : files) {
                 getFileList().add(new TargetFile(file));
             }
 
             getFileCount().increment(files.length);
         }
     }
 
 
     protected synchronized void addSubDirs(File[] subdirs) {
         if (subdirs != null) {
             for (File subdir : subdirs) {
                 getRemaining().addFirst(subdir);
             }
         }
     }
 
 
     //------------------------------------------------------------
     //- Public Interface Functions
 
     public String toString() {
         // String result = "Finder[" + getProfile() + "]";
         String spec = "";
         if (getProfile() != null) {
             spec = getProfile().createSpecification();
         }
         String result = "Finder[" + spec + "]";
 
         return result;
     }
 
 
     public String toProfileString() {
         String result = "[no profile]";
 
         if (getProfile() != null) {
             result = getProfile().createSpecification();
         }
 
         return result;
     }
 
 
     public synchronized void reset() {
         getFileList().clear();
         getRemaining().clear();
         getFileCount().reset();
     }
 
 
     public void scan() {
         reset();
         getStatusOutput().print("Looking for files ...");
 
         getRemaining().addFirst(getRoot());
 
         Timer timer = new Timer();
         int numberDirsExamined = 0;
 
         getReportOutput().print("Scanning directories for files ...");
 
         while (!getModel().isAborted() && !getRemaining().isEmpty()) {
             File dir = getRemaining().removeFirst();
             ++numberDirsExamined;
             DirScan scan = new DirScan(this, dir);
             scan.run();
         }
 
         getReportOutput().println(" examined " + numberDirsExamined + " directories.");
 
         timer.stop();
         long total = timer.getTotal();
         int count = getFileList().size();
         double avg = timer.findAverage(count);
 
         getReportOutput().println("Scan time: " + total + " ms, " +
                                   count + " files, " + avg + " ms per file.");
 
         // If it was aborted before finishing, then reset everything to
         // ensure no partial data.
         if (!getRemaining().isEmpty()) {
             reset();
         }
     }
 
 
     //------------------------------------------------------------
     //- Class Interface Functions
 
 
 
     //------------------------------------------------------------
     //- Inner Classes
 
 
 
     //------------------------------------------------------------
     //- Main
 
 
 
 }