XcodeSDK.h

Go to the documentation of this file.

//===-- XcodeSDK.h ----------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_UTILITY_XCODESDK_H
#define LLDB_UTILITY_XCODESDK_H
 
#include "lldb/Utility/FileSpec.h"
#include "lldb/lldb-forward.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/VersionTuple.h"
#include <tuple>
 
namespace llvm {
class Triple;
}
 
namespace lldb_private {
 
/// An abstraction for Xcode-style SDKs that works like \ref ArchSpec.
class XcodeSDK {
  std::string m_name;
 
public:
  /// Different types of Xcode SDKs.
  enum Type : int {
    MacOSX = 0,
    iPhoneSimulator,
    iPhoneOS,
    AppleTVSimulator,
    AppleTVOS,
    WatchSimulator,
    watchOS,
    XRSimulator,
    XROS,
    BridgeOS,
    Linux,
    unknown = -1
  };
  static constexpr int numSDKTypes = Linux + 1;
 
  /// A parsed SDK directory name.
  struct Info {
    Type type = unknown;
    llvm::VersionTuple version;
    bool internal = false;
 
    Info() = default;
    bool operator<(const Info &other) const;
    bool operator==(const Info &other) const;
  };
 
 
  /// Default constructor, constructs an empty string.
  XcodeSDK() = default;
  /// Construct an XcodeSDK object from a specification.
  XcodeSDK(Info info);
  /// Initialize an XcodeSDK object with an SDK name. The SDK name is the last
  /// directory component of a path one would pass to clang's -isysroot
  /// parameter. For example, "MacOSX.10.14.sdk".
  XcodeSDK(std::string &&name) : m_name(std::move(name)) {}
  static XcodeSDK GetAnyMacOS() { return XcodeSDK("MacOSX.sdk"); }
 
  /// The merge function follows a strict order to maintain monotonicity:
  /// 1. SDK with the higher SDKType wins.
  /// 2. The newer SDK wins.
  void Merge(const XcodeSDK &other);
 
  XcodeSDK &operator=(const XcodeSDK &other);
  XcodeSDK(const XcodeSDK&) = default;
  bool operator==(const XcodeSDK &other) const;
 
  /// Return parsed SDK type and version number.
  Info Parse() const;
  bool IsAppleInternalSDK() const;
  llvm::VersionTuple GetVersion() const;
  Type GetType() const;
  llvm::StringRef GetString() const;
 
  /// Whether LLDB feels confident importing Clang modules from this SDK.
  static bool SDKSupportsModules(Type type, llvm::VersionTuple version);
  static bool SDKSupportsModules(Type desired_type, const FileSpec &sdk_path);
 
  /// Return the canonical SDK name, such as "macosx" for the macOS SDK.
  static std::string GetCanonicalName(Info info);
  /// Return the best-matching SDK type for a specific triple.
  static XcodeSDK::Type GetSDKTypeForTriple(const llvm::Triple &triple);
 
  static std::string FindXcodeContentsDirectoryInPath(llvm::StringRef path);
};
 
/// An abstraction which groups an XcodeSDK with the sysroot it was used from.
///
/// The sysroot is not necessarily a path to the SDK named by the XcodeSDK: a
/// compiler may record a sysroot that was remapped, for example with
/// -fdebug-prefix-map, in which case it is only meaningful verbatim.
class XcodeSDKAndSysroot {
  XcodeSDK m_sdk;
  FileSpec m_sysroot;
 
public:
  /// Constructs an empty SDK with no sysroot.
  XcodeSDKAndSysroot() = default;
  XcodeSDKAndSysroot(XcodeSDK sdk, FileSpec sysroot)
      : m_sdk(std::move(sdk)), m_sysroot(std::move(sysroot)) {}
  XcodeSDKAndSysroot(std::string name, FileSpec sysroot)
      : m_sdk(XcodeSDK(std::move(name))), m_sysroot(std::move(sysroot)) {}
 
  bool operator==(const XcodeSDKAndSysroot &other) const;
  bool operator!=(const XcodeSDKAndSysroot &other) const;
 
  const XcodeSDK &GetSDK() const { return m_sdk; }
  const FileSpec &GetSysroot() const { return m_sysroot; }
  llvm::StringRef GetString() const { return m_sdk.GetString(); }
  XcodeSDK::Type GetType() const { return m_sdk.GetType(); }
 
  void Merge(const XcodeSDKAndSysroot &other);
  bool IsAppleInternalSDK() const { return m_sdk.IsAppleInternalSDK(); }
};
 
} // namespace lldb_private
 
#endif