tools/SourceKit/include/SourceKit/Core/Context.h

//===--- Context.h - --------------------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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 LLVM_SOURCEKIT_CORE_CONTEXT_H
#define LLVM_SOURCEKIT_CORE_CONTEXT_H

#include "SourceKit/Core/LLVM.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/Support/Mutex.h"
#include <memory>
#include <string>

namespace llvm {
  class MemoryBuffer;
}

namespace SourceKit {
  class LangSupport;
  class NotificationCenter;

class GlobalConfig {
public:
  struct Settings {
    /// When true, the default compiler options and other configuration flags
    /// will be chosen to optimize for usage from an IDE.
    ///
    /// At the time of writing this just means ignoring .swiftsourceinfo files.
    bool OptimizeForIDE = false;

    struct CompletionOptions {

      /// Max count of reusing ASTContext for cached code completion.
      unsigned MaxASTContextReuseCount = 100;

      /// Interval second for checking dependencies in cached code completion.
      unsigned CheckDependencyInterval = 5;
    } CompletionOpts;
  };

private:
  Settings State;
  mutable llvm::sys::Mutex Mtx;

public:
  Settings update(Optional<bool> OptimizeForIDE,
                  Optional<unsigned> CompletionMaxASTContextReuseCount,
                  Optional<unsigned> CompletionCheckDependencyInterval);
  bool shouldOptimizeForIDE() const;
  Settings::CompletionOptions getCompletionOpts() const;
};

class Context {
  std::string RuntimeLibPath;
  std::string DiagnosticDocumentationPath;
  std::unique_ptr<LangSupport> SwiftLang;
  std::shared_ptr<NotificationCenter> NotificationCtr;
  std::shared_ptr<GlobalConfig> Config;

public:
  Context(StringRef RuntimeLibPath, StringRef DiagnosticDocumentationPath,
          llvm::function_ref<std::unique_ptr<LangSupport>(Context &)>
              LangSupportFactoryFn,
          bool shouldDispatchNotificationsOnMain = true);
  ~Context();

  StringRef getRuntimeLibPath() const { return RuntimeLibPath; }
  StringRef getDiagnosticDocumentationPath() const {
    return DiagnosticDocumentationPath;
  }

  LangSupport &getSwiftLangSupport() { return *SwiftLang; }

  std::shared_ptr<NotificationCenter> getNotificationCenter() { return NotificationCtr; }

  std::shared_ptr<GlobalConfig> getGlobalConfiguration() { return Config; }
};

} // namespace SourceKit

#endif