mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
249 lines
8.6 KiB
C++
249 lines
8.6 KiB
C++
//===--- LangOptions.h - Language & configuration options -------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines the LangOptions class, which provides various
|
|
// language and configuration flags.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_LANGOPTIONS_H
|
|
#define SWIFT_LANGOPTIONS_H
|
|
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "clang/Basic/VersionTuple.h"
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/ADT/Triple.h"
|
|
#include <string>
|
|
|
|
namespace swift {
|
|
/// \brief A collection of options that affect the language dialect and
|
|
/// provide compiler debugging facilities.
|
|
class LangOptions {
|
|
public:
|
|
|
|
/// \brief The target we are building for.
|
|
///
|
|
/// This represents the minimum deployment target.
|
|
llvm::Triple Target;
|
|
|
|
///
|
|
/// Language features
|
|
///
|
|
|
|
/// \brief Disable API availability checking.
|
|
bool DisableAvailabilityChecking = false;
|
|
|
|
/// Whether to warn about "needless" words in declarations.
|
|
bool WarnOmitNeedlessWords = false;
|
|
|
|
/// Should access control be respected?
|
|
bool EnableAccessControl = true;
|
|
|
|
/// Enable 'availability' restrictions for App Extensions.
|
|
bool EnableAppExtensionRestrictions = false;
|
|
|
|
///
|
|
/// Support for alternate usage modes
|
|
///
|
|
|
|
/// \brief Enable features useful for running in the debugger.
|
|
bool DebuggerSupport = false;
|
|
|
|
/// Allows using identifiers with a leading dollar.
|
|
bool EnableDollarIdentifiers = false;
|
|
|
|
/// \brief Allow throwing call expressions without annotation with 'try'.
|
|
bool EnableThrowWithoutTry = false;
|
|
|
|
/// \brief Enable features useful for running playgrounds.
|
|
// FIXME: This should probably be limited to the particular SourceFile.
|
|
bool Playground = false;
|
|
|
|
/// \brief Keep comments during lexing and attach them to declarations.
|
|
bool AttachCommentsToDecls = false;
|
|
|
|
/// Whether to include initializers when code-completing a postfix
|
|
/// expression.
|
|
bool CodeCompleteInitsInPostfixExpr = false;
|
|
|
|
///
|
|
/// Flags for use by tests
|
|
///
|
|
|
|
/// Enable Objective-C Runtime interop code generation and build
|
|
/// configuration options.
|
|
bool EnableObjCInterop = true;
|
|
|
|
/// Enables checking that uses of @objc require importing
|
|
/// the Foundation module.
|
|
/// This is enabled by default because SILGen can crash in such a case, but
|
|
/// it gets disabled when compiling the Swift core stdlib.
|
|
bool EnableObjCAttrRequiresFoundation = true;
|
|
|
|
/// If true, <code>@testable import Foo</code> produces an error if \c Foo
|
|
/// was not compiled with -enable-testing.
|
|
bool EnableTestableAttrRequiresTestableModule = true;
|
|
|
|
///
|
|
/// Flags for developers
|
|
///
|
|
|
|
/// \brief Whether we are debugging the constraint solver.
|
|
///
|
|
/// This option enables verbose debugging output from the constraint
|
|
/// solver.
|
|
bool DebugConstraintSolver = false;
|
|
|
|
/// \brief Specific solution attempt for which the constraint
|
|
/// solver should be debugged.
|
|
unsigned DebugConstraintSolverAttempt = 0;
|
|
|
|
/// \brief Enable the iterative type checker.
|
|
bool IterativeTypeChecker = false;
|
|
|
|
/// Debug the generic signatures computed by the archetype builder.
|
|
bool DebugGenericSignatures = false;
|
|
|
|
/// Triggers llvm fatal_error if typechecker tries to typecheck a decl or an
|
|
/// identifier reference with the provided prefix name.
|
|
/// This is for testing purposes.
|
|
std::string DebugForbidTypecheckPrefix;
|
|
|
|
/// Number of parallel processes performing AST verification.
|
|
unsigned ASTVerifierProcessCount = 1U;
|
|
|
|
/// ID of the current process for the purposes of AST verification.
|
|
unsigned ASTVerifierProcessId = 1U;
|
|
|
|
/// \brief The upper bound, in bytes, of temporary data that can be
|
|
/// allocated by the constraint solver.
|
|
unsigned SolverMemoryThreshold = 15000000;
|
|
|
|
/// \brief Perform all dynamic allocations using malloc/free instead of
|
|
/// optimized custom allocator, so that memory debugging tools can be used.
|
|
bool UseMalloc = false;
|
|
|
|
/// \brief Enable experimental "switch" pattern-matching features.
|
|
bool EnableExperimentalPatterns = false;
|
|
|
|
/// \brief Enable experimental property behavior feature.
|
|
bool EnableExperimentalPropertyBehaviors = false;
|
|
|
|
/// Should we check the target OSs of serialized modules to see that they're
|
|
/// new enough?
|
|
bool EnableTargetOSChecking = true;
|
|
|
|
/// Whether we're omitting needless words when importing Objective-C APIs.
|
|
///
|
|
/// The vast majority of the logic for omitting needless words is
|
|
/// centralized in the Clang importer. However, there are a few
|
|
/// places elsewhere in the compiler that specifically reference
|
|
/// Objective-C entities whose names are affected by
|
|
/// omit-needless-words.
|
|
bool OmitNeedlessWords = true;
|
|
|
|
/// Whether we are stripping the "NS" prefix from Foundation et al.
|
|
///
|
|
/// This is only queried when \c OmitNeedlessWords is true.
|
|
bool StripNSPrefix = false;
|
|
|
|
/// Enable the Swift 3 migration via Fix-Its.
|
|
bool Swift3Migration = false;
|
|
|
|
/// Sets the target we are building for and updates platform conditions
|
|
/// to match.
|
|
///
|
|
/// \returns A pair - the first element is true if the OS was invalid.
|
|
/// The second element is true if the Arch was invalid.
|
|
std::pair<bool, bool> setTarget(llvm::Triple triple);
|
|
|
|
/// Returns the minimum platform version to which code will be deployed.
|
|
///
|
|
/// This is only implemented on certain OSs. If no target has been
|
|
/// configured, returns v0.0.0.
|
|
clang::VersionTuple getMinPlatformVersion() const {
|
|
unsigned major, minor, revision;
|
|
if (Target.isMacOSX()) {
|
|
Target.getMacOSXVersion(major, minor, revision);
|
|
} else if (Target.isiOS()) {
|
|
Target.getiOSVersion(major, minor, revision);
|
|
} else if (Target.isWatchOS()) {
|
|
Target.getOSVersion(major, minor, revision);
|
|
} else if (Target.isOSLinux() || Target.isOSFreeBSD() ||
|
|
Target.isOSWindows() ||
|
|
Target.getTriple().empty())
|
|
{
|
|
major = minor = revision = 0;
|
|
} else {
|
|
llvm_unreachable("Unsupported target OS");
|
|
}
|
|
return clang::VersionTuple(major, minor, revision);
|
|
}
|
|
|
|
/// Sets an implicit platform condition.
|
|
///
|
|
/// There are currently three supported platform conditions:
|
|
/// - os: The active os target (OSX or iOS)
|
|
/// - arch: The active arch target (x86_64, i386, arm, arm64)
|
|
/// - _runtime: Runtime support (_ObjC or _Native)
|
|
void addPlatformConditionValue(StringRef Name, StringRef Value) {
|
|
assert(!Name.empty() && !Value.empty());
|
|
PlatformConditionValues.emplace_back(Name, Value);
|
|
}
|
|
|
|
/// Removes all values added with addPlatformConditionValue.
|
|
void clearAllPlatformConditionValues() {
|
|
PlatformConditionValues.clear();
|
|
}
|
|
|
|
/// Returns the value for the given platform condition or an empty string.
|
|
StringRef getPlatformConditionValue(StringRef Name) const;
|
|
|
|
/// Explicit conditional compilation flags, initialized via the '-D'
|
|
/// compiler flag.
|
|
void addCustomConditionalCompilationFlag(StringRef Name) {
|
|
assert(!Name.empty());
|
|
CustomConditionalCompilationFlags.push_back(Name);
|
|
}
|
|
|
|
/// Determines if a given conditional compilation flag has been set.
|
|
bool isCustomConditionalCompilationFlagSet(StringRef Name) const;
|
|
|
|
ArrayRef<std::pair<std::string, std::string>>
|
|
getPlatformConditionValues() const {
|
|
return PlatformConditionValues;
|
|
}
|
|
|
|
ArrayRef<std::string> getCustomConditionalCompilationFlags() const {
|
|
return CustomConditionalCompilationFlags;
|
|
}
|
|
|
|
/// Returns true if the 'os' platform condition argument represents
|
|
/// a supported target operating system.
|
|
static bool isPlatformConditionOSSupported(StringRef OSName);
|
|
|
|
/// Returns true if the 'arch' platform condition argument represents
|
|
/// a supported target architecture.
|
|
static bool isPlatformConditionArchSupported(StringRef ArchName);
|
|
|
|
private:
|
|
llvm::SmallVector<std::pair<std::string, std::string>, 3>
|
|
PlatformConditionValues;
|
|
llvm::SmallVector<std::string, 2> CustomConditionalCompilationFlags;
|
|
};
|
|
}
|
|
|
|
#endif // SWIFT_LANGOPTIONS_H
|
|
|