//===- LogicalResult.h - Utilities for handling success/failure -*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

#ifndef MLIR_SUPPORT_LOGICAL_RESULT_H

#define MLIR_SUPPORT_LOGICAL_RESULT_H

#include "mlir/Support/LLVM.h"

namespace mlir {

// Values that can be used to signal success/failure. This should be used in

// conjunction with the utility functions below.

struct LogicalResult {

  enum ResultEnum { Success, Failure } value;

  LogicalResult(ResultEnum v) : value(v) {}

};

/// Utility function to generate a LogicalResult. If isSuccess is true a

/// `success` result is generated, otherwise a 'failure' result is generated.

inline LogicalResult success(bool isSuccess = true) {

  return LogicalResult{isSuccess ? LogicalResult::Success

                                 : LogicalResult::Failure};

}

/// Utility function to generate a LogicalResult. If isFailure is true a

/// `failure` result is generated, otherwise a 'success' result is generated.

inline LogicalResult failure(bool isFailure = true) {

  return LogicalResult{isFailure ? LogicalResult::Failure

                                 : LogicalResult::Success};

}

/// Utility function that returns true if the provided LogicalResult corresponds

/// to a success value.

inline bool succeeded(LogicalResult result) {

  return result.value == LogicalResult::Success;

}

/// Utility function that returns true if the provided LogicalResult corresponds

/// to a failure value.

inline bool failed(LogicalResult result) {

  return result.value == LogicalResult::Failure;

}

} // namespace mlir

#endif // MLIR_SUPPORT_LOGICAL_RESULT_H