pm_err::getFile Interface Reference

Generate and return a decorated string as "@file(FILE)" where FILE is replaced by the input source file of interest.
More...

Detailed Description

Generate and return a decorated string as "@file(FILE)" where FILE is replaced by the input source file of interest.

The procedures under this generic interface are meant to facilitate tracing of origin of an error in error message when it occurs.
Although the task performed by this generic interface is rather trivial, the goal is to offer consistent style over the entire library for traceback information collection.

Parameters

[in]

file

: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU), containing the path of the file within which an error or an interesting event has occurred. The path of a source file is frequently returned by the compiler-defined macro __FILE__. At least two compilers (Intel and GNU) define the macro __FILE__ at compile time.

Returns

str : The output scalar character of default kind SK containing a decoration of the input file.

Possible calling interfaces ⛓

use pm_kind, only: SK
use pm_err, only: getFile
character(:, SK), allocatable :: str
 
str = getFile(file)

Remarks

The procedures under discussion are pure.

See also

getFile
getLine
getStr
setNoted
setWarned
setAborted
setAsserted

Example usage ⛓

#ifndef __FILE__
#define __FILE__ 0
#endif
program example
 
    use pm_kind, only: SK
    use pm_err, only: getFile
    use pm_io, only: display_type
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%show("getFile(__FILE__)//SK_': This is the line number in the source file where printing was instructed.'")
    call disp%show( getFile(__FILE__)//SK_': This is the line number in the source file where printing was instructed.', 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 ⛓

getFile(__FILE__)//SK_': This is the line number in the source file where printing was instructed.'
"@file(/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/fortran/checking/pkg/example/pm_err/getFile/main.F90): This is the line number in the source file where printing was instructed."
 
 

test_pm_err

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

Todo:

Normal Priority: Adding an example usage to this interface can be helpful.

Author:

Amir Shahmoradi, 3:43 AM Friday, March 1, 2013, Institute for Fusion Studies, The University of Texas Austin

Definition at line 504 of file pm_err.F90.

---

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

• src/fortran/main/pm_err.F90