Generate and return the index of the first character of the basename part of the input path
.
By definition, the basename of a path is the segment that appears after the last directory separator in the path.
As such, the basename of a path can be either empty, a directory, or correspond to a filename (including its extension).
The end index of the basename segment of the path is trivial (len(path)
) and not returned as the output of this procedure.
For example, if path = "./paramonte"
, then path(getIndexBaseName(path,"/"):)
yields paramonte
.
See also the details of the documentation of the generic interface getIndexDirName and getDirName.
- Parameters
-
[in] | path | : The input scalar character of default kind SK containing the path.
|
[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 .
|
[in] | style | : The input scalar that can be,
-
the constant verbatim or an object of type verbatim_type implying the use of the ParaMonte style described above in extracting the output
basename .
(optional. If missing, the default behavior corresponds to that of the basename command on POSIX systems. See examples below.) |
- Returns
index
: The output scalar integer
of default kind IK containing the starting position of the basename of the input path
.
If the input path
does not contain a basename, the output value for index
will be len(path) + 1
.
Possible calling interfaces ⛓
integer(IK) :: index
Generate and return the index of the first character of the basename part of the input path.
This module contains classes and procedures for manipulating system file/folder paths.
type(verbatim_type), parameter verbatim
The scalar constant of type verbatim_type that can be used to signify the verbatim interpretation of ...
- 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 ⛓
10 character(:),
allocatable :: path
12 type(display_type) :: disp
18 call disp%show(
"getIndexBaseName(path, SK_'/')")
20 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
27 call disp%show(
"getIndexBaseName(path, SK_'/')")
29 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
36 call disp%show(
"getIndexBaseName(path, SK_'/')")
38 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
45 call disp%show(
"getIndexBaseName(path, SK_'/')")
47 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
54 call disp%show(
"getIndexBaseName(path, SK_'/')")
56 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
63 call disp%show(
"getIndexBaseName(path, SK_'/')")
65 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
70 call disp%show(
"path = SK_'/paramonte'")
71 path
= SK_
'/paramonte'
72 call disp%show(
"getIndexBaseName(path, SK_'/')")
74 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
79 call disp%show(
"path = SK_'./paramonte'")
80 path
= SK_
'./paramonte'
81 call disp%show(
"getIndexBaseName(path, SK_'/')")
83 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
88 call disp%show(
"path = SK_'./paramonte/parallel/library.txt'")
89 path
= SK_
'./paramonte/parallel/library.txt'
90 call disp%show(
"getIndexBaseName(path, SK_'/')")
92 call disp%show(
"path(getIndexBaseName(path, SK_'/'):)")
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
51path
= SK_
'./paramonte'
58path
= SK_
'./paramonte/parallel/library.txt'
- Test:
- test_pm_sysPath
- Todo:
- High Priority: This procedure should be extended to support non-default character kinds.
- Todo:
- Normal Priority: The examples should be extended to cover the optional argument
style
.
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.
-
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.
-
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, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin
Definition at line 5666 of file pm_sysPath.F90.