Changeset 266 for trunk/SRC/Utilities/xfile.pro

Timestamp:

08/24/07 14:27:48 (17 years ago)

Author:

pinsard

Message:

bug fix and diagnostics improvements in xfile and xhelp. see 65. typo in some pro files

File:

• trunk/SRC/Utilities/xfile.pro (modified) (2 diffs)

trunk/SRC/Utilities/xfile.pro

@@ -8 +8 @@
 ;
 ; @categories
-; Utilities
+; Utilities Widget
 ;
-; @param FILENAME {in}{required}
+; @param FILENAME {in}{required} {type=scalar string}
 ; It is the name of the procedure or of the function
 ; we want to display (with or without .pro at the end).
+; FILENAME should be located in !path.
+; ".pro" suffix will be appended if needed.
 ;
 ; @keyword _EXTRA
 ; Used to pass keywords to <proidl>XDISPLAYFILE</proidl>
+;
+; @restrictions
+; Triggers the <proidl>XMANAGER</proidl> if it is not already in use.
 ;
 ; @examples
@@ -34 +39 @@
   compile_opt idl2, strictarrsubs
 ;
+  usage="xfile, filename, _EXTRA = ex"
+;
+; check parameters
+  check_param = N_PARAMS()
+  if (check_param EQ 0) then begin
+     dummy = report(['No input parameter', $
+                     'Usage : ' + usage])
+     return
+  endif
+;
+; check arguments
+  if arg_present(filename) then begin
+     dummy = report(['No input parameter filename', $
+                     'Usage : ' + usage])
+     return
+  endif
+;
 ; Are we sure filename is a string?
    intype = size(filename, /type)
    if intype NE 7 then begin
-      dummy = report('Input parameter must be a string and not a '+size(filename, /tname))
+      dummy = report(['Input parameter filename type : ' + size(filename,/TNAME) , $
+                      'Input parameter filename must be a string'])
       return
    endif
+;
 ; find the file and display it!
    pfile = find(filename, /first_found)
-   IF pfile NE 'NOT_FOUND' THEN xdisplayfile, pfile[0], _extra = ex $
-   ELSE dummy = report(filename + ' does not exist ...')
-
+   if (pfile NE 'NOT FOUND') then begin
+     xdisplayfile, pfile[0], _EXTRA = ex
+   endif else begin
+     dummy = report(['Input parameter filename : ' + filename, $
+                     filename + ' does not exist ...'])
+   endelse
+;
    return
 end