llvm-6502/include/llvm/Object/Archive.h
Ahmed Charles fbf6daaec6 [C++11] Add overloads for externally used OwningPtr functions.
This will allow external callers of these functions to switch over time
rather than forcing a breaking change all a once. These particular
functions were determined by building clang/lld/lldb.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202959 91177308-0d34-0410-b5e6-96231b3b80d8
2014-03-05 10:27:34 +00:00

211 lines
5.5 KiB
C++

//===- Archive.h - ar archive file format -----------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file declares the ar archive file format class.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_OBJECT_ARCHIVE_H
#define LLVM_OBJECT_ARCHIVE_H
#include "llvm/ADT/StringRef.h"
#include "llvm/Object/Binary.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/ErrorOr.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/MemoryBuffer.h"
namespace llvm {
namespace object {
struct ArchiveMemberHeader {
char Name[16];
char LastModified[12];
char UID[6];
char GID[6];
char AccessMode[8];
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;
/// Members are not larger than 4GB.
uint32_t getSize() const;
sys::fs::perms getAccessMode() const;
sys::TimeValue getLastModified() const;
unsigned getUID() const;
unsigned getGID() const;
};
class Archive : public Binary {
virtual void anchor();
public:
class Child {
const Archive *Parent;
/// \brief Includes header but not padding byte.
StringRef Data;
/// \brief Offset from Data to the start of the file.
uint16_t StartOfFile;
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 {
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;
error_code getName(StringRef &Result) const;
StringRef getRawName() const { return getHeader()->getName(); }
sys::TimeValue getLastModified() const {
return getHeader()->getLastModified();
}
unsigned getUID() const { return getHeader()->getUID(); }
unsigned getGID() const { return getHeader()->getGID(); }
sys::fs::perms getAccessMode() const {
return getHeader()->getAccessMode();
}
/// \return the size of the archive member without the header or padding.
uint64_t getSize() const { return Data.size() - StartOfFile; }
StringRef getBuffer() const {
return StringRef(Data.data() + StartOfFile, getSize());
}
error_code getMemoryBuffer(OwningPtr<MemoryBuffer> &Result,
bool FullPath = false) const;
error_code getMemoryBuffer(std::unique_ptr<MemoryBuffer> &Result,
bool FullPath = false) const;
error_code getAsBinary(OwningPtr<Binary> &Result,
LLVMContext *Context = 0) const;
error_code getAsBinary(std::unique_ptr<Binary> &Result,
LLVMContext *Context = 0) const;
};
class child_iterator {
Child child;
public:
child_iterator() : child(Child(0, 0)) {}
child_iterator(const Child &c) : child(c) {}
const Child* operator->() const {
return &child;
}
bool operator==(const child_iterator &other) const {
return child == other.child;
}
bool operator!=(const child_iterator &other) const {
return !(*this == other);
}
bool operator <(const child_iterator &other) const {
return child < other.child;
}
child_iterator& operator++() { // Preincrement
child = child.getNext();
return *this;
}
};
class Symbol {
const Archive *Parent;
uint32_t SymbolIndex;
uint32_t StringIndex; // Extra index to the string.
public:
bool operator ==(const Symbol &other) const {
return (Parent == other.Parent) && (SymbolIndex == other.SymbolIndex);
}
Symbol(const Archive *p, uint32_t symi, uint32_t stri)
: Parent(p)
, SymbolIndex(symi)
, StringIndex(stri) {}
error_code getName(StringRef &Result) const;
error_code getMember(child_iterator &Result) const;
Symbol getNext() const;
};
class symbol_iterator {
Symbol symbol;
public:
symbol_iterator(const Symbol &s) : symbol(s) {}
const Symbol *operator->() const {
return &symbol;
}
bool operator==(const symbol_iterator &other) const {
return symbol == other.symbol;
}
bool operator!=(const symbol_iterator &other) const {
return !(*this == other);
}
symbol_iterator& operator++() { // Preincrement
symbol = symbol.getNext();
return *this;
}
};
Archive(MemoryBuffer *source, error_code &ec);
static ErrorOr<Archive *> create(MemoryBuffer *Source);
enum Kind {
K_GNU,
K_BSD,
K_COFF
};
Kind kind() const {
return Format;
}
child_iterator child_begin(bool SkipInternal = true) const;
child_iterator child_end() const;
symbol_iterator symbol_begin() const;
symbol_iterator symbol_end() const;
// Cast methods.
static inline bool classof(Binary const *v) {
return v->isArchive();
}
// check if a symbol is in the archive
child_iterator findSym(StringRef name) const;
bool hasSymbolTable() const;
private:
child_iterator SymbolTable;
child_iterator StringTable;
child_iterator FirstRegular;
Kind Format;
};
}
}
#endif