Merge branch 'release/1.0.1'

Author: samharrison7

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+Notable changes to the Fortran Error Handler will be documented here.
+
+## [Unreleased]
+
+## [1.0.1] - 2020-06-30
+### Added
+- Option to turn off printing of non-critical (warning) errors on trigger. Configured by `triggerWarnings` parameter on `ErrorHandler%init(...)`.
+- This CHANGELOG.
+
+### Fixed
+- A few corrections to documentation.
+
+## [1.0] - 2020-06-05
+### Added
+- First major release.
+
+[Unreleased]: https://github.com/samharrison7/fortran-error-handler/tree/develop 
+[1.0.1]: https://github.com/samharrison7/fortran-error-handler/tree/1.0.1
+[1.0]: https://github.com/samharrison7/fortran-error-handler/tree/1.0 

README.md

@@ -140,9 +140,9 @@ $ 1
 $ Input value is: 1
 ```
 
-The stop codes 105 and 106 are the default error codes for those particular limit criteria. These codes can be modified using the ErrorCriteria's `modifyErrorCriterionCode` procedure. See the [ErrorCriteria docs](docs/ErrorCriteria.md).
+The stop codes 105 and 106 are the default error codes for those particular limit criteria. These codes can be modified using the ErrorCriteria's `modifyErrorCriterionCode` procedure. See the [ErrorCriteria docs](doc/ErrorCriteria.md).
 
-The framework is designed to work seemlessly in large object-oriented projects, where Result objects can be returned from functions with ErrorInstances that contain a user-defined trace of where the error came from. The goal of such a trace is to provide more useful errors to end users of your application, who might not have access to the source code and thus find standard stack traces containing references to files and line numbers useless. More details can be found in the [ErrorInstance docs](docs/ErrorInstance.md), and more thorough examples in the [examples directory](example/).
+The framework is designed to work seemlessly in large object-oriented projects, where Result objects can be returned from functions with ErrorInstances that contain a user-defined trace of where the error came from. The goal of such a trace is to provide more useful errors to end users of your application, who might not have access to the source code and thus find standard stack traces containing references to files and line numbers useless. More details can be found in the [ErrorInstance docs](doc/ErrorInstance.md), and more thorough examples in the [examples directory](example/).
 
 ## Learn more <a name="more"></a>
 

doc/ErrorCriteria.md

@@ -33,7 +33,7 @@ Initialising ErrorCriteria serves the purpose of [initialising its parent](Error
 | `character(len=*), optional :: criticalPrefix` | Custom prefix to be prepended to critical error messages. | "Error:" |
 | `character(len=*), optional :: warningPrefix` | Custom prefix to non-critical (warning) error messages. | "Warning:" |
 | `character(len=*), optional :: messageSuffix` | Custom suffix to be appended to error message. | - |
-| `logical, optional :: bashColors` | Should colors be displayed in output to bash consoles? | .true. |
+| `logical, optional :: bashColors` | Should colors be displayed in output to bash consoles? | `.true.` |
 
 For example:
 

doc/ErrorHandler.md

@@ -22,8 +22,10 @@ The ErrorHandler must be initialised before use, by calling the `init` procedure
 | `character(len=*), optional :: criticalPrefix` | Custom prefix to be prepended to critical error messages. | "Error:" |
 | `character(len=*), optional :: warningPrefix` | Custom prefix to non-critical (warning) error messages. | "Warning:" |
 | `character(len=*), optional :: messageSuffix` | Custom suffix to be appended to error message. | - |
-| `logical, optional :: bashColors` | Should colors be displayed in output to bash consoles? | .true. |
-| `logical, optional :: on` | Should the `trigger` procedure actually trigger errors? | .true. |
+| `logical, optional :: bashColors` | Should colors be displayed in output to bash consoles? | `.true.` |
+| `logical, optional :: printErrorCode` | Should the error code be prepended to the prefix? | `.false.` |
+| `logical, optional :: triggerWarnings` | Should warnings be printed when the error queue is triggered? | `.true.` |
+| `logical, optional :: on` | Should the `trigger` procedure actually trigger errors? | `.true.` |
 
 For example:
 
@@ -50,7 +52,7 @@ For single errors, `add` acts as a generic to the ErrorHandler's `addErrorInstan
 | :--- | :--- | :--- |
 | `integer, optional :: code` | Error code to add. | - |
 | `character(len=*), optional :: message` | Message for the error. | "" |
-| `logical, optional :: isCritical` | Is the error critical? | .true. |
+| `logical, optional :: isCritical` | Is the error critical? | `.true.` |
 | `type(ErrorInstance), optional :: error` | ErrorInstance to add, if a code hasn't been specified. | - |
 
 For example:
@@ -67,7 +69,7 @@ For multiple errors input as an array of codes and optional messages and areCrit
 | :--- | :--- | :--- |
 | `integer :: codes(:)` | Array of error codes to add. | - |
 | `character(len=*), optional :: messages(:)` | Corresponding messages for the errors. | "" |
-| `logical, optional :: areCritical(:)` | Are the errors critical? | .true. |
+| `logical, optional :: areCritical(:)` | Are the errors critical? | `.true.` |
 
 For example:
 

doc/ErrorInstance.md

@@ -14,9 +14,9 @@ An `ErrorInstance(code, message, isCritical, trace)` interface is provided so th
 
 | Parameter declaration | Description | Default |
 | :--- | :--- | :--- |
-| `integer, optional :: code` | The error code. | 1 |
-| `character(len=*), optional :: message` | Default message for the error (which there is plenty of opportunity to override). | "" |
-| `logical, optional :: isCritical` | Is the error critical (i.e., should it stop the program)? | .true. |
+| `integer, optional :: code` | The error code. | `1` |
+| `character(len=*), optional :: message` | Default message for the error (which there is plenty of opportunity to override). | `""` |
+| `logical, optional :: isCritical` | Is the error critical (i.e., should it stop the program)? | `.true.` |
 | `character(len=*), optional :: trace(:)` | Custom trace for the error | - |
 
 For example:

src/ErrorCriteria.f90

@@ -139,14 +139,16 @@ subroutine initErrorCriteria(this, &
                         messageSuffix, &
                         bashColors, &
                         printErrorCode, &
+                        triggerWarnings, &
                         on)
             class(ErrorCriteria), intent(inout)         :: this                 !! This ErrorCriteria instance
             type(ErrorInstance), intent(in), optional   :: errors(:)            !! Custom defined errors
             character(len=*), intent(in), optional      :: criticalPrefix       !! Prefix to critical error messages
             character(len=*), intent(in), optional      :: warningPrefix        !! Prefix to warning error messages
             character(len=*), intent(in), optional      :: messageSuffix        !! Suffix to error messages
             logical, intent(in), optional               :: bashColors           !! Should prefixes be colored in bash shells?
-            logical, intent(in), optional               :: printErrorCode
+            logical, intent(in), optional               :: printErrorCode       !! Should error messages be prefixed with the error code?
+            logical, intent(in), optional               :: triggerWarnings      !! Should warnings be printing on trigger?
             logical, intent(in), optional               :: on                   !! Should the ErrorHandler output errors?
 
             ! Initialise the parent ErrorHandler                                                                    
@@ -156,6 +158,7 @@ subroutine initErrorCriteria(this, &
                 warningPrefix=warningPrefix, &
                 messageSuffix=messageSuffix, &
                 bashColors=bashColors, &
+                triggerWarnings=triggerWarnings, &
                 printErrorCode=printErrorCode, &
                 on=on &
             )

src/ErrorHandler.f90

@@ -17,6 +17,7 @@ module ErrorHandlerModule
         logical                             :: isInitialised = .false.      !! Has the ErrorHandler been initialised?
         logical                             :: bashColors = .true.          !! Should colors be displayed in bash consoles?
         logical                             :: printErrorCode = .false.     !! Should the error code be printed when errors triggered?
+        logical                             :: triggerWarnings = .true.     !! Should warnings be printed on trigger?
         logical                             :: on = .true.                  !! Set to .false. to turn ErrorHandler output off
 
         contains
@@ -64,6 +65,7 @@ subroutine initErrorHandler(this, &
                         messageSuffix, &
                         bashColors, &
                         printErrorCode, &
+                        triggerWarnings, &
                         on)
             class(ErrorHandler), intent(inout)          :: this             !! This ErrorHandler instance
             type(ErrorInstance), intent(in), optional   :: errors(:)        !! List of ErrorInstances to add
@@ -72,6 +74,7 @@ subroutine initErrorHandler(this, &
             character(len=*), intent(in), optional      :: messageSuffix    !! Suffix for error messages
             logical, intent(in), optional               :: bashColors       !! Use bash colours or not?
             logical, intent(in), optional               :: printErrorCode   !! Should the error code be prepended to the prefix?
+            logical, intent(in), optional               :: triggerWarnings  !! Should warnings be printed on trigger?
             logical, intent(in), optional               :: on               !! Turn the ErrorHandler on or off
             integer                                     :: i                ! Loop iterator.
             logical, allocatable                        :: mask(:)          ! Logical mask to remove default errors from input errors array.
@@ -137,8 +140,10 @@ subroutine initErrorHandler(this, &
             if (this%bashColors .eqv. .true.) this%criticalPrefix = "\x1B[91m" // adjustl(trim(this%criticalPrefix)) // "\x1B[0m"
             if (this%bashColors .eqv. .true.) this%warningPrefix = "\x1B[94m" // adjustl(trim(this%warningPrefix)) // "\x1B[0m"
 
-            ! Set whether we want the error code to be prefix to the message
+            ! Set whether we want the error code to be prefixed to the message and whether
+            ! we want warnings to be triggered
             if (present(printErrorCode)) this%printErrorCode = printErrorCode
+            if (present(triggerWarnings)) this%triggerWarnings = triggerWarnings
 
             ! Set whether ErrorHandler output is on or off
             if (present(on)) this%on = on
@@ -503,7 +508,8 @@ subroutine trigger(this, code, error, errors)
                     ! print out errors for elements of arrays that mightn't have
                     ! been used (e.g., if the wrong size array was declared). Don't do 
                     ! anything if error code is zero.
-                    if (errorsOut(i)%getCode() > 0 .and. errorsOut(i)%getCode() < 99999) then
+                    if (errorsOut(i)%getCode() > 0 .and. errorsOut(i)%getCode() < 99999 &
+                        .and. .not. (.not. this%triggerWarnings .and. .not. errorsOut(i)%isCritical)) then
                         ! Set message prefix according to whether error is
                         ! critical or warning. Also add colour for Bash consoles.
                         if (errorsOut(i)%isCritical) then