ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
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
logical(LK) :: pathIsAbs
pathIsAbs = isPathAbsWindows(path)
Generate and return .true. is the input path is an absolute Windows path (whether existing or virtual...
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274
Remarks
The procedures under discussion are pure.
The procedures under discussion are elemental.
See also
getPathAbs
isPathAbsPosix
isPathAbsWindows


Example usage

1program example
2
3 use pm_kind, only: LK, IK, SK
4 use pm_io, only: display_type
6
7 implicit none
8
9 character(1023, SK) :: errmsg = SK_""
10
11 type(display_type) :: disp
12 disp = display_type(file = "main.out.F90")
13
14 call disp%skip()
15 call disp%show("isPathAbsWindows('')")
16 call disp%show( isPathAbsWindows('') )
17 call disp%skip()
18
19 call disp%skip()
20 call disp%show("isPathAbsWindows(['.', '\', '/'])")
21 call disp%show( isPathAbsWindows(['.', '\', '/']) )
22 call disp%skip()
23
24 call disp%skip()
25 call disp%show("isPathAbsWindows(['./', '\.', '/.'])")
26 call disp%show( isPathAbsWindows(['./', '\.', '/.']) )
27 call disp%skip()
28
29 call disp%skip()
30 call disp%show("isPathAbsWindows(['../', '..\', '\..', '/..'])")
31 call disp%show( isPathAbsWindows(['../', '..\', '\..', '/..']) )
32 call disp%skip()
33
34 call disp%skip()
35 call disp%show("isPathAbsWindows('main.F90')")
36 call disp%show( isPathAbsWindows('main.F90') )
37 call disp%skip()
38
39 call disp%skip()
40 call disp%show("isPathAbsWindows(['/main.F90', '\main.F90'])")
41 call disp%show( isPathAbsWindows(['/main.F90', '\main.F90']) )
42 call disp%skip()
43
44 call disp%skip()
45 call disp%show("isPathAbsWindows('C:main.F90')")
46 call disp%show( isPathAbsWindows('C:main.F90') )
47 call disp%skip()
48
49 call disp%skip()
50 call disp%show("isPathAbsWindows(['C:/main.F90', 'C:\main.F90'])")
51 call disp%show( isPathAbsWindows(['C:/main.F90', 'C:\main.F90']) )
52 call disp%skip()
53
54 call disp%skip()
55 call disp%show("isPathAbsWindows(['./paramonte', '//paramonte', '\/paramonte', '\\paramonte'])")
56 call disp%show( isPathAbsWindows(['./paramonte', '//paramonte', '\/paramonte', '\\paramonte']) )
57 call disp%skip()
58
59end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
3F
4
5
6isPathAbsWindows(['.', '\', '/'])
7F, F, F
8
9
10isPathAbsWindows(['./', '\.', '/.'])
11F, F, F
12
13
14isPathAbsWindows(['../', '..\', '\..', '/..'])
15F, F, F, F
16
17
18isPathAbsWindows('main.F90')
19F
20
21
22isPathAbsWindows(['/main.F90', '\main.F90'])
23F, F
24
25
26isPathAbsWindows('C:main.F90')
27F
28
29
30isPathAbsWindows(['C:/main.F90', 'C:\main.F90'])
31T, T
32
33
34isPathAbsWindows(['./paramonte', '//paramonte', '\/paramonte', '\\paramonte'])
35F, T, T, T
36
37
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.

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

Definition at line 2372 of file pm_sysPath.F90.


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