Coverage Report

Created: 2019-02-15 18:59

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/include/llvm/BinaryFormat/Magic.h
Line
Count
Source (jump to first uncovered line)
1
//===- llvm/BinaryFormat/Magic.h - File magic identification ----*- C++ -*-===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
9
#ifndef LLVM_BINARYFORMAT_MAGIC_H
10
#define LLVM_BINARYFORMAT_MAGIC_H
11
12
#include "llvm/ADT/StringRef.h"
13
#include "llvm/ADT/Twine.h"
14
15
#include <system_error>
16
17
namespace llvm {
18
/// file_magic - An "enum class" enumeration of file types based on magic (the
19
/// first N bytes of the file).
20
struct file_magic {
21
  enum Impl {
22
    unknown = 0,       ///< Unrecognized file
23
    bitcode,           ///< Bitcode file
24
    archive,           ///< ar style archive file
25
    elf,               ///< ELF Unknown type
26
    elf_relocatable,   ///< ELF Relocatable object file
27
    elf_executable,    ///< ELF Executable image
28
    elf_shared_object, ///< ELF dynamically linked shared lib
29
    elf_core,          ///< ELF core image
30
    macho_object,      ///< Mach-O Object file
31
    macho_executable,  ///< Mach-O Executable
32
    macho_fixed_virtual_memory_shared_lib,    ///< Mach-O Shared Lib, FVM
33
    macho_core,                               ///< Mach-O Core File
34
    macho_preload_executable,                 ///< Mach-O Preloaded Executable
35
    macho_dynamically_linked_shared_lib,      ///< Mach-O dynlinked shared lib
36
    macho_dynamic_linker,                     ///< The Mach-O dynamic linker
37
    macho_bundle,                             ///< Mach-O Bundle file
38
    macho_dynamically_linked_shared_lib_stub, ///< Mach-O Shared lib stub
39
    macho_dsym_companion,                     ///< Mach-O dSYM companion file
40
    macho_kext_bundle,                        ///< Mach-O kext bundle file
41
    macho_universal_binary,                   ///< Mach-O universal binary
42
    coff_cl_gl_object,   ///< Microsoft cl.exe's intermediate code file
43
    coff_object,         ///< COFF object file
44
    coff_import_library, ///< COFF import library
45
    pecoff_executable,   ///< PECOFF executable file
46
    windows_resource,    ///< Windows compiled resource file (.res)
47
    wasm_object,         ///< WebAssembly Object file
48
    pdb,                 ///< Windows PDB debug info file
49
  };
50
51
0
  bool is_object() const { return V != unknown; }
52
53
  file_magic() = default;
54
25.7k
  file_magic(Impl V) : V(V) {}
55
64.1k
  operator Impl() const { return V; }
56
57
private:
58
  Impl V = unknown;
59
};
60
61
/// Identify the type of a binary file based on how magical it is.
62
file_magic identify_magic(StringRef magic);
63
64
/// Get and identify \a path's type based on its content.
65
///
66
/// @param path Input path.
67
/// @param result Set to the type of file, or file_magic::unknown.
68
/// @returns errc::success if result has been successfully set, otherwise a
69
///          platform-specific error_code.
70
std::error_code identify_magic(const Twine &path, file_magic &result);
71
} // namespace llvm
72
73
#endif