python/object/function_doc_signature.hpp

0001 // Copyright Nikolay Mladenov 2007.
0002 // Distributed under the Boost Software License, Version 1.0. (See
0003 // accompanying file LICENSE_1_0.txt or copy at
0004 // http://www.boost.org/LICENSE_1_0.txt)
0005 #ifndef FUNCTION_SIGNATURE_20070531_HPP
0006 # define FUNCTION_SIGNATURE_20070531_HPP
0007
0008 #include <boost/python/object/function.hpp>
0009 #include <boost/python/converter/registrations.hpp>
0010 #include <boost/python/str.hpp>
0011 #include <boost/python/tuple.hpp>
0012
0013 #include <boost/python/detail/signature.hpp>
0014
0015
0016 #include <vector>
0017
0018 namespace boost { namespace python { namespace objects {
0019
0020 class function_doc_signature_generator{
0021     static const  char * py_type_str(const python::detail::signature_element &s);
0022     static bool arity_cmp( function const *f1, function const *f2 );
0023     static bool are_seq_overloads( function const *f1, function const *f2 , bool check_docs);
0024     static std::vector<function const*> flatten(function const *f);
0025     static std::vector<function const*> split_seq_overloads( const std::vector<function const *> &funcs, bool split_on_doc_change);
0026     static str raw_function_pretty_signature(function const *f, size_t n_overloads,  bool cpp_types = false);
0027     static str parameter_string(py_function const &f, size_t n, object arg_names, bool cpp_types);
0028     static str pretty_signature(function const *f, size_t n_overloads,  bool cpp_types = false);
0029
0030 public:
0031     static list function_doc_signatures( function const * f);
0032 };
0033
0034 }}}//end of namespace boost::python::objects
0035
0036 #endif //FUNCTION_SIGNATURE_20070531_HPP