fuzion/runtime/fault.fz

# This file is part of the Fuzion language implementation.
#
# The Fuzion language implementation is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License as published
# by the Free Software Foundation, version 3 of the License.
#
# The Fuzion language implementation is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
# License for more details.
#
# You should have received a copy of the GNU General Public License along with The
# Fuzion language implementation.  If not, see <https://www.gnu.org/licenses/>.


# -----------------------------------------------------------------------
#
#  Tokiwa Software GmbH, Germany
#
#  Source code of Fuzion standard library feature fault
#
#  Author: Fridtjof Siebert (siebert@tokiwa.software)
#
# -----------------------------------------------------------------------

# fault -- effect that terminates a computation due to a runtime fault
#
#
# Hierarchy of faults:
#
# runtime.fault
# ?
# ??? stackoverflow
# ?
# ??? panic
# ?
# ??? contract_fault
#     ??? pre_fault
#     ??? post_fault
#     ??? variant_fault
#     ??? check_fault
#
#
public fault (
  # the handler this effect uses to fail
  p (
      # the kind of the fault, e.g. "postcondition"
     (String,
      # the error message of the fault
      String)
    ) -> void
  ) : eff.fallible p
is


  # default implementation of fuzion.runtime.fault
  #
  # this will get instated automatically at startup
  #
  public redef fixed type.default_value option fuzion.runtime.fault =>
    new kind_and_msg->
      kind, msg := kind_and_msg
      fuzion.sys.fatal_fault kind msg


  # create an instance of `fault` with the given error handler.
  #
  public fixed redef type.new(h ((String,String))->void) fuzion.runtime.fault => fuzion.runtime.fault h