pm_sysPath::ls Interface Reference

Generate and return a list of all paths within the specified input path.
More...

Detailed Description

Generate and return a list of all paths within the specified input path.

This generic interface is a convenience wrapper around the more verbose isFailedList.
Unlike isFailedList which can gracefully handle the occurrence of runtime error, this generic interface halts the program by calling error stop if a runtime error occurs.

Parameters

[in]	path	: The input scalar character of default kind SK of arbitrary length type parameter containing the directory or file pattern to list.
[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.)

Returns

list : The output 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.

Possible calling interfaces ⛓

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

Remarks

The procedures under discussion are impure.

Note

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: ls, isFailedMakeDir
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("ls(SK_'.')")
    call disp%show( ls(SK_'.') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("ls(SK_'..')")
    call disp%show( ls(SK_'..') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("ls(SK_'./*.F90')")
    call disp%show( ls(SK_'./*.F90') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("ls(SK_'./main.F90')")
    call disp%show( ls(SK_'./main.F90') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("ls(SK_'./*.nonexistent')")
    call disp%show( ls(SK_'./*.nonexistent') , deliml = SK_"""" )
    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 ⛓

 
ls(SK_'.')
"CMakeFiles/", "CMakeCache.txt", "CMakeLists.txt", "Makefile", "build.sh", "cmake_install.cmake", "main.F90", "main.exe", "main.out.F90"
 
 
ls(SK_'..')
"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/"
 
 
ls(SK_'./*.F90')
 
 
 
ls(SK_'./main.F90')
"./main.F90"
 
 
ls(SK_'./*.nonexistent')
 
 
 

Test:

test_pm_sysPath

Todo:

Normal 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.

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 882 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90