io/file/Delete.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 Delete
#
#  Author: Wael Youssfi (wael.youssfi@tokiwa.software)
#
# -----------------------------------------------------------------------

# Delete -- effect wrapping the file delete operation
#
public Delete ref : effect is

  # deletes the file/dir found in the path
  # returns unit as outcome in case of successful deletion and error in case of failure
  # if the targeted dir has content, then the return value will be error and the deletion will not take place
  #
  public delete(
         # the (relative or absolute) dir name, using platform specific path separators
         path io.path) outcome unit => abstract


  # default implementation of delete
  #
  # this will get instated automatically at startup
  #
  public redef fixed type.default_value option io.file.Delete
  =>
    _ : io.file.Delete is
      public redef delete(path io.path) outcome unit =>
        fuzion.sys.fileio.delete path


# shorthand for accessing Delete effect in current environment and performing the default delete operation using io.file.Delete.delete path
# deletes the file/dir found in the path
# returns unit as outcome in case of successful deletion and error in case of failure
# if the targeted dir has content, then the return value will be error and the deletion will not take place
#
public delete(path io.path) outcome unit ! io.file.Delete =>
  io.file.Delete.env.delete path