Changeset 239 for trunk/SRC/Utilities/xhelp.pro

Timestamp:

03/28/07 08:50:03 (17 years ago)

Author:

smasson

Message:

cleaning + minor bugfix related to the path definition

File:

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

trunk/SRC/Utilities/xhelp.pro

@@ -9 +9 @@
 ; @param FILENAME {in}{required}
 ; A scalar string that contains the filename of the file to display.
-; If FILENAME does not include a complete path specification, xhelp will
-; search for the file in the current working directory and then each of the
-; directories listed in !PATH environment variable.  The
-; ".pro" file suffix will be appended if it is not supplied.
+; Filename should be located in !path.
+; ".pro" suffix will be appended if needed.
 ;
 ; @keyword _EXTRA
-; Used to pass keywords
+; Used to pass keywords to <proidl>xdisplayfile</proidl>
 ;
 ; @restrictions
@@ -45 +43 @@
 
 ; Are we sure filename is a string?
-   cquoidonc = size(filename, /type)
-   if cquoidonc NE 7 then begin
-      ras = report('Input parameter must be a string and not a '+size(filename, /tname))
+   intype = size(filename, /type)
+   if intype NE 7 then begin
+      dummy = report('Input parameter must be a string and not a '+size(filename, /tname))
       return
    endif
-; We have to find the full name
-   pfile=FILENAME
-   if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro"
-   thisOS = strupcase(strmid(!version.os_family, 0, 3))
-   CASE thisOS of
-      'MAC':BEGIN & sep = ':' & pathsep = ',' & end
-      'WIN':BEGIN & sep = '\' & pathsep = ';' & end
-      ELSE: BEGIN & sep = '/' & pathsep = ':' & end
-   ENDCASE
-   cd, current = current
-   if strpos(pfile,sep) lt 0 then BEGIN
-      if rstrpos(current,sep) NE strlen(current)-1 then current = current+sep
-      multipath = str_sep(!path,pathsep)
-      if rstrpos(multipath[0],sep) NE strlen(multipath[0])-1 then multipath = multipath +sep
-      pfile = [current, multipath]+ pfile
-   ENDIF
-; We test each possible name to find where the file is.
-   nfile=n_elements(pfile)
-   n = 0
-   repeat begin
-      res = findfile(pfile[n])
-      n = n+1
-   endrep until res[0] NE '' OR n EQ n_elements(pfile)
-   if res[0] NE '' then BEGIN
-      openr, unit,pfile[n-1], /get_lun ; opening of the file
-; we select the heading piece
-      a = strarr(1000)          ;Maximum # of lines
-      xsize=0
-      i = 0
-      c = ''
-      readon=0
-      while not eof(unit) do begin
-         readf,unit,c
-         if strpos(c,';-') eq 0 then readon=0
-         if readon then BEGIN
-            dum=where(byte(c) eq 9b,ntab) ; count tab characters
-            xsize=xsize > (strlen(c)+8*ntab)
-            a[i] = strmid(c,1,200)
-            i = i + 1
-         endif
-         if strpos(c,';+') eq 0 then readon=1
-      endwhile
-      if i EQ 0 then $
-         ras = report('file is badly written, no header ... Use xfile') ELSE BEGIN
-         a = a[0:i-1]
-; we wrote the a's content in a widget
-         xdisplayfile,'toto',text = a,title=pfile[n-1], _extra = ex
-      ENDELSE
-      FREE_LUN, unit         ;free the file unit.
-   ENDIF ELSE ras = report(filename + ' does not exist ...')
+; find the file and display it!
+   pfile = (find(filename, /first_found))[0]
+; read it
+   IF pfile NE 'NOT_FOUND' THEN BEGIN 
+     fulltext = getfile(pfile)
+; find the ";+"and ";-"
+     start = where(stregex(fulltext,'^ *;\+ *$', /boolean) EQ 1, cnt1)
+     ending = where(stregex(fulltext,'^ *;- *$', /boolean) EQ 1, cnt2)
+     IF cnt1 EQ 0 OR cnt1 NE cnt2 THEN BEGIN
+       dummy = report('file '+pfile+' is badly written, no proper header found... Use xfile')
+       return
+     ENDIF
+; do we have hidden parts?
+     hide = where(stregex(fulltext, '^ *; *@hidden *$', /boolean) EQ 1)
+; buid the text to display
+     header = ''
+     sepbloc = ['', string(replicate(byte('='), 60)), '']
+     FOR i = 0, cnt1-1 DO BEGIN
+; is this part hidden ?
+       st = start[i]
+       ed = ending[i]
+       IF st NE ed +1 THEN BEGIN ; non-empty bloc
+         dummy = where(hide GT st AND hide LT ed, cnt)
+       IF cnt EQ 0 THEN header = [header, '', sepbloc, fulltext[st+1:ed-1]]
+       ENDIF
+     ENDFOR
+; remove the fisrt useless lines
+     IF n_elements(header) GT 1 THEN header = header[4:*] ELSE BEGIN 
+       dummy = report('file '+pfile+' has empty header... Use xfile')
+       return
+     ENDELSE
+;     
+     xdisplayfile, 'dummy', text = header[1:*], title = pfile, _extra = ex
+;
+   ENDIF ELSE dummy = report(filename + ' does not exist ...')
 
    return