generateCodeFiles {RGtkBindingGenerator}R Documentation

~~function to do ... ~~

Description

This is the top-level entry point for the read-generate process which creates S- and C-language bindings for Gtk-based libraries from symbolic IDL-like descriptions of classes, routines, enumerations, etc. This reads the description (or .defs) files and generates S and C code to interfae to the code described within them.

Usage

generateCodeFiles(..., classNames = NULL, dir = c(C="/tmp", S="tmp"),
                   verbose = FALSE, constructorFile = "constructors.R",
                   package = "RGtk", allDefs = NULL)

Arguments

... a collection of .defs files (with or without their .defs extension) from which we read the description of the classes, routines, enumerations, etc.
classNames
dir usually, a named-character vector giving the names of the directories in which to create the C and S code. The names of the elements must be "C" and "S", respectively. If one requires finer control over the names of and where the files are located (e.g. to place the different C files in different directories), you can supply a function that is given the base name of the file to create and returns the fully qualified file name.
verbose a logical value controlling whether information is written to the console about how the processing and generating of the code is being done. TRUE means provide information to the ``user'', i.e. the caller of this function.
constructorFile the name of the file in which to place the constructor functions.
package the name of the package in which this generated code will be located. This is used in the code that makes calls to .C and .Call (actually .GtkCall) functions in the generated code.
allDefs any previously existing definitions (e.g. the base Gtk defs) which are used to locate classes, enumerations, etc. referenced in these Gtk library definitions. This is mainly used when we are processing defs files outside of the core Gtk library but need some of the definitions from the latter.

Details

This uses Python code to read the .defs files and uses the http://www.omegahat.org/RSPython package to do this from R and return the results (as recursive named lists of character strings) to R where we then generate the code.

Value

A list giving the definitions read from the different .defs files and

allDefs the class, function, enumeration, flag and box definitions from the .defs files
klasses a list with an element for each of the .defs files. Each element is character vector giving the names of the classes within

Author(s)

Duncan Temple Lang <duncan@research.bell-labs.com>

References

http://www.omegahat.org/RGtk http://www.omegahat.org/GtkAutoBindingGen http://www.gtk.org

See Also

genCode getDefs genLoadClassesCode

Examples



[Package RGtkBindingGenerator version 0.3 Index]