swift-mirror/test/Interop/Cxx/stdlib/Inputs/std-span.h

#ifndef TEST_INTEROP_CXX_STDLIB_INPUTS_STD_SPAN_H
#define TEST_INTEROP_CXX_STDLIB_INPUTS_STD_SPAN_H

#include <cstddef>
#include <span>
#include <string>
#include <vector>

#ifdef __counted_by
#undef __counted_by // some libstdc++ versions seem to include incompatible definitions of __counted_by??
#endif

#if defined(__has_feature) && __has_feature(bounds_safety_attributes)
#define __counted_by(x) __attribute__((__counted_by__(x)))
#else
#define __counted_by(x)
#endif

using ConstSpanOfInt = std::span<const int>;
using SpanOfInt = std::span<int>;
using ConstSpanOfString = std::span<const std::string>;
using SpanOfString = std::span<std::string>;
using VecOfInt = std::vector<int>;

static int iarray[]{1, 2, 3};
static std::string sarray[]{"", "ab", "abc"};
static ConstSpanOfInt icspan = {iarray};
static SpanOfInt ispan = {iarray};
static ConstSpanOfString scspan = {sarray};
static SpanOfString sspan = {sarray};

struct SpanBox {
  ConstSpanOfInt icspan;
  SpanOfInt ispan;
  ConstSpanOfString scspan;
  SpanOfString sspan;
};

class CppApi {
public:
  ConstSpanOfInt getConstSpan();
  SpanOfInt getSpan();
};

ConstSpanOfInt CppApi::getConstSpan() {
  ConstSpanOfInt sp{new int[2], 2};
  return sp;
}

SpanOfInt CppApi::getSpan() {
  SpanOfInt sp{new int[2], 2};
  return sp;
}

inline ConstSpanOfInt initConstSpan() {
  return ConstSpanOfInt(iarray);
}

inline SpanOfInt initSpan() {
  return SpanOfInt(iarray);
}

inline SpanOfInt initSpan(int arr[], size_t size) {
  return SpanOfInt(arr, size);
}

struct DependsOnSelf {
  std::vector<int> v;
  __attribute__((swift_name("get()")))
  __attribute__((swift_attr("@safe")))
  ConstSpanOfInt get() const [[clang::lifetimebound]] { return ConstSpanOfInt(v.data(), v.size()); }
};

inline struct SpanBox getStructSpanBox() { return {iarray, iarray, sarray, sarray}; }

struct CaptureByReference {
    void set(const std::vector<int>& x [[clang::lifetime_capture_by(this)]]) { 
        this->x = ConstSpanOfInt(x.data(), x.size());
    };
    ConstSpanOfInt x;
};

inline void funcWithSafeWrapper(ConstSpanOfInt s [[clang::noescape]]) {}

inline ConstSpanOfInt funcWithSafeWrapper2(ConstSpanOfInt s
                                           [[clang::lifetimebound]]) {
  return s;
}

inline ConstSpanOfInt funcWithSafeWrapper3(const VecOfInt &v
                                           [[clang::lifetimebound]]) {
  return ConstSpanOfInt(v.data(), v.size());
}

struct X {
  inline void methodWithSafeWrapper(ConstSpanOfInt s [[clang::noescape]]) {}
  SpanOfInt getMutable(ConstSpanOfInt s [[clang::noescape]]) [[clang::lifetimebound]];
};

inline ConstSpanOfInt mixedFuncWithSafeWrapper1(const int * __counted_by(len) p
                                           [[clang::lifetimebound]], int len) {
  return ConstSpanOfInt(p, len);
}

inline const int * __counted_by(len) mixedFuncWithSafeWrapper2(const VecOfInt &v
                                           [[clang::lifetimebound]], int len) {
  if (v.size() <= len)
    return v.data();
  return nullptr;
}

inline void mixedFuncWithSafeWrapper3(ConstSpanOfInt s [[clang::noescape]],
                                      int * __counted_by(len) p, int len) {}

inline void mixedFuncWithSafeWrapper4(ConstSpanOfInt s [[clang::noescape]],
                                      const int * __counted_by(len) p [[clang::noescape]], int len) {}

inline void mixedFuncWithSafeWrapper5(ConstSpanOfInt s,
                                      const int * __counted_by(len) p [[clang::noescape]], int len) {}

inline void mixedFuncWithSafeWrapper6(ConstSpanOfInt s,
                                      int * __counted_by(len) p, int len) {}

inline ConstSpanOfInt mixedFuncWithSafeWrapper7(const int * __counted_by(len) p, int len) {
  return ConstSpanOfInt(p, len);
}

inline void FuncWithMutableSafeWrapper(SpanOfInt s [[clang::noescape]]) {}

inline SpanOfInt FuncWithMutableSafeWrapper2(SpanOfInt s
                                           [[clang::lifetimebound]]) {
  return s;
}

inline SpanOfInt FuncWithMutableSafeWrapper3(VecOfInt &v
                                           [[clang::lifetimebound]]) {
  return SpanOfInt(v.data(), v.size());
}

struct Y {
  inline void methodWithMutableSafeWrapper(SpanOfInt s [[clang::noescape]]) {}
};

inline SpanOfInt MixedFuncWithMutableSafeWrapper1(int * __counted_by(len) p
                                           [[clang::lifetimebound]], int len) {
  return SpanOfInt(p, len);
}

inline int * __counted_by(len) MixedFuncWithMutableSafeWrapper2(VecOfInt &v
                                           [[clang::lifetimebound]], int len) {
  if (v.size() <= len)
    return v.data();
  return nullptr;
}

inline void MixedFuncWithMutableSafeWrapper3(SpanOfInt s [[clang::noescape]],
                                      int * __counted_by(len) p, int len) {}

inline void MixedFuncWithMutableSafeWrapper4(SpanOfInt s [[clang::noescape]],
                                      int * __counted_by(len) p [[clang::noescape]], int len) {}

inline void MixedFuncWithMutableSafeWrapper5(SpanOfInt s,
                                      int * __counted_by(len) p [[clang::noescape]], int len) {}

inline void MixedFuncWithMutableSafeWrapper6(SpanOfInt s,
                                      int * __counted_by(len) p, int len) {}

inline SpanOfInt MixedFuncWithMutableSafeWrapper7(int * __counted_by(len) p, int len) {
  return SpanOfInt(p, len);
}

template <typename X>
struct S {};

struct SpanWithoutTypeAlias {
  std::span<const int> bar() [[clang::lifetimebound]];
  void foo(std::span<const int> s [[clang::noescape]]);
  void otherTemplatedType(ConstSpanOfInt copy [[clang::noescape]], S<int>);
  void otherTemplatedType2(ConstSpanOfInt copy [[clang::noescape]], S<int> *);
};

inline void func(ConstSpanOfInt copy [[clang::noescape]]) {}
inline void mutableKeyword(SpanOfInt copy [[clang::noescape]]) {}

inline void spanWithoutTypeAlias(std::span<const int> s [[clang::noescape]]) {}
inline void mutableSpanWithoutTypeAlias(std::span<int> s [[clang::noescape]]) {}

#define IMMORTAL_FRT                                                           \
  __attribute__((swift_attr("import_reference")))                              \
  __attribute__((swift_attr("retain:immortal")))                               \
  __attribute__((swift_attr("release:immortal")))

struct IMMORTAL_FRT DependsOnSelfFRT {
  std::vector<int> v;
  __attribute__((swift_name("get()"))) ConstSpanOfInt get() const
      [[clang::lifetimebound]] {
    return ConstSpanOfInt(v.data(), v.size());
  }
  SpanOfInt getMutable() [[clang::lifetimebound]] {
    return SpanOfInt(v.data(), v.size());
  }
};

#endif // TEST_INTEROP_CXX_STDLIB_INPUTS_STD_SPAN_H