summaryrefslogtreecommitdiff
path: root/compiler/loco/src/ADT/AnnotatedItem.test.cpp
blob: 42113ff7bf8ee3f9d45ae13fc8ca8838949a4046 (plain)
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
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "loco/ADT/AnnotatedItem.h"

#include <gtest/gtest.h>
#include <stdex/Memory.h>

namespace
{

struct Annotation
{
  virtual ~Annotation() = default;
};

template <int N> struct DerivedAnnotation final : public Annotation
{
  static std::unique_ptr<DerivedAnnotation<N>> make(void)
  {
    return stdex::make_unique<DerivedAnnotation<N>>();
  }
};

} // namespace

TEST(AnnotatedItemTest, annotation)
{
  loco::AnnotatedItem<::Annotation> item;

  ASSERT_EQ(item.annot<DerivedAnnotation<0>>(), nullptr);

  item.annot(DerivedAnnotation<0>::make());

  ASSERT_NE(item.annot<DerivedAnnotation<0>>(), nullptr);
  ASSERT_EQ(item.annot<DerivedAnnotation<1>>(), nullptr);

  item.annot<DerivedAnnotation<0>>(nullptr);
  ASSERT_EQ(item.annot<DerivedAnnotation<0>>(), nullptr);

  // Below check guarantees that "annot<T>(nullptr)" is allowed even when there is no annotation.
  // This guarantee allows us to simplify code for some cases.
  //
  // Let us consider the following example:
  //
  // void f(loco::AnnotatedItem<T> *item)
  // {
  //   /* DO SOMETHING */
  //   if (cond) { item->annot<T>(nullptr);
  // }
  //
  // void g(loco::AnnotatedItem<T> *item)
  // {
  //   f(item);
  //   item->annot<T>(nullptr);
  // }
  //
  // The implementation of "g" gets complicated if annot<T>(nullptr) is not allowed if there is
  // no annotation.
  //
  item.annot<DerivedAnnotation<0>>(nullptr);
}