//===-- llvm/MC/MCValue.h - MCValue class -----------------------*- 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
 
//
 
//===----------------------------------------------------------------------===//
 
//
 
// This file contains the declaration of the MCValue class.
 
//
 
//===----------------------------------------------------------------------===//
 
 
 
#ifndef LLVM_MC_MCVALUE_H
 
#define LLVM_MC_MCVALUE_H
 
 
 
#include "llvm/MC/MCExpr.h"
 
#include "llvm/Support/DataTypes.h"
 
 
 
namespace llvm {
 
class raw_ostream;
 
 
 
/// This represents an "assembler immediate".
 
///
 
///  In its most general form, this can hold ":Kind:(SymbolA - SymbolB +
 
///  imm64)".  Not all targets supports relocations of this general form, but we
 
///  need to represent this anyway.
 
///
 
/// In general both SymbolA and SymbolB will also have a modifier
 
/// analogous to the top-level Kind. Current targets are not expected
 
/// to make use of both though. The choice comes down to whether
 
/// relocation modifiers apply to the closest symbol or the whole
 
/// expression.
 
///
 
/// Note that this class must remain a simple POD value class, because we need
 
/// it to live in unions etc.
 
class MCValue {
 
  const MCSymbolRefExpr *SymA = nullptr, *SymB = nullptr;
 
  int64_t Cst = 0;
 
  uint32_t RefKind = 0;
 
 
 
public:
 
  MCValue() = default;
 
  int64_t getConstant() const { return Cst; }
 
  const MCSymbolRefExpr *getSymA() const { return SymA; }
 
  const MCSymbolRefExpr *getSymB() const { return SymB; }
 
  uint32_t getRefKind() const { return RefKind; }
 
 
 
  /// Is this an absolute (as opposed to relocatable) value.
 
  bool isAbsolute() const { return !SymA && !SymB; }
 
 
 
  /// Print the value to the stream \p OS.
 
  void print(raw_ostream &OS) const;
 
 
 
  /// Print the value to stderr.
 
  void dump() const;
 
 
 
  MCSymbolRefExpr::VariantKind getAccessVariant() const;
 
 
 
  static MCValue get(const MCSymbolRefExpr *SymA,
 
                     const MCSymbolRefExpr *SymB = nullptr,
 
                     int64_t Val = 0, uint32_t RefKind = 0) {
 
    MCValue R;
 
    R.Cst = Val;
 
    R.SymA = SymA;
 
    R.SymB = SymB;
 
    R.RefKind = RefKind;
 
    return R;
 
  }
 
 
 
  static MCValue get(int64_t Val) {
 
    MCValue R;
 
    R.Cst = Val;
 
    R.SymA = nullptr;
 
    R.SymB = nullptr;
 
    R.RefKind = 0;
 
    return R;
 
  }
 
 
 
};
 
 
 
} // end namespace llvm
 
 
 
#endif