1 //===--- FormatInternal.h - Format C++ code ---------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief This file declares Format APIs to be used internally by the
12 /// formatting library implementation.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_LIB_FORMAT_FORMATINTERNAL_H
17 #define LLVM_CLANG_LIB_FORMAT_FORMATINTERNAL_H
19 #include "BreakableToken.h"
20 #include "clang/Tooling/Core/Lookup.h"
27 /// \brief Reformats the given \p Ranges in the code fragment \p Code.
29 /// A fragment of code could conceptually be surrounded by other code that might
30 /// constrain how that fragment is laid out.
31 /// For example, consider the fragment of code between 'R"(' and ')"',
32 /// exclusive, in the following code:
34 /// void outer(int x) {
35 /// string inner = R"(name: data
36 /// ^ FirstStartColumn
45 /// The outer code can influence the inner fragment as follows:
46 /// * \p FirstStartColumn specifies the column at which \p Code starts.
47 /// * \p NextStartColumn specifies the additional indent dictated by the
48 /// surrounding code. It is applied to the rest of the lines of \p Code.
49 /// * \p LastStartColumn specifies the column at which the last line of
50 /// \p Code should end, in case the last line is an empty line.
52 /// In the case where the last line of the fragment contains content,
53 /// the fragment ends at the end of that content and \p LastStartColumn is
54 /// not taken into account, for example in:
57 /// string inner = R"(name: value)";
60 /// Each range is extended on either end to its next bigger logic unit, i.e.
61 /// everything that might influence its formatting or might be influenced by its
64 /// Returns a pair P, where:
65 /// * P.first are the ``Replacements`` necessary to make all \p Ranges comply
67 /// * P.second is the penalty induced by formatting the fragment \p Code.
68 /// If the formatting of the fragment doesn't have a notion of penalty,
71 /// If ``Status`` is non-null, its value will be populated with the status of
72 /// this formatting attempt. See \c FormattingAttemptStatus.
73 std::pair<tooling::Replacements, unsigned>
74 reformat(const FormatStyle &Style, StringRef Code,
75 ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
76 unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
77 FormattingAttemptStatus *Status);
79 } // namespace internal