IncludeSorter.h
2.81 KB
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
//===------------ IncludeSorter.h - clang-tidy ----------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_INCLUDESORTER_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_INCLUDESORTER_H
#include "../ClangTidyCheck.h"
#include <string>
namespace clang {
namespace tidy {
namespace utils {
/// Class used by ``IncludeInserterCallback`` to record the names of the
/// inclusions in a given source file being processed and generate the necessary
/// commands to sort the inclusions according to the precedence encoded in
/// ``IncludeKinds``.
class IncludeSorter {
public:
/// Supported include styles.
enum IncludeStyle { IS_LLVM = 0, IS_Google = 1 };
/// The classifications of inclusions, in the order they should be sorted.
enum IncludeKinds {
IK_MainTUInclude = 0, ///< e.g. ``#include "foo.h"`` when editing foo.cc
IK_CSystemInclude = 1, ///< e.g. ``#include <stdio.h>``
IK_CXXSystemInclude = 2, ///< e.g. ``#include <vector>``
IK_NonSystemInclude = 3, ///< e.g. ``#include "bar.h"``
IK_InvalidInclude = 4 ///< total number of valid ``IncludeKind``s
};
/// ``IncludeSorter`` constructor; takes the FileID and name of the file to be
/// processed by the sorter.
IncludeSorter(const SourceManager *SourceMgr, const FileID FileID,
StringRef FileName, IncludeStyle Style);
/// Adds the given include directive to the sorter.
void AddInclude(StringRef FileName, bool IsAngled,
SourceLocation HashLocation, SourceLocation EndLocation);
/// Creates a quoted inclusion directive in the right sort order. Returns None
/// on error or if header inclusion directive for header already exists.
Optional<FixItHint> CreateIncludeInsertion(StringRef FileName, bool IsAngled);
private:
typedef SmallVector<SourceRange, 1> SourceRangeVector;
const SourceManager *SourceMgr;
const IncludeStyle Style;
FileID CurrentFileID;
/// The file name stripped of common suffixes.
StringRef CanonicalFile;
/// Locations of visited include directives.
SourceRangeVector SourceLocations;
/// Mapping from file name to #include locations.
llvm::StringMap<SourceRangeVector> IncludeLocations;
/// Includes sorted into buckets.
SmallVector<std::string, 1> IncludeBucket[IK_InvalidInclude];
};
} // namespace utils
template <> struct OptionEnumMapping<utils::IncludeSorter::IncludeStyle> {
static ArrayRef<std::pair<utils::IncludeSorter::IncludeStyle, StringRef>>
getEnumMapping();
};
} // namespace tidy
} // namespace clang
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_INCLUDESORTER_H