blob: 544caf58be7cca4a6ce46775f32071345cf1b968 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
#pragma once
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
//===- ExtractAPI/APIIgnoresList.h ---------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file This file defines APIIgnoresList which is a type that allows querying
/// a file containing symbols to ignore when extracting API information.
///
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_API_IGNORES_LIST_H
#define LLVM_CLANG_API_IGNORES_LIST_H
#include "clang/Basic/FileManager.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/raw_ostream.h"
#include <memory>
#include <system_error>
namespace llvm {
class MemoryBuffer;
} // namespace llvm
namespace clang {
namespace extractapi {
struct IgnoresFileNotFound : public llvm::ErrorInfo<IgnoresFileNotFound> {
std::string Path;
static char ID;
explicit IgnoresFileNotFound(StringRef Path) : Path(Path) {}
virtual void log(llvm::raw_ostream &os) const override;
virtual std::error_code convertToErrorCode() const override;
};
/// A type that provides access to a new line separated list of symbol names to
/// ignore when extracting API information.
struct APIIgnoresList {
/// The API to use for generating from the file at \p IgnoresFilePath.
///
/// \returns an initialized APIIgnoresList or an Error.
static llvm::Expected<APIIgnoresList> create(llvm::StringRef IgnoresFilePath,
FileManager &FM);
APIIgnoresList() = default;
/// Check if \p SymbolName is specified in the APIIgnoresList and if it should
/// therefore be ignored.
bool shouldIgnore(llvm::StringRef SymbolName) const;
private:
using SymbolNameList = llvm::SmallVector<llvm::StringRef, 32>;
APIIgnoresList(SymbolNameList SymbolsToIgnore,
std::unique_ptr<llvm::MemoryBuffer> Buffer)
: SymbolsToIgnore(std::move(SymbolsToIgnore)), Buffer(std::move(Buffer)) {
}
SymbolNameList SymbolsToIgnore;
std::unique_ptr<llvm::MemoryBuffer> Buffer;
};
} // namespace extractapi
} // namespace clang
#endif // LLVM_CLANG_API_IGNORES_LIST_H
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
|
