Generate and return .true.
if the requested copy action failed, otherwise return .false.
indicating success.
The procedures of this generic interface perform the copy action depending on the type of the two input paths:
- If
from
is an existing file, then,
- If
to
is an existing directory, the source file from
will be copied (with the same old file base name) into the existing destination folder.
Example:
from = "./file.txt"
, to = "./nested/existing/dir/"
(Upon return, a new file file.txt
will exist in the destination folder to
).
- If
to
is an existing file, then the source file will overwrite the existing destination file if and only if the optional argument forced = .true.
is specified.
Example:
from = "./file.txt"
, to = "./nested/existing/dir/existing.file"
(Upon return, existing.file
will have been overwritten only if forced = .true.
).
- If
to
is a non-existing path, then,
- if
to
ends with any of the directory separators recognized by the runtime shell, then to
is interpreted as a non-existing destination folder. If so,
- Firstly, the (potentially nested non-existing) destination directory
to
will be created.
- Secondly, the source file
from
will be copied into the newly created destination folder to
.
Example:
- (Unix/Windows)
from = "./file.txt"
, to = "./nested/non-existing/path/"
(Upon return, a new file file.txt
will exist in the destination folder to
).
- (Windows)
from = ".\file.txt"
, to = ".\nested\non-existing\path\"
(Upon return, a new file file.txt
will exist in the destination folder to
).
- if
to
does not end with any of the directory separators recognized by the runtime shell, then to
is interpreted as a non-existing destination file. If so,
- Firstly, the (potentially nested non-existing) dirname of the destination file will be created.
- Secondly, the source file
from
will be copied to the destination folder with a new name that is the base name of to
.
Example:
from = "./file.txt"
, to = "./nested/non-existing/path"
(A new file named path
will be created containing the contents of file.txt
).
- If
from
is an existing directory, then,
- If
to
is an existing directory, the entire source directory from
(along with its basename) will be copied into the existing destination folder.
- Existing files with the same name as in the source folder
from
will be overwritten only if the optional argument forced = .true.
is specified.
Example:
from = "./paramonte/examples/"
, to = "./newdir/"
(A new directory "./newdir/examples/"
will be created containing the contents of from
).
- If
to
is an existing file, the program will not perform the requested copy action and will return failed = .true.
.
- If
to
is a non-existing path, then to
is interpreted as a non-existing destination directory.
- Firstly, the (potentially nested non-existing) destination directory
to
will be created.
- Secondly, the contents of the source directory
from
will be copied into the newly-created destination directory to
.
- This behavior is similar to the behavior of
cp
linux command, except that this procedure automatically creates the dirname of to
if it does not exist.
Example:
from = "./paramonte/examples/"
, to = "./new/nested/path"
(non-existing). Result: The newly-created directory to = "./new/nested/path"
will contain the contents of from
.
- If
from
is neither an existing file nor an existing folder, the program will not perform the requested copy action and will return failed = .true.
.
This procedure is capable of copying a file or a directory to nonexistent (potentially nested) directories.
The copy request is done by first identifying the processor shell type (CMD, PowerShell, Bash, csh, zsh, ...) and then calling the runtime system shell via the Fortran intrinsic subroutine execute_command_line()
to invoke mkdir
shell command with appropriate flags.
Consequently, this procedure should function as expected in Windows CMD, PowerShell, and POSIX-compatible (Unix-like) shells.
- On POSIX-compliant shells, the commands
cp -arn
and cp -arf
are used to perform the copy regularly or forcefully (with overwriting), respectively.
- On Windows-based terminals, the commands
xcopy /e /q /s
and xcopy /e /q /s /Y
are used to perform the copy regularly or forcefully (with overwriting), respectively.
- Parameters
-
[in] | from | : The input scalar character of default kind SK containing a POSIX-style or Windows-style path to a file or directory.
|
[in] | to | : The input scalar character of default kind SK containing a POSIX-style or Windows-style path to which the path from should be copied.
When the input argument from points to a single file, there is ambiguity about how the destination path should be interpreted.
As such, if to points to a (potentially non-existing) folder, make sure to end it with a suitable directory separator getDirSep before passing it to the procedures under this generic integer.
Otherwise, to is assumed to point to a file name.
|
[in] | recursive | : The input scalar logical of default kind LK. If .true. the copy action will be performed recursively (including all subdirectories).
This input argument is relevant only if the input source path from is a directory with subdirectories.
(optional, default = .false. . See the warning below regarding the implications of setting recursive = .true. .) |
[in] | forced | : The input scalar logical of default kind LK. If .true. the copy action will overwrite the destination to if it already exists.
This input argument is relevant only if the input destination path partially or entirely contains the same files in from .
(optional, default = .false. ) |
[in] | wait | : The input scalar logical of default kind LK with the same functionality as the wait argument of the Fortran intrinsic execute_command_line() .
-
If
.true. , the procedure will wait for the shell action to terminate before returning the control to the Fortran program.
-
Otherwise, the system call will be done asynchronously and the success of the action will not be verified.
(optional, default = .true. ) |
[in] | ntry | : The input scalar positive integer of default kind IK representing the number of times the requested action should be attempted.
Multiple tries are particularly useful on Windows platforms where applications take the ownership of a particular resource on the system and may not allow other applications to utilize the resource.
For example, Dropbox is a well-known example of an application that blocks any other applications from making any changes to a specific path with which it is working, preventing any manipulation of the path by other applications.
(optional, default = 1 ) |
[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.
If the length of errmsg is too short for the output error message, the message tail will be clipped as needed.
A length of 2047 characters for errmsg is likely enough to capture most error messages in full.
(optional. If missing, no error message will be output.) |
- Returns
failed
: The output scalar logical
of default kind LK. It is .true.
if and only if an error occurs while performing the requested task.
This includes the possibility of the input path from
not existing before the copy action or the destination path to
not existing after the copy action.
Possible calling interfaces ⛓
character(2047, SK) :: errmsg
logical(LK) :: failed, forced
logical(LK) :: recursive
logical(LK) :: wait
integer(IK) :: ntry
failed
= isFailedCopy(from, to, recursive
= recursive, forced
= forced,
wait = wait, ntry
= ntry,
errmsg = errmsg)
Generate and return .true. if the requested copy action failed, otherwise return ....
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 IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
This module contains classes and procedures for manipulating system file/folder paths.
- Warning
- When does the option
recursive = .true.
lead to infinite copy loop?
When to
is a subdirectory of from
.
Be warned that setting the input argument recursive = .true.
when to
is a subdirectory of from
can lead to a never ending copy cycle which will likely eventually cause the process to crash.
Use recursive = .true.
only if to
is guaranteed to not be a subdirectory of from
.
-
This procedure currently does not copy hidden files consciously. The result is currently platform and usage dependent.
-
Note that this procedure does not verify the conformance of the input paths to the naming conventions of the current processor shell. For example,
- if the shell is POSIX-conforming, then the path is expected to conform to the POSIX conventions.
- if the shell is Windows CMD or PowerShell, the path is expected to conform to the Windows conventions.
-
This procedure interprets the input paths verbatim.
This procedure potentially calls the operating system to create the input destination path directories.
To minimize security vulnerabilities and to properly handle the presence of whitespace or other potentially problematic characters, the input path will be interpreted verbatim by calling getPathVerbatim.
-
Asynchronous copy action.
Note that even if the processor supports asynchronous command execution (wait = .false.
), there is no mechanism provided for finding out later whether the command being executed asynchronously has terminated or what its exit status exitstat
was.
-
The input
ntry
must be a positive (non-zero) integer
.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1
.
- See also
- isFailedCopy
isFailedMove
isFailedRemove
isFailedMakeDir
Example usage ⛓
9 character(:, SK),
allocatable :: cpath, dir, subdir, destination
11 type(display_type) :: disp
15 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
16 call disp%show(
"! Copy file to a new non-existing destination file.")
17 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
21 call disp%show(
"cpath = getPathNew(ext = SK_'.main.out.F90') ! define a random unique path name.")
24 call disp%show( cpath , deliml
= SK_
"""" )
27 call disp%show(
"isFailedCopy(from = SK_'main.out.F90', to = cpath)")
34 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
35 call disp%show(
"! Copy file to a new non-existing doubly-nested destination folder.")
36 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
40 call disp%show(
"dir = getPathNew(dir = getPathNew(), prefix = SK_'sub')//getDirSep() ! Ending the directory name with directory separator is crucial if it does not exit already, otherwise it is interpreted as file name.")
43 call disp%show( dir , deliml
= SK_
"""" )
48 call disp%show(
"isFailedCopy(from = SK_'main.out.F90', to = dir)")
52 call disp%show(
"isFile(dir//SK_'main.out.F90')")
57 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
58 call disp%show(
"! Copy file to a new location and overwrite the existing file.")
59 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
63 call disp%show(
"destination = dir//SK_'main.out.F90'")
64 destination
= dir
//SK_
'main.out.F90'
66 call disp%show( destination , deliml
= SK_
"""" )
67 call disp%show(
"isFile(destination)")
69 call disp%show(
"isFailedCopy(from = SK_'main.out.F90', to = destination, forced = .true.)")
76 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
77 call disp%show(
"! Copy file to a new non-existing destination file name in a non-existing subfolder.")
78 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
82 call disp%show(
"subdir = getPathNew(dir = dir, prefix = SK_'subsub')")
83 subdir
= getPathNew(dir
= dir, prefix
= SK_
'subsub')
85 call disp%show( subdir , deliml
= SK_
"""" )
88 call disp%show(
"cpath = subdir//getDirSep()//SK_'main.out.F90'")
89 cpath
= subdir
//getDirSep()
//SK_
'main.out.F90'
91 call disp%show( cpath , deliml
= SK_
"""" )
94 call disp%show(
"isFailedCopy(from = SK_'main.out.F90', to = cpath)")
101 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
102 call disp%show(
"! Copy 'the contents of' a folder recursively into another (potentially non-existing) destination folder.")
103 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
107 call disp%show(
"dir ! Note the ending directory separator which is essential for copying the contents of the folder and not the folder itself.")
108 call disp%show( dir , deliml
= SK_
"""" )
111 call disp%show(
"cpath = getPathNew(prefix = SK_'recursive_copy')")
112 cpath
= getPathNew(prefix
= SK_
'recursive_copy')
115 call disp%show(
"isFailedCopy(from = dir, to = cpath, recursive = .true._LK)")
117 call disp%show(
"isDir(cpath//getDirSep()//dir)")
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.
Generate and return the directory separator symbol based on the runtime system shell.
Generate and return a unique (directory or file) path name in the specified directory or the default ...
Generate and return .true. is the input path is an extant system directory, otherwise return ....
Generate and return .true. is the input path is a file (not a directory), otherwise return ....
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.
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 ⛓
9"new_20240822_211525_321_pid_1.main.out.F90"
25"new_20240822_211525_327_pid_1/sub20240822_211525_329_pid_1/"
34isFile(dir
//SK_
'main.out.F90')
43destination
= dir
//SK_
'main.out.F90'
45"new_20240822_211525_327_pid_1/sub20240822_211525_329_pid_1/main.out.F90"
48isFailedCopy(from
= SK_
'main.out.F90', to
= destination, forced
= .true.)
59subdir
= getPathNew(dir
= dir, prefix
= SK_
'subsub')
61"new_20240822_211525_327_pid_1/sub20240822_211525_329_pid_1/subsub20240822_211525_341_pid_1"
64cpath
= subdir
//getDirSep()
//SK_
'main.out.F90'
66"new_20240822_211525_327_pid_1/sub20240822_211525_329_pid_1/subsub20240822_211525_341_pid_1/main.out.F90"
81"new_20240822_211525_327_pid_1/sub20240822_211525_329_pid_1/"
84cpath
= getPathNew(prefix
= SK_
'recursive_copy')
87isFailedCopy(from
= dir, to
= cpath, recursive
= .true._LK)
- 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.
This generic interface should be extended to in the future to support non-default character kinds when they fully supported by the Fortran intrinsic procedures.
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:09 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin
Definition at line 3484 of file pm_sysPath.F90.