xref: /openbsd-src/gnu/llvm/clang/lib/Format/AffectedRangeManager.h (revision e5dd70708596ae51455a0ffa086a00c5b29f8583)
1*e5dd7070Spatrick //===--- AffectedRangeManager.h - Format C++ code ---------------*- C++ -*-===//
2*e5dd7070Spatrick //
3*e5dd7070Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*e5dd7070Spatrick // See https://llvm.org/LICENSE.txt for license information.
5*e5dd7070Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*e5dd7070Spatrick //
7*e5dd7070Spatrick //===----------------------------------------------------------------------===//
8*e5dd7070Spatrick ///
9*e5dd7070Spatrick /// \file
10*e5dd7070Spatrick /// AffectedRangeManager class manages affected ranges in the code.
11*e5dd7070Spatrick ///
12*e5dd7070Spatrick //===----------------------------------------------------------------------===//
13*e5dd7070Spatrick 
14*e5dd7070Spatrick #ifndef LLVM_CLANG_LIB_FORMAT_AFFECTEDRANGEMANAGER_H
15*e5dd7070Spatrick #define LLVM_CLANG_LIB_FORMAT_AFFECTEDRANGEMANAGER_H
16*e5dd7070Spatrick 
17*e5dd7070Spatrick #include "clang/Basic/SourceManager.h"
18*e5dd7070Spatrick 
19*e5dd7070Spatrick namespace clang {
20*e5dd7070Spatrick namespace format {
21*e5dd7070Spatrick 
22*e5dd7070Spatrick struct FormatToken;
23*e5dd7070Spatrick class AnnotatedLine;
24*e5dd7070Spatrick 
25*e5dd7070Spatrick class AffectedRangeManager {
26*e5dd7070Spatrick public:
AffectedRangeManager(const SourceManager & SourceMgr,const ArrayRef<CharSourceRange> Ranges)27*e5dd7070Spatrick   AffectedRangeManager(const SourceManager &SourceMgr,
28*e5dd7070Spatrick                        const ArrayRef<CharSourceRange> Ranges)
29*e5dd7070Spatrick       : SourceMgr(SourceMgr), Ranges(Ranges.begin(), Ranges.end()) {}
30*e5dd7070Spatrick 
31*e5dd7070Spatrick   // Determines which lines are affected by the SourceRanges given as input.
32*e5dd7070Spatrick   // Returns \c true if at least one line in \p Lines or one of their
33*e5dd7070Spatrick   // children is affected.
34*e5dd7070Spatrick   bool computeAffectedLines(SmallVectorImpl<AnnotatedLine *> &Lines);
35*e5dd7070Spatrick 
36*e5dd7070Spatrick   // Returns true if 'Range' intersects with one of the input ranges.
37*e5dd7070Spatrick   bool affectsCharSourceRange(const CharSourceRange &Range);
38*e5dd7070Spatrick 
39*e5dd7070Spatrick private:
40*e5dd7070Spatrick   // Returns true if the range from 'First' to 'Last' intersects with one of the
41*e5dd7070Spatrick   // input ranges.
42*e5dd7070Spatrick   bool affectsTokenRange(const FormatToken &First, const FormatToken &Last,
43*e5dd7070Spatrick                          bool IncludeLeadingNewlines);
44*e5dd7070Spatrick 
45*e5dd7070Spatrick   // Returns true if one of the input ranges intersect the leading empty lines
46*e5dd7070Spatrick   // before 'Tok'.
47*e5dd7070Spatrick   bool affectsLeadingEmptyLines(const FormatToken &Tok);
48*e5dd7070Spatrick 
49*e5dd7070Spatrick   // Marks all lines between I and E as well as all their children as affected.
50*e5dd7070Spatrick   void markAllAsAffected(SmallVectorImpl<AnnotatedLine *>::iterator I,
51*e5dd7070Spatrick                          SmallVectorImpl<AnnotatedLine *>::iterator E);
52*e5dd7070Spatrick 
53*e5dd7070Spatrick   // Determines whether 'Line' is affected by the SourceRanges given as input.
54*e5dd7070Spatrick   // Returns \c true if line or one if its children is affected.
55*e5dd7070Spatrick   bool nonPPLineAffected(AnnotatedLine *Line, const AnnotatedLine *PreviousLine,
56*e5dd7070Spatrick                          SmallVectorImpl<AnnotatedLine *> &Lines);
57*e5dd7070Spatrick 
58*e5dd7070Spatrick   const SourceManager &SourceMgr;
59*e5dd7070Spatrick   const SmallVector<CharSourceRange, 8> Ranges;
60*e5dd7070Spatrick };
61*e5dd7070Spatrick 
62*e5dd7070Spatrick } // namespace format
63*e5dd7070Spatrick } // namespace clang
64*e5dd7070Spatrick 
65*e5dd7070Spatrick #endif // LLVM_CLANG_LIB_FORMAT_AFFECTEDRANGEMANAGER_H
66