Revert r240137 (Fixed/added namespace ending comments using clang-tidy. NFC)
[oota-llvm.git] / include / llvm / Object / Archive.h
index 7a818a10d83d87a00b6ffca394924da67903b192..8da6919a46555cf515e8ab379c87f2bf47fcf9a1 100644 (file)
 #ifndef LLVM_OBJECT_ARCHIVE_H
 #define LLVM_OBJECT_ARCHIVE_H
 
-#include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringRef.h"
-#include "llvm/ADT/Twine.h"
+#include "llvm/ADT/iterator_range.h"
 #include "llvm/Object/Binary.h"
-#include "llvm/Support/DataTypes.h"
 #include "llvm/Support/ErrorHandling.h"
+#include "llvm/Support/ErrorOr.h"
+#include "llvm/Support/FileSystem.h"
 #include "llvm/Support/MemoryBuffer.h"
 
 namespace llvm {
@@ -33,34 +33,21 @@ struct ArchiveMemberHeader {
   char Size[10]; ///< Size of data, not including header or padding.
   char Terminator[2];
 
-  ///! Get the name without looking up long names.
-  llvm::StringRef getName() const {
-    char EndCond;
-    if (Name[0] == '/' || Name[0] == '#')
-      EndCond = ' ';
-    else
-      EndCond = '/';
-    llvm::StringRef::size_type end =
-        llvm::StringRef(Name, sizeof(Name)).find(EndCond);
-    if (end == llvm::StringRef::npos)
-      end = sizeof(Name);
-    assert(end <= sizeof(Name) && end > 0);
-    // Don't include the EndCond if there is one.
-    return llvm::StringRef(Name, end);
-  }
+  /// Get the name without looking up long names.
+  llvm::StringRef getName() const;
+
+  /// Members are not larger than 4GB.
+  uint32_t getSize() const;
 
-  uint64_t getSize() const {
-    uint64_t ret;
-    if (llvm::StringRef(Size, sizeof(Size)).rtrim(" ").getAsInteger(10, ret))
-      llvm_unreachable("Size is not an integer.");
-    return ret;
+  sys::fs::perms getAccessMode() const;
+  sys::TimeValue getLastModified() const;
+  llvm::StringRef getRawLastModified() const {
+    return StringRef(LastModified, sizeof(LastModified)).rtrim(" ");
   }
+  unsigned getUID() const;
+  unsigned getGID() const;
 };
 
-static const ArchiveMemberHeader *ToHeader(const char *base) {
-  return reinterpret_cast<const ArchiveMemberHeader *>(base);
-}
-
 class Archive : public Binary {
   virtual void anchor();
 public:
@@ -71,84 +58,61 @@ public:
     /// \brief Offset from Data to the start of the file.
     uint16_t StartOfFile;
 
-  public:
-    Child(const Archive *p, StringRef d) : Parent(p), Data(d) {
-      if (!p || d.empty())
-        return;
-      // Setup StartOfFile and PaddingBytes.
-      StartOfFile = sizeof(ArchiveMemberHeader);
-      // Don't include attached name.
-      StringRef Name = ToHeader(Data.data())->getName();
-      if (Name.startswith("#1/")) {
-        uint64_t NameSize;
-        if (Name.substr(3).rtrim(" ").getAsInteger(10, NameSize))
-          llvm_unreachable("Long name length is not an integer");
-        StartOfFile += NameSize;
-      }
+    const ArchiveMemberHeader *getHeader() const {
+      return reinterpret_cast<const ArchiveMemberHeader *>(Data.data());
     }
 
+  public:
+    Child(const Archive *Parent, const char *Start);
+
     bool operator ==(const Child &other) const {
-      return (Parent == other.Parent) && (Data.begin() == other.Data.begin());
+      assert(Parent == other.Parent);
+      return Data.begin() == other.Data.begin();
     }
 
     bool operator <(const Child &other) const {
       return Data.begin() < other.Data.begin();
     }
 
-    Child getNext() const {
-      size_t SpaceToSkip = Data.size();
-      // If it's odd, add 1 to make it even.
-      if (SpaceToSkip & 1)
-        ++SpaceToSkip;
-
-      const char *NextLoc = Data.data() + SpaceToSkip;
-
-      // Check to see if this is past the end of the archive.
-      if (NextLoc >= Parent->Data->getBufferEnd())
-        return Child(Parent, StringRef(0, 0));
+    Child getNext() const;
 
-      size_t NextSize =
-          sizeof(ArchiveMemberHeader) + ToHeader(NextLoc)->getSize();
-
-      return Child(Parent, StringRef(NextLoc, NextSize));
+    ErrorOr<StringRef> getName() const;
+    StringRef getRawName() const { return getHeader()->getName(); }
+    sys::TimeValue getLastModified() const {
+      return getHeader()->getLastModified();
+    }
+    StringRef getRawLastModified() const {
+      return getHeader()->getRawLastModified();
+    }
+    unsigned getUID() const { return getHeader()->getUID(); }
+    unsigned getGID() const { return getHeader()->getGID(); }
+    sys::fs::perms getAccessMode() const {
+      return getHeader()->getAccessMode();
     }
-
-    error_code getName(StringRef &Result) const;
-    StringRef getRawName() const { return ToHeader(Data.data())->getName(); }
-    int getLastModified() const;
-    int getUID() const;
-    int getGID() const;
-    int getAccessMode() const;
     /// \return the size of the archive member without the header or padding.
-    uint64_t getSize() const { return Data.size() - StartOfFile; }
+    uint64_t getSize() const;
+    /// \return the size in the archive header for this member.
+    uint64_t getRawSize() const;
 
     StringRef getBuffer() const {
       return StringRef(Data.data() + StartOfFile, getSize());
     }
+    uint64_t getChildOffset() const;
 
-    error_code getMemoryBuffer(OwningPtr<MemoryBuffer> &Result,
-                               bool FullPath = false) const {
-      StringRef Name;
-      if (error_code ec = getName(Name))
-        return ec;
-      SmallString<128> Path;
-      Result.reset(MemoryBuffer::getMemBuffer(
-          getBuffer(), FullPath ? (Twine(Parent->getFileName()) + "(" + Name +
-                                   ")").toStringRef(Path) : Name, false));
-      return error_code::success();
-    }
+    ErrorOr<MemoryBufferRef> getMemoryBufferRef() const;
 
-    error_code getAsBinary(OwningPtr<Binary> &Result) const;
+    ErrorOr<std::unique_ptr<Binary>>
+    getAsBinary(LLVMContext *Context = nullptr) const;
   };
 
   class child_iterator {
     Child child;
+
   public:
-    child_iterator() : child(Child(0, StringRef())) {}
+    child_iterator() : child(Child(nullptr, nullptr)) {}
     child_iterator(const Child &c) : child(c) {}
-    const Child* operator->() const {
-      return &child;
-    }
+    const Child *operator->() const { return &child; }
+    const Child &operator*() const { return child; }
 
     bool operator==(const child_iterator &other) const {
       return child == other.child;
@@ -158,11 +122,11 @@ public:
       return !(*this == other);
     }
 
-    bool operator <(const child_iterator &other) const {
+    bool operator<(const child_iterator &other) const {
       return child < other.child;
     }
 
-    child_iterator& operator++() {  // Preincrement
+    child_iterator &operator++() { // Preincrement
       child = child.getNext();
       return *this;
     }
@@ -182,8 +146,8 @@ public:
       : Parent(p)
       , SymbolIndex(symi)
       , StringIndex(stri) {}
-    error_code getName(StringRef &Result) const;
-    error_code getMember(child_iterator &Result) const;
+    StringRef getName() const;
+    ErrorOr<child_iterator> getMember() const;
     Symbol getNext() const;
   };
 
@@ -191,9 +155,8 @@ public:
     Symbol symbol;
   public:
     symbol_iterator(const Symbol &s) : symbol(s) {}
-    const Symbol *operator->() const {
-      return &symbol;
-    }
+    const Symbol *operator->() const { return &symbol; }
+    const Symbol &operator*() const { return symbol; }
 
     bool operator==(const symbol_iterator &other) const {
       return symbol == other.symbol;
@@ -209,23 +172,30 @@ public:
     }
   };
 
-  Archive(MemoryBuffer *source, error_code &ec);
+  Archive(MemoryBufferRef Source, std::error_code &EC);
+  static ErrorOr<std::unique_ptr<Archive>> create(MemoryBufferRef Source);
 
   enum Kind {
     K_GNU,
+    K_MIPS64,
     K_BSD,
     K_COFF
   };
 
-  Kind kind() const { 
-    return Format;
-  }
+  Kind kind() const { return (Kind)Format; }
 
-  child_iterator begin_children(bool skip_internal = true) const;
-  child_iterator end_children() const;
+  child_iterator child_begin(bool SkipInternal = true) const;
+  child_iterator child_end() const;
+  iterator_range<child_iterator> children(bool SkipInternal = true) const {
+    return iterator_range<child_iterator>(child_begin(SkipInternal),
+                                          child_end());
+  }
 
-  symbol_iterator begin_symbols() const;
-  symbol_iterator end_symbols() const;
+  symbol_iterator symbol_begin() const;
+  symbol_iterator symbol_end() const;
+  iterator_range<symbol_iterator> symbols() const {
+    return iterator_range<symbol_iterator>(symbol_begin(), symbol_end());
+  }
 
   // Cast methods.
   static inline bool classof(Binary const *v) {
@@ -235,10 +205,16 @@ public:
   // check if a symbol is in the archive
   child_iterator findSym(StringRef name) const;
 
+  bool hasSymbolTable() const;
+  child_iterator getSymbolTableChild() const { return SymbolTable; }
+  uint32_t getNumberOfSymbols() const;
+
 private:
   child_iterator SymbolTable;
   child_iterator StringTable;
-  Kind Format;
+  child_iterator FirstRegular;
+  unsigned Format : 2;
+  unsigned IsThin : 1;
 };
 
 }