pm_sysPath::getFileName Interface Reference

Generate and return the filename part of the input path.
More...

Detailed Description

Generate and return the filename part of the input path.

The filename is defined as the segment of the path that starts after the last directory separator in the path and before the start of the file extension of the path (if any file extension exists).
For example, the filename segment of path = "./paramonte.txt" is paramonte.

Parameters

[in]	path	: The input scalar character of default kind SK of arbitrary length type parameter containing the path to split.
[in]	dirsep	: The input scalar character of default kind SK of arbitrary length type parameter containing the runtime directory separator(s). The directory separator can be obtained from either the dirsep component of an object of type shell_type or getDirSep. The directory separator is \ or / in Windows-based terminals (e.g., CMD or PowerShell) and / in POSIX-compliant shells. When in doubt (for example, in Windows terminals), dirsep can be set to multiple characters, for example dirsep = "/\". In such a case, the input path will be scanned for the presence of any of the individual characters in dirsep.

Returns

filename : The output allocatable scalar character of default kind SK containing the filename segment of the input path.

Possible calling interfaces ⛓

use pm_sysPath, only: getFileName
character(:, SK), allocatable :: filename
 
filename = getFileName(path, dirsep)

Warning

The condition 0 < len(dirsep) must hold for the corresponding input arguments.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.

See also

getDirName
getExtName
getFileName
getBaseName
getIndexDirName
getIndexExtName
getIndexBaseName

Example usage ⛓

program example
 
    use pm_kind, only: LK
    use pm_kind, only: SK ! all processor types and kinds are supported.
    use pm_io, only: display_type
    use pm_sysPath, only: getFileName
 
    implicit none
 
    character(:), allocatable :: path
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("path = SK_''")
                    path = SK_''
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'.'")
                    path = SK_'.'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'..'")
                    path = SK_'..'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'/..'")
                    path = SK_'/..'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'../'")
                    path = SK_'../'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'/'")
                    path = SK_'/'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'/paramonte'")
                    path = SK_'/paramonte'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'./paramonte'")
                    path = SK_'./paramonte'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("path = SK_'./paramonte/parallel/library.txt'")
                    path = SK_'./paramonte/parallel/library.txt'
    call disp%show("getFileName(path, SK_'/')")
    call disp%show( getFileName(path, SK_'/') , 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 ⛓

 
path = SK_''
getFileName(path, SK_'/')
""
 
 
path = SK_'.'
getFileName(path, SK_'/')
""
 
 
path = SK_'..'
getFileName(path, SK_'/')
"."
 
 
path = SK_'/..'
getFileName(path, SK_'/')
"."
 
 
path = SK_'../'
getFileName(path, SK_'/')
"../"
 
 
path = SK_'/'
getFileName(path, SK_'/')
"/"
 
 
path = SK_'/paramonte'
getFileName(path, SK_'/')
"paramonte"
 
 
path = SK_'./paramonte'
getFileName(path, SK_'/')
"paramonte"
 
 
path = SK_'./paramonte/parallel/library.txt'
getFileName(path, SK_'/')
"library"
 
 

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 at Austin

Definition at line 6140 of file pm_sysPath.F90.

---

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

• src/fortran/main/pm_sysPath.F90