pattern_test.cpp

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

#include "explorer/ast/pattern.h"

#include <gmock/gmock.h>
#include <gtest/gtest.h>

#include "explorer/ast/expression.h"
#include "explorer/ast/paren_contents.h"
#include "explorer/common/arena.h"
#include "llvm/Support/Casting.h"

namespace Carbon::Testing {
namespace {

using llvm::cast;
using llvm::isa;
using testing::ElementsAre;
using testing::IsEmpty;

// Matches any `AutoPattern`.
MATCHER(AutoField, "") { return isa<AutoPattern>(*arg); }

static auto FakeSourceLoc(int line_num) -> SourceLocation {
  return SourceLocation("<test>", line_num);
}

class PatternTest : public ::testing::Test {
 protected:
  Arena arena;
};

TEST_F(PatternTest, EmptyAsPattern) {
  ParenContents<Pattern> contents = {.elements = {},
                                     .has_trailing_comma = false};
  Nonnull<const Pattern*> pattern =
      PatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(pattern->source_loc(), FakeSourceLoc(1));
  ASSERT_TRUE(isa<TuplePattern>(*pattern));
  EXPECT_THAT(cast<TuplePattern>(*pattern).fields(), IsEmpty());
}

TEST_F(PatternTest, EmptyAsTuplePattern) {
  ParenContents<Pattern> contents = {.elements = {},
                                     .has_trailing_comma = false};
  Nonnull<const TuplePattern*> tuple =
      TuplePatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(tuple->source_loc(), FakeSourceLoc(1));
  EXPECT_THAT(tuple->fields(), IsEmpty());
}

TEST_F(PatternTest, UnaryNoCommaAsPattern) {
  // Equivalent to a code fragment like
  // ```
  // (
  //   auto
  // )
  // ```
  ParenContents<Pattern> contents = {
      .elements = {arena.New<AutoPattern>(FakeSourceLoc(2))},
      .has_trailing_comma = false};

  Nonnull<const Pattern*> pattern =
      PatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(pattern->source_loc(), FakeSourceLoc(2));
  ASSERT_TRUE(isa<AutoPattern>(*pattern));
}

TEST_F(PatternTest, UnaryNoCommaAsTuplePattern) {
  ParenContents<Pattern> contents = {
      .elements = {arena.New<AutoPattern>(FakeSourceLoc(2))},
      .has_trailing_comma = false};

  Nonnull<const TuplePattern*> tuple =
      TuplePatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(tuple->source_loc(), FakeSourceLoc(1));
  EXPECT_THAT(tuple->fields(), ElementsAre(AutoField()));
}

TEST_F(PatternTest, UnaryWithCommaAsPattern) {
  ParenContents<Pattern> contents = {
      .elements = {arena.New<AutoPattern>(FakeSourceLoc(2))},
      .has_trailing_comma = true};

  Nonnull<const Pattern*> pattern =
      PatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(pattern->source_loc(), FakeSourceLoc(1));
  ASSERT_TRUE(isa<TuplePattern>(*pattern));
  EXPECT_THAT(cast<TuplePattern>(*pattern).fields(), ElementsAre(AutoField()));
}

TEST_F(PatternTest, UnaryWithCommaAsTuplePattern) {
  ParenContents<Pattern> contents = {
      .elements = {arena.New<AutoPattern>(FakeSourceLoc(2))},
      .has_trailing_comma = true};

  Nonnull<const TuplePattern*> tuple =
      TuplePatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(tuple->source_loc(), FakeSourceLoc(1));
  EXPECT_THAT(tuple->fields(), ElementsAre(AutoField()));
}

TEST_F(PatternTest, BinaryAsPattern) {
  ParenContents<Pattern> contents = {
      .elements = {arena.New<AutoPattern>(FakeSourceLoc(2)),
                   arena.New<AutoPattern>(FakeSourceLoc(2))},
      .has_trailing_comma = true};

  Nonnull<const Pattern*> pattern =
      PatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(pattern->source_loc(), FakeSourceLoc(1));
  ASSERT_TRUE(isa<TuplePattern>(*pattern));
  EXPECT_THAT(cast<TuplePattern>(*pattern).fields(),
              ElementsAre(AutoField(), AutoField()));
}

TEST_F(PatternTest, BinaryAsTuplePattern) {
  ParenContents<Pattern> contents = {
      .elements = {arena.New<AutoPattern>(FakeSourceLoc(2)),
                   arena.New<AutoPattern>(FakeSourceLoc(2))},
      .has_trailing_comma = true};

  Nonnull<const TuplePattern*> tuple =
      TuplePatternFromParenContents(&arena, FakeSourceLoc(1), contents);
  EXPECT_EQ(tuple->source_loc(), FakeSourceLoc(1));
  EXPECT_THAT(tuple->fields(), ElementsAre(AutoField(), AutoField()));
}

}  // namespace
}  // namespace Carbon::Testing