1//===- ExtractAPI/APIIgnoresList.cpp -------*- 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/// \file
10/// This file implements APIIgnoresList that allows users to specifiy a file
11/// containing symbols to ignore during API extraction.
12///
13//===----------------------------------------------------------------------===//
14
15#include "clang/ExtractAPI/APIIgnoresList.h"
16#include "clang/Basic/FileManager.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/Support/Error.h"
19
20using namespace clang;
21using namespace clang::extractapi;
22using namespace llvm;
23
24char IgnoresFileNotFound::ID;
25
26void IgnoresFileNotFound::log(llvm::raw_ostream &os) const {
27 os << "Could not find API ignores file " << Path;
28}
29
30std::error_code IgnoresFileNotFound::convertToErrorCode() const {
31 return llvm::inconvertibleErrorCode();
32}
33
34Expected<APIIgnoresList>
35APIIgnoresList::create(const FilePathList &IgnoresFilePathList,
36 FileManager &FM) {
37 SmallVector<StringRef, 32> Lines;
38 BufferList symbolBufferList;
39
40 for (const auto &CurrentIgnoresFilePath : IgnoresFilePathList) {
41 auto BufferOrErr = FM.getBufferForFile(Filename: CurrentIgnoresFilePath);
42
43 if (!BufferOrErr)
44 return make_error<IgnoresFileNotFound>(Args: CurrentIgnoresFilePath);
45
46 auto Buffer = std::move(BufferOrErr.get());
47 Buffer->getBuffer().split(A&: Lines, Separator: '\n', /*MaxSplit*/ -1,
48 /*KeepEmpty*/ false);
49 symbolBufferList.push_back(Elt: std::move(Buffer));
50 }
51
52 // Symbol names don't have spaces in them, let's just remove these in case
53 // the input is slighlty malformed.
54 transform(Range&: Lines, d_first: Lines.begin(), F: [](StringRef Line) { return Line.trim(); });
55 sort(C&: Lines);
56 return APIIgnoresList(std::move(Lines), std::move(symbolBufferList));
57}
58
59bool APIIgnoresList::shouldIgnore(StringRef SymbolName) const {
60 auto It = lower_bound(Range: SymbolsToIgnore, Value&: SymbolName);
61 return (It != SymbolsToIgnore.end()) && (*It == SymbolName);
62}
63