//===--- BridgingUtils.h - utilities for swift bridging -------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_BASIC_BRIDGINGUTILS_H
#define SWIFT_BASIC_BRIDGINGUTILS_H

#include "swift/Basic/BasicBridging.h"
#include "swift/Basic/SourceLoc.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/AllocatorBase.h"

#include <string>

namespace swift {

inline BridgedStringRef getBridgedStringRef(llvm::StringRef str) {
  return {(const unsigned char *)str.data(), str.size()};
}

inline llvm::StringRef getStringRef(BridgedStringRef str) {
  return llvm::StringRef((const char *)str.data, str.length);
}

template <typename T>
inline llvm::ArrayRef<T> getArrayRef(BridgedArrayRef bridged) {
  return {static_cast<const T *>(bridged.data), bridged.numElements};
}

inline CharSourceRange
getCharSourceRange(const BridgedCharSourceRange &bridged) {
  return CharSourceRange(bridged.start, bridged.byteLength);
}

inline BridgedCharSourceRange
getBridgedCharSourceRange(const CharSourceRange &range) {
  return {range.getStart(), range.getByteLength()};
}

/// Copies the string in an malloc'ed memory and the caller is responsible for
/// freeing it. 'freeBridgedStringRef()' is available in 'BasicBridging.h'
inline BridgedStringRef
getCopiedBridgedStringRef(std::string str, bool removeTrailingNewline = false) {
  // A couple of mallocs are needed for passing a std::string to Swift. But
  // it's currently only used or debug descriptions. So, its' maybe not so bad -
  // for now.
  // TODO: find a better way to pass std::strings to Swift.
  llvm::StringRef strRef(str);
  if (removeTrailingNewline)
    strRef.consume_back("\n");
  llvm::MallocAllocator allocator;
  llvm::StringRef copy = strRef.copy(allocator);
  return getBridgedStringRef(copy);
}

} // namespace swift

#endif