Changeset 11 for trunk/Utilities/isafile.pro

Timestamp:

04/27/06 11:05:35 (18 years ago)

Author:

pinsard

Message:

upgrade of UTILITAIRE/Utilities according to cerbere.lodyc.jussieu.fr: /usr/home/smasson/SAXO_RD/ : files

File:

• trunk/Utilities/isafile.pro (moved) (moved from trunk/UTILITAIRE/isafile.pro) (2 diffs)

trunk/Utilities/isafile.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:isafile
+; NAME: isafile
 ;
-; PURPOSE:find a file and check if it is a real file!
+; PURPOSE: same as find.pro except that as long as the file is 'NOT FOUND',
+;          isafile calls dialog_pickfile, to ask the user to select a file.
 ;
-; CATEGORY:for open
+; CATEGORY: io
 ;
-; CALLING SEQUENCE:filename = isafile()
+; CALLING SEQUENCE:filename = isafile([filein])
 ; 
-; INPUTS:none
+; INPUTS:optional:a proposed name. If neither filein
+;        input parameter of filename keyword are defined,
+;        the ask the user to choose a file.
 ;
 ; KEYWORD PARAMETERS:
-;       FILENAME: a proposed filename.
-;       IODIRECTORY: a directory where must be the file.
-;       /NEW:to specify that filename is a new file
 ;
-; OUTPUTS:the filename
+;     FILENAME: a proposed filename.
+;
+;     IODIRECTORY: a directory where we look for the file. this
+;           keyword is taken into account only if the dirmame
+;           of filein or filename is '.'
+;
+;     /NEW:to specify that filename is a new file and that
+;        we should check only its path
+;
+;     RECURSIVE: performs recursive searching of directory hierarchies.
+;        In a recursive search, find looks recursively for any and all 
+;        subdirectories in the file hierarchy rooted at the IODIRECTORY
+;        argument. 
+;
+;     all find, file_search and dialog_pickfile keywords (like title)
+;
+; OUTPUTS:the filename with its path
 ;
 ; COMMON BLOCKS:none
@@ -28 +44 @@
 ; EXAMPLE:
 ;
+;  IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro')
+;  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
+;  IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD/Commons')
+;  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
+;  IDL> print, isafile('cm_4mesh.pro', iodir = !path)
+;  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
+;  IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD', /recursive)
+;  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
+;  IDL> print, isafile('cm_4mesh.pro', iodir = getenv('HOME'), /recursive)
+;  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
+;  IDL> print, isafile('fake_file.pro')
+;
 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      11/2/2000
+; June 2005: Sebastien Masson: cleaning, use for file_* functions
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-FUNCTION isafile, FILENAME = filename, IODIRECTORY = iodirectory, FILTER = filter, NEW = new
+FUNCTION isafile, filein, FILENAME = filename, IODIRECTORY = iodirectory $
+                  , NEW = new, RECURSIVE = RECURSIVE, _extra = ex
 ;------------------------------------------------------------
-; we find the filename.
-;------------------------------------------------------------
-; is filename given by the FILENAME keyword a good one?
-; si iodirectory n''est pas definit on l''initialise au repertoire courant
-   if NOT keyword_set(filename) then filename = 'nimportequoi'
-   thisOS = strupcase(strmid(!version.os_family, 0, 3))
-   CASE thisOS OF 
-      'MAC':sep = ':'
-      'WIN':sep = '\'
-      ELSE:sep = '/'
-   ENDCASE
-; we complete filename by iodirectory?
-   if strpos(filename, sep) EQ -1 then begin
-      if NOT keyword_set(iodirectory) then cd, current = iodirectory
-; si iodirectory ne finit pas par sep on le rajoute
-      if rstrpos(iodirectory, sep) NE strlen(iodirectory)-1 then $
-       iodirectory = iodirectory+sep
-      filename = iodirectory+filename
-   ENDIF
-   if keyword_set(new) then return, filename
-   test = findfile(filename)    ; le nom cherche correspond bien a un fichier?
-   while test[0] EQ '' OR n_elements(test) GT 1 do BEGIN ; on en cherche un tant qu''il ne correspond a rien!
-      test = test[0]
-      if keyword_set(filter) AND thisOS NE 'MAC' AND thisOS NE 'WIN' then $
-       filename = dialog_pickfile(path = iodirectory, filter = filter) $
-       ELSE filename = dialog_pickfile(path = iodirectory)
-      if filename EQ '' then return, report('read_data canceled')
-      test = findfile(filename)
-   endwhile
-
-   return, filename
-end
+  CASE 1 OF
+    (size(filein, /type))[0] EQ 7:fileout = filein
+    keyword_set(filename):fileout = filename
+    ELSE:fileout = 'file that is not existing'
+  ENDCASE
+  if size(fileout, /type) NE 7 THEN return, -1
+;
+  basename = file_basename(fileout)
+  dirname = file_dirname(fileout)
+; should we redefine dirname?
+  if keyword_set(iodirectory) AND dirname EQ '.' then dirname = iodirectory
+;
+  if keyword_set(new) then return, dirname + path_sep() + basename
+;
+  fileout = find(basename, iodirectory = dirname $
+                 , recursive = recursive, /unique, /firstfound, _extra = ex)
+  WHILE fileout[0] EQ 'NOT FOUND' DO BEGIN
+    fileout = dialog_pickfile(path = dirname[0], _extra = ex)
+    if fileout EQ '' THEN RETURN, report('check/find file canceled')
+; check again everything...
+    basename = file_basename(fileout)
+    dirname = file_dirname(fileout)
+; check if the name of the dirname is ok
+    dirname = isadirectory(dirname, title = 'choose a directory for the file ' $
+                           + basename)
+; if we cancel the check
+    IF size(dirname, /type) NE 7 THEN return, report('check/find file canceled')
+    fileout = find(basename, iodirectory = dirname $
+                   , recursive = recursive, /unique, /firstfound, _extra = ex)
+  ENDWHILE
+;
+  RETURN, fileout
+END