CodeCompletionOrganizer.h

//===--- CodeCompletionOrganizer.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_LIB_SWIFTLANG_CODECOMPLETIONORGANIZER_H
#defineLLVM_SOURCEKIT_LIB_SWIFTLANG_CODECOMPLETIONORGANIZER_H

#include"CodeCompletion.h"
#include"SourceKit/Core/LangSupport.h"
//#include "swift/IDE/CodeCompletionContext.h"
#include"swift/IDE/SwiftCompletionInfo.h"
#include"llvm/ADT/StringMap.h"

namespaceswift {
classCompilerInvocation;
}

namespaceSourceKit {

using TypeContextKind = swift::ide::CodeCompletionContext::TypeContextKind;

namespaceCodeCompletion {

structOptions {
bool sortByName = false;
bool useImportDepth = true;
bool groupOverloads = false;
bool groupStems = false;
bool includeExactMatch = true;
bool addInnerResults = false;
bool addInnerOperators = true;
bool addInitsToTopLevel = false;
bool hideUnderscores = true;
bool reallyHideAllUnderscores = false;
bool hideLowPriority = true;
bool hideByNameStyle = true;
bool fuzzyMatching = true;
bool annotatedDescription = false;
bool includeObjectLiterals = true;
bool addCallWithNoDefaultArgs = true;
unsigned minFuzzyLength = 2;
unsigned showTopNonLiteralResults = 3;

// Options for combining priorities.
unsigned semanticContextWeight = 7;
unsigned fuzzyMatchWeight = 13;
unsigned popularityBonus = 2;
};

typedef llvm::StringMap<PopularityFactor> NameToPopularityMap;

std::vector<Completion *>
extendCompletions(ArrayRef<SwiftResult *> swiftResults, CompletionSink &sink,
 swift::ide::SwiftCompletionInfo &info,
const NameToPopularityMap *nameToPopularity,
const Options &options, Completion *prefix = nullptr,
bool clearFlair = false);

booladdCustomCompletions(CompletionSink &sink,
 std::vector<Completion *> &completions,
 ArrayRef<CustomCompletionInfo> customCompletions,
 CompletionKind completionKind);

classCodeCompletionOrganizer {
classImpl;
 Impl &impl;
const Options &options;
public:
CodeCompletionOrganizer(const Options &options, CompletionKind kind,
 TypeContextKind typeContextKind);
~CodeCompletionOrganizer();

staticvoid
preSortCompletions(llvm::MutableArrayRef<Completion *> completions);

/// Add \p completions to the organizer, removing any results that don't match
/// \p filterText and returning \p exactMatch if there is an exact match.
///
/// Precondition: \p completions should be sorted with preSortCompletions().
voidaddCompletionsWithFilter(ArrayRef<Completion *> completions,
 StringRef filterText, const FilterRules &rules,
 Completion *&exactMatch);

voidgroupAndSort(const Options &options);

/// Finishes the results and returns them.
/// For convenience, this returns a shared_ptr, but it is uniquely referenced.
 CodeCompletionViewRef takeResultsView();
};

} // end namespace CodeCompletion
} // end namespace SourceKit

#endif// LLVM_SOURCEKIT_LIB_SWIFTLANG_CODECOMPLETIONORGANIZER_H