revng-revng/include/revng/Pipeline/Errors.h

#pragma once

//
// This file is distributed under the MIT License. See LICENSE.md for details.
//

#include "llvm/Support/Error.h"
#include "llvm/Support/raw_ostream.h"

#include "revng/Pipeline/Contract.h"
#include "revng/Support/Assert.h"

namespace pipeline {

/// A error thrown when the autoenforcer is not able to satisfy the deduced
/// requirements to produce a target
class UnsatisfiableRequestError
  : public llvm::ErrorInfo<UnsatisfiableRequestError> {
public:
  static char ID;

private:
  ContainerToTargetsMap Requested;
  ContainerToTargetsMap LastResort;

public:
  UnsatisfiableRequestError(ContainerToTargetsMap Requested,
                            ContainerToTargetsMap LastResort) :
    Requested(std::move(Requested)), LastResort(std::move(LastResort)) {}

public:
  std::error_code convertToErrorCode() const override;
  void log(llvm::raw_ostream &OS) const override;
};

/// Error thrown when the user tries to erase a target that does not exists
class UnknownTargetError : public llvm::ErrorInfo<UnknownTargetError> {
public:
  static char ID;

private:
  TargetsList Unknown;
  std::string ContainerName;

public:
  UnknownTargetError(TargetsList Unknown, llvm::StringRef ContainerName) :
    Unknown(std::move(Unknown)), ContainerName(ContainerName.str()) {}

public:
  std::error_code convertToErrorCode() const override;
  void log(llvm::raw_ostream &OS) const override;
};

/// Error thrown when one needs to annotate another error with extra data
class AnnotatedError : public llvm::ErrorInfo<AnnotatedError> {
public:
  static char ID;

private:
  std::string Inner;
  std::string ExtraData;

public:
  AnnotatedError(llvm::Error Error, const llvm::Twine &ExtraData) :
    ExtraData(ExtraData.str()) {
    revng_assert(Error);
    llvm::raw_string_ostream S(Inner);
    S << Error;
    S.flush();
    llvm::consumeError(std::move(Error));
  }

public:
  std::error_code convertToErrorCode() const override;
  void log(llvm::raw_ostream &OS) const override;
};

} // namespace pipeline