mirror of
https://github.com/Gericom/teak-llvm.git
synced 2025-06-24 22:08:57 -04:00
fc51490baf
This patch moves the virtual file system form clang to llvm so it can be
used by more projects.
Concretely the patch:
- Moves VirtualFileSystem.{h|cpp} from clang/Basic to llvm/Support.
- Moves the corresponding unit test from clang to llvm.
- Moves the vfs namespace from clang::vfs to llvm::vfs.
- Formats the lines affected by this change, mostly this is the result of
the added llvm namespace.
RFC on the mailing list:
http://lists.llvm.org/pipermail/llvm-dev/2018-October/126657.html
Differential revision: https://reviews.llvm.org/D52783
llvm-svn: 344140
129 lines
3.8 KiB
C++
129 lines
3.8 KiB
C++
//===- unittest/AST/CommentTextTest.cpp - Comment text extraction test ----===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// 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
|
|
}
|
|
|
|
} // namespace clang
|