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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
//===- unittest/AST/CommentTextTest.cpp - Comment text extraction test ----===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// Tests for user-friendly output formatting of comments, i.e.
// RawComment::getFormattedText().
//
//===----------------------------------------------------------------------===//
#include "clang/AST/RawCommentList.h"
#include "clang/Basic/CommentOptions.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/DiagnosticIDs.h"
#include "clang/Basic/FileManager.h"
#include "clang/Basic/FileSystemOptions.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/VirtualFileSystem.h"
#include <gtest/gtest.h>
namespace clang {
class CommentTextTest : public ::testing::Test {
protected:
std::string formatComment(llvm::StringRef CommentText) {
SourceManagerForFile FileSourceMgr("comment-test.cpp", CommentText);
SourceManager& SourceMgr = FileSourceMgr.get();
auto CommentStartOffset = CommentText.find("/");
assert(CommentStartOffset != llvm::StringRef::npos);
FileID File = SourceMgr.getMainFileID();
SourceRange CommentRange(
SourceMgr.getLocForStartOfFile(File).getLocWithOffset(
CommentStartOffset),
SourceMgr.getLocForEndOfFile(File));
CommentOptions EmptyOpts;
// FIXME: technically, merged that we set here is incorrect, but that
// shouldn't matter.
RawComment Comment(SourceMgr, CommentRange, EmptyOpts, /*Merged=*/true);
DiagnosticsEngine Diags(new DiagnosticIDs, new DiagnosticOptions);
return Comment.getFormattedText(SourceMgr, Diags);
}
};
TEST_F(CommentTextTest, FormattedText) {
// clang-format off
auto ExpectedOutput =
R"(This function does this and that.
For example,
Runnning it in that case will give you
this result.
That's about it.)";
// Two-slash comments.
auto Formatted = formatComment(
R"cpp(
// This function does this and that.
// For example,
// Runnning it in that case will give you
// this result.
// That's about it.)cpp");
EXPECT_EQ(ExpectedOutput, Formatted);
// Three-slash comments.
Formatted = formatComment(
R"cpp(
/// This function does this and that.
/// For example,
/// Runnning it in that case will give you
/// this result.
/// That's about it.)cpp");
EXPECT_EQ(ExpectedOutput, Formatted);
// Block comments.
Formatted = formatComment(
R"cpp(
/* This function does this and that.
* For example,
* Runnning it in that case will give you
* this result.
* That's about it.*/)cpp");
EXPECT_EQ(ExpectedOutput, Formatted);
// Doxygen-style block comments.
Formatted = formatComment(
R"cpp(
/** This function does this and that.
* For example,
* Runnning it in that case will give you
* this result.
* That's about it.*/)cpp");
EXPECT_EQ(ExpectedOutput, Formatted);
// Weird indentation.
Formatted = formatComment(
R"cpp(
// This function does this and that.
// For example,
// Runnning it in that case will give you
// this result.
// That's about it.)cpp");
EXPECT_EQ(ExpectedOutput, Formatted);
// clang-format on
}
TEST_F(CommentTextTest, KeepsDoxygenControlSeqs) {
// clang-format off
auto ExpectedOutput =
R"(\brief This is the brief part of the comment.
\param a something about a.
@param b something about b.)";
auto Formatted = formatComment(
R"cpp(
/// \brief This is the brief part of the comment.
/// \param a something about a.
/// @param b something about b.)cpp");
EXPECT_EQ(ExpectedOutput, Formatted);
// clang-format on
}
TEST_F(CommentTextTest, EmptyFormattedText) {
// Test that empty formatted text doesn't cause crash.
const char *ExpectedOutput = "";
auto Formatted = formatComment("//!<");
EXPECT_EQ(ExpectedOutput, Formatted);
}
} // namespace clang
|
