mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-17 17:26:41 +00:00
ed8f788278
The functionality is incomplete and the authors have since shifted gears to other work, so this is effectively unmaintained. The original design document for clang-pseudo can be found at: https://docs.google.com/document/d/1eGkTOsFja63wsv8v0vd5JdoTonj-NlN3ujGF0T7xDbM/edit in case anyone wishes to pick this project back up again in the future. Original RFC: https://discourse.llvm.org/t/removing-pseudo-parser/71131/
42 lines
1.6 KiB
C++
42 lines
1.6 KiB
C++
//===--- 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
|