doc tweaks
[luabind.git] / luabind / detail / find_best_match.hpp
blob98a6ee23dce74549feaa5d1ea1ccee9a66abefd8
1 // Copyright (c) 2003 Daniel Wallin and Arvid Norberg
3 // Permission is hereby granted, free of charge, to any person obtaining a
4 // copy of this software and associated documentation files (the "Software"),
5 // to deal in the Software without restriction, including without limitation
6 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
7 // and/or sell copies of the Software, and to permit persons to whom the
8 // Software is furnished to do so, subject to the following conditions:
10 // The above copyright notice and this permission notice shall be included
11 // in all copies or substantial portions of the Software.
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
14 // ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
15 // TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
16 // PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
17 // SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
18 // ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
21 // OR OTHER DEALINGS IN THE SOFTWARE.
24 #ifndef LUABIND_FIND_BEST_MATCH_HPP_INCLUDED
25 #define LUABIND_FIND_BEST_MATCH_HPP_INCLUDED
27 #include <luabind/config.hpp>
29 #include <boost/limits.hpp>
31 namespace luabind { namespace detail
34 // expects that a match function can be accesed through the iterator
35 // as int match_fun(lua_State*)
36 // returns true if it found a match better than the given. If it finds a better match match_index is
37 // updated to contain the new index to the best match (this index now refers to the list given to
38 // this call).
39 // orep_size is supposed to tell the size of the actual structures that start and end points to
40 // ambiguous is set to true if the match was ambiguous
41 // min_match should be initialized to the currently best match value (the number of implicit casts
42 // to get a perfect match). If there are no previous matches, set min_match to std::numeric_limits<int>::max()
44 LUABIND_API bool find_best_match(lua_State* L, const detail::overload_rep_base* start, int num_overloads, size_t orep_size, bool& ambiguous, int& min_match, int& match_index, int num_params);
45 LUABIND_API void find_exact_match(lua_State* L, const detail::overload_rep_base* start, int num_overloads, size_t orep_size, int cmp_match, int num_params, std::vector<const overload_rep_base*>& dest);
49 #endif // LUABIND_FIND_BEST_MATCH_HPP_INCLUDED