global.h

// This file if part of the llir-opt project.
// Licensing information can be found in the LICENSE file.
// (C) 2018 Nandor Licker. All rights reserved.
 
#pragma once
 
#include <optional>
#include <string>
#include <string_view>
#include <llvm/ADT/StringRef.h>
#include <llvm/Support/Alignment.h>
 
#include "core/user.h"
#include "core/visibility.h"
 
class Prog;
 
 
 
class Global : public User {
public:
  static constexpr Value::Kind kValueKind = Value::Kind::GLOBAL;
 
public:
  enum class Kind {
    EXTERN,
    FUNC,
    BLOCK,
    ATOM
  };
 
public:
  Global(
      Kind kind,
      const std::string_view name,
      Visibility visibility = Visibility::LOCAL,
      unsigned numOps = 0
  );
  virtual ~Global();
 
  Kind GetKind() const { return kind_; }
  bool Is(Kind kind) const { return GetKind() == kind; }
 
  const std::string_view GetName() const { return name_; }
  llvm::StringRef getName() const { return name_; }
 
  virtual std::optional<llvm::Align> GetAlignment() const = 0;
 
  void SetVisibility(Visibility visibility) { visibility_ = visibility; }
  Visibility GetVisibility() const { return visibility_; }
 
  bool IsRoot() const;
  bool IsLocal() const;
  bool IsWeak() const;
 
  virtual void removeFromParent() = 0;
  virtual void eraseFromParent() = 0;
 
  virtual Prog *getProg() = 0;
 
  virtual void dump(llvm::raw_ostream &os = llvm::errs()) const = 0;
 
private:
  friend class Prog;
  Kind kind_;
  std::string name_;
  Visibility visibility_;
};