1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-24 03:33:20 +01:00
llvm-mirror/include/llvm/MC/MCLabel.h
Dmitri Gribenko 93c7ec80b7 Fix Doxygen issues:
* wrap code blocks in \code ... \endcode;
* refer to parameter names in paragraphs correctly (\arg is not what most
  people want -- it starts a new paragraph);
* use \param instead of \arg to document parameters in order to be consistent
  with the rest of the codebase.

llvm-svn: 163902
2012-09-14 14:57:36 +00:00

59 lines
1.8 KiB
C++

//===- MCLabel.h - Machine Code Directional Local Labels --------*- 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 MCLabel class.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_MC_MCLABEL_H
#define LLVM_MC_MCLABEL_H
#include "llvm/Support/Compiler.h"
namespace llvm {
class MCContext;
class raw_ostream;
/// MCLabel - Instances of this class represent a label name in the MC file,
/// and MCLabel are created and unique'd by the MCContext class. MCLabel
/// should only be constructed for valid instances in the object file.
class MCLabel {
// Instance - the instance number of this Directional Local Label
unsigned Instance;
private: // MCContext creates and uniques these.
friend class MCContext;
MCLabel(unsigned instance)
: Instance(instance) {}
MCLabel(const MCLabel&) LLVM_DELETED_FUNCTION;
void operator=(const MCLabel&) LLVM_DELETED_FUNCTION;
public:
/// getInstance - Get the current instance of this Directional Local Label.
unsigned getInstance() const { return Instance; }
/// incInstance - Increment the current instance of this Directional Local
/// Label.
unsigned incInstance() { return ++Instance; }
/// print - Print the value to the stream \p OS.
void print(raw_ostream &OS) const;
/// dump - Print the value to stderr.
void dump() const;
};
inline raw_ostream &operator<<(raw_ostream &OS, const MCLabel &Label) {
Label.print(OS);
return OS;
}
} // end namespace llvm
#endif