pm_sysPath::isFailedList Interface Reference

Generate and return .true. if the attempt to fetch the directory listing of the specified input path fails, otherwise, return .false..
More...

Detailed Description

Generate and return .true. if the attempt to fetch the directory listing of the specified input path fails, otherwise, return .false..

This generic interface partially replicates the common behaviors in the dir command of Windows terminals and the ls command of POSIX-compliant shells.

The returned list of directory contents can be either,

1. a vector of scalar string containers css_type.
   
2. a scalar string container, containing the all directory contents concatenated within a single string whose records start and stop elements are returned in the output array index(1:2,:).
   This format is particularly efficient as it involved only one allocation compared to the former containerized storage mode.
   

Parameters

[in]	path	: The input scalar character of default kind SK of arbitrary length type parameter containing the directory or file to list. Note that the input path is interpreted verbatim. See isFailedGlob for pattern matching (globing), the results of which can be passed as input to this generic interface.
[out]	list	: The output object that can be either, an allocatable scalar character of default kind SK containing the path entries in sequence, such that the next path entry starts immediately after the last character of the previous entry. an allocatable vector of containers of type css_type containing scalar strings of kind SK, each element of which contains the path to one entry in the directory listing. Note that the allocation status or the contents of list remain undefined if failed = .true. on return.
[out]	index	: The output allocatable array of type integer of default kind IK of shape `(1:2,1:pathCount) where, pathCount represents the number of paths in the output list, and index(1,:) is the vector of positions of the starting character of individual paths in list, and index(2,:) is the vector of positions of the ending character of individual paths in list. By definition, index(1,1) = 1 and index(2,pathCount) = len(list). such that the next path entry starts immediately after the last character of the previous entry. Note that the allocation status or the contents of index remain undefined if failed = .true. on return. (optional. It must be present if and only if the input argument list is a scalar character of default kind SK.)
[in]	sort	: The input scalar character of default kind SK of arbitrary length type parameter containing the sorting methodology used for sorting paths in the listing. The following values are supported, sort = "name": Sort all items alphabetically by their names. sort = "tmod": Sort all items chronologically by their dates of last modification (oldest first). sort = "tacc": Sort all items chronologically by their dates of last access (oldest first). sort = "size": Sort all items by their size (smallest first). sort = "fext": Sort all items alphabetically by their file name extension (empty extensions first). (optional, default = "name")
[in]	showdir	: The input scalar logical of default kind LK. If .true., the subdirectories (if any exist) in the specified path will be also listed. (optional, default = .true.)
[in]	showfile	: The input scalar logical of default kind LK. If .true., the file (if any exist) in the specified path will be also listed. (optional, default = .true.)
[in]	showhidden	: The input scalar logical of default kind LK. If .true., the hidden files (if any exist) in the specified path will be also listed. (optional, default = .true.)
[in]	reversed	: The input scalar logical of default kind LK. If .true., the sorting of the list will be reversed. (optional, default = .false.)
[in,out]	errmsg	: The input/output scalar character of default kind SK of arbitrary length type parameter. If present and an error occurs, it is assigned an explanatory message describing the nature of the error that has occurred. A length of LEN_IOMSG characters is likely sufficient to capture most error messages in full. (optional. Its presence is relevant only if failed is also present.)

Returns

failed : The output scalar logical of default kind LK.
It is .true. if and only if an error occurs while resolving path.

Possible calling interfaces ⛓

use pm_kind, only: SK, IK, LK
use pm_sysPath, only: isFailedList
character(:, SK), allocatable :: string
type(css_type), allocatable :: list(:)
integer(IK), allocatable :: index(:,:)
logical(LK) :: failed
logical(LK) :: showdir
logical(LK) :: showfile
logical(LK) :: showhidden
 
failed = isFailedList(path, list(:), sort = sort, showdir = showdir, showfile = showfile, showhidden = showhidden, reversed = reversed, errmsg = errmsg) ! `list` is a vector of string containers.
failed = isFailedList(path, string, index, sort = sort, showdir = showdir, showfile = showfile, showhidden = showhidden, reversed = reversed, errmsg = errmsg) ! `string` is a scalar string.

Remarks

The procedures under discussion are impure.

Note

The interface returning list as a scalar string of concatenated paths is significantly faster than a container implementation by reducing the number of allocations from an arbitrarily large number to < 3, frequently only 1.
The runtime performance gain is particularly significant when the returned list contains thousands of paths.

The procedures of this generic interface can handle characters of any kind (including nongraphical ASCII characters like newline) on Unix systems.

See also

ls
isFailedList

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysPath, only: isFailedList, isFailedMakeDir
 
    implicit none
 
    character(:, SK), allocatable   :: list
    integer(IK)     , allocatable   :: index(:,:)
    integer                         :: i
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("isFailedMakeDir('./temp')")
    call disp%show( isFailedMakeDir('./temp') )
    call disp%show("if (isFailedList('.', list, index)) then; error stop; else; do i = 1, size(index,2); call disp%show(list(index(1,i):index(2,i)), deliml = SK_'""'); end do; end if")
                    if (isFailedList('.', list, index)) then; error stop; else; do i = 1, size(index,2); call disp%show(list(index(1,i):index(2,i)), deliml = SK_""""); end do; end if
    call disp%skip()
 
    call disp%skip()
    call disp%show("if (isFailedList('..', list, index)) then; error stop; else; do i = 1, size(index,2); call disp%show(list(index(1,i):index(2,i)), deliml = SK_'""'); end do; end if")
                    if (isFailedList('..', list, index)) then; error stop; else; do i = 1, size(index,2); call disp%show(list(index(1,i):index(2,i)), deliml = SK_""""); end do; end if
    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 ⛓

 
isFailedMakeDir('./temp')
F
if (isFailedList('.', list, index)) then; error stop; else; do i = 1, size(index,2); call disp%show(list(index(1,i):index(2,i)), deliml = SK_'"'); end do; end if
"CMakeFiles/"
"temp/"
"CMakeCache.txt"
"CMakeLists.txt"
"Makefile"
"build.sh"
"cmake_install.cmake"
"main.F90"
"main.exe"
"main.out.F90"
 
 
if (isFailedList('..', list, index)) then; error stop; else; do i = 1, size(index,2); call disp%show(list(index(1,i):index(2,i)), deliml = SK_'"'); end do; end if
"getBaseName/"
"getDirCurrent/"
"getDirHome/"
"getDirName/"
"getDirSep/"
"getDirSeps/"
"getExtName/"
"getFileName/"
"getIndexBaseName/"
"getIndexDirName/"
"getIndexExtName/"
"getPathAbs/"
"getPathExpandedUser/"
"getPathHostNameIndex/"
"getPathJoined/"
"getPathMatch/"
"getPathNew/"
"getPathPosix/"
"getPathPosixEscaped/"
"getPathQuoted/"
"getPathSep/"
"getPathTemp/"
"getPathVerbatim/"
"getPathVerbatimCMD/"
"getPathVerbatimFish/"
"getPathVerbatimPosix/"
"getPathVerbatimPowerShell/"
"getPathWindows/"
"glob/"
"hasDriveLetter/"
"isDir/"
"isExtant/"
"isFailedChangeDir/"
"isFailedCopy/"
"isFailedGlob/"
"isFailedList/"
"isFailedMakeDir/"
"isFailedMakeDirTemp/"
"isFailedMove/"
"isFailedRemove/"
"isFile/"
"isPathAbsPosix/"
"isPathAbsWindows/"
"ls/"
"setPathMatch/"
"setPathPosix/"
"setPathPosixEscaped/"
"setPathWindows/"
 
 

Test:

test_pm_sysPath

Todo:

High Priority: The current Fortran standard 202x does not allow passing characters of non-default kind to the intrinsic Fortran statements and procedures.
As such, the implementation of the procedures of this generic interface for non-default character kinds leads to compile-time kind mismatch errors.
This procedure should be converted back to a generic interface in the future when non-default character kinds are also fully supported by the intrinsic functions.

Todo:

Critical Priority: Support for Windows powershell must be added.

Todo:

Critical Priority: Support for input wildcard patterns must be added with the help of isFailedGlob.

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, 7:03 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 1257 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90