;+
; Project     : SSW      
;                   
; Name        : CONCAT_DIR
;               
; Purpose     : To concatenate directory and file names for current os.
;               
; Explanation : The given file name is appended to the given directory
;               name with the format appropriate to the current operating
;               system. Can be also used to append two directory names
;               
; Use         : IDL> full_name = concat_dir(directory,filename)
;               IDL> pixfile = concat_dir('$DIR_GIS_MODEL','pixels.dat')
;
;               IDL> file = ['f1.dat','f2.dat','f3.dat']
;               IDL> dir = '$DIR_NIS_CAL'
;               IDL> f = concat_dir(dir,file)
;
; Inputs      : DIRECTORY           the directory path (string)
;               FILE                the basic file name and extension (string)
;                                   can be an array of filenames or directory
;                                   names
;
; Opt. Inputs : None
;               
; Outputs     : The function returns the concatenated string.  If the file 
;               input is a string array then the output will be a string 
;               array also.
;               
; Keywords    : DIR -- If set, the second argument is treated as a directory
;                      name instead of a file name (it has no effect if not
;                      under VMS system)
;               CHECK -- Check the validity of directory name(s) if set
;               NOTRANSLATE - bypass translation of environmental/logicals
;
; Calls       : CHK_DIR, BELL, BREAK_PATH, OS_FAMILY, GET_LOGENV, ARR2STR, STR_SEP
;               
; Restrictions: Assumes Unix type format if os is not VMS or windows.
;               
; Side effects: None
;               
; Category    : Utilities, Strings
;               
; Prev. Hist. : Yohkoh routine by M. Morrison
;
; Written     : CDS version by C D Pike, RAL, 19/3/93
;               
; Modified    : 
;       Version 2, Liyun Wang, GSFC/ARC, January 3, 1995
;          Made it capable of concatenating directory names
;          Added keywords CHECK and DIR for output
;	Version 3, William Thompson, GSFC, 3 May 1995
;		Modified so spurious $ characters in front of VMS logical names
;		are ignored.  This makes it easier to port software written for
;		Unix to VMS.
;	Version 4, William Thompson, GSFC, 29 August 1995
;		Modified to use OS_FAMILY.
;
;       Version 5, Samuel Freeland, GSFC, 21-February 1996
;               Merge SLF change to Decode Environmental/Logicals
;       Version 5.1, Samuel Freeland, LPARL, 12-mar-1996
;		restore /NOTRANS keyword
;	Version 5.2, RAS, HSTX, 20-Jun-1996, protect against '..' from concealed 
;		directories in VMS
;       Version 5.3 J. Newmark, 03-Jun-1998, changed loops to long integer
;	Version 6, 14-Jan-1999, William Thompson, GSFC
;		Automatically decode environment variables starting with "$" in
;		the Windows.  Treat case where dirname ends in '/' in Windows.
;               
; VERSION:
;       Version 6, 14-Jan-1999
;-            
;
FUNCTION concat_dir, dirname, filnam, check=check, dir=dir, notranslate=notranslate
;
;  Check number of parameters
;
   IF N_PARAMS() LT 2 THEN BEGIN
      PRINT,' ' & bell
      PRINT,'Use:   out_string = concat_dir( directory, filename)'
      PRINT,' ' 
      RETURN,''
   ENDIF
;
;  remove leading/trailing blanks
;
   dir0 = STRTRIM(dirname, 2)
   n_dir = N_ELEMENTS(dir0)

;  --------- S.L.Freeland, 22-feb-1995 / Decode Logicals/Environment -----
   check=keyword_set(check)			; set boolean,s.l.f, 22-feb-1995

   envchk=get_logenv(dir0,outenv=outenv)   ; translate logical/environ
   envs=where(envchk ne '',envcnt)

   if envcnt gt 0 then begin
      case 1 of
         keyword_set(notranslate): dir0(envs)=outenv
         else: dir0(envs)=envchk(envs)
      endcase
   endif
;  ----------------------------------------------------------------------
;
;  act according to operating system
;
   IF (!version.os EQ 'vms') THEN BEGIN
      i = 0
      wnot3 = strpos( dir0,'...]')
      w2per = (strpos( dir0,'..') ne -1) and (strpos(dir0,'...') eq -1) 
      while i lt n_dir DO BEGIN
;
;  Call BREAK_PATH to make sure that a leading dollar sign is not a problem.
;  If more than one directory is returned, then only use the first one.  (Note
;  that the first entry in the array returned by break_path is always the null
;  path.
;
	 dir0(i) = (break_path(dir0(i)))(1)
;
;  ------------- RAS, 20-jun-1996  / protect against concealed file's period
;
         if wnot3(i) eq -1 then dir0(i) = arr2str( str_sep( dir0(i),'.]'),']')
         if w2per(i) then dir0(i) = arr2str( str_sep( dir0(i),'..'),'.')
         IF check THEN BEGIN
            IF NOT chk_dir(dir0(i)) THEN MESSAGE,/cont,$
                  'Warning: directory '+dir0(i)+' does not exist'
         ENDIF
         last = STRMID(dir0(i), STRLEN(dir0(i))-1,1)
         IF ((last NE ']') AND (last NE ':')) THEN BEGIN 
            dir0(i) = dir0(i) + ':' ;append an ending ':'
         ENDIF
	 i = i + 1
      ENDwhile
;
;  Under Windows, if the directory starts with a dollar sign, then check to see
;  the if it's really an environment variable.  If it is, then substitute the
;  the environment variable for the directory name.
;
   ENDIF ELSE IF OS_FAMILY() EQ 'Windows' THEN BEGIN
      FOR i = 0l, n_dir-1 DO BEGIN
	 FIRST = STRMID(DIR0(I), 0, 1)
	 IF FIRST EQ '$' THEN BEGIN
	     SLASH = STRPOS(DIR0(I)+'/','/') < STRPOS(DIR0(I)+'\','\')
	     TEST = GETENV(STRMID(DIR0(I),1,SLASH-1))
	     IF TEST NE '' THEN BEGIN
		 IF STRLEN(DIR0(I)) GT SLASH THEN TEST = TEST +	$
			 STRMID(DIR0(I),SLASH,STRLEN(DIR0(I))-SLASH)
		 DIR0(I) = TEST
	     ENDIF
	 ENDIF
;
         IF check THEN BEGIN
            IF NOT chk_dir(dir0(i)) THEN MESSAGE,/cont,$
                  'Warning: directory '+dir0(i)+' does not exist'
         ENDIF
         last = STRMID(dir0(i), STRLEN(dir0(i))-1, 1)
         IF (last NE '\') AND (last NE '/') AND (last NE ':') THEN BEGIN
            dir0(i) = dir0(i) + '\' ;append an ending '\' 
         ENDIF
      ENDFOR

   ENDIF ELSE BEGIN
      FOR i = 0l, n_dir-1 DO BEGIN
         IF check THEN BEGIN
            IF NOT chk_dir(dir0(i)) THEN MESSAGE,/cont,$
                  'Warning: directory '+dir0(i)+' does not exist'
         ENDIF
         IF (STRMID(dir0(i), STRLEN(dir0(i))-1, 1) NE '/') THEN BEGIN
            dir0(i) = dir0(i) + '/' ;append an ending '/' 
         ENDIF
      ENDFOR
   ENDELSE
;
;  no '/' needed when using default directory
;
   FOR i = 0l, n_dir-1 DO BEGIN
      IF (dirname(i) EQ '') THEN dir0(i) = ''
   ENDFOR

;----------------------------------------------------------------------
;  Under Unix and Windows, FILNAM can still be appended to dir0 even if it 
;  is a directory name. Under VMS, however, we have to check to see if 
;  FILNAM is a directory name, and if it is, we have to do more to append
;  it to dir0.
;----------------------------------------------------------------------
   IF !version.os EQ 'vms' AND KEYWORD_SET(dir) THEN BEGIN
      dirlen = STRLEN(dir0(0))
      IF STRMID(dir0(0), dirlen-1,1) EQ ':' THEN BEGIN
;----------------------------------------------------------------------
;         dir0(0) is a logical dir name; we need to get its real name
;----------------------------------------------------------------------
         realdir = chklog(dir0(0))
         IF realdir EQ '' THEN $
            MESSAGE, dir0(0)+' is not a directory!'
      ENDIF ELSE realdir = dir0(0)
      temp = STRMID(realdir,0,STRLEN(realdir)-1)+'.'
      FOR i = 0l, N_ELEMENTS(filnam)-1 DO BEGIN
         new_name = temp+STRUPCASE(filnam(i))+']'
         IF check THEN BEGIN
            IF chk_dir(new_name,outdir,/full) THEN BEGIN
               IF N_ELEMENTS(result) EQ 0 THEN $
                  result = outdir $
               ELSE $
                  result = [result, outdir]
            ENDIF ELSE $
	       message, 'Warning: '+new_name+' is not a valid directory name!',$
	          /continue
         ENDIF ELSE BEGIN
            IF N_ELEMENTS(result) EQ 0 THEN $
               result = new_name $
            ELSE $
               result = [result, new_name]
         ENDELSE
      ENDFOR
      IF N_ELEMENTS (result) NE 0 THEN RETURN, result ELSE RETURN, ''
   ENDIF ELSE RETURN, dir0 + filnam
END