Symbol.h

Go to the documentation of this file.

// Copyright 2023 SandboxAQ
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
 
#pragma once
 
#include "llvm/Object/ObjectFile.h"
 
#include <optional>
 
namespace saq::bartleby {
 
struct SymbolInfo {
  llvm::object::SymbolRef Sym;
 
  std::optional<llvm::object::SymbolRef::Type> Type;
 
  std::optional<uint32_t> Flags;
 
  std::optional<llvm::StringRef> Name;
 
  llvm::Triple::ObjectFormatType ObjectType =
      llvm::Triple::ObjectFormatType::UnknownObjectFormat;
 
  bool Err = false;
};
 
class Symbol {
public:
  [[nodiscard]] bool isGlobal() const noexcept;
 
  [[nodiscard]] bool isDefined() const noexcept;
 
  [[nodiscard]] size_t getReferences() const noexcept;
 
  [[nodiscard]] std::optional<llvm::StringRef>
  getOverwriteName() const noexcept;
 
  [[nodiscard]] bool isMachO() const noexcept;
 
  void setName(std::string Name) noexcept;
 
  void updateWithNewSymbolInfo(const SymbolInfo &Syminfo) noexcept;
 
  Symbol() noexcept;
 
  Symbol(const Symbol &) noexcept = delete;
  Symbol(Symbol &&) noexcept = default;
  Symbol &operator=(const Symbol &) noexcept = delete;
  Symbol &operator=(Symbol &&) noexcept = default;
  ~Symbol() noexcept = default;
 
private:
  std::optional<std::string> OverwriteName;
 
  llvm::Triple::ObjectFormatType Type =
      llvm::Triple::ObjectFormatType::UnknownObjectFormat;
 
  bool Global = false;
 
  bool Defined = false;
};
 
} // end namespace saq::bartleby