Changeset 128 for trunk/SRC/Utilities/find.pro

Timestamp:

07/06/06 16:32:02 (18 years ago)

Author:

pinsard

Message:

improvements of Utilities/*.pro header

File:

• trunk/SRC/Utilities/find.pro (modified) (8 diffs, 2 props)

trunk/SRC/Utilities/find.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; @file_comments based on file_search, but it is possible to specify
-;          a set of possibles names and a different set of
-;          possibles directories names.
-;          By default look for files included in !path
+; @file_comments
+; based on file_search, but it is possible to specify
+; a set of possibles names and a different set of
+; possibles directories names.
+; By default look for files included in !path
+;
+; all file_search keywords can be used.
 ;
 ; @categories find a file
@@ -21 +24 @@
 ;
 ; @keyword IODIRECTORY {default=!path} A scalar or array variable of string type, containing
-;        directories names where we are looking for the file.  
+;        directories names where we are looking for the file.
 ;        Different directories can be separated by
 ;        path_sep(/search_path) (':' on unix type machine) as it is done
@@ -39 +42 @@
 ;
 ; @keyword RECURSIVE performs recursive searching of directory hierarchies.
-;        In a recursive search, find looks recursively for any and all 
+;        In a recursive search, find looks recursively for any and all
 ;        subdirectories in the file hierarchy rooted at the IODIRECTORY
-;        argument. 
+;        argument.
 ;
 ; @keyword REPERTOIRE obsolete. keep for compatibility, use directory keyword
@@ -50 +53 @@
 ; @keyword _EXTRA used to pass your keywords
 ;
-; @file_comments all file_search keywords can be used.
 ;
 ; @returns A scalar or array variable of string type, containing the
@@ -57 +59 @@
 ;       the scalar string : 'NOT FOUND'
 ;
-; @examples 
+; @examples
 ;
-;   IDL> print, find('*loadct')  
+; IDL> print, find('*loadct')
 ;   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
 ;   /usr/local/rsi/idl_6.0/lib/loadct.pro
-;   IDL> print, find('*loadct', iodir=!dir,/recursive)
+; IDL> print, find('*loadct', iodir=!dir,/recursive)
 ;   /usr/local/rsi/idl_6.0/lib/loadct.pro
 ;   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
-;   IDL> print, find('*loadct.pro')  
+; IDL> print, find('*loadct.pro')
 ;   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
 ;   /usr/local/rsi/idl_6.0/lib/loadct.pro
-;   IDL> print, find('*loadct',/nopro)  
+; IDL> print, find('*loadct',/nopro)
 ;   NOT FOUND
-;   IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib')  
+; IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib')
 ;   /usr/local/rsi/idl_6.0/lib/loadct.pro
-;   IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write)  
+; IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write)
 ;   NOT FOUND
-;   IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive)  
+; IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive)
 ;   /usr/local/rsi/idl_6.0/lib/loadct.pro
 ;   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
-;   IDL> print, find('mesh*', iodirectory = [iodir, !path])
+; IDL> print, find('mesh*', iodirectory = [iodir, !path])
 ;   /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc
 ;   /Users/sebastie/IDL/meshmaskclosesea.pro
@@ -103 +105 @@
 ;
   CASE 1 OF
-    keyword_set(lookalldir):BEGIN 
+    keyword_set(lookalldir):BEGIN
 @cm_general
       dirnames = [iodir, homedir, !path]
@@ -142 +144 @@
     ENDCASE
 ; use dirnames only if dir eq '.'
-    IF dir EQ  '.' THEN BEGIN 
+    IF dir EQ  '.' THEN BEGIN
       if keyword_set(recursive) THEN $
         found = file_search(dirnames, base, _extra = ex) $
         ELSE found = file_search(dirnames + '/' + base, _extra = ex)
     ENDIF ELSE found = file_search(dir + '/' + base, _extra = ex)
-    IF found[0] NE '' THEN BEGIN 
-      IF keyword_set(firstfound) THEN BEGIN 
+    IF found[0] NE '' THEN BEGIN
+      IF keyword_set(firstfound) THEN BEGIN
         IF keyword_set(unique) THEN return, found[uniq(found, sort(found))] $
         ELSE return, found
@@ -158 +160 @@
   ELSE fileout = fileout[1:*]
 ;
-  IF n_elements(fileout) GT 1 THEN BEGIN 
+  IF n_elements(fileout) GT 1 THEN BEGIN
     IF keyword_set(unique) THEN fileout = fileout[uniq(fileout, sort(fileout))]
   ENDIF ELSE fileout = fileout[0]