mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
ff63eaea6f
We've been running doxygen with the autobrief option for a couple of
years now. This makes the \brief markers into our comments
redundant. Since they are a visual distraction and we don't want to
encourage more \brief markers in new code either, this patch removes
them all.
Patch produced by
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done
143 lines
3.7 KiB
C++
143 lines
3.7 KiB
C++
//===- tapi/Core/File.h - TAPI File -----------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
///
|
|
/// \file
|
|
/// TAPI File abstraction.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef TAPI_CORE_FILE_H
|
|
#define TAPI_CORE_FILE_H
|
|
|
|
#include "LLVM.h"
|
|
#include "Defines.h"
|
|
#include "llvm/Support/MemoryBuffer.h"
|
|
#include "llvm/Support/Path.h"
|
|
#include <system_error>
|
|
#include <vector>
|
|
|
|
TAPI_NAMESPACE_INTERNAL_BEGIN
|
|
|
|
// clang-format off
|
|
enum FileType : unsigned {
|
|
/// Invalid file type.
|
|
Invalid = 0U,
|
|
|
|
/// TAPI Configuration file.
|
|
TAPI_Configuration_V1 = 1U << 0,
|
|
|
|
/// MachO Dynamic Library file.
|
|
MachO_DynamicLibrary = 1U << 1,
|
|
|
|
/// MachO Dynamic Library Stub file.
|
|
MachO_DynamicLibrary_Stub = 1U << 2,
|
|
|
|
/// MachO Bundle file.
|
|
MachO_Bundle = 1U << 3,
|
|
|
|
/// Text-based stub file (.tbd) version 1.0
|
|
TBD_V1 = 1U << 4,
|
|
|
|
/// Text-based stub file (.tbd) version 2.0
|
|
TBD_V2 = 1U << 5,
|
|
|
|
/// Text-based stub file (.tbd) version 3.0
|
|
TBD_V3 = 1U << 6,
|
|
|
|
/// JSON Header List
|
|
JSON_V1 = 1U << 7,
|
|
|
|
/// LD64 re-export file
|
|
ReexportFile = 1U << 8,
|
|
|
|
/// Text-based API file (.api) version 1.0
|
|
API_V1 = 1U << 9,
|
|
|
|
/// Text-based SPI file (.spi) version 1.0
|
|
SPI_V1 = 1U << 10,
|
|
|
|
/// SDKDB file (.sdkdb) version 1.0
|
|
SDKDB_V1 = 1U << 11,
|
|
|
|
All = ~0U,
|
|
};
|
|
// clang-format on
|
|
|
|
inline FileType operator&(const FileType lhs, const FileType rhs) {
|
|
return static_cast<FileType>(static_cast<unsigned>(lhs) &
|
|
static_cast<unsigned>(rhs));
|
|
}
|
|
|
|
inline FileType operator|(const FileType lhs, const FileType rhs) {
|
|
return static_cast<FileType>(static_cast<unsigned>(lhs) |
|
|
static_cast<unsigned>(rhs));
|
|
}
|
|
|
|
/// Abstract TAPI file.
|
|
class File {
|
|
public:
|
|
enum class Kind : unsigned {
|
|
Configuration,
|
|
JSONFile,
|
|
InterfaceFileBase,
|
|
InterfaceFile,
|
|
ExtendedInterfaceFile,
|
|
SDKDBFile,
|
|
};
|
|
|
|
virtual ~File() = default;
|
|
|
|
template <typename T> void setPath(T &&path) {
|
|
_path = std::forward<T &&>(path);
|
|
}
|
|
const std::string &getPath() const { return _path; }
|
|
|
|
llvm::StringRef getFileName() const {
|
|
return llvm::sys::path::filename(_path);
|
|
}
|
|
|
|
void setFileType(FileType type) { _fileType = type; }
|
|
FileType getFileType() const { return _fileType; }
|
|
|
|
void setMemoryBuffer(std::unique_ptr<MemoryBuffer> memBuffer) {
|
|
_buffer = std::move(memBuffer);
|
|
}
|
|
|
|
MemoryBufferRef getMemBufferRef() const { return _buffer->getMemBufferRef(); }
|
|
|
|
void addDocument(std::shared_ptr<File> &&document) {
|
|
_documents.emplace_back(std::move(document));
|
|
}
|
|
|
|
Kind kind() const { return _kind; }
|
|
|
|
std::vector<std::shared_ptr<File>> _documents;
|
|
|
|
protected:
|
|
File(Kind kind) : _kind(kind) {}
|
|
void setKind(Kind kind) { _kind = kind; }
|
|
|
|
// Manually add the default implementations back in. The implicit ones have
|
|
// been removed, because we defined a virtual destructor.
|
|
File(File &&) = default;
|
|
File &operator=(File &&) = default;
|
|
|
|
private:
|
|
Kind _kind;
|
|
std::string _path;
|
|
FileType _fileType = FileType::Invalid;
|
|
// The backing store this file was derived from. We use this as context for
|
|
// the strings that we reference.
|
|
std::unique_ptr<MemoryBuffer> _buffer;
|
|
};
|
|
|
|
TAPI_NAMESPACE_INTERNAL_END
|
|
|
|
#endif // TAPI_CORE_FILE_H
|