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