class Bindgen::Parser::Method

• Bindgen::Parser::Method
• Reference
• Object

Overview

Describes a method as found by the clang tool.

Included Modules

• JSON::Serializable

Defined in:

bindgen/parser/method.cr
bindgen/parser/method/signature.cr

Constant Summary

Log = ::Log.for(self)

RESERVED_NAMES = ["initialize", "finalize"] of ::String

Method names Crystal reserves, which a C++ method of that name gets prefixed with cpp_: QHeaderView::initialize is #cpp_initialize.

Constructors

• .build(name, return_type : Parser::Type, arguments : Array(Parser::Argument), class_name : String, type = Parser::Method::Type::MemberMethod, access = AccessSpecifier::Public, crystal_name = nil) : self

  Utility method to easily build a Method using a more Crystal-style syntax.

• .from_signature(signature : String, class_name : String) : Method

  Parses a C++ member method declaration, as written in a header, into a Method of the class class_name, for the declare_methods: type rule: QMenu *menu() const, static Foo *make(int count = 1), void setMenu(QMenu *menu).

• .new(name : String, class_name : String, return_type : Bindgen::Parser::Type, arguments : Array(Bindgen::Parser::Argument), first_default_argument : Int32 | Nil = nil, access : Bindgen::Parser::AccessSpecifier = AccessSpecifier::Public, type : Bindgen::Parser::Method::Type = Type::MemberMethod, const : Bool = false, virtual : Bool = false, pure : Bool = false, final : Bool = false, extern_c : Bool = false, builtin : Bool = false, origin : Nil | Bindgen::Parser::Method = nil, crystal_name : Nil | String = nil, binding_name : Nil | String = nil, doc : Nil | String = nil, deprecated : Bool = false, free_function : Bool = false)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #access : AccessSpecifier

  Visibility of the method.

• #aggregate_constructor?(*args, **options)
• #aggregate_constructor?(*args, **options, &)
• #any_constructor?(*args, **options)
• #any_constructor?(*args, **options, &)
• #any_default_constructor? : Bool

  Is this a constructor that can take no arguments?

• #arguments : Array(Argument)

  Arguments of the method.

• #arguments=(arguments : Array(Argument))

  Arguments of the method.

• #binding_method_name

  Name of the method in C++ and Crystal bindings.

• #binding_name=(binding_name : String | Nil)

  Forces the bindings to use the specified name.

• #binding_operator_name

  Name of the unary operator method in C++ and Crystal bindings.

• #builtin? : Bool

  Is this a method implicitly generated by C++?

• #class_name : String

  Fully qualified name of the class in which the method is defined.

• #const? : Bool

  Returns if the method is const-qualified: std::string getName() const;

• #constructor?(*args, **options)
• #constructor?(*args, **options, &)
• #conversion_operator?(*args, **options)
• #conversion_operator?(*args, **options, &)
• #copy_constructor?(*args, **options)
• #copy_constructor?(*args, **options, &)
• #crystal_name(override : String | Nil = nil) : String

  Turns the method name into something canonical to Crystal.

• #crystal_name=(crystal_name : String | Nil)

  Forces the Crystal wrapper to use the specified name.

• #deprecated? : Bool

  Is this method declared [[deprecated]]? Removed by the filter_methods processor if ignore_deprecated is configured.

• #destructor?(*args, **options)
• #destructor?(*args, **options, &)
• #doc : String | Nil

  Documentation comment from the C++ source, without comment markers.

• #equals_except_const?(other : Method) : Bool

  Checks if this method is equal to other, except for the const-qualification.

• #equals_virtually?(other : Method) : Bool

  Checks if this method is equal to other, as is suitable to determine if they're the same for C++ virtual methods between parent- and sub-classes.

• #explicit_crystal_name? : Bool

  Checks if the #crystal_name was set explicitly (true), or will be generated (false).

• #extern_c? : Bool

  Does this function use the C ABI?

• #filtered?(db : TypeDatabase) : Bool

  Is this method filtered out?

• #final? : Bool

  Is this a final virtual function, which can't be overridden?

• #first_default_argument : Int32 | Nil

  The index of the first argument with a default value, if any.

• #fix_post_succ_or_pred? : Method | Nil

  Checks if this method is a post-increment or post-decrement method that takes a placeholder int argument.

• #free_function? : Bool

  Is this a free function of member_functions, like qHash, bound as a member method of the class of its first argument, which is self? The C++ glue calls it with *_self_ first.

• #function_pointer(name : String | Nil = nil) : String

  Generates a C++ function pointer type matching this methods prototype.

• #getter?(name = @name)

  Try to deduce if this is a getter.

• #has_move_semantics? : Bool

  Does this method have move semantics anywhere?

• #has_result?

  Returns if this method returns something, or not

• #hash(hasher)

  See Object#hash(hasher)

• #macro?(*args, **options)
• #macro?(*args, **options, &)
• #mangled_name

  Mangled name for the C++ wrapper method name

• #member_getter?(*args, **options)
• #member_getter?(*args, **options, &)
• #member_method?(*args, **options)
• #member_method?(*args, **options, &)
• #member_setter?(*args, **options)
• #member_setter?(*args, **options, &)
• #merge(other : Method) : Method

  Merges this and the other method with regards to default values and type deductions.

• #merge_args!(other : Method)

  Unify arguments of this and another method.

• #name : String

  Name of the method.

• #needs_instance?

  Returns if this method needs a class instance to be called.

• #operator?(*args, **options)
• #operator?(*args, **options, &)
• #origin : Method | Nil

  The method this method is based on.

• #out_arguments(db : TypeDatabase) : Array(Int32)

  The indices of the out arguments: the non-const references and pointers to converted value types (TypeDatabase#converted_out_argument?), like QString & or QString *, and in a method having one, those to built-in types and enums too (TypeDatabase#builtin_out_argument?), like int &.

• #private?(*args, **options)
• #private?(*args, **options, &)
• #protected?(*args, **options)
• #protected?(*args, **options, &)
• #public?(*args, **options)
• #public?(*args, **options, &)
• #pure? : Bool

  Is this a pure virtual function?

• #qualified_name : String

  Fully qualified name of the method: class_name::name.

• #question_getter?(name = @name)

  Try to deduce if this is a getter for a boolean value.

• #return_type : Parser::Type

  The return type of this method

• #return_type=(return_type : Bindgen::Parser::Type)

  Replaces the return type, see the nilable: type rule.

• #same_crystal_signature?(other : Method) : Bool

  Does other have the same Crystal name and argument types, like try_lock next to tryLock? Both would define the same method.

• #setter?(name = @name)

  Try to deduce if this is a setter.

• #signal?(*args, **options)
• #signal?(*args, **options, &)
• #signature : String

  C++ signature of the method, naming its overload: name(type, type), with const appended for a const method.

• #static?(*args, **options)
• #static?(*args, **options, &)
• #static_getter?(*args, **options)
• #static_getter?(*args, **options, &)
• #static_method?(*args, **options)
• #static_method?(*args, **options, &)
• #static_setter?(*args, **options)
• #static_setter?(*args, **options, &)
• #substitute_type(name : String, with type : Type) : Method

  Substitutes all uses of name on the argument and return types of this method with the given type.

• #substitute_type(replacements : Hash(String, Parser::Type)) : Method

  Performs type substitution on the argument and return types of this method using the given replacements.

• #superclass_copy : Method

  Returns a non-virtual copy of this method suitable for use in superclass wrapper structs.

• #supported_operator? : Bool

  Is this operator one bindgen can name, like operator+? Not operator-> or operator,, which filter_methods drops.

• #takes_out_arguments? : Bool

  Can this method have out arguments? A constructor usually keeps the pointer it is given, like QTextStream(QString *), and so does the setter of a pointer member, a signal passes its arguments to the block, and an operator returning a tuple would be odd: these keep dropping the non-const references and pointers to converted types.

• #takes_storage_references? : Bool

  Can this method take a pointer to the structure a wrapper hosts, see TypeDatabase#storage_reference?? Not a virtual method, whose Crystal override would get a copy, nor a signal or a constructor.

• #type : Method::Type

  Type of the method.

• #variadic? : Bool

  Does this function take a variable amount of arguments?

• #variants(&)

  Yields all variants of this method, going through an increasing level of default arguments.

• #variants : Array(Method)

  Non-yielding version of #variants.

• #virtual=(virtual : Bool)

  Makes the method non-virtual for the wrappers, so a Crystal subclass can't override it, and the C++ subclass of Processor::VirtualOverride gets no forwarder for it: the Qt processor does this to the methods Q_OBJECT declares, which Processor::QtMetaObject overrides itself.

• #virtual? : Bool

  Is this a virtual function?

Constructor Detail

Instance Method Detail