|
ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
|
|
ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
Generate and return .true. if the requested copy action failed, otherwise return .false. indicating success.
More...
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:
from is an existing file, then,to is an existing directory, the source file from will be copied (with the same old file base name) into the existing destination folder.from = "./file.txt", to = "./nested/existing/dir/" (Upon return, a new file file.txt will exist in the destination folder to).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.from = "./file.txt", to = "./nested/existing/dir/existing.file" (Upon return, existing.file will have been overwritten only if forced = .true.).to is a non-existing path, then,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,to will be created.from will be copied into the newly created destination folder to.from = "./file.txt", to = "./nested/non-existing/path/" (Upon return, a new file file.txt will exist in the destination folder to).from = ".\file.txt", to = ".\nested\non-existing\path\" (Upon return, a new file file.txt will exist in the destination folder to).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,from will be copied to the destination folder with a new name that is the base name of to.from = "./file.txt", to = "./nested/non-existing/path" (A new file named path will be created containing the contents of file.txt).from is an existing directory, then,to is an existing directory, the entire source directory from (along with its basename) will be copied into the existing destination folder.from will be overwritten only if the optional argument forced = .true. is specified.from = "./paramonte/examples/", to = "./newdir/" (A new directory "./newdir/examples/" will be created containing the contents of from).to is an existing file, the program will not perform the requested copy action and will return failed = .true..to is a non-existing path, then to is interpreted as a non-existing destination directory.to will be created.from will be copied into the newly-created destination directory to.cp linux command, except that this procedure automatically creates the dirname of to if it does not exist.from = "./paramonte/examples/", to = "./new/nested/path" (non-existing). Result: The newly-created directory to = "./new/nested/path" will contain the contents of from.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.
cp -arn and cp -arf are used to perform the copy regularly or forcefully (with overwriting), respectively.xcopy /e /q /s and xcopy /e /q /s /Y are used to perform the copy regularly or forcefully (with overwriting), respectively.| [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().
.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.) |
failed : The output scalar logical of default kind LK. It is .true. if and only if an error occurs while performing the requested task.from not existing before the copy action or the destination path to not existing after the copy action.
Possible calling interfaces ⛓
recursive = .true. lead to infinite copy loop?to is a subdirectory of from.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.recursive = .true. only if to is guaranteed to not be a subdirectory of from.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.ntry must be a positive (non-zero) integer.CHECK_ENABLED=1.impure.
Example usage ⛓
ifort compiler ⛓ ifort compiler ⛓ gfortran compiler ⛓
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.
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.
Definition at line 3484 of file pm_sysPath.F90.
1.9.3