getFields: Find the TU nodes for fields or slots in a class or struct or...

In omegahat/RGCCTranslationUnit: R interface to GCC source code information

Description

This function follows the chain of translation unit nodes to collect the nodes defining fields within a C/C++ container object such as a struct or union or a C++ class. It is called with the TU node identifying the class or struct/union definition, and the function then traverses the linked nodes using nodeIterator. It can distinguish between public and/or protected fields which can be useful in different contexts, e.g. when creating regular accessors or generating derived classes whose methods can "see" protected fields.

Usage

getFields(def, access = c("public", "protected"), existingClasses = list(),
           artificial = FALSE)

Arguments

def	a TU node identifying the container definition, i.e. a GCC::Node::type_decl or GCC::Node::record_type or a node identifying a field or variable declaration within a container. Passing a field or var declaration causes the function to iterate over the fields from that point on. This could be useful if one want to skip over certain fields, e.g. the first field in a C struct when it is being used as a primitive inheritance technique. This value is passed to field.decl to find the first field.
access	a character vector specifying whether we are interested in public and/or protected fields. These are matched against the access attribute within the processed TU field/var nodes. This uses partial matching and so, for example, "pro" or "pri" would suffice. If this is either the empty character vector (i.e. character()) or NA, all fields are returned. This is equivalent to c("public", "protected", "private").
existingClasses	unused
artificial	a logical value indicating whether to include (TRUE) or discard artificial fields that are generated by the compiler and not explicitly part of the structure as programmed.

Value

A list containing the translation unit nodes corresponding to the fields of interest.

Author(s)

Duncan Temple Lang

See Also

parseTU.Perl nodeIterator as.field.decl

Examples

library(RGCCTranslationUnit)
p = parseTU(system.file("examples", "shapes.cc.t00.tu", package = "RGCCTranslationUnit"))
klasses = getClassNodes(p, "shapes")

    # Get all fields in the Shape class
 getFields(klasses[["Shape"]], character())

    # Get the public and protected fields in the Shape class
 getFields(klasses[["Shape"]])

 getFields(klasses[["Circle"]])

    # all fields, i.e. the private radius
 getFields(klasses[["Circle"]], character())

omegahat/RGCCTranslationUnit documentation built on May 24, 2019, 1:53 p.m.