.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Clang::Cursor 3pm" .TH Clang::Cursor 3pm "2018-11-01" "perl v5.28.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Clang::Cursor \- Clang cursor class .SH "VERSION" .IX Header "VERSION" version 0.09 .SH "DESCRIPTION" .IX Header "DESCRIPTION" A \f(CW\*(C`Clang::Cursor\*(C'\fR represents an element in the abstract syntax tree of a translation unit. .SH "METHODS" .IX Header "METHODS" .SS "kind( )" .IX Subsection "kind( )" Retrieve the Clang::CursorKind of the given cursor. .SS "type( )" .IX Subsection "type( )" Retrieve the Clang::Type of the entity referenced by the given cursor. .SS "spelling( )" .IX Subsection "spelling( )" Retrieve the name for the entity referenced by the given cursor. .SS "num_arguments( )" .IX Subsection "num_arguments( )" Retrieve the number of arguments referenced by the given cursor. .SS "displayname( )" .IX Subsection "displayname( )" Return the display name for the entity referenced by the given cursor. .SS "children( )" .IX Subsection "children( )" Retrieve a list of the children of the given cursor. The children are \&\f(CW\*(C`Clang::Cursor\*(C'\fR objects too. .SS "is_pure_virtual( )" .IX Subsection "is_pure_virtual( )" Determine whether the given cursor kind represents a pure virtual method. .SS "is_virtual( )" .IX Subsection "is_virtual( )" Determine whether the given cursor kind represents a virtual method. .SS "location( )" .IX Subsection "location( )" Retrieve the location of the given cursor. This function returns five values: a string containing the source file name, an integer containing the initial line number, an integer containing the initial column number, an integer containing the final line number, and another integer containing the final column number. .SS "access_specifier( )" .IX Subsection "access_specifier( )" Retrieve the access of the given cursor. This can return the following values: \&\f(CW\*(C`invalid\*(C'\fR, \f(CW\*(C`public\*(C'\fR, \f(CW\*(C`protected\*(C'\fR or \f(CW\*(C`private\*(C'\fR. Note that this only works for \*(C+ code, it will return \f(CW\*(C`invalid\*(C'\fR for C functions. .SH "AUTHOR" .IX Header "AUTHOR" Alessandro Ghedini .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2012 Alessandro Ghedini. .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the \s-1GNU\s0 General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.