pm_sysPath::isPathAbsWindows Interface Reference

Generate and return .true. is the input path is an absolute Windows path (whether existing or virtual), otherwise return .false..
More...

Detailed Description

Generate and return .true. is the input path is an absolute Windows path (whether existing or virtual), otherwise return .false..

The definition of an absolute path on Windows is given in the details section of pm_sysPath.
In general, a Windows path is considered absolute by the procedures of this generic interface if,

1. it begins with two directory separators recognized on Windows as stored in DIR_SEP_WINDOWS_ALL (i.e., it is a UNC path), or
2. it begins with a drive letter, followed by a colon character :, followed by at least one of the directory separators recognized on Windows as stored in DIR_SEP_WINDOWS_ALL.
   

A path that begins with one of the directory separators recognized on Windows as stored in DIR_SEP_WINDOWS_ALL, is not absolute.
Such a path is recognied by Microsoft as a relative path with respect to the current drive.
This is contrary to the conventions followed by some other languages (e.g., Python).
This generic interface follows Microsoft conventions for the definition of an absolute path on Windows.
For example,

1. \paramonte is a relative path with respect to the current drive of the runtime shell.
   
2. C:paramonte is a relative path on drive C with respect to the current working directory of the runtime shell.
   

By definition, an absolute Windows path must contain at least 3 characters (or more for UNC-style absolute paths).
To check whether a path begins with a drive letter, use hasDriveLetter.

Parameters

[in]

path

: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) containing an existing or virtual path. An empty input path is by definition a relative path (not absolute).

Returns

pathIsAbs : The output scalar logical of default kind LK that is .true. if and only if the input path is an absolute path based on Windows conventions.

Possible calling interfaces ⛓

use pm_kind, only : LK
use pm_sysPath, only: isPathAbsWindows
logical(LK) :: pathIsAbs
 
pathIsAbs = isPathAbsWindows(path)

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

See also

getPathAbs
isPathAbsPosix
isPathAbsWindows

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysPath, only: isPathAbsWindows
 
    implicit none
 
    character(1023, SK) :: errmsg = SK_""
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("isPathAbsWindows('')")
    call disp%show( isPathAbsWindows('') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows(['.', '\', '/'])")
    call disp%show( isPathAbsWindows(['.', '\', '/']) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows(['./', '\.', '/.'])")
    call disp%show( isPathAbsWindows(['./', '\.', '/.']) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows(['../', '..\', '\..', '/..'])")
    call disp%show( isPathAbsWindows(['../', '..\', '\..', '/..']) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows('main.F90')")
    call disp%show( isPathAbsWindows('main.F90') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows(['/main.F90', '\main.F90'])")
    call disp%show( isPathAbsWindows(['/main.F90', '\main.F90']) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows('C:main.F90')")
    call disp%show( isPathAbsWindows('C:main.F90') )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows(['C:/main.F90', 'C:\main.F90'])")
    call disp%show( isPathAbsWindows(['C:/main.F90', 'C:\main.F90']) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isPathAbsWindows(['./paramonte', '//paramonte', '\/paramonte', '\\paramonte'])")
    call disp%show( isPathAbsWindows(['./paramonte', '//paramonte', '\/paramonte', '\\paramonte']) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
isPathAbsWindows('')
F
 
 
isPathAbsWindows(['.', '\', '/'])
F, F, F
 
 
isPathAbsWindows(['./', '\.', '/.'])
F, F, F
 
 
isPathAbsWindows(['../', '..\', '\..', '/..'])
F, F, F, F
 
 
isPathAbsWindows('main.F90')
F
 
 
isPathAbsWindows(['/main.F90', '\main.F90'])
F, F
 
 
isPathAbsWindows('C:main.F90')
F
 
 
isPathAbsWindows(['C:/main.F90', 'C:\main.F90'])
T, T
 
 
isPathAbsWindows(['./paramonte', '//paramonte', '\/paramonte', '\\paramonte'])
F, T, T, T
 
 

Test:

test_pm_sysPath

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Tuesday March 7, 2017, 3:09 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 2372 of file pm_sysPath.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_sysPath.F90