File: Bracket.h

package info (click to toggle)
llvm-toolchain-21 1%3A21.1.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,245,028 kB
  • sloc: cpp: 7,619,726; ansic: 1,434,018; asm: 1,058,748; python: 252,740; f90: 94,671; objc: 70,685; lisp: 42,813; pascal: 18,401; sh: 8,601; ml: 5,111; perl: 4,720; makefile: 3,675; awk: 3,523; javascript: 2,409; xml: 892; fortran: 770
file content (41 lines) | stat: -rw-r--r-- 1,593 bytes parent folder | download | duplicates (5)
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
//===--- Bracket.h - Analyze bracket structure --------------------*-C++-*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Bracket structure (particularly braces) is key to isolating broken regions
// of code and preventing parsing from going "off the rails".
//
// For correct C++ code, brackets are well-nested and identifying pairs and
// therefore blocks is simple. In broken code, brackets are not properly nested.
// We cannot match them all and must choose which pairs to form.
//
// Rather than have the grammar-based parser make these choices, we pair
// brackets up-front based on textual features like indentation.
// This mirrors the way humans read code, and so is likely to produce the
// "correct" interpretation of broken code.
//
// This interpretation then guides the parse: a rule containing a bracket pair
// must match against paired bracket tokens.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_BRACKET_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_BRACKET_H

#include "Token.h"

namespace clang {
namespace clangd {

/// Identifies bracket token in the stream which should be paired.
/// Sets Token::Pair accordingly.
void pairBrackets(TokenStream &);

} // namespace clangd
} // namespace clang

#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_BRACKET_H