[4213] | 1 | !---------------------------------------------------------------------- |
---|
| 2 | ! NEMO system team, System and Interface for oceanic RElocable Nesting |
---|
| 3 | !---------------------------------------------------------------------- |
---|
| 4 | ! |
---|
| 5 | ! DESCRIPTION: |
---|
[6393] | 6 | !> @brief This module manage log file. |
---|
[5037] | 7 | !> @details |
---|
[6393] | 8 | !> This module create log file and fill it depending of verbosity. |
---|
| 9 | !> |
---|
[5037] | 10 | !> verbosity could be choosen between : |
---|
[4213] | 11 | !> - trace : Most detailed information. |
---|
| 12 | !> - debug : Detailed information on the flow through the system. |
---|
| 13 | !> - info : Interesting runtime events (startup/shutdown). |
---|
| 14 | !> - warning: Use of deprecated APIs, poor use of API, 'almost' errors, |
---|
| 15 | !> other runtime situations that are undesirable or unexpected, |
---|
| 16 | !> but not necessarily "wrong". |
---|
| 17 | !> - error : Other runtime errors or unexpected conditions. |
---|
[5609] | 18 | !> - fatal : Severe errors that cause premature termination. |
---|
| 19 | !> - none : to not create and write any information in logger file.<br /> |
---|
[6393] | 20 | !> @warn in this case only FATAL ERROR will be detected.<br /> |
---|
| 21 | !> |
---|
| 22 | !> @note default verbosity is warning |
---|
| 23 | !> |
---|
[5037] | 24 | !> If total number of error exceeded maximum number |
---|
| 25 | !> authorized, program stop. |
---|
[4213] | 26 | !> |
---|
[5037] | 27 | !> to open/create logger file:<br/> |
---|
| 28 | !> @code |
---|
[5609] | 29 | !> CALL logger_open(cd_file, [cd_verbosity,] [id_maxerror,] [id_loggerid]) |
---|
[5037] | 30 | !> @endcode |
---|
| 31 | !> - cd_file is logger file name |
---|
| 32 | !> - cd_verbosity is verbosity to be used [optional, default 'warning'] |
---|
| 33 | !> - id_loggerid is file id [optional, use only to flush] |
---|
| 34 | !> - id_maxerror is the maximum number of error authorized before program stop [optional, default 5] |
---|
[4213] | 35 | !> |
---|
[5037] | 36 | !> to close logger file:<br/> |
---|
| 37 | !> @code |
---|
| 38 | !> CALL logger_close() |
---|
| 39 | !> @endcode |
---|
[4213] | 40 | !> |
---|
[6393] | 41 | !> to clean logger file:<br/> |
---|
| 42 | !> @code |
---|
| 43 | !> CALL logger_clean() |
---|
| 44 | !> @endcode |
---|
| 45 | !> |
---|
[5037] | 46 | !> to write header in logger file:<br/> |
---|
| 47 | !> @code |
---|
| 48 | !> CALL logger_header() |
---|
| 49 | !> @endcode |
---|
[4213] | 50 | !> |
---|
[5037] | 51 | !> to write footer in logger file:<br/> |
---|
| 52 | !> @code |
---|
| 53 | !> CALL logger_footer() |
---|
| 54 | !> @endcode |
---|
[4213] | 55 | !> |
---|
[5037] | 56 | !> to flushing output:<br/> |
---|
| 57 | !> @code |
---|
| 58 | !> CALL logger_flush() |
---|
| 59 | !> @endcode |
---|
[4213] | 60 | !> |
---|
[5037] | 61 | !> to write TRACE message in logger file:<br/> |
---|
| 62 | !> @code |
---|
| 63 | !> CALL logger_trace(cd_msg [,ld_flush]) |
---|
| 64 | !> @endcode |
---|
| 65 | !> - cd_msg is TRACE message |
---|
| 66 | !> - ld_flush to flush output [optional] |
---|
[4213] | 67 | !> |
---|
[5037] | 68 | !> to write DEBUG message in logger file:<br/> |
---|
| 69 | !> @code |
---|
| 70 | !> CALL logger_debug(cd_msg [,ld_flush]) |
---|
| 71 | !> @endcode |
---|
| 72 | !> - cd_msg is DEBUG message |
---|
| 73 | !> - ld_flush to flush output [optional] |
---|
[4213] | 74 | !> |
---|
[5037] | 75 | !> to write INFO message in logger file:<br/> |
---|
| 76 | !> @code |
---|
| 77 | !> CALL logger_info(cd_msg [,ld_flush]) |
---|
| 78 | !> @endcode |
---|
| 79 | !> - cd_msg is INFO message |
---|
| 80 | !> - ld_flush to flush output [optional] |
---|
[4213] | 81 | !> |
---|
[5037] | 82 | !> to write WARNING message in logger file:<br/> |
---|
| 83 | !> @code |
---|
| 84 | !> CALL logger_warn(cd_msg [,ld_flush]) |
---|
| 85 | !> @endcode |
---|
| 86 | !> - cd_msg is WARNING message |
---|
| 87 | !> - ld_flush to flush output [optional] |
---|
[4213] | 88 | !> |
---|
[5037] | 89 | !> to write ERROR message in logger file:<br/> |
---|
| 90 | !> @code |
---|
| 91 | !> CALL logger_error(cd_msg [,ld_flush]) |
---|
| 92 | !> @endcode |
---|
| 93 | !> - cd_msg is ERROR message |
---|
| 94 | !> - ld_flush to flush output [optional] |
---|
[4213] | 95 | !> |
---|
[5037] | 96 | !> to write FATAL message in logger file:<br/> |
---|
| 97 | !> @code |
---|
| 98 | !> CALL logger_fatal(cd_msg) |
---|
| 99 | !> @endcode |
---|
| 100 | !> - cd_msg is FATAL message |
---|
[4213] | 101 | !> |
---|
[5037] | 102 | !> Examples :<br /> |
---|
| 103 | !> @code |
---|
[4213] | 104 | !> CALL logger_open('loggerfile.txt','info') |
---|
| 105 | !> |
---|
[5037] | 106 | !> CALL logger_header() |
---|
| 107 | !> CALL logger_debug('une info de debug') |
---|
| 108 | !> CALL logger_info('une info') |
---|
| 109 | !> CALL logger_warn('un warning') |
---|
| 110 | !> CALL logger_error('une erreur') |
---|
| 111 | !> CALL logger_footer() |
---|
| 112 | !> CALL logger_close() |
---|
[6393] | 113 | !> CALL logger_clean() |
---|
[5037] | 114 | !> @endcode |
---|
[4213] | 115 | !> |
---|
[5037] | 116 | !> @code |
---|
[4213] | 117 | !> CALL logger_open('loggerfile.txt') |
---|
| 118 | !> |
---|
[5037] | 119 | !> CALL logger_header() |
---|
| 120 | !> CALL logger_debug('une info de debug') |
---|
| 121 | !> CALL logger_info('une info') |
---|
| 122 | !> CALL logger_warn('un warning') |
---|
| 123 | !> CALL logger_error('une erreur') |
---|
| 124 | !> CALL logger_footer() |
---|
| 125 | !> CALL logger_close() |
---|
[6393] | 126 | !> CALL logger_clean() |
---|
[5037] | 127 | !> @endcode |
---|
[12080] | 128 | !> |
---|
[4213] | 129 | !> @author |
---|
| 130 | !> J.Paul |
---|
[12080] | 131 | !> |
---|
[5617] | 132 | !> @date November, 2013 - Initial Version |
---|
[5609] | 133 | !> @date February, 2015 |
---|
| 134 | !> - check verbosity validity |
---|
| 135 | !> - add 'none' verbosity level to not used logger file |
---|
[6393] | 136 | !> @date January, 2016 |
---|
| 137 | !> - add logger_clean subroutine |
---|
[4213] | 138 | !> |
---|
[12080] | 139 | !> @note Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[4213] | 140 | !---------------------------------------------------------------------- |
---|
| 141 | MODULE logger |
---|
[12080] | 142 | |
---|
[4213] | 143 | USE kind ! F90 kind parameter |
---|
| 144 | USE fct ! basic useful function |
---|
| 145 | IMPLICIT NONE |
---|
| 146 | ! NOTE_avoid_public_variables_if_possible |
---|
| 147 | |
---|
| 148 | ! type and variable |
---|
[5037] | 149 | PRIVATE :: TLOGGER !< logger structure |
---|
[4213] | 150 | |
---|
[5037] | 151 | PRIVATE :: tm_logger !< logger structure |
---|
| 152 | PRIVATE :: im_nverbosity !< number of log level |
---|
| 153 | PRIVATE :: cm_verbosity !< verbosity array |
---|
| 154 | |
---|
[4213] | 155 | ! function and subroutine |
---|
[5037] | 156 | PUBLIC :: logger_open !< create a log file with given verbosity |
---|
| 157 | PUBLIC :: logger_close !< close log file |
---|
[6393] | 158 | PUBLIC :: logger_clean !< clean log structure |
---|
[5037] | 159 | PUBLIC :: logger_header !< write header on log file |
---|
| 160 | PUBLIC :: logger_footer !< write footer on log file |
---|
| 161 | PUBLIC :: logger_flush !< flushing output |
---|
| 162 | PUBLIC :: logger_trace !< write trace message in log file |
---|
| 163 | PUBLIC :: logger_debug !< write debug message in log file |
---|
| 164 | PUBLIC :: logger_info !< write info message in log file |
---|
| 165 | PUBLIC :: logger_warn !< write warning message in log file |
---|
| 166 | PUBLIC :: logger_error !< write error message in log file |
---|
| 167 | PUBLIC :: logger_fatal !< write fatal message in log file, and stop |
---|
[4213] | 168 | |
---|
| 169 | PRIVATE :: logger__write ! cut message to get maximum of 80 character by line in log file |
---|
[5609] | 170 | PRIVATE :: logger__check_verb! check verbosity validity |
---|
[4213] | 171 | |
---|
[5037] | 172 | TYPE TLOGGER !< logger structure |
---|
[4213] | 173 | INTEGER(i4) :: i_id = 0 !< log file id |
---|
[5609] | 174 | LOGICAL :: l_use=.TRUE. !< use logger or not |
---|
[4213] | 175 | CHARACTER(LEN=lc) :: c_name !< log file name |
---|
| 176 | CHARACTER(LEN=lc) :: c_verbosity = "warning" !< verbosity choose |
---|
[5037] | 177 | CHARACTER(LEN=lc) :: c_verb = "" !< array of "verbosities" to used |
---|
[4213] | 178 | INTEGER(i4) :: i_nerror = 0 !< number of error |
---|
| 179 | INTEGER(i4) :: i_nfatal = 0 !< number of fatal error |
---|
| 180 | INTEGER(i4) :: i_maxerror = 5 !< maximum number of error before stoping program |
---|
| 181 | END TYPE TLOGGER |
---|
| 182 | |
---|
| 183 | ! module variable |
---|
[5609] | 184 | INTEGER(i4), PARAMETER :: im_nverbosity=7 !< number of log level |
---|
[5037] | 185 | CHARACTER(len=*), DIMENSION(im_nverbosity), PARAMETER :: cm_verbosity= & !< verbosity array |
---|
[4213] | 186 | & (/ 'trace ',& |
---|
| 187 | & 'debug ',& |
---|
| 188 | & 'info ',& |
---|
| 189 | & 'warning ',& |
---|
| 190 | & 'error ',& |
---|
[5609] | 191 | & 'fatal ',& |
---|
| 192 | & 'none '/) |
---|
[4213] | 193 | |
---|
| 194 | TYPE(TLOGGER), SAVE :: tm_logger !< logger structure |
---|
| 195 | |
---|
| 196 | CONTAINS |
---|
[12080] | 197 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 198 | SUBROUTINE logger_open(cd_file, cd_verbosity, id_maxerror, id_logid) |
---|
[4213] | 199 | !------------------------------------------------------------------- |
---|
[5037] | 200 | !> @brief This subroutine create a log file with default verbosity |
---|
| 201 | !> ('warning'). |
---|
| 202 | !> @details |
---|
| 203 | !> Optionally verbosity could be change to |
---|
| 204 | !> ('trace','debug','info',warning','error','fatal').<br/> |
---|
| 205 | !> Optionally maximum number of error allowed could be change. |
---|
[4213] | 206 | !> |
---|
| 207 | !> @author J.Paul |
---|
[5617] | 208 | !> @date November, 2013 - Initial Version |
---|
[12080] | 209 | !> |
---|
[5037] | 210 | !> @param[in] cd_file log file name |
---|
| 211 | !> @param[in] cd_verbosity log file verbosity |
---|
[5609] | 212 | !> @param[in] id_maxerror maximum number of error |
---|
[5037] | 213 | !> @param[in] id_logid log file id (use to flush) |
---|
[4213] | 214 | !------------------------------------------------------------------- |
---|
[12080] | 215 | |
---|
[4213] | 216 | IMPLICIT NONE |
---|
[12080] | 217 | |
---|
[4213] | 218 | ! Argument |
---|
| 219 | CHARACTER(len=*), INTENT(IN) :: cd_file ! log file name |
---|
| 220 | CHARACTER(len=*), INTENT(IN), OPTIONAL :: cd_verbosity ! log file verbosity |
---|
[5609] | 221 | INTEGER(i4), INTENT(IN), OPTIONAL :: id_maxerror ! log max error |
---|
[4213] | 222 | INTEGER(i4), INTENT(IN), OPTIONAL :: id_logid ! log file id |
---|
| 223 | |
---|
| 224 | ! local variable |
---|
| 225 | INTEGER(i4) :: il_status |
---|
| 226 | |
---|
[5609] | 227 | LOGICAL :: ll_valid |
---|
| 228 | |
---|
[4213] | 229 | ! loop |
---|
| 230 | INTEGER(i4) :: ji |
---|
| 231 | !---------------------------------------------------------------- |
---|
| 232 | |
---|
| 233 | ! if present, change verbosity value |
---|
| 234 | IF( PRESENT(cd_verbosity) )THEN |
---|
[5609] | 235 | ll_valid=logger__check_verb(TRIM(ADJUSTL(cd_verbosity))) |
---|
| 236 | IF( ll_valid )THEN |
---|
| 237 | tm_logger%c_verbosity=TRIM(ADJUSTL(cd_verbosity)) |
---|
| 238 | ENDIF |
---|
[4213] | 239 | ENDIF |
---|
| 240 | |
---|
[5609] | 241 | IF( TRIM(tm_logger%c_verbosity) == 'none' ) tm_logger%l_use=.FALSE. |
---|
| 242 | |
---|
| 243 | IF( tm_logger%l_use )THEN |
---|
[4213] | 244 | |
---|
[5609] | 245 | ! get id if not already define |
---|
| 246 | IF( PRESENT(id_logid) )THEN |
---|
| 247 | tm_logger%i_id=id_logid |
---|
| 248 | ELSE |
---|
| 249 | tm_logger%i_id=fct_getunit() |
---|
| 250 | ENDIF |
---|
| 251 | |
---|
| 252 | ! open log file |
---|
| 253 | OPEN( tm_logger%i_id, & |
---|
| 254 | & STATUS="unknown", & |
---|
| 255 | & FILE=TRIM(ADJUSTL(cd_file)), & |
---|
| 256 | & ACTION="write", & |
---|
| 257 | & POSITION="append", & |
---|
| 258 | & IOSTAT=il_status) |
---|
| 259 | CALL fct_err(il_status) |
---|
| 260 | |
---|
| 261 | ! keep filename |
---|
| 262 | tm_logger%c_name=TRIM(ADJUSTL(cd_file)) |
---|
| 263 | |
---|
| 264 | ! compute "tab" of verbosity to be used |
---|
| 265 | IF( TRIM(ADJUSTL(tm_logger%c_verb)) == "" )THEN |
---|
| 266 | DO ji=im_nverbosity,1,-1 |
---|
| 267 | tm_logger%c_verb = & |
---|
| 268 | & TRIM(tm_logger%c_verb)//" "//TRIM(ADJUSTL(cm_verbosity(ji))) |
---|
| 269 | IF( TRIM(tm_logger%c_verbosity) == TRIM(cm_verbosity(ji)) )THEN |
---|
| 270 | EXIT |
---|
| 271 | ENDIF |
---|
| 272 | ENDDO |
---|
| 273 | ENDIF |
---|
| 274 | |
---|
| 275 | IF( PRESENT(id_maxerror) )THEN |
---|
| 276 | tm_logger%i_maxerror=id_maxerror |
---|
| 277 | ENDIF |
---|
| 278 | |
---|
[4213] | 279 | ENDIF |
---|
| 280 | |
---|
| 281 | END SUBROUTINE logger_open |
---|
[12080] | 282 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 283 | SUBROUTINE logger_close() |
---|
[4213] | 284 | !------------------------------------------------------------------- |
---|
| 285 | !> @brief This subroutine close a log file. |
---|
| 286 | !> |
---|
| 287 | !> @author J.Paul |
---|
[5617] | 288 | !> @date November, 2013 - Initial Version |
---|
[4213] | 289 | !------------------------------------------------------------------- |
---|
[12080] | 290 | |
---|
[4213] | 291 | IMPLICIT NONE |
---|
[12080] | 292 | |
---|
[4213] | 293 | ! local variable |
---|
[6393] | 294 | INTEGER(i4) :: il_status |
---|
[4213] | 295 | !---------------------------------------------------------------- |
---|
[12080] | 296 | |
---|
[5609] | 297 | IF( tm_logger%l_use )THEN |
---|
| 298 | IF( tm_logger%i_id /= 0 )THEN |
---|
[6393] | 299 | !tm_logger%i_id = 0 |
---|
[5609] | 300 | CLOSE( tm_logger%i_id, & |
---|
| 301 | & IOSTAT=il_status) |
---|
| 302 | CALL fct_err(il_status) |
---|
| 303 | ELSE |
---|
| 304 | CALL logger_open('logger.log') |
---|
| 305 | CALL logger_header() |
---|
| 306 | CALL logger_fatal('you must have create logger to use logger_close') |
---|
| 307 | ENDIF |
---|
[4213] | 308 | ENDIF |
---|
| 309 | |
---|
| 310 | END SUBROUTINE logger_close |
---|
[12080] | 311 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 312 | SUBROUTINE logger_clean() |
---|
[4213] | 313 | !------------------------------------------------------------------- |
---|
[6393] | 314 | !> @brief This subroutine clean a log structure. |
---|
| 315 | !> |
---|
| 316 | !> @author J.Paul |
---|
| 317 | !> @date January, 2016 - Initial Version |
---|
| 318 | !------------------------------------------------------------------- |
---|
[12080] | 319 | |
---|
[6393] | 320 | IMPLICIT NONE |
---|
[12080] | 321 | |
---|
[6393] | 322 | ! local variable |
---|
| 323 | TYPE(TLOGGER) :: tl_logger |
---|
| 324 | !---------------------------------------------------------------- |
---|
[12080] | 325 | |
---|
[6393] | 326 | tm_logger = tl_logger |
---|
| 327 | |
---|
| 328 | END SUBROUTINE logger_clean |
---|
[12080] | 329 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
[6393] | 330 | !------------------------------------------------------------------- |
---|
[4213] | 331 | !> @brief This subroutine flushing output into log file. |
---|
| 332 | !> |
---|
| 333 | !> @author J.Paul |
---|
[5617] | 334 | !> @date November, 2013 - Initial Version |
---|
[4213] | 335 | !------------------------------------------------------------------- |
---|
| 336 | SUBROUTINE logger_flush() |
---|
[12080] | 337 | |
---|
[4213] | 338 | IMPLICIT NONE |
---|
[12080] | 339 | |
---|
[4213] | 340 | !---------------------------------------------------------------- |
---|
[12080] | 341 | |
---|
[5609] | 342 | IF( tm_logger%l_use )THEN |
---|
| 343 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 344 | CALL logger_close() |
---|
| 345 | CALL logger_open( tm_logger%c_name, tm_logger%c_verbosity, & |
---|
| 346 | & tm_logger%i_maxerror, tm_logger%i_id ) |
---|
| 347 | ELSE |
---|
| 348 | CALL logger_open('logger.log') |
---|
| 349 | CALL logger_header() |
---|
| 350 | CALL logger_fatal('you must have create logger to use logger_flush') |
---|
| 351 | ENDIF |
---|
[4213] | 352 | ENDIF |
---|
| 353 | |
---|
| 354 | END SUBROUTINE logger_flush |
---|
[12080] | 355 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 356 | RECURSIVE SUBROUTINE logger_header() |
---|
[4213] | 357 | !------------------------------------------------------------------- |
---|
| 358 | !> @brief This subroutine write header on log file. |
---|
| 359 | !> |
---|
| 360 | !> @author J.Paul |
---|
[5617] | 361 | !> @date November, 2013 - Initial Version |
---|
[4213] | 362 | !------------------------------------------------------------------- |
---|
[12080] | 363 | |
---|
[4213] | 364 | IMPLICIT NONE |
---|
[12080] | 365 | |
---|
[4213] | 366 | ! local variable |
---|
[5037] | 367 | INTEGER(i4) :: il_status |
---|
[4213] | 368 | !---------------------------------------------------------------- |
---|
[12080] | 369 | |
---|
[5609] | 370 | IF( tm_logger%l_use )THEN |
---|
| 371 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 372 | WRITE( tm_logger%i_id, & |
---|
| 373 | & FMT='(4(a/))', & |
---|
| 374 | & IOSTAT=il_status ) & |
---|
| 375 | & "--------------------------------------------------",& |
---|
| 376 | & "INIT : verbosity "//TRIM(tm_logger%c_verbosity),& |
---|
| 377 | & "INIT : max error "//TRIM(fct_str(tm_logger%i_maxerror)), & |
---|
| 378 | & "--------------------------------------------------" |
---|
| 379 | CALL fct_err(il_status) |
---|
| 380 | ELSE |
---|
| 381 | CALL logger_open('logger.log') |
---|
| 382 | CALL logger_header() |
---|
| 383 | CALL logger_fatal('you must have create logger to use logger_header') |
---|
| 384 | ENDIF |
---|
[4213] | 385 | ENDIF |
---|
| 386 | |
---|
| 387 | END SUBROUTINE logger_header |
---|
[12080] | 388 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 389 | SUBROUTINE logger_footer() |
---|
[4213] | 390 | !------------------------------------------------------------------- |
---|
| 391 | !> @brief This subroutine write footer on log file. |
---|
| 392 | !> |
---|
| 393 | !> @author J.Paul |
---|
[5617] | 394 | !> @date November, 2013 - Initial Version |
---|
[4213] | 395 | !------------------------------------------------------------------- |
---|
[12080] | 396 | |
---|
[4213] | 397 | IMPLICIT NONE |
---|
[12080] | 398 | |
---|
[4213] | 399 | ! local variable |
---|
[5037] | 400 | INTEGER(i4) :: il_status |
---|
[4213] | 401 | !---------------------------------------------------------------- |
---|
[12080] | 402 | |
---|
[5609] | 403 | IF( tm_logger%l_use )THEN |
---|
| 404 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 405 | WRITE( tm_logger%i_id, & |
---|
| 406 | & FMT='(4(/a))', & |
---|
| 407 | & IOSTAT=il_status ) & |
---|
| 408 | & "--------------------------------------------------",& |
---|
| 409 | & "END : log ended ", & |
---|
| 410 | & "END : "//TRIM(fct_str(tm_logger%i_nerror))// & |
---|
| 411 | & " ERROR detected ", & |
---|
| 412 | & "END : "//TRIM(fct_str(tm_logger%i_nfatal))// & |
---|
| 413 | & " FATAL detected ", & |
---|
| 414 | & "--------------------------------------------------" |
---|
| 415 | CALL fct_err(il_status) |
---|
| 416 | ELSE |
---|
| 417 | CALL logger_open('logger.log') |
---|
| 418 | CALL logger_header() |
---|
| 419 | CALL logger_fatal('you must have create logger to use logger_footer') |
---|
| 420 | ENDIF |
---|
[4213] | 421 | ENDIF |
---|
[12080] | 422 | |
---|
[4213] | 423 | END SUBROUTINE logger_footer |
---|
[12080] | 424 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 425 | SUBROUTINE logger_trace(cd_msg, ld_flush) |
---|
[4213] | 426 | !------------------------------------------------------------------- |
---|
| 427 | !> @brief This subroutine write trace message on log file. |
---|
[5037] | 428 | !> @details |
---|
| 429 | !> Optionally you could flush output. |
---|
[4213] | 430 | !> |
---|
| 431 | !> @author J.Paul |
---|
[5617] | 432 | !> @date November, 2013 - Initial Version |
---|
[12080] | 433 | !> |
---|
[5037] | 434 | !> @param[in] cd_msg message to write |
---|
| 435 | !> @param[in] ld_flush flushing ouput |
---|
[4213] | 436 | !------------------------------------------------------------------- |
---|
[12080] | 437 | |
---|
[4213] | 438 | IMPLICIT NONE |
---|
[12080] | 439 | |
---|
[4213] | 440 | ! Argument |
---|
| 441 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 442 | LOGICAL, INTENT(IN), OPTIONAL :: ld_flush |
---|
| 443 | !---------------------------------------------------------------- |
---|
[12080] | 444 | |
---|
[5609] | 445 | IF( tm_logger%l_use )THEN |
---|
| 446 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 447 | IF( INDEX(TRIM(tm_logger%c_verb),'trace')/=0 )THEN |
---|
[4213] | 448 | |
---|
[5609] | 449 | CALL logger__write("TRACE :",cd_msg) |
---|
[4213] | 450 | |
---|
[5609] | 451 | IF( PRESENT(ld_flush) )THEN |
---|
| 452 | IF( ld_flush )THEN |
---|
| 453 | CALL logger_flush() |
---|
| 454 | ENDIF |
---|
| 455 | ENDIF |
---|
| 456 | ENDIF |
---|
| 457 | ELSE |
---|
| 458 | CALL logger_open('logger.log') |
---|
| 459 | CALL logger_header() |
---|
| 460 | CALL logger_fatal('you must have create logger to use logger_trace') |
---|
[4213] | 461 | ENDIF |
---|
| 462 | ENDIF |
---|
[12080] | 463 | |
---|
[4213] | 464 | END SUBROUTINE logger_trace |
---|
[12080] | 465 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 466 | SUBROUTINE logger_debug(cd_msg, ld_flush) |
---|
[4213] | 467 | !------------------------------------------------------------------- |
---|
| 468 | !> @brief This subroutine write debug message on log file. |
---|
[5037] | 469 | !> @details |
---|
| 470 | !> Optionally you could flush output. |
---|
[4213] | 471 | !> |
---|
| 472 | !> @author J.Paul |
---|
[5617] | 473 | !> @date November, 2013 - Initial Version |
---|
[12080] | 474 | !> |
---|
[5037] | 475 | !> @param[in] cd_msg message to write |
---|
| 476 | !> @param[in] ld_flush flushing ouput |
---|
[4213] | 477 | !------------------------------------------------------------------- |
---|
[12080] | 478 | |
---|
[4213] | 479 | IMPLICIT NONE |
---|
[12080] | 480 | |
---|
[4213] | 481 | ! Argument |
---|
| 482 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 483 | LOGICAL, INTENT(IN), OPTIONAL :: ld_flush |
---|
| 484 | !---------------------------------------------------------------- |
---|
[12080] | 485 | |
---|
[5609] | 486 | IF( tm_logger%l_use )THEN |
---|
| 487 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 488 | IF( INDEX(TRIM(tm_logger%c_verb),'debug')/=0 )THEN |
---|
[4213] | 489 | |
---|
[5609] | 490 | CALL logger__write("DEBUG :",cd_msg) |
---|
[4213] | 491 | |
---|
[5609] | 492 | IF( PRESENT(ld_flush) )THEN |
---|
| 493 | IF( ld_flush )THEN |
---|
| 494 | CALL logger_flush() |
---|
| 495 | ENDIF |
---|
| 496 | ENDIF |
---|
| 497 | ENDIF |
---|
| 498 | ELSE |
---|
| 499 | CALL logger_open('logger.log') |
---|
| 500 | CALL logger_header() |
---|
| 501 | CALL logger_fatal('you must have create logger to use logger_debug') |
---|
[4213] | 502 | ENDIF |
---|
| 503 | ENDIF |
---|
[12080] | 504 | |
---|
[4213] | 505 | END SUBROUTINE logger_debug |
---|
[12080] | 506 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 507 | SUBROUTINE logger_info(cd_msg, ld_flush) |
---|
[4213] | 508 | !------------------------------------------------------------------- |
---|
| 509 | !> @brief This subroutine write info message on log file. |
---|
[5037] | 510 | !> @details |
---|
| 511 | !> Optionally you could flush output. |
---|
[4213] | 512 | !> |
---|
| 513 | !> @author J.Paul |
---|
[5617] | 514 | !> @date November, 2013 - Initial Version |
---|
[12080] | 515 | !> |
---|
[5037] | 516 | !> @param[in] cd_msg message to write |
---|
| 517 | !> @param[in] ld_flush flushing ouput |
---|
[4213] | 518 | !------------------------------------------------------------------- |
---|
[12080] | 519 | |
---|
[4213] | 520 | IMPLICIT NONE |
---|
[12080] | 521 | |
---|
[4213] | 522 | ! Argument |
---|
| 523 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 524 | LOGICAL, INTENT(IN), OPTIONAL :: ld_flush |
---|
| 525 | !---------------------------------------------------------------- |
---|
[12080] | 526 | |
---|
[5609] | 527 | IF( tm_logger%l_use )THEN |
---|
| 528 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 529 | IF( INDEX(TRIM(tm_logger%c_verb),'info')/=0 )THEN |
---|
[4213] | 530 | |
---|
[5609] | 531 | CALL logger__write("INFO :",cd_msg) |
---|
[4213] | 532 | |
---|
[5609] | 533 | IF( PRESENT(ld_flush) )THEN |
---|
| 534 | IF( ld_flush )THEN |
---|
| 535 | CALL logger_flush() |
---|
| 536 | ENDIF |
---|
| 537 | ENDIF |
---|
| 538 | ENDIF |
---|
| 539 | ELSE |
---|
| 540 | CALL logger_open('logger.log') |
---|
| 541 | CALL logger_header() |
---|
| 542 | CALL logger_fatal('you must have create logger to use logger_info') |
---|
[4213] | 543 | ENDIF |
---|
| 544 | ENDIF |
---|
| 545 | END SUBROUTINE logger_info |
---|
[12080] | 546 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 547 | SUBROUTINE logger_warn(cd_msg, ld_flush) |
---|
[4213] | 548 | !------------------------------------------------------------------- |
---|
| 549 | !> @brief This subroutine write warning message on log file. |
---|
[5037] | 550 | !> @details |
---|
| 551 | !> Optionally you could flush output. |
---|
[4213] | 552 | !> |
---|
| 553 | !> @author J.Paul |
---|
[5617] | 554 | !> @date November, 2013 - Initial Version |
---|
[12080] | 555 | !> |
---|
[5037] | 556 | !> @param[in] cd_msg message to write |
---|
| 557 | !> @param[in] ld_flush flushing ouput |
---|
[4213] | 558 | !------------------------------------------------------------------- |
---|
[12080] | 559 | |
---|
[4213] | 560 | IMPLICIT NONE |
---|
[12080] | 561 | |
---|
[4213] | 562 | ! Argument |
---|
| 563 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 564 | LOGICAL, INTENT(IN), OPTIONAL :: ld_flush |
---|
| 565 | !---------------------------------------------------------------- |
---|
[12080] | 566 | |
---|
[5609] | 567 | IF( tm_logger%l_use )THEN |
---|
| 568 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 569 | IF( INDEX(TRIM(tm_logger%c_verb),'warn')/=0 )THEN |
---|
[4213] | 570 | |
---|
[5609] | 571 | CALL logger__write("WARNING :",cd_msg) |
---|
[4213] | 572 | |
---|
[5609] | 573 | IF( PRESENT(ld_flush) )THEN |
---|
| 574 | IF( ld_flush )THEN |
---|
| 575 | CALL logger_flush() |
---|
| 576 | ENDIF |
---|
| 577 | ENDIF |
---|
| 578 | ENDIF |
---|
| 579 | ELSE |
---|
| 580 | CALL logger_open('logger.log') |
---|
| 581 | CALL logger_header() |
---|
| 582 | CALL logger_fatal('you must have create logger to use logger_warn') |
---|
[4213] | 583 | ENDIF |
---|
| 584 | ENDIF |
---|
[12080] | 585 | |
---|
[4213] | 586 | END SUBROUTINE logger_warn |
---|
[12080] | 587 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 588 | SUBROUTINE logger_error(cd_msg, ld_flush) |
---|
[4213] | 589 | !------------------------------------------------------------------- |
---|
| 590 | !> @brief This subroutine write error message on log file. |
---|
[5037] | 591 | !> @details |
---|
| 592 | !> Optionally you could flush output. |
---|
[4213] | 593 | !> |
---|
| 594 | !> @author J.Paul |
---|
[5617] | 595 | !> @date November, 2013 - Initial Version |
---|
[12080] | 596 | !> |
---|
[5037] | 597 | !> @param[in] cd_msg message to write |
---|
| 598 | !> @param[in] ld_flush flushing ouput |
---|
[4213] | 599 | !------------------------------------------------------------------- |
---|
[12080] | 600 | |
---|
[4213] | 601 | IMPLICIT NONE |
---|
[12080] | 602 | |
---|
[4213] | 603 | ! Argument |
---|
| 604 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 605 | LOGICAL, INTENT(IN), OPTIONAL :: ld_flush |
---|
| 606 | |
---|
| 607 | ! local variable |
---|
| 608 | CHARACTER(LEN=lc) :: cl_nerror |
---|
| 609 | !---------------------------------------------------------------- |
---|
[12080] | 610 | |
---|
[5609] | 611 | IF( tm_logger%l_use )THEN |
---|
| 612 | IF( tm_logger%i_id /= 0 )THEN |
---|
[6393] | 613 | ! increment the error number |
---|
| 614 | tm_logger%i_nerror=tm_logger%i_nerror+1 |
---|
[4213] | 615 | |
---|
[5609] | 616 | IF( INDEX(TRIM(tm_logger%c_verb),'error')/=0 )THEN |
---|
[4213] | 617 | |
---|
[5609] | 618 | CALL logger__write("ERROR :",cd_msg) |
---|
[4213] | 619 | |
---|
[5609] | 620 | IF( PRESENT(ld_flush) )THEN |
---|
| 621 | IF( ld_flush )THEN |
---|
| 622 | CALL logger_flush() |
---|
| 623 | ENDIF |
---|
| 624 | ENDIF |
---|
| 625 | ENDIF |
---|
[4213] | 626 | |
---|
[5609] | 627 | IF( tm_logger%i_nerror >= tm_logger%i_maxerror )THEN |
---|
| 628 | WRITE(cl_nerror,*) tm_logger%i_maxerror |
---|
| 629 | CALL logger_fatal(& |
---|
| 630 | & 'Error count reached limit of '//TRIM(ADJUSTL(cl_nerror)) ) |
---|
| 631 | ENDIF |
---|
| 632 | ELSE |
---|
| 633 | CALL logger_open('logger.log') |
---|
| 634 | CALL logger_header() |
---|
| 635 | CALL logger_fatal('you must have create logger to use logger_error') |
---|
[4213] | 636 | ENDIF |
---|
| 637 | ENDIF |
---|
[12080] | 638 | |
---|
[4213] | 639 | END SUBROUTINE logger_error |
---|
[12080] | 640 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 641 | RECURSIVE SUBROUTINE logger_fatal(cd_msg) |
---|
[4213] | 642 | !------------------------------------------------------------------- |
---|
| 643 | !> @brief This subroutine write fatal error message on log file, |
---|
| 644 | !> close log file and stop process. |
---|
| 645 | !> |
---|
| 646 | !> @author J.Paul |
---|
[5617] | 647 | !> @date November, 2013 - Initial Version |
---|
[6393] | 648 | !> @date September, 2015 |
---|
| 649 | !> - stop program for FATAL ERROR if verbosity is none |
---|
[12080] | 650 | !> |
---|
[5037] | 651 | !> @param[in] cd_msg message to write |
---|
[4213] | 652 | !------------------------------------------------------------------- |
---|
[12080] | 653 | |
---|
[4213] | 654 | IMPLICIT NONE |
---|
[12080] | 655 | |
---|
[4213] | 656 | ! Argument |
---|
| 657 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 658 | !---------------------------------------------------------------- |
---|
[12080] | 659 | |
---|
[5609] | 660 | IF( tm_logger%l_use )THEN |
---|
| 661 | IF( tm_logger%i_id /= 0 )THEN |
---|
| 662 | IF( INDEX(TRIM(tm_logger%c_verb),'fatal')/=0 )THEN |
---|
| 663 | ! increment the error number |
---|
| 664 | tm_logger%i_nfatal=tm_logger%i_nfatal+1 |
---|
[4213] | 665 | |
---|
[5609] | 666 | CALL logger__write("FATAL :",cd_msg) |
---|
[4213] | 667 | |
---|
[5609] | 668 | CALL logger_footer() |
---|
| 669 | CALL logger_close() |
---|
[4213] | 670 | |
---|
[12080] | 671 | WRITE(*,*) 'FATAL ERROR, see ',TRIM(tm_logger%c_name) |
---|
[5609] | 672 | STOP |
---|
| 673 | ENDIF |
---|
| 674 | ELSE |
---|
| 675 | CALL logger_open('logger.log') |
---|
| 676 | CALL logger_header() |
---|
| 677 | CALL logger_fatal('you must have create logger to use logger_fatal') |
---|
[4213] | 678 | ENDIF |
---|
[6393] | 679 | ELSE |
---|
| 680 | PRINT *,"FATAL ERROR :"//TRIM(cd_msg) |
---|
| 681 | STOP |
---|
[4213] | 682 | ENDIF |
---|
[12080] | 683 | |
---|
[4213] | 684 | END SUBROUTINE logger_fatal |
---|
[12080] | 685 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 686 | SUBROUTINE logger__write(cd_verb, cd_msg) |
---|
[4213] | 687 | !------------------------------------------------------------------- |
---|
| 688 | !> @brief This subroutine cut message to get maximum of 80 character |
---|
| 689 | !> by line in log file. |
---|
| 690 | !> |
---|
| 691 | !> @author J.Paul |
---|
[5617] | 692 | !> @date November, 2013 - Initial Version |
---|
[12080] | 693 | !> |
---|
[5037] | 694 | !> @param[in] cd_verb verbosity of the message to write |
---|
| 695 | !> @param[in] cd_msg message to write |
---|
[4213] | 696 | !------------------------------------------------------------------- |
---|
[12080] | 697 | |
---|
[4213] | 698 | IMPLICIT NONE |
---|
[12080] | 699 | |
---|
[4213] | 700 | ! Argument |
---|
| 701 | CHARACTER(LEN=*), INTENT(IN) :: cd_verb |
---|
| 702 | CHARACTER(LEN=*), INTENT(IN) :: cd_msg |
---|
| 703 | |
---|
| 704 | ! local variable |
---|
| 705 | INTEGER(i4) :: il_status |
---|
| 706 | INTEGER(i4) :: il_verb |
---|
| 707 | INTEGER(i4) :: il_msg |
---|
| 708 | CHARACTER(LEN=lc) :: cl_verb |
---|
| 709 | CHARACTER(LEN=lc) :: cl_msg |
---|
| 710 | CHARACTER(LEN=lc) :: cl_tmp |
---|
[12080] | 711 | !---------------------------------------------------------------- |
---|
[4213] | 712 | |
---|
| 713 | cl_verb=TRIM(ADJUSTL(cd_verb)) |
---|
| 714 | cl_msg=TRIM(ADJUSTL(cd_msg)) |
---|
| 715 | |
---|
| 716 | il_verb=LEN_TRIM(cl_verb) |
---|
| 717 | il_msg=LEN_TRIM(cl_msg) |
---|
| 718 | DO WHILE( il_verb + il_msg > 78 ) |
---|
| 719 | cl_tmp=TRIM(cl_verb)//' '//TRIM(cl_msg(1:78-il_verb)) |
---|
| 720 | |
---|
| 721 | WRITE( tm_logger%i_id, & |
---|
| 722 | & FMT=*, & |
---|
| 723 | & IOSTAT=il_status & |
---|
| 724 | & ) TRIM(cl_tmp) |
---|
| 725 | CALL fct_err(il_status) |
---|
| 726 | |
---|
| 727 | |
---|
| 728 | cl_msg=cl_msg(78-il_verb+1:il_msg) |
---|
| 729 | cl_verb=" :" |
---|
| 730 | |
---|
| 731 | il_msg=LEN_TRIM(cl_msg) |
---|
| 732 | |
---|
| 733 | ENDDO |
---|
| 734 | |
---|
| 735 | cl_tmp=TRIM(cl_verb)//' '//TRIM(cl_msg) |
---|
| 736 | WRITE( tm_logger%i_id, & |
---|
| 737 | & FMT=*, & |
---|
| 738 | & IOSTAT=il_status & |
---|
| 739 | & ) TRIM(cl_tmp) |
---|
| 740 | CALL fct_err(il_status) |
---|
| 741 | |
---|
| 742 | END SUBROUTINE logger__write |
---|
[12080] | 743 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 744 | FUNCTION logger__check_verb(cd_verb) & |
---|
| 745 | & RESULT (lf_show) |
---|
[5609] | 746 | !------------------------------------------------------------------- |
---|
| 747 | !> @brief This function check validity of verbosity. |
---|
| 748 | !> |
---|
| 749 | !> @author J.Paul |
---|
[5617] | 750 | !> @date February, 2015 - Initial Version |
---|
[12080] | 751 | !> |
---|
[5609] | 752 | !> @param[in] cd_verb verbosity of the message to write |
---|
| 753 | !> @return verbosity is valid or not |
---|
| 754 | !------------------------------------------------------------------- |
---|
[12080] | 755 | |
---|
[5609] | 756 | IMPLICIT NONE |
---|
[12080] | 757 | |
---|
[5609] | 758 | ! Argument |
---|
[12080] | 759 | CHARACTER(LEN=*), INTENT(IN) :: cd_verb |
---|
[5609] | 760 | |
---|
| 761 | !function |
---|
[12080] | 762 | LOGICAL :: lf_show |
---|
[5609] | 763 | |
---|
| 764 | ! local variable |
---|
| 765 | ! loop indices |
---|
| 766 | INTEGER(i4) :: ji |
---|
| 767 | !---------------------------------------------------------------- |
---|
| 768 | |
---|
[12080] | 769 | lf_show=.FALSE. |
---|
| 770 | |
---|
[5609] | 771 | DO ji=1,im_nverbosity |
---|
| 772 | IF( TRIM(cd_verb) == TRIM(cm_verbosity(ji)) )THEN |
---|
[12080] | 773 | lf_show=.TRUE. |
---|
[5609] | 774 | EXIT |
---|
| 775 | ENDIF |
---|
| 776 | ENDDO |
---|
| 777 | |
---|
[12080] | 778 | IF( .NOT. lf_show )THEN |
---|
[5609] | 779 | CALL logger_open('logger.log') |
---|
| 780 | CALL logger_header() |
---|
| 781 | CALL logger_fatal('LOGGER : invalid verbosity, check namelist.'//& |
---|
| 782 | & ' default one will be used.') |
---|
| 783 | CALL logger_footer() |
---|
| 784 | ENDIF |
---|
[12080] | 785 | |
---|
[5609] | 786 | END FUNCTION logger__check_verb |
---|
[12080] | 787 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
[4213] | 788 | END MODULE logger |
---|
| 789 | |
---|