MCStreamer.h: Prune \return, corresponding to r252102. [-Wdocumentation]
[oota-llvm.git] / include / llvm / MC / MCLinkerOptimizationHint.h
index eb37d158e40e425dd917a70e80af3a973083b1cb..a519c4b71b033163b8d4ff500d1e177d0164e844 100644 (file)
@@ -18,8 +18,8 @@
 #define LLVM_MC_MCLINKEROPTIMIZATIONHINT_H
 
 #include "llvm/ADT/SmallVector.h"
-#include "llvm/ADT/StringSwitch.h"
 #include "llvm/ADT/StringRef.h"
+#include "llvm/ADT/StringSwitch.h"
 #include "llvm/MC/MCMachObjectWriter.h"
 #include "llvm/Support/raw_ostream.h"
 
@@ -45,7 +45,7 @@ static inline StringRef MCLOHDirectiveName() {
   return StringRef(".loh");
 }
 
-static inline bool isValidMCLOHType(MCLOHType Kind) {
+static inline bool isValidMCLOHType(unsigned Kind) {
   return Kind >= MCLOH_AdrpAdrp && Kind <= MCLOH_AdrpLdrGot;
 }
 
@@ -97,118 +97,109 @@ static inline int MCLOHIdToNbArgs(MCLOHType Kind) {
 }
 
 /// Store Linker Optimization Hint information (LOH).
-template<typename T>
-class LOHDirective {
-private:
+class MCLOHDirective {
   MCLOHType Kind;
 
   /// Arguments of this directive. Order matters.
-  SmallVector<T *, 3> Args;
+  SmallVector<MCSymbol *, 3> Args;
 
-  /// Emit this directive in @p OutStream using the information available
-  /// in the given @p ObjWriter and @p Layout to get the address of the
+  /// Emit this directive in \p OutStream using the information available
+  /// in the given \p ObjWriter and \p Layout to get the address of the
   /// arguments within the object file.
-  /// This function is currently specialized for T = MCSymbol.
-  void Emit_impl(raw_ostream &OutStream, const MachObjectWriter &ObjWriter,
-                 const MCAsmLayout &Layout) const {  }
+  void emit_impl(raw_ostream &OutStream, const MachObjectWriter &ObjWriter,
+                 const MCAsmLayout &Layout) const;
 
 public:
-  typedef SmallVectorImpl<T *> LOHArgs;
+  typedef SmallVectorImpl<MCSymbol *> LOHArgs;
 
-  LOHDirective(MCLOHType Kind, const LOHArgs &Args)
-  : Kind(Kind), Args(Args.begin(), Args.end()) {};
+  MCLOHDirective(MCLOHType Kind, const LOHArgs &Args)
+      : Kind(Kind), Args(Args.begin(), Args.end()) {
+    assert(isValidMCLOHType(Kind) && "Invalid LOH directive type!");
+  }
 
   MCLOHType getKind() const { return Kind; }
 
-  const LOHArgs & getArgs() const { return Args; }
+  const LOHArgs &getArgs() const { return Args; }
 
   /// Emit this directive as:
   /// <kind, numArgs, addr1, ..., addrN>
-  void Emit(MachObjectWriter &ObjWriter, const MCAsmLayout &Layout) const {
+  void emit(MachObjectWriter &ObjWriter, const MCAsmLayout &Layout) const {
     raw_ostream &OutStream = ObjWriter.getStream();
-    Emit_impl(OutStream, ObjWriter, Layout);
+    emit_impl(OutStream, ObjWriter, Layout);
   }
 
-  /// Get the size in bytes of this directive if emitted in @p ObjWriter with
-  /// the given @p Layout.
+  /// Get the size in bytes of this directive if emitted in \p ObjWriter with
+  /// the given \p Layout.
   uint64_t getEmitSize(const MachObjectWriter &ObjWriter,
                        const MCAsmLayout &Layout) const {
-    std::string Buffer;
-    raw_string_ostream OutStream(Buffer);
-    Emit_impl(OutStream, ObjWriter, Layout);
+    class raw_counting_ostream : public raw_ostream {
+      uint64_t Count;
+
+      void write_impl(const char *, size_t size) override { Count += size; }
+
+      uint64_t current_pos() const override { return Count; }
+
+    public:
+      raw_counting_ostream() : Count(0) {}
+      ~raw_counting_ostream() override { flush(); }
+    };
+
+    raw_counting_ostream OutStream;
+    emit_impl(OutStream, ObjWriter, Layout);
     return OutStream.tell();
   }
 };
 
-template<typename T>
-class LOHContainer {
-public:
-  typedef SmallVectorImpl<LOHDirective<T> > LOHDirectives;
-
-private:
+class MCLOHContainer {
   /// Keep track of the emit size of all the LOHs.
   mutable uint64_t EmitSize;
 
   /// Keep track of all LOH directives.
-  SmallVector<LOHDirective<T>, 32> Directives;
-
-  /// Accessor to the directives.
-  LOHDirectives &getDirectives() { return Directives; }
+  SmallVector<MCLOHDirective, 32> Directives;
 
 public:
-  LOHContainer() : EmitSize(0) {};
+  typedef SmallVectorImpl<MCLOHDirective> LOHDirectives;
+
+  MCLOHContainer() : EmitSize(0) {}
 
   /// Const accessor to the directives.
   const LOHDirectives &getDirectives() const {
-    return const_cast<LOHContainer *>(this)->getDirectives();
+    return Directives;
   }
 
-  /// Add the directive of the given kind @p Kind with the given arguments
-  /// @p Args to the container.
-  void addDirective(MCLOHType Kind,
-                    const typename LOHDirective<T>::LOHArgs &Args) {
-    assert(isValidMCLOHType(Kind) && "Invalid LOH directive type!");
-    getDirectives().push_back(LOHDirective<T>(Kind, Args));
+  /// Add the directive of the given kind \p Kind with the given arguments
+  /// \p Args to the container.
+  void addDirective(MCLOHType Kind, const MCLOHDirective::LOHArgs &Args) {
+    Directives.push_back(MCLOHDirective(Kind, Args));
   }
 
   /// Get the size of the directives if emitted.
   uint64_t getEmitSize(const MachObjectWriter &ObjWriter,
                        const MCAsmLayout &Layout) const {
     if (!EmitSize) {
-      for (typename LOHDirectives::const_iterator It = getDirectives().begin(),
-             EndIt = getDirectives().end(); It != EndIt; ++It)
-        EmitSize += It->getEmitSize(ObjWriter, Layout);
+      for (const MCLOHDirective &D : Directives)
+        EmitSize += D.getEmitSize(ObjWriter, Layout);
     }
     return EmitSize;
   }
 
   /// Emit all Linker Optimization Hint in one big table.
-  /// Each line of the table is emitted by LOHDirective::Emit.
-  void Emit(MachObjectWriter &ObjWriter, const MCAsmLayout &Layout) const {
-    for (typename LOHDirectives::const_iterator It = getDirectives().begin(),
-           EndIt = getDirectives().end(); It != EndIt; ++It)
-      It->Emit(ObjWriter, Layout);
+  /// Each line of the table is emitted by LOHDirective::emit.
+  void emit(MachObjectWriter &ObjWriter, const MCAsmLayout &Layout) const {
+    for (const MCLOHDirective &D : Directives)
+      D.emit(ObjWriter, Layout);
   }
 
   void reset() {
-    getDirectives().clear();
+    Directives.clear();
     EmitSize = 0;
   }
 };
 
 // Add types for specialized template using MCSymbol.
-typedef LOHDirective<MCSymbol> MCLOHDirective;
-typedef LOHDirective<MCSymbol>::LOHArgs MCLOHArgs;
-
-typedef LOHContainer<MCLOHDirective>::LOHDirectives MCLOHDirectives;
-
-typedef LOHContainer<MCSymbol> MCLOHContainer;
+typedef MCLOHDirective::LOHArgs MCLOHArgs;
+typedef MCLOHContainer::LOHDirectives MCLOHDirectives;
 
-// Declare the specialization for MCSymbol.
-template<>
-void MCLOHDirective::Emit_impl(raw_ostream &OutStream,
-                               const MachObjectWriter &ObjWriter,
-                               const MCAsmLayout &Layout) const;
 } // end namespace llvm
 
 #endif