pm_sysPath::setPathMatch Interface Reference

Return a list of directory paths matching a requested system application.
More...

Detailed Description

Return a list of directory paths matching a requested system application.

This generic interface is meant to provide an easy unified cross-language way of detecting applications, particularly, vendor MPI installations on the system.
The original approach of implementing this functionality separately in different programming language environments proved messy.
This generic interface along with getPathMatch attempt to reduce multi-language code duplication to only one (Fortran) language.

Search Strategy
The search strategy relies on retrieving the output of the command system_profiler SPApplicationsDataType in Darwin OS.
The search strategy relies on retrieving the contents of the processor environmental PATH variable in Windows and Linux OS.
Each identified path will be checked to ensure it is a real path before inclusion in the result.

Parameters

[in]	key	: The input scalar character of default kind SK of arbitrary non-zero length type parameter containing a list of search keywords separated by the specified input sep character. An empty key (with zero length type parameter) leads to returning all identified paths in the processor environment. Similarly, an empty search keyword item in the input key evaluates to match all paths. The input key must be null-terminated when the procedure is called from the C language.
[in]	inc	: The input scalar character of the same type and kind as the input key of arbitrary length type parameter containing the (partial) name of a target file, subfolder, or application that should be present in the output directory paths. If the input inc is missing or empty, the entire list of paths matching key will be returned in the output list. The input inc must be null-terminated when the procedure is called from the C language.
[in]	sep	: The input scalar character of the type and kind as key of length type parameter 1, containing the character to be used for separating search keywords provided in key. The recommended value for sep is the returned value from getPathSep.
[out]	list	: The output scalar character of the same type and kind as the input key, containing a list of the identified paths matching the input search keywords without case-sensitivity. The paths, if any more than one are detected, are separated by the specified input sep character. The interpretation of the output contents of list depends on the value of the input/output argument lenList.
[in,out]	lenList	: The input/output scalar integer of default kind IK. On input, it must contain the positive-valued length of the slice of list buffer to be used for storing the results. On output, depending on its value, lenList can signal different scenarios: A positive output value larger than its input value implies the slice list contains the directory path only partially. In such a case, user may want to call the routine with a larger input buffer list length specified via lenList to store the path in full. A positive output value smaller than its input value implies the slice list(1:lenList) contains the directory path in full. A negative output value implies that and error occurred and/or no installed application path matching the specified keywords could be found. In such a case, the slice list(1 : abs(lenList)) contains a description of the error or other informative messages. The interpretation of the value of abs(lenList) is subject to the same rules for the positive value of lenList laid out above. A zero output value implies that no installed application path matching the specified keywords could be found on the system. A value of MAX_LEN_FILE_PATH for lenList should be more than sufficient with focused keyword search. If the input key contents are expected to match many paths, a longer buffer list may be needed. In such cases, the length of the environmental PATH variable can be used a rule of thumb for input value of lenList.

Possible calling interfaces ⛓

use pm_sysPath, only: setPathMatch
 
call setPathMatch(key, inc, sep, list, lenList)

Warning

The condition 0 < lenList must hold for the corresponding input arguments.
The input argument key must be null-terminated when the procedure is called from the C language.

Remarks

The procedures under discussion are impure.

Note

This generic interface is primarily intended for access from other programming language environments.
For a more flexible within-Fortran interface see the generic function interface getPathMatch.

See also

getPathMatch
setPathMatch

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysPath, only: getPathSep
    use pm_sysPath, only: setPathMatch
    use pm_arrayReplace, only: getReplaced
 
    implicit none
 
    integer(IK) :: lenList
    type(display_type) :: disp
    character(:, SK), allocatable :: list
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("lenList = 9999")
                    lenList = 9999
    call disp%show("list = repeat(' ', lenList)")
                    list = repeat(' ', lenList)
    call disp%show("call setPathMatch(key = SK_'', inc = SK_'', sep = getPathSep(), list = list, lenList = lenList)")
                    call setPathMatch(key = SK_'', inc = SK_'', sep = getPathSep(), list = list, lenList = lenList)
    call disp%show("lenList")
    call disp%show( lenList )
    call disp%show("getReplaced(trim(list), getPathSep(), new_line(SK_'a'))")
    call disp%show( getReplaced(trim(list), getPathSep(), new_line(SK_'a')) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("lenList = 9999")
                    lenList = 9999
    call disp%show("list = repeat(' ', lenList)")
                    list = repeat(' ', lenList)
    call disp%show("call setPathMatch(key = SK_'intel:oneapi:mpi:', inc = SK_'', sep = getPathSep(), list = list, lenList = lenList)")
                    call setPathMatch(key = SK_'intel:oneapi:mpi:', inc = SK_'', sep = getPathSep(), list = list, lenList = lenList)
    call disp%show("lenList")
    call disp%show( lenList )
    call disp%show("getReplaced(trim(list), SK_':', new_line(SK_'a'))")
    call disp%show( getReplaced(trim(list), SK_':', new_line(SK_'a')) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("lenList = 9999")
                    lenList = 9999
    call disp%show("list = repeat(' ', lenList)")
                    list = repeat(' ', lenList)
    call disp%show("call setPathMatch(key = SK_'intel:oneapi:mpi', inc = SK_'mpiexec', sep = getPathSep(), list = list, lenList = lenList)")
                    call setPathMatch(key = SK_'intel:oneapi:mpi', inc = SK_'mpiexec', sep = getPathSep(), list = list, lenList = lenList)
    call disp%show("lenList")
    call disp%show( lenList )
    call disp%show("getReplaced(trim(list), getPathSep(), new_line(SK_'a'))")
    call disp%show( getReplaced(trim(list), getPathSep(), new_line(SK_'a')) , 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 ⛓

 
lenList = 9999
list = repeat(' ', lenList)
call setPathMatch(key = SK_'', inc = SK_'', sep = getPathSep(), list = list, lenList = lenList)
lenList
+3393
getReplaced(trim(list), getPathSep(), new_line(SK_'a'))
"/home/amir/.bin
/home/amir/gems/bin
/usr/local/MATLAB/R2023b/bin
/usr/local/sbin
/usr/local/bin
/usr/sbin
/usr/bin
/sbin
/bin
/usr/games
/usr/local/games
/usr/lib/wsl/lib
/mnt/c/Ruby32-x64/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/release/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin/utils/
/mnt/c/Program Files (x86)/Intel/oneAPI/tbb/latest/redist/intel64/vc_mt/
/mnt/c/Program Files (x86)/Intel/oneAPI/tbb/latest/redist/ia32/vc_mt/
/mnt/c/Program Files (x86)/Intel/oneAPI/compiler/latest/windows/redist/intel64_win/compiler
/mnt/c/Program Files (x86)/Intel/oneAPI/compiler/latest/windows/redist/ia32_win/compiler
/mnt/c/Windows/system32
/mnt/c/Windows
/mnt/c/Windows/System32/Wbem
/mnt/c/Windows/System32/WindowsPowerShell/v1.0/
/mnt/c/Windows/System32/OpenSSH/
/mnt/c/Program Files/dotnet/
/mnt/c/Program Files (x86)/NVIDIA Corporation/PhysX/Common
/mnt/c/Program Files/MATLAB/R2024a/runtime/win64
/mnt/c/Program Files/MATLAB/R2024a/bin
/mnt/c/Program Files/MATLAB/R2023b/runtime/win64
/mnt/c/Program Files/MATLAB/R2023b/bin
/mnt/c/Program Files/MATLAB/R2023a/bin
/mnt/c/Program Files/MATLAB/R2022b/runtime/win64
/mnt/c/Program Files/MATLAB/R2022b/bin
/mnt/c/Program Files/MiKTeX/miktex/bin/x64/
/mnt/c/Program Files/Microsoft SQL Server/150/Tools/Binn/
/mnt/c/Program Files/Microsoft SQL Server/Client SDK/ODBC/170/Tools/Binn/
/mnt/c/Program Files/Git/cmd
/mnt/c/Program Files/gs/gs10.00.0/bin
/mnt/c/Program Files/PuTTY/
/mnt/c/Program Files/MATLAB/R2020b/runtime/win64
/mnt/c/Program Files/MATLAB/R2020b/bin
/mnt/c/Program Files/MATLAB/R2019b/runtime/win64
/mnt/c/Program Files/MATLAB/R2019b/bin
/mnt/c/Program Files (x86)/Pulse Secure/VC142.CRT/X64/
/mnt/c/Program Files (x86)/Pulse Secure/VC142.CRT/X86/
/mnt/c/Program Files (x86)/Common Files/Pulse Secure/TNC Client Plugin/
/mnt/c/Program Files (x86)/Intel/oneAPI/vpl/latest/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/tbb/latest/redist/intel64/vc_mt
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin/utils
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/release
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/mkl/latest/redist/intel64
/mnt/c/Program Files (x86)/Intel/oneAPI/mkl/latest/bin/intel64
/mnt/c/Program Files (x86)/Intel/oneAPI/itac/latest/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/itac/latest/dll
/mnt/c/Program Files (x86)/Intel/oneAPI/ippcp/latest/redist/intel64
/mnt/c/Program Files (x86)/Intel/oneAPI/ipp/latest/redist/intel64
/mnt/c/Program Files (x86)/Intel/oneAPI/dpcpp-ct/latest/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/dnnl/latest/cpu_dpcpp_gpu_dpcpp/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/dev-utilities/latest/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/debugger/latest/gdb/intel64/bin
/mnt/c/Users/amir/AppData/Local/quickstart_fortran/mingw64/bin
/mnt/c/Users/amir/AppData/Local/quickstart_fortran/fpm
/mnt/c/Users/amir/AppData/Local/quickstart_fortran/MinGit/mingw64/bin
/mnt/c/Users/amir/AppData/Local/quickstart_fortran/utils
/mnt/c/Program Files/CMake/bin
/mnt/c/Users/amir/AppData/Local/Programs/Microsoft VS Code/bin
/mnt/c/Users/amir/.dotnet/tools
/mnt/c/Users/amir/AppData/Local/Pandoc/
/snap/bin"
 
 
lenList = 9999
list = repeat(' ', lenList)
call setPathMatch(key = SK_'intel:oneapi:mpi:', inc = SK_'', sep = getPathSep(), list = list, lenList = lenList)
lenList
+692
getReplaced(trim(list), SK_':', new_line(SK_'a'))
"/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/release/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin/utils/
/mnt/c/Program Files (x86)/Intel/oneAPI/compiler/latest/windows/redist/intel64_win/compiler
/mnt/c/Program Files (x86)/Intel/oneAPI/compiler/latest/windows/redist/ia32_win/compiler
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin/utils
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/libfabric/bin
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/release
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin"
 
 
lenList = 9999
list = repeat(' ', lenList)
call setPathMatch(key = SK_'intel:oneapi:mpi', inc = SK_'mpiexec', sep = getPathSep(), list = list, lenList = lenList)
lenList
+110
getReplaced(trim(list), getPathSep(), new_line(SK_'a'))
"/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin/
/mnt/c/Program Files (x86)/Intel/oneAPI/mpi/latest/bin"
 
 

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 this procedure 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 6338 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90