saq::bartleby::Symbol Class Reference

An high view of a symbol. More...

#include <Symbol.h>

Public Member Functions
bool	isGlobal () const noexcept
	Returns the visibility of the symbol.
bool	isDefined () const noexcept
	Returns the definedness of the symbol.
size_t	getReferences () const noexcept
	Counts how many times this symbol is referenced.
std::optional< llvm::StringRef >	getOverwriteName () const noexcept
	Returns the overwrite name.
bool	isMachO () const noexcept
	Returns true if the symbol contains references to some mach-o symbols.
void	setName (std::string Name) noexcept
	Sets the name of the symbol.
void	updateWithNewSymbolInfo (const SymbolInfo &Syminfo) noexcept
	Updates the symbol with new symbol information.
	Symbol () noexcept
	Constructs a new symbol.
	Symbol (const Symbol &) noexcept=delete
	Symbol (Symbol &&) noexcept=default
Symbol &	operator= (const Symbol &) noexcept=delete
Symbol &	operator= (Symbol &&) noexcept=default

Detailed Description

An high view of a symbol.

Constructor & Destructor Documentation

Symbol()

BARTLEBY_API Symbol::Symbol ( )

noexcept

Constructs a new symbol.

{}

Member Function Documentation

getOverwriteName()

BARTLEBY_API std::optional< llvm::StringRef > Symbol::getOverwriteName ( ) const

noexcept

Returns the overwrite name.

Returns

The overwrite name.

                                        {
  return OverwriteName;
}

getReferences()

size_t saq::bartleby::Symbol::getReferences ( ) const

noexcept

Counts how many times this symbol is referenced.

Returns

Number of references.

isDefined()

BARTLEBY_API bool Symbol::isDefined ( ) const

noexcept

Returns the definedness of the symbol.

Returns

True if symbol is defined, else false.

{ return Defined; }

isGlobal()

BARTLEBY_API bool Symbol::isGlobal ( ) const

noexcept

Returns the visibility of the symbol.

Returns

True if symbol is global, else false.

{ return Global; }

isMachO()

bool Symbol::isMachO ( ) const

noexcept

Returns true if the symbol contains references to some mach-o symbols.

Returns

True if the symbol contains references to some mach-o, else false.

                                    {
  return Type == llvm::Triple::ObjectFormatType::MachO;
}

setName()

BARTLEBY_API void Symbol::setName ( std::string  Name )

noexcept

Sets the name of the symbol.

Parameters

name	Name to set.

                                                         {
  OverwriteName = Name;
}

updateWithNewSymbolInfo()

void Symbol::updateWithNewSymbolInfo ( const SymbolInfo &  Syminfo )

noexcept

Updates the symbol with new symbol information.

Parameters

syminfo

Symbol information.

                                                                       {
  assert(SymInfo.Err == false);
 
  if ((*SymInfo.Flags & llvm::object::BasicSymbolRef::Flags::SF_Weak) == 0) {
    if ((*SymInfo.Flags & llvm::object::BasicSymbolRef::Flags::SF_Undefined) ==
        0) {
      LLVM_DEBUG(llvm::errs() << "symbol is defined. marked as defined\n");
      Defined = true;
    }
    if (*SymInfo.Flags & llvm::object::BasicSymbolRef::Flags::SF_Global) {
      LLVM_DEBUG(llvm::errs() << "symbol is global. marked as defined\n");
      Global = true;
    }
  }
  Type = SymInfo.ObjectType;
}

---

The documentation for this class was generated from the following files:

• bartleby/include/Bartleby/Symbol.h
• bartleby/lib/Bartleby/Symbol.cpp