1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
|
// Copyright (C) 2011-2020 ycmd contributors
//
// This file is part of ycmd.
//
// ycmd is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ycmd is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with ycmd. If not, see <http://www.gnu.org/licenses/>.
#ifndef PYTHONSUPPORT_H_KWGFEX0V
#define PYTHONSUPPORT_H_KWGFEX0V
#include <pybind11/pybind11.h>
namespace YouCompleteMe {
/// Given a list of python objects (that represent completion candidates) in a
/// python list |candidates|, a |candidate_property| on which to filter and sort
/// the candidates and a user query, returns a new sorted python list with the
/// original objects that survived the filtering. This list contains at most
/// |max_candidates|. If |max_candidates| is omitted or 0, all candidates are
/// sorted.
YCM_EXPORT pybind11::list FilterAndSortCandidates(
const pybind11::list& candidates,
pybind11::str candidate_property,
std::string& query,
const size_t max_candidates = 0 );
/// Given a Python object that's supposed to be "string-like", returns a UTF-8
/// encoded std::string. Raises an exception if the object can't be converted to
/// a string.
std::string GetUtf8String( pybind11::handle value );
} // namespace YouCompleteMe
#endif /* end of include guard: PYTHONSUPPORT_H_KWGFEX0V */
|