llvm-6502/include/llvm/MC/MCSymbol.h
Daniel Dunbar d6bb283de9 Tweak MCSymbol doxyments.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74599 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-01 07:03:41 +00:00

68 lines
2.3 KiB
C++

//===- MCSymbol.h - Machine Code Symbols ------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file contains the declaration of the MCSymbol class.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_MC_MCSYMBOL_H
#define LLVM_MC_MCSYMBOL_H
#include <string>
namespace llvm {
class MCSection;
class MCContext;
/// MCSymbol - Instances of this class represent a symbol name in the MC file,
/// and MCSymbols are created and unique'd by the MCContext class.
///
/// If the symbol is defined/emitted into the current translation unit, the
/// Section member is set to indicate what section it lives in. Otherwise, if
/// it is a reference to an external entity, it has a null section.
///
class MCSymbol {
/// Name - The name of the symbol.
std::string Name;
/// Section - The section the symbol is defined in, or null if the symbol
/// has not been defined in the associated translation unit.
MCSection *Section;
/// IsTemporary - True if this is an assembler temporary label, which
/// typically does not survive in the .o file's symbol table. Usually
/// "Lfoo" or ".foo".
unsigned IsTemporary : 1;
/// IsExternal - True if this symbol has been implicitly defined as an
/// external, for example by using it in an expression without ever emitting
/// it as a label. The @var Section for an external symbol is always null.
unsigned IsExternal : 1;
private: // MCContext creates and uniques these.
friend class MCContext;
MCSymbol(const char *_Name, bool _IsTemporary)
: Name(_Name), Section(0), IsTemporary(_IsTemporary), IsExternal(false) {}
MCSymbol(const MCSymbol&); // DO NOT IMPLEMENT
void operator=(const MCSymbol&); // DO NOT IMPLEMENT
public:
MCSection *getSection() const { return Section; }
void setSection(MCSection *Value) { Section = Value; }
bool isExternal() const { return IsExternal; }
void setExternal(bool Value) { IsExternal = Value; }
const std::string &getName() const { return Name; }
};
} // end namespace llvm
#endif