All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.ifarchive.glk.Function 

java.lang.Object
   |
   +----org.ifarchive.glk.Function
public class Function
extends Object
A Glk dispatch function description. Note that the function pointer doesn't percolate up to the Java layer; only C sees it.

Variable Index

o id
The function's dispatch ID.
o name
The name of this function.

Method Index

o count()
Return count of Glk functions.
o get(int)
Get a Glk function by its index
o getByID(int)
Get a Glk function by its ID.
o parsedPrototype()
Parse the prototype string for a function and display it.
o parsedPrototype(int)
Parse the prototype string for a function and display it.
o prototype()
Get prototype string for a function.
o prototype(int)
Get prototype string for a function.

Variables

o name 
 public String name
The name of this function.

o id 
 public int id
The function's dispatch ID.

Methods

o prototype 
 public String prototype()
Get prototype string for a function. See the Glk specification for full details.

Returns:
The prototype string; null if the function can't be invoked through Glk.dispatchCall()
See Also:
dispatchCall
o count 
 public static int count()
Return count of Glk functions.

Returns:
number of functions in this Glk library.
o get 
 public static Function get(int index)
Get a Glk function by its index

Parameters:
index - The number of the function, 0 - count()
Returns:
The corresponding Function, or null if there isn't one.
See Also:
count
o getByID 
 public static Function getByID(int id)
Get a Glk function by its ID.

Parameters:
id - The ID number for the function.
Returns:
The corresponding Function, or null if there isn't one.
o prototype 
 public static String prototype(int func)
Get prototype string for a function. See the Glk specification for full details.

Returns:
The prototype string; null if the function can't be invoked through Glk.dispatchCall()
See Also:
dispatchCall
o parsedPrototype 
 public String parsedPrototype()
Parse the prototype string for a function and display it. See the Glk specification for full details.

Returns:
A human-readable dump of the parsed data.
See Also:
dispatchCall
o parsedPrototype 
 public static String parsedPrototype(int func)
Parse the prototype string for a function and display it. See the Glk specification for full details.

Parameters:
func - The Glk ID of the function.
Returns:
A human-readable dump of the parsed data.
See Also:
dispatchCall 
All Packages  Class Hierarchy  This Package  Previous  Next  Index