Method and system for interfacing to a type library

[0002] 1. Technical Field

[0003] This invention relates generally to a computer method and system for storing type information, and in particular, a method and system for storing type information in a language-independent manner.

[0004] 2. Background of the Invention

[0005] The use of object-oriented programming techniques can facilitate the development of complex computer programs. Programming languages that support object-oriented techniques have been developed. One such programming language is C++. The C++ programming language is described in “The C++ Language Reference,” published by Microsoft Corporation, which is hereby incorporated by reference.

[0006] Two common characteristics of object-oriented programming languages are support for data encapsulation and data type inheritance. Data encapsulation refers to the coupling of data to the functions that operate on the data. Inheritance refers to the ability to define a data type as an extension of other data types. An instance of a data type that couples data and functions is referred to as an “object.”

[0007] An object is a run time structure for a user-defined type (a class type) that may contain data members and function members. Each class has a class definition that specifies its data members and function members. Each object is declared to be a certain class type. In a preferred embodiment, the run time data structures of an object conforms to the model defined in U.S. patent application Ser. No. 07/682,537, now U.S. Pat. No. 5,297,284, entitled “A Method for Implementing Virtual Functions and Virtual Bases in a Compiler for an Object-Oriented Programming Language,” which is hereby incorporated by reference.

[0008] It is often useful for two computer programs to access the same instance of an object. For example, a first computer program instantiates an object in shared memory and notifies a second computer program of the location of the object. The second computer program then accesses the object in shared memory. However, to access the object, the second computer program needs to be written and compiled with the class definition of the object. Without the class definition, the second computer program would not know how to access the data members and function members of the object. Thus, a computer program is written and compiled with the class definition for each object it wishes to share with another computer program.

[0009] When the developer of a computer program wishes to allow other computer programs to access its objects, the developer publishes the class definitions of the objects. The developers of other computer programs could then incorporate the published class definitions into their computer programs. One skilled in the art would appreciate that this publication may use a “header” file containing the class definitions. The developers of other computer programs could then write their computer programs to access objects defined in the header file and “include” the header file in the source code for the computer programs. The source code is then compiled and is ready to access the object.

[0010] Because prior methods require that a class definition be available when developing a computer program, there has been limited sharing of objects between computer programs developed by independent developers. This limited sharing occurs because, for example, it is difficult to distribute class definitions to independent developers, who may be located throughout the world, in a timely manner. Similarly, it is difficult to distribute updates to the class definition and difficult for the developers to integrate these updates and distribute updated versions of the computer programs to users. These difficulties are compounded when a computer program incorporates class definitions provided by several developers. Also, because there is no standard programming language, it can be difficult to adapt a class definition in one programming language to another.

[0011] It is an object of the present invention to provide a system for storing and accessing information defining user-defined types.

[0012] It is another object of the present invention to provide a system for storing and accessing information for binding to objects.

[0013] It is another object of the present invention to provide a system for storing and accessing information for loading class definitions.

[0014] It is another object of the present invention to provide a type library interface and implementation for storing and accessing, defining, binding, and loading information relating to objects such that objects instantiated by one computer program can be accessed at run time by a second computer program without need for the second computer program to be compiled with the class definitions at compile time.

[0015] It is another object of the present invention to provide language-independent, implementation-indepdendent precompiled type definitions.

[0016] These and other objects, which will become apparent as the invention is more fully described below, are obtained by an improved method and system for interfacing to type libraries that store type information. In a preferred embodiment, the present invention defines an interface to a type library. The interface has a plurality of interface methods through which type information can be stored in and retrieved from the type library. A plurality of implementations of the defined interface are provided. A computer program is compiled using the defined interfaces to access the type information. When the compiled computer program is executed, it accesses the type information using one of the plurality of implementations. In a preferred embodiment, a type library contains type information to allow a compiler to bind to an instance of type at compile time (early binding).

[0017] FIG. 1 is a screen layout showing a sample computer program and application that use a type library.

[0018] FIG. 2 is a block diagram showing the generation of a type library.

[0019] FIG. 3 is a block diagram showing sample components used when a word processor invokes a macro interpreter.

[0020] FIGS. 4 through 7 are block diagrams illustrating a preferred type library interface hierarchy.

[0021] FIG. 5 is a block diagram showing the hierarchy of an ITypeMembers object.

[0022] FIG. 6 is a block diagram showing the hierarchy of an IFuncDesc object.

[0023] FIG. 7 is a block diagram showing the hierarchy of an ITypeDesc object.

[0024] FIG. 8 is a diagram showing steps a macro interpreter executes when interpreting the macro of Code Table 1.

[0025] FIG. 9 is a flow diagram of the routine ExecuteGlobalFunction.

[0026] FIG. 10 is a flow diagram of the routine GetAddressOfGlobalFunction.

[0027] FIG. 11 is a flow diagram of the routine ExecuteFunctionMember.

[0028] FIG. 12 is a flow diagram of the routine GetOffsetOfFunctionMember.

[0029] FIG. 13 is a block diagram showing the general structure of an interface object.

[0030] The present invention provides a method and system for a computer program to make its objects (data members and function members) accessible to other computer programs that are developed independently of the computer program. In a preferred embodiment, information defining the type of the objects that are accessible is stored in a “type library.” A type library “exposes” to the applications the accessible objects of the computer program. A type library also contains binding information about the exposed objects. The binding information includes information needed by applications, such as compilers or interpreters, to bind to data and function members of the exposed objects. Binding information includes the offsets of data members within instance data and offsets of pointers to function members within virtual function tables. A type library preferably also contains loading information. The loading information includes information needed by applications, such as loaders, to determine the address of global functions and variables. A type library also preferably contains documentation describing the types defined in the library, which alternatively may include references to a help file containing more detailed information. An application accesses the objects of the computer program based on information in a type library.

[0031] The present invention provides interfaces (defined below) to a type library through which a developer of a computer program stores type definitions and through which an application retrieves the type definitions. Type definitions, binding information, and loading information for objects to be exposed are stored by instantiating type library interface objects and invoking the function members. An application accesses the exposed objects by instantiating type library interface objects and invoking the function members. The term “application” refers to code that is exposed to the computer program objects. The code can either execute in the same process or in a separate process from the computer program.

[0032] An interface is an abstract class which contains only pure virtual function members, that is, the class has no data members and no non-virtual function members. The function members of an interface are typically semantically related. Table 12 illustrates an interface for the class ISample.

[0033] An interface provides an implementation-independent mechanism defining access to an instance of an implementation of the interface, referred to as an interface object. An interface object is a data structure that provides access to the function members of the interface. FIG. 13 is a block diagram showing the general structure of an interface object. An interface object comprises instance data 1301, virtual function table 1302, and functions 1303, 1304. The instance data 1301 contains a pointer to the virtual function table and private data that is not accessible only to the function members of the interface object. The virtual function table 1302 contains the address of each virtual function defined by the interface. The functions 1303, 1304 contain the code that implements the interface.

[0034] The following example illustrates the generation of a type library and the use of the type library by an application. FIG. 1 is a screen layout showing a sample computer program and application that use a type library. The computer program is a word processor that interacts with a user through window 101. The word processor has opened a document named “example.doc” that contains several paragraphs 102. The word processor has menu 103 for invoking a macro interpreter (an application). In this example, the macro interpreter is designed to run as part of the same process of the invoking computer program. The macro interpreter inputs statements in a C++-like language from a user and interprets the statements. When the user selects the macro menu 103, macro window 104 is created. The user inputs the macro statements 105 and then selects the run menu of the macro window 104 to interpret the macro statements. In this example, the macro statements 105 cause each paragraph in the opened document to be right justified.

[0035] Continuing with the example, the developer of the word processor publishes a type library containing the type definitions, binding information, loading information, and documentation with the executable code of the word processor. The developer of the macro interpreter publishes a description of its C++-like language. The word processor and the macro interpreter are developed with no special knowledge of the other. That is, the word processor is developed knowing only that it needs to load a macro interpreter stored in a file of a predefined name and invoke that macro interpreter when the user selects its macro menu. Similarly, the macro interpreter is developed knowing only that it needs to look to the type library that it is passed when invoked to access the exposed objects of the invoking computer program. The same macro interpreter can be invoked by other kinds of computer programs, such as a spreadsheet or database program. A user uses the documentation of the type definitions of the exposed word processor objects and the published definition of the language of the macro interpreter to develop macros for the word processor. The macro interpreter inputs these macros and interacts with the word processor based on the information in the word processor type library to interpret the macros.

[0036] FIG. 2 is a block diagram showing the generation of a type library. To generate a type library, a “make type library” program 202 inputs a definition 201 of the type of objects that the word processor exposes along with loading information contained in a dynamic link library 205 and uses the type library interface 203 to generate the type library 204. The dynamic link library 205 contains the compiled global functions and the function members that are defined in the definition 201. The make type library program 202 adds the object type definitions to the type library and adds loading information derived from the dynamic link library 205. The program then “compiles” the definitions to generate binding information.

[0037] FIG. 3 is a block diagram showing the components used when the word processor invokes the macro interpreter. When a user selects the macro menu of the word processor 301, the word processor loads the macro interpreter code 302 in the address space of the word processor 301. In an alternate embodiment, the macro interpreter 302 could be loaded as a separate process and could use standard interprocess communication mechanisms to communicate with the word processor 301. Once the macro interpreter is invoked, the user then inputs macro statements 303. The macro interpreter 302 instantiates type library interface objects 304 to access the information in the word processor type library 305. In this example, the word processor 301 exposes objects of type “document” class and “paragraph” class. In this example, the document object 310 contains instance data 311 and a virtual function table 312. The virtual function table 312 contains pointers to the code that implements the virtual function members of the document class (e.g. GetPara() 313). The function member GetPara returns to the caller a pointer to the paragraph of the designated index within the open document. The instance data 311 contains a pointer to virtual function table 312 and a pointer to a list of paragraphs 314 in the document. The paragraphs are sequentially ordered by index starting at 0. The list of paragraphs 314 contains pointers to the paragraph objects 320, 330, which contain the text and properties (e.g., justification) of the paragraphs. The word processor instantiates a paragraph object for each paragraph in the document. Each paragraph object contains instance data 321 and virtual function table 322. The virtual function table 322 contains pointers to the code that implements the virtual function members of the paragraph class (e.g. Setjustify() 323). The function member SetJustify sets the paragraph to the designated justification. The word processor also exposes global function GetDoc 340. As its name suggests, the function GetDoc returns to the caller a pointer to the document object for the currently open document.

[0038] Code Table 1 lists macro statements that set the justification of each paragraph in the open document. The numbers to the left of the statements are for reference. In line 1, the macro declares the variable pdoc to point to a document object. In line 2, the macro declares the variable ppara to point to a paragraph object. In line 3, the macro sets the variable pdoc to point to the document object for the open document. The function GetDoc returns the pointer to the document object. In line 4, the macro sets the variable i to 0. The variable i is used to index through the paragraphs. In lines 5 and 6, the macro loops through each paragraph setting its justification to right justified. The function member GetPara of the document class returns as its value a pointer to the paragraph indexed by its parameter. If the parameter is greater than the number of paragraphs in the open document, then the function return value is set to NULL. The function member SetJustify of the paragraph class sets the paragraph to right justified. The steps that the macro interpreter performs to interpret the macro of Code Table 1 are described in detail below.

[0039] Type libraries can also be used to allow an application to create instances of objects defined in the type libraries. For example, a type library can provide a function CreateInstance that creates an instance of a designated type and returns a pointer to the instantiated object. The application can then access the object. The macro interpreter of the above example could instantiate an object a type paragraph, store data in the object using its methods, and use a method of the document object to add the paragraph object to the document.

[0040] Type Library Interfaces

[0041] The type library interfaces provide a mechanism for defining and accessing object type information, binding information, and loading information. In a preferred embodiment, the type library interfaces include the following interfaces:

[0042] ITypeLib

[0043] ITypeInfo

[0044] ITypeBind

[0045] ITypeFixups

[0046] ITypeMembers

[0047] IVarInfo

[0048] ITypeDesc

[0049] IFuncInfo

[0050] IFuncDesc

[0051] IParamInfo

[0052] An implementation of each type library interface has a corresponding interface object. The type library interfaces are defined in a hierarchy.

[0053] FIGS. 4 through 7 are block diagrams illustrating the type library interfaces hierarchy. One skilled in the art would appreciate that the illustrated hierarchy represents a data structure layout of the interface objects in one implementation. Other data structure layouts could also be used. (Referring to FIG. 4, template interface object 401 represents the interface object layout used in FIGS. 4 through 7. Each interface object contains a virtual function table pointer 412, which points to the virtual function table containing pointers to the function members of the interface, and contains private data members 413.) At the root of the type library interfaces hierarchy is the ITypeLib interface object 402. Each type library has one ITypeLib interface object. (In the following, the term “ITypeLib interface object” is shortened to “ITypeLib object”). The ITypeLib object 402 contains a pointer to a list of pointers 403 to the object type definitions contained in the type library. The object type definitions are sequentially ordered starting from 0. Each pointer in the list points to an ITypeInfo object 404, 405. Each ITypeInfo object contains the definition and binding and loading information of one object type. Each ITypeInfo object contains a pointer to an ITypeMembers object 406, an ITypeBind object 407, and an ITypeFixups object 408.

[0054] FIG. 5 is a block diagram showing the hierarchy below an ITypeMembers object. Each ITypeMembers object contains the definitions of the data members, function members, and base members of the container object type. The container object type for an interface object refers to the object type defined in the ITypeInfo object from which the interface object descends. An ITypeMembers object 501 contains pointers to three lists of pointers 510, 520, and 530. The list of pointers 510 contains pointers to the function member definitions of the container object type. The list of pointers 520 contains pointers to the data member definitions of the container object type. The list of pointers 530 contains pointers to the base class definitions of the container object type. In one embodiment, the present invention supports multiple inheritance. The function member definitions, data member definitions, and base member definitions are each sequentially ordered starting from 0. Each pointer to a function member definition points to an IFuncInfo object 511, 512. Each IFuncInfo object contains the definition of one function member of the container object type. Each IFuncInfo object contains a pointer to an IFuncDesc object 513, which defines the formal parameters of the function member. Each pointer to a data member definition points to an IVarInfo object 521, 522. Each IVarInfo object contains a definition of a data member or a base member. Each IVarInfo object 521, 522 contains a pointer to an ITypeDesc object 523, which defines the type of a data member. Each pointer to a base member definition points to an ITypeInfo object 531, 532, which define the type of the base members.

[0055] FIG. 6 is a block diagram showing the hierarchy below an IFuncDesc object. An IFuncDesc object 601 contains a pointer to an ITypeDesc object 602, which defines the return type of the function member; a pointer to a list of pointers 603 to the formal parameters of a function member; and a pointer to an ITypeDesc object 607, which defines the type of THIS pointer for the function member. Each IParamInfo object 604, 605 points to an ITypeDesc object 606, which defines the type of the formal parameter.

[0056] FIG. 7 is a block diagram showing the hierarchy below an ITypeDesc object. The ITypeDesc objects define the types of various components of an object type (e.g., data members, formal parameters, base members). An ITypeDesc object 701 optionally contains pointers to an ITypeDesc object 702, which defines the type of the basis (described below) of the component; to an IFuncDesc object 703, which defines the type of the function to which the component points; and to an ITypeInfo object 704, which defines a user-defined type.

[0057] Tables 1 through 11 define the type library interfaces. Each of the methods interfaces are described in detail in the following. The data members of an interface object may be stored and retrieved using methods. The methods that retrieve data are prefixed by “Get,” and the methods that store data are prefixed by “Set.” For example, the name of a type library is stored by the method ITypeLib::SetName, and is retrieved by the method ITypeLib::GetName. The parameters of the methods are named and typed in a manner to suggest the information passed as a parameter.

[0058] ITypeLib Interface

[0059] The ITypeLib interface defines the methods of an ITypeLib object. An application uses a function OpenTypeLibrary to open a type library of a designated name, to instantiate an ITypeLib object corresponding to the open type library, and to return a pointer to the instantiated ITypeLib object. The methods of an ITypeLib object provide the functionality to add and remove ITypeInfo objects, to store and retrieve descriptive information of the type library (e.g., help file, name of type library), to retrieve the ITypeInfo objects within the type library, and to retrieve binding and loading information for functions and data defined in the type library. Table 1 lists the ITypeLib interface.

[0060] In a preferred embodiment, a type library can store information defining a C++-like class, C++-like enumerators, and global functions and data.

[0061] ITypeLib::GetTypeInfoCount

[0062] The method GetTypeInfoCount retrieves the number of ITypeInfo objects contained in this ITypeLib object. (In the following, the term “this” before an interface object refers to the instance for which the method is invoked.) The method returns the number as its value. The number corresponds to the number of pointers in the list of object type definitions 403.

[0063] ITypeLib::GetTypeInfo

[0064] The method GetTypeInfo retrieves the ITypeInfo object of the designated index for this ITypeLib object. (In the following, the term “designated” refers to a parameter of the method.) The method returns a pointer to the retrieved ITypeInfo object as a parameter.

[0065] ITypeLib::GetDocumentation

[0066] The method GetDocumentation retrieves a string containing a brief description of this ITypeLib object. The string contains a description of this ITypeLib object and would typically be used by a “browser.” A browser refers to an application that displays object type definitions within a type library to a user. For example, the macro interpreter of the above example could have a browsing mode in which it displayed the object type definitions of the word processor using the word processor or type library. The method returns a pointer to the retrieved string as a parameter.

[0067] ITypeLib::GetHelpFileName

[0068] The method GetHelpFileName retrieves a string containing the file name of a help file for this ITypeLib object. The help file contains information useful to provide assistance to users. The method returns a pointer to the retrieved string as a parameter.

[0069] ITypeLib::GetHelpContext

[0070] The method GetHelpContext retrieves the context for the help file for this ITypeLib object. The help context indicates a location within the help file of pertinent information. The method returns the retrieved help context as a parameter.

[0071] ITypeLib::GetTypeBind

[0072] The method GetTypeBind retrieves an ITypeBind object for this ITypeLib object. The method returns a pointer to the retrieved ITypeBind object as a parameter. The retrieved ITypeBind object allows an application to retrieve binding information for all global functions and global data within this ITypeLib object. Although the functionality of the retrieved ITypeBind object can be provided by instantiating all ITypeInfo objects within this ITypeLib object that have a type kind of MODULE (see below), this method allows a more efficient mechanism to be implemented.

[0073] ITypeLib::GetlndexOfName

[0074] The method GetlndexOfName retrieves the index of the ITypeInfo object of the designated name for this ITypeLib object. The method returns the retrieved index as a parameter.

[0075] ITypeLib::GetName

[0076] The method GetName retrieves the name of this ITypeLib object. The method returns the name as a parameter. The name is intended to be used by compilers that support accessing types defined with a type library. For example, the statement “WP:Document *pdoc” may indicate to the compiler that the type—“WP:Document”—is defined in a type library named “WP” as a type name “Document.”

[0077] ITypeLib::GetLanguageCode

[0078] The method GetLanguageCode retrieves a language identifier for this ITypeLib object. The language identifier indicates the natural language (e.g., English, French) of the names and text in this ITypeLib object. The method returns the language identifier as its value.

[0079] ITypeLib::GetTypeName

[0080] The method GetTypeName retrieves the name of the ITypeInfo object of the designated index of this ITypeLib object. This method provides a mechanism for retrieving the object type names without loading the ITypeInfo object. The method returns the retrieved name as a parameter.

[0081] ITypeLib::GetTypeDocumentation

[0082] The method GetTypeDocumentation retrieves a string containing a description of the ITypeInfo object of the designated index of this ITypeLib object. This method provides a mechanism for retrieving object type documentation without loading the ITypeInfo object. The method returns the retrieved string as a parameter.

[0083] ITypeLib::SetDocumentation

[0084] The method SetDocumentation stores the designated string as the documentation for this ITypeLib object.

[0085] ITypeLib::SetHelpFileName

[0086] The method SetHelpFileName stores the designated string as the help file name for this ITypeLib object.

[0087] ITypeLib::SetHelpContext

[0088] The method SetHelpContext stores the designated help context as the help context for this ITypeLib object.

[0089] ITypeLib::SetName

[0090] The method SetName stores the designated string as the name of this ITypeLib object.

[0091] ITypeLib::SetLanguageCode

[0092] The method SetLanguageCode stores the designated code as the language code of this ITypeLib object.

[0093] ITypeLib::AddTypeInfo

[0094] The method AddTypeInfo adds the designated ITypeInfo object with the designated name to this ITypeLib object. An ITypeInfo object is created with the routine CreateTypeInfo (described below).

[0095] ITypeLib::RemTypeInfo

[0096] The method RemTypeInfo removes the ITypeInfo object of the designated index from this ITypeLib object.

[0097] In an alternate embodiment, each global function defined in a type library is assigned a unique function identifier. The ITypeLib interface provides methods through which information about a global function can be retrieved using the function identifier. Information can be retrieved more efficiently by using the function identifier rather than by using a string containing the function name.

[0098] ITypeInfo Interface

[0099] The ITypeInfo interface defines the methods of an ITypeInfo object. An ITypeInfo object points to an ITypeMembers object, an ITypeBind object, and an ITypeFixups object. Each of these pointed to objects provide a mechanism for different applications to access information needed by the application in an efficient way. For example, a browser may use an ITypeMembers object to display the definition of the container object type to a user. (A browser is an application that displays information in a type library to a user). A compiler or interpreter may use an ITypeBind object to retrieve the offsets of data members and function members. A loader may use an ITypeFixups object to determine the address of static data members and static function members of the container object type. Table 2 lists the ITypeInfo interface.

[0100] Each ITypeInfo object has a designated “type kind.” In a preferred embodiment, the type kinds include ENUM, RECORD, MODULE, CLASS, ALIAS, and UNION. An ENUM type kind is a C++-like enumerator. A RECORD type kind is a C++-like class with no function members and no base members. A MODULE type kind is an aggregation of non-class functions and data. A CLASS type kind is a C++-like class. An ALIAS type kind is a C++-like type definition. A UNION type kind is a C++-like union.

[0101] ITypeInfo::GetName

[0102] The method GetName retrieves the name of the object type defined by this ITypeInfo object. The method returns the name as a parameter.

[0103] ITypeInfo::GetTypeMembers

[0104] The method GetTypeMembers retrieves the ITypeMembers object of the object type defined by this ITypeInfo object. When this method is called initially after this ITypeInfo object is instantiated, the retrieved ITypeMembers object is initialized so that its member lists are empty. The method returns a pointer to the retrieved ITypeMembers object as a parameter.

[0105] ITypeInfo::GetTypeBind

[0106] The method GetTypeBind retrieves the ITypeBind object instance of the object type defined by this ITypeInfo object. When this method is called initially after this ITypeInfo object is instantiated, the retrieved ITypeBind object is uninitialized. The method returns a pointer to the retrieved ITypeBind object as a parameter.

[0107] ITypeInfo::GetTypeFixups

[0108] The method GetTypeFixups retrieves the ITypeFixups object of the object type defined by this ITypeInfo object. When this method is called initially after this ITypeInfo object is instantiated, the retrieved ITypeFixups object is uninitialized. The method returns a pointer to the retrieved ITypeFixups object as a parameter.

[0109] ITypeInfo::GetTypeKind

[0110] The method GetTypeKind retrieves the type kind of the object type defined by this ITypeInfo object. The method returns the retrieved type kind as its value.

[0111] ITypeInfo::GetLanguageCode

[0112] The method GetLanguageCode retrieves a language identifier of the object defined by this ITypeInfo object. The language identifier indicates the natural language (e.g., English, French) of the text in this ITypeInfo object. The method returns the language identifier as its value.

[0113] ITypeInfo::CreateInstance

[0114] The method CreateInstance creates an instance of an object defined by this ITypeInfo object. This method returns an error if the type kind of the object defined by this ITypeInfo object is not CLASS. The method returns a pointer to the instantiated object.

[0115] ITypeInfo::GetDocumentation

[0116] The method GetDocumentation retrieves a string containing brief documentation describing the object type defined by this ITypeInfo object. The method returns the retrieved string as a parameter.

[0117] ITypeInfo::GetHelpFileName

[0118] The method GetHelpFileName retrieves a string containing the file name of a help file for the object type defined by this ITypeInfo object. The method returns the retrieved string as a parameter.

[0119] ITypeInfo::GetHelpContext

[0120] The method GetHelpContext retrieves the help context for the help file for the object type defined by this ITypeInfo object. The method returns the help context as a parameter.

[0121] ITypeInfo::GetAlignmentKind

[0122] The method GetAlignmentKind retrieves the alignment that should be used when instantiating an object of the object type defined by this ITypeInfo object. The method returns the alignment as its value.

[0123] ITypeInfo::IsModifiable

[0124] The method IsModifiable retrieves a flag that indicates whether the object type defined by this ITypeInfo object can be modified. An object type definition is made not modifiable, for example, to prevent users of a type library from modifying the definitions. The method returns the flag as its value.

[0125] ITypeInfo::SetName

[0126] The method SetName stores the designated name as the name of the object type defined by this ITypeInfo object.

[0127] ITypeInfo::SetTypeKind

[0128] The method SetTypeKind stores the designated type kind as the type kind of the object type defined by this ITypeInfo object.

[0129] ITypeInfo::SetDocumentation

[0130] The method SetDocumentation stores the designated string as the documentation of the object type defined by this ITypeInfo object.

[0131] ITypeInfo::SetHelpContext

[0132] The method SetHelpContext stores the designated help context as a help context of the object type defined by this ITypeInfo object.

[0133] ITypeInfo::SetAlignmentKind

[0134] The method SetAlignmentKind stores the designated alignment as the alignment for an object of the object type defined by this ITypeInfo object.

[0135] ITypeMembers Interface

[0136] The ITypeMembers interface defines the methods of an ITypeMembers object. As described above, an ITypeMembers object defines the base members, data members, and function members of the container object type. A complete hierarchy of an object type can be generated by recursively processing the type of the base members. Table 3 lists the ITypeMembers interface. The ITypeMembers interface defines a member handle that is used to identify a member within its container object type. The member handle provides a more efficient way of identifying a member than by using a string containing the member name.

[0137] ITypeMembers::GetTypeInfoContainer

[0138] The method GetTypeInfoContainer retrieves the ITypeInfo object which contains this ITypeMembers object. The method returns a pointer to the retrieved ITypeInfo object as a parameter. When an ITypeMembers object is created, its instance data contains an indication of the container ITypeInfo object. The method can be used to retrieve attributes of the type (e.g., its ITypeBind interface).

[0139] ITypeMembers::GetFuncCount

[0140] The method GetFuncCount retrieves the number of function members that are defined for the container object type defined by this ITypeMembers object. The method returns the retrieved number as its value.

[0141] ITypeMembers::GetFunc

[0142] The method GetFunc retrieves an IFuncInfo object defining the function member with the designated index of the container object type defined by this ITypeMembers object. This method returns a pointer to the retrieved IFuncInfo object as a parameter.

[0143] ITypeMembers::GetVarCount

[0144] The method GetVarCount retrieves the number of data members that are defined for the container object type defined by this ITypeMembers object. The method returns the number as its value.

[0145] ITypeMembers::GetVar

[0146] The method GetVar retrieves an IVarInfo object defining the data member with the designated index of the container object type defined by this ITypeMembers object. This method returns a pointer to the retrieved IVarInfo object as a parameter.

[0147] ITypeMembers::GetBase

[0148] The method GetBase retrieves a pointer to an ITypeInfo object defining the base member, if any. This method returns a pointer to the ITypeInfo object as a parameter.

[0149] ITypeMembers::GetVarTypeEnumImpl

[0150] The method GetVarTypeEnumImpl retrieves the integral type of enumerators defined by this ITypeMembers object. If the container object type defined by this ITypeMembers object is not an ENUM type kind, then the method returns an error, else the method returns the integral type as its value.

[0151] ITypeMembers::IsLaidOut

[0152] The method IsLaidOut retrieves a flag indicating whether the container object type defined by this ITypeMembers object has been successfully compiled. The compilation process generates the binding information such that applications can use the binding information to access objects of the container object type. The method returns the retrieved flag as its value.

[0153] ITypeMembers::GetTypeDescPvft

[0154] The method GetTypeDescPvft retrieves an ITypeDesc object that defines the type (e.g., constant, near, far, etc) of the virtual function table pointer of the container object type defined by the container object type defined by this ITypeMembers object. If the container object type has no primary virtual function table pointer, then the method sets the pointer to NULL. The method returns the retrieved pointer as a parameter.

[0155] ITypeMembers::GetTypeDescAlias

[0156] The method GetTypeDescAlias retrieves the ITypeDesc object that defines the type for which the container object type defined by this ITypeMembers object is an alias. If the container object type is not an ALIAS type kind, then the method sets the pointer to NULL. The method returns a pointer to the retrieved ITypeDesc object as a parameter.

[0157] ITypeMembers::GetMemberInfoOfHmember

[0158] The method GetMemberInfoOfHmember retrieves an IMemberInfo object defining the member with the designated member handle for the container object type defined by this ITypeMembers object. The method returns a pointer to the retrieved IMemberInfo object as a parameter.

[0159] ITypeMembers::AddFunc

[0160] The method AddFunc adds a copy of the designated IFuncInfo object defining a function member before the designated index in the list of function members of the container object defined by this ITypeMembers object. A new function may be appended by designating an index equal to the number of function members presently defined in the container object type.

[0161] ITypeMembers::RemFunc

[0162] The method RemFunc removes the IFuncInfo object with the designated index from the list of function members of the container object type defined by this ITypeMembers object. After removal, the indexes of the function members greater than the designated index are decremented.

[0163] ITypeMembers::AddVar

[0164] The method AddVar adds a copy of the designated IVarInfo object defining a data member before the designated index in the list of data members of the container object type defined by this ITypeMembers object. A new data member may be appended by designating an index equal to the number of data members presently defined in the container object type.

[0165] ITypeMembers::RemVar

[0166] The method RemVar removes the IVarInfo object with the designated index from the list of data members of the container object type defined by this ITypeMembers object. After removal, the indexes of the data members greater than the designated index are decremented.

[0167] ITypeMembers::SetBase

[0168] The method SetBase sets the base class to the designated ITypeInfo.

[0169] ITypeMembers::MakeLaidOut

[0170] The method MakeLaidOut compiles the container object type defined by this ITypeMembers object.

[0171] ITypeMembers::SetVarTypeEnumImpl

[0172] The method SetVarTypeEnumImpl stores the integral type of the enumerators of the container object type defined by this ITypeMembers object.

[0173] ITypeMembers::SetTypeDescPvft

[0174] The method SetTypeDescPvft stores the type of the virtual function table pointer of the container object type defined by this ITypeMembers object.

[0175] ITypeMembers::SetTypeDescAlias

[0176] The method SetTypeDescAlias stores the object type for which the container object type defined by this ITypeMembers object is an alias.

[0177] IMemberInfo Interface

[0178] The IMemberInfo interface defines the methods of an IMemberInfo object. The IMemberInfo interface serves as a base class for the IVarInfo and IFuncInfo interfaces. The IMemberInfo interface defines characteristics that are common to data members, base members, and function members. Table 4 lists the IMemberInfo interface.

[0179] IMemberInfo::GetName

[0180] The method GetName retrieves the name of the member of the container object type defined by this IVarInfo or IFuncInfo object. The method returns the retrieved name as a parameter.

[0181] IMemberInfo::GetHmember

[0182] The method GetHmember produces the member handle for the member of the container object type defined by this IVarInfo or IFuncInfo object.

[0183] IMemberInfo::GetDllEntry

[0184] The method GetDllEntry retrieves the name of the dynamic link library (DLL) and ordinal in the DLL for the member of the container object type defined by this IVarInfo or IFuncInfo object, when the member has a DLL entry. Static data members and static function members have DLL entries. If the member has no corresponding entry in a DLL, the method sets the DLL file name to an empty string. The method returns the retrieved DLL file name and ordinal as parameters.

[0185] IMemberInfo::GetDocumentation

[0186] The method GetDocumentation retrieves a string containing a description of the member of the container object type defined by this IVarInfo or IFuncInfo object. The method returns the retrieved string as a parameter.

[0187] IMemberInfo::GetHelpContext

[0188] The method GetHelpContext retrieves the help context for the member of the container object type defined by this IVarInfo or IFuncInfo object. The help context is an index into the help file of the container ITypeInfo object. The help context is used to access detailed description of the member. The method returns the retrieved help context as a parameter.

[0189] IMemberInfo::GetTypeInfoContainer

[0190] The method GetTypeInfoContainer retrieves the ITypeInfo object that contains this IVarInfo or IFuncInfo object. The method returns a pointer to the retrieved ITypeInfo object as a parameter.

[0191] IMemberInfo::SetName

[0192] The method SetName stores the designated name as the name of the member of the container object type defined by this IVarInfo or IFuncInfo object.

[0193] IMemberInfo::SetHmember

[0194] The method SetHmember stores the designated member handle as the member handle of the member of the container object type defined by this IVarInfo or IFuncInfo object.

[0195] IMemberInfo::SetDllEntry

[0196] The method SetDllEntry stores the designated file name and designated ordinal as the file name and ordinal for the member of the container object type defined by this IVarInfo or IFuncInfo object.

[0197] IMemberInfo::SetDocumentation

[0198] The method SetDocumentation stores the designated string as documentation for the member of the container object type defined by this IVarInfo or IFuncInfo object.

[0199] IMemberInfo::SetHelpContext

[0200] The method SetHelpContext stores the help context for the member of the container object type defined by this IVarInfo or IFuncInfo object.

[0201] IVarInfo Interface

[0202] The IVarInfo interface defines the methods of an IVarInfo object. The IVarInfo interface inherits the IMemberInfo interface and provides a mechanism for defining data members, base members, and enumerators. The term “variable kind” indicates whether an IVarInfo object defines a base member, data member, or enumerator. The term “variable” refers to data member, base member, or enumerator . Table 5 lists the method introduced by the IVarInfo interface.

[0203] IVarInfo::GetVarKind

[0204] The method GetVarKind retrieves the variable kind that this IVarInfo object defines.

[0205] IVarInfo::GetTypeDesc

[0206] The method GetTypeDesc retrieves an ITypeDesc object that defines the object type of the variable defined by this IVarInfo object. The method returns a pointer to the retrieved ITypeDesc as a parameter.

[0207] IVarInfo::GetVal

[0208] The method GetVal retrieves a variant type when the variable defined by this IVarInfo object is a constant data member or an enumerator. The method returns the pointer as an argument. The method returns an error if the variable is not a constant data member or an enumerator.

[0209] IVarInfo::IsStatic

[0210] The method IsStatic retrieves a flag that indicates whether the variable defined by this IVarInfo object is static. The method returns the retrieved flag as its value. If the type kind of the container object type is MODULE, then the data member is preferably always static.

[0211] IVarInfo::GetOVar

[0212] The method GetOVar retrieves the offset from the start of the instance data of an object of the container object type for the variable defined by this IVarInfo object. This offset is only applicable to base members and non-constant data members. The method returns the offset as a parameter.

[0213] IVarInfo::SetTypeDesc

[0214] The method SetTypeDesc stores the type of the variable defined by this IVarInfo object.

[0215] IVarInfo::SetVal

[0216] The method SetVal stores the designated variant as the constant value for the variable defined by this IVarInfo object.

[0217] IVarInfo::SetStatic

[0218] The method SetStatic stores the designated flag as the static flag for the variable defined by this IVarInfo object.

[0219] ITypeDesc Interface

[0220] The ITypeDesc interface defines the methods of an ITypeDesc object. An ITypeDesc object defines the type of variable. In a preferred embodiment, an ITypeDesc object defines a fundamental type (e.g., integral type, floating type), and a derived type. Table 6 lists the ITypeDesc interface. A derived type includes directly derived types (e.g., array of variables or objects, functions, pointers to variables or objects, references to objects, constants, pointers to class members) and composed derived types (e.g., classes, structures, unions).

[0221] ITypeDesc::GetVarType

[0222] The method GetVarType retrieves the variable type of this ITypeDesc object. This method returns the retrieved variable type as its value. The variable type indicates whether this variable is a particular fundamental type, directly derived type, or composed derivative type.

[0223] ITypeDesc::GetTypeDescBasis

[0224] The method GetTypeDescBasis retrieves an ITypeDesc object that defines the derived type of the variable defined by this ITypeDesc object. The method returns a pointer to the retrieved ITypeDesc as a parameter.

[0225] ITypeDesc::IsConst

[0226] The method IsConst retrieves a flag that indicates whether the variable defined by this ITypeDesc object is a constant. The method returns the retrieved flag as its value.

[0227] ITypeDesc::IsVolatile

[0228] The method IsVolatile retrieves a flag that indicates whether the variable defined by this ITypeDesc object is volatile. The method returns the retrieved flag as its value.

[0229] ITypeDesc::GetSize

[0230] The method GetSize retrieves the size of the variable defined by this ITypeDesc object. The method returns the retrieved size as its value.

[0231] ITypeDesc::GetFuncDesc

[0232] The method GetFuncDesc retrieves an IFuncDesc object that defines the prototype of the function to which the variable defined by this ITypeDesc object points. The method returns a pointer to the retrieved IFuncDesc as a parameter. If this variable is not a pointer to a function, then the method sets the pointer to NULL.

[0233] ITypeDesc::GetTypeInfo

[0234] The method GetTypeInfo retrieves an ITypeInfo object that defines the object type of the variable defined by this ITypeDesc object. The method returns a pointer to the retrieved ITypeDesc object. If not applicable, the method sets the pointer to NULL.

[0235] ITypeDesc::SetVarType

[0236] The method SetVarType stores the variable type of the variable defined by this ITypeDesc object.

[0237] ITypeDesc::SetTypeDescBasis

[0238] The method SetTypeDescBasis stores the designated ITypeDesc object to describe the derived type of the variable defined by this ITypeDesc object.

[0239] ITypeDesc::SetConst

[0240] The method SetConst stores the designated flag as the constant flag of the variable defined by for this ITypeDesc object.

[0241] ITypeDesc::SetVolatile

[0242] The method SetVolatile stores the designated flag as the volatile flag of the variable defined by this ITypeDesc object.

[0243] ITypeDesc::Setsize

[0244] The method SetSize stores the designated size as the size of the variable defined by this ITypeDesc object. The size is settable only for fixed-length strings. The size can be inferred from all other variable types.

[0245] ITypeDesc::SetFuncDesc

[0246] The method SetFuncDesc stores the designated IFuncDesc to define the prototype of the function pointed to by the variable defined by this ITypeDesc object.

[0247] IFuncInfo Interface

[0248] The IFuncInfo interface defines the methods of an IFuncInfo object. The IFuncInfo interface inherits the IMemberInfo interface and defines the prototype of a function and binding information of the function. Table 7 lists the IFuncInfo prototype.

[0249] IFuncInfo::GetFuncDesc

[0250] The method GetFuncDesc retrieves a pointer to an IFuncDesc object that defines the prototype information of the function defined by this IFuncInfo object. The method returns a pointer to the retrieved IFuncDesc as a parameter.

[0251] IFuncInfo::GetPropKind

[0252] The method GetPropKind retrieves the property kind for the function defined by this IFuncInfo object. The property kind indicates whether this IFuncInfo is a property function, and if it is, the type of property function. A property function is a function that is syntactically invoked in a language in the same way a data member is accessed. The compiler compiles what appears to be data member access to a function member invocation. A property function allows actions to be performed when the property is set. For example, if a paragraph has a justify property, then when the justify property is set to right, not only is a data member set, but also a method is invoked to update the paragraph if displayed. A property function type is either set or get. The method returns the property kind as its value.

[0253] IFuncInfo::IsPure

[0254] The method IsPure retrieves a flag indicating whether the function defined by this IFuncInfo object is a pure virtual function. The method returns the retrieved flag as its value.

[0255] IFuncInfo::GetOvft

[0256] The method GetOvft retrieves the offset in the virtual function table of the container object type of the function defined by this IFuncInfo object. If this function is not a virtual function, then an indicator is returned. The offset is set during compilation. The method returns the retrieved offset as its value.

[0257] IFuncInfo::GetFuncKind

[0258] The method GetFuncKind retrieves the function kind (e.g., virtual, static, etc.) of the function defined by this IFuncInfo object. The method returns the retrieved function kind as its value.

[0259] IFuncInfo::SetFuncDesc

[0260] The method SetFuncDesc stores the designated IFuncDesc object as the prototype information of the function defined by this IFuncInfo object.

[0261] IFuncInfo::SetPropKind

[0262] The method SetPropKind stores the designated property kind as a property kind of the function defined by this IFuncInfo object.

[0263] IFuncInfo::SetPure

[0264] The method SetPure stores the designated flag as the pure flag of the function defined by this IFuncInfo object.

[0265] IFunInfo::SetFuncKind

[0266] The method SetFuncKind stores the designated function kind as the function kind of the function defined by this IFuncInfo object.

[0267] IFuncDesc Interface

[0268] The IFuncDesc interface defines the methods of an IFuncInfo object. The IFuncDesc interface provides a mechanism to access function prototype definitions. Table 8 lists the IFuncDesc interface.

[0269] IFuncDesc::GetTypeDescResult

[0270] The method GetTypeDescResult retrieves an ITypeDesc object that defines the return type of the function defined by this IFuncDesc object. The method returns a pointer to the ITypeDesc object as a parameter.

[0271] IFuncDesc::GetParamCount

[0272] The method GetParamCount retrieves the number of formal parameters of the function defined by this IFuncDesc object. The method returns the number as its value. The number indicates the minimum number of parameters required by this function. Additional parameters are of type variant.

[0273] IFuncDesc::GetParam

[0274] The method GetParam retrieves an IParamInfo object that defines the formal parameter of the designated index of the function defined by this IFuncDesc object. The method returns the pointer to the IParamInfo object as a parameter.

[0275] IFuncDesc::GetCallingConvention

[0276] The method GetCallingConvention retrieves the calling convention (e.g., Pascal, C++) of the function defined by this IFuncDesc object. The method returns the retrieved calling convention as its value.

[0277] IFuncDesc::GetTypeDescThis

[0278] The method GetTypeDescThis retrieves an ITypeDesc object that defines the type of the THIS pointer (e.g., near, far) of the function defined by this IFuncDesc object. The method returns a pointer to the ITypeDesc object as a parameter. If this function is static, the method sets the pointer to NULL.

[0279] IFuncDesc::HasAnyNumArgs

[0280] The method HasAnyNumArgs retrieves a flag indicating whether the function defined by this IFuncDesc supports a variable number of parameters. The method returns the retrieved flag as its value.

[0281] IFuncDesc::GetOptionalArgs

[0282] The method GetOptionalArgs retrieves the number of optional parameters that the function defined by this IFuncDesc object supports. The method returns the retrieved number as its value.

[0283] IFuncDesc::SetTypeDescResult

[0284] The method SetTypeDescResult stores the designated ITypeDesc object as the return type of the function defined by this IFuncDesc object.

[0285] IFuncDesc::AddParam

[0286] The method AddParam adds the designated IParamInfo object before the designated index of parameters of the function defined by this IFuncDesc object. A new parameter may be appended by designating an index equal to the number of parameters presently defined for the function.

[0287] IFuncDesc::RemParam

[0288] The RemParam removes the formal parameter of the designated index from the formal parameter list of the function defined by this IFuncDesc object.

[0289] IFuncDesc::SetCallingConvention

[0290] The method SetCallingConvention stores the designated calling convention as a calling convention of the function defined by this IFuncDesc object.

[0291] IFuncDesc::SetTypeDescThis

[0292] The method SetTypeDescThis stores the designated ITypeDesc object to define the type of the THIS pointer of the function defined by this IFuncDesc object.

[0293] IFuncDesc::SetAnyNumArgs

[0294] The method SetAnyNumArgs stores the designated number as the number of optional parameters of the function defined by this IFuncDesc object. If the HasAnyNumArgs flag is false, the method returns an error. If the last formal parameter is not an array of variants, the method returns an error.

[0295] IFuncDesc::SetOptionalArgs

[0296] The method SetOptionalArgs stores the designated number as the number of trailing optional parameters. If the last formal parameter is not a variant, the method returns an error.

[0297] IParamInfo Interface

[0298] The IParamInfo interface defines the methods of an IParamInfo object. An IParamInfo object provides a mechanism for defining formal parameters. Table 9 lists the IParamInfo interface.

[0299] IParamInfo::GetParamName

[0300] The method GetParamName retrieves the name of the formal parameter defined by this IParamInfo object. The name is used by languages that support a named parameter call syntax (e.g., ParamB=104). The method returns the retrieved name as a parameter.

[0301] IParamInfo::GetDocumentation

[0302] The method GetDocumentation retrieves a string containing a description of the formal parameter defined by this IParamInfo object. The retrieved string is returned as a parameter

[0303] IParamInfo::GetTypeDesc

[0304] The method GetTypeDesc retrieves the ITypeDesc object that defines the type of the formal parameter defined by this IParamInfo object. The method returns a pointer to the retrieved ITypeDesc object as a parameter.

[0305] IParamInfo::SetParamName

[0306] The method SetParamName stores the designated name as the name of the formal parameter defined by this IParamInfo object.

[0307] IParamInfo::SetDocumentation

[0308] The method SetDocumentation stores the designated string as the documentation the formal parameter defined by this IParamInfo object.

[0309] IParamInfo::SetTypeDesc

[0310] The method SetTypeDesc stores the designated ITypeDesc object to define the type of the formal parameter defined by of this IParamInfo object.

[0311] ITypeBind Interface

[0312] The ITypeBind interface defines the methods of an ITypeBind object. The ITypeBind interface provides a mechanism for compilers to retrieve information needed to compile using the container object type. Compilers invoke methods of an ITypeBind object to bind to an instance of an object of the type defined in the container object type. In a preferred embodiment, the bind names (member names and type names) are represented as handles (hgnam) to a name table. In this way, bind names can be efficiently identified during binding by the handle rather than by using a string. A compiler converts each bind name to a name handle before invoking the methods of the ITypeBind interface. The type library may supply a global function for this conversion. Table 10 lists the ITypeBind interface.

[0313] ITypeBind::GetTypeInfoContainer

[0314] The method GetTypeInfoContainer retrieves an ITypeInfo object defining the container object type of this ITypeBind object. The method returns a pointer to the retrieved ITypeInfo object as a parameter.

[0315] ITypeBind::GetCbSize

[0316] The GetCbSize method retrieves the size of an object of the object type defined by this ITypeBind object. This size is the size of the instance data. The method returns the retrieved size as its value.

[0317] ITypeBind::GetAlignment

[0318] The method GetAlignment retrieves the alignment for embedded objects of the container object type of this ITypeBind object. The method returns the alignment as its value.

[0319] ITypeBind::GetCbSizeVft

[0320] The method GetCbSizeVft retrieves the size of the virtual function table for the container object type of this ITypeBind object. The method returns the retrieved size as its value.

[0321] ITypeBind::Bind

[0322] The method Bind retrieves an IVarInfo or IFuncInfo object that defines the member matching the designated name handle within the container type defined by this ITypeBind object. The method returns an indication whether the member is a property. If the member is a property, then the BindProperty method should be invoked next. The method returns a pointer to the IVarInfo or IFuncInfo object as a parameter.

[0323] ITypeBind::BindProperty

[0324] The method BindProperty retrieves an IFuncInfo object defining a get property function and a put property function of the member matching the designated name handle of the container object type of this ITypeBind object. The method returns pointers to the IFuncInfo objects.

[0325] ITypeBind::BindType

[0326] The method BindType retrieves an ITypeBind object which defines the type matching the designated type name. This method is invoked on the ITypeBind object returned by the method ITypeLib::GetTypeBind to bind to types defined within that library. The method is also used to bind to nested types.

[0327] ITypeBind::CanCast

[0328] The method CanCast retrieves an ITypeInfo object defining the base member of the container object type of this ITypeBind object. In an alternate embodiment, an array of ITypeBind objects is retrieved to accommodate multiple inheritance. The method returns a pointer to the retrieved ITypeBind instance.

[0329] ITypeBind::GetOverridenFunction

[0330] The method GetOverridenFunction retrieves an IFuncInfo object that defines a virtual function member whose prototype is identical to the function defined by the designated IFuncInfo object that defines a function member of the container object type of the this ITypeBind object. The method returns a pointer to the retrieved IFuncInfo object as a parameter.

[0331] ITypeFixups Interface

[0332] The ITypeFixups interface defines the methods of an ITypeFixups object. The ITypeFixups interface provides a mechanism for loaders to retrieve the address of static function members, static data members, and global functions and data. Table 11 lists the ITypeFixups interface.

[0333] ITypeFixups::GetTypeInfoContainer

[0334] The method GetTypeInfoContainer retrieves an ITypeInfo object that defines the container object type of this ITypeFixups object. The method returns a pointer to the retrieved ITypeInfo object as a parameter.

[0335] ITypeFixups::AddressOfMember

[0336] The method AddressOfMember retrieves the address of the designated member of the container object type of this ITypeFixups object. If the designated member is a static function member or a global function, the method loads the code implementing the function from a dynamic link library. In an alternate embodiment, all static function members and global functions could be loaded when the type library is first opened. Also, the functions could be stored directly in the type library rather than in a separated dynamic link library. The method returns the address as its value.

[0337] Auxiliary Function

[0338] The present invention provides various auxiliary functions. The auxiliary functions provide a mechanism for an application to open a type library and instantiate various interface objects. For example, the function CreateITypeDesc creates an uninitialized ITypeDesc object and returns a pointer to the object. These functions, except for the function to open a library, can be defined as global functions within the type library.

[0339] Continuing Example

[0340] Code Tables 2 through 5 list pseudocode that shows the adding of a class definition to a type library. Code Table 2 lists pseudocode for the routine AddClass. The routine AddClass is passed a pointer to an ITypeLib object into which a designated class₁₃definition is to be added. In line 2, the routine invokes routine GenerateClassTypeInfo passing the designated class definition. The routine GenerateClassTypeInfo returns an ITypeInfo object that is initialized with the designated class definition. In line 3, the routine adds the ITypeInfo object to the designated ITypeLib object.

[0341] Code Table 3 lists pseudocode for the routine GenerateClassTypeInfo. The routine GenerateClassTypeInfo is passed a class definition (e.g., name, member names), instantiates all objects needed to describe the class, and returns an ITypeInfo object defining the class. In line 2, the routine invokes routine CreateTypeInfo to instantiate an uninitialized ITypeInfo object. In line 3, 4, and 5, the routine sets various attributes of the class. Other attributes of the class could be set including documentation, help file, etc. In line 6, the routine invokes method GetTypeMembers to retrieve an uninitialized ITypeMembers object. In lines 7 through 10, 11 through 14, and 15 through 18, the routine adds the definition of data member, function member, and base members to the ITypeMembers object. In the following, the steps of adding the description of data members is described. One skilled in the art would appreciate that the description of adding function members and base members is analogous. In lines 7 through 10, the routine adds the definition of all the data members of the class to the ITypeMembers. In line 7, the routine initializes the variable i, which is used to index the data members. In lines 8 through 10, the routine loop added the definition of each data member. In line 9, the routine invokes the routine GenerateDataInfo passing in the data member definition and the ITypeInfo object. The routine GenerateDataInfo returns an IVarInfo object containing the definition of the data member. In line 10, the routine adds the IVarInfo object to the ITypeMembers object.

[0342] Code Table 4 lists pseudocode for the routine GenerateDataInfo. The routine GenerateDataInfo is passed information defining a data member, generates an IVarInfo object defining the data member, and returns the IVarInfo object. In line 2, the routine invokes routine CreateVarInfo, which creates an uninitialized IVarInfo object. In line 5, the routine sets the name of the IVarInfo instance to the data member name. In line 6, the routine invokes routine GenerateTypeDesc to create and initialize an ITypeDesc instance for the designated data member. In line 7, the routine stores the pointer to the ITypeDesc instance in the IVarInfo instance. In lines 8 and 9, the routine sets various attributes of the data member.

[0343] Code Table 5 lists pseudocode for the routine GenerateTypeDesc. The routine GenerateTypeDesc is passed a type definition and an ITypeInfo object, creates and initializes an ITypeDesc object, and returns the ITypeDesc object. In line 2, the routine invokes routine CreateTypeDesc to create an uninitialized ITypeDesc object. In line 3, the routine sets a pointer to an ITypeInfo object. In line 4, the routine sets the variable kind of the ITypeDesc object. In lines 4 through 6, if the variable is a derived type, then the routine generates an ITypeDesc object for the derived from type by recursively calling routine GenerateTypeDesc and stores a pointer to the ITypeDesc object for the derived type. In lines 7 through 11, the routine sets various attributes and creates and initializes an IFuncDesc instance when the variable points to a function.

[0344] FIG. 8 is a diagram showing steps the macro interpreter executes to interpret the macro of Code Table 1. FIG. 8 does not represent a flow diagram of the macro interpreter, but rather represents those steps the macro interpreter executes when interpreting the macro of Code Table 1. In step 801, the macro interpreter opens the type library for the word processor. When the type library is opened, a pointer to an ITypeLib object is returned in variable ptlib. In step 802, the macro interpreter allocates memory for the variable pdoc, which is a pointer to a document type. In step 803, the macro interpreter allocates memory for the variable ppara which is a pointer to a paragraph type. In step 804, the macro interpreter interprets line 3 of Code Table 1. The macro interpreter invokes its routine ExecuteGlobalFunction passing it a pointer to the open type library, the name of the global function GetDoc, and an indication that there are no parameters. The routine returns as its value a pointer to the document object for the open document in the word processor. In step 805, the macro interpreter sets the variable pdoc to the return value. In step 806, the macro interpreter interprets line 4 of Code Table 1.The macro interpreter sets the variable i to 0. In steps 807 through 810, the macro interpreter interprets lines 5 and 6 of Code Table 1. In step 807, the macro interpreter invokes the routine ExecuteMemberFunction passing a pointer to the ITypeLib object for the open library, a pointer to the document object, an indication that the pointer is to the document object type, the name of the function member to execute (GetPara), and an indication of the number of parameters. The routine returns the result of the GetPara function member. The GetPara function member returns a pointer to a paragraph object of the designated index. In step 808, the macro interpreter sets variable ppara equal to the return value. In step 809, if the variable ppara is equal to null, then all the paragraphs have been processed and the macro interpreter is done interpreting the Code Table 1, else the macro interpreter continues at step 810. In step 810, the macro interpreter invokes routine ExecuteFunctionMember passing a pointer to the ITypeLib object for the open library, a pointer to the paragraph object, an indication that the pointer to the paragraph object points to a paragraph, the name of the function member of the paragraph object to execute (SetJustify), and the parameter “right.” The function member SetJustify has no return value. The macro interpreter then loops to step 807 to continue execution of the loop of lines 5 and 6 of Code Table 1.

[0345] FIG. 9 is a flow diagram of the routine ExecuteGlobalFunction. This routine determines the address of a global function, pushes the parameters for that global function, invokes the global function, and returns the value of the global function. This routine is passed a pointer to an ITypeLib, the name of the global function to execute, and the parameters for the function. This routine returns the value of the global function. In step 901, the routine invokes routine GetAddressOfGlobalFunction passing it a pointer to the ITypeLib object, the function name, and the parameters. The routine GetAddressOfGlobalFunction returns the address of the global function of the designated name within the word processing program. In step 902, the routine pushes the parameters. The step of pushing the parameters would depend upon the calling convention of the global function. In step 903, the routine invokes the global function. In step 904, the routine stores the value of the global function as the return value and returns itself.

[0346] FIG. 10 is a flow diagram of the routine GetAddressOfGlobalFunction. Routine GetAddressOfGlobalFunction accesses the type library to determine the address of the designated global function. The routine is passed a pointer to an ITypeLib object, the name of the global function, and the parameters to pass to the global function. The routine returns the address of the global function. In step 1001, the routine invokes routine BindToGlobalFunction passing it the pointer to the ITypeLib object and the name of the global function. The BindToGlobalFunction routine returns a pointer to an ITypeBind object for the designated global function. In step 1002, the routine invokes routine GetFuncInfo passing it the pointer to the ITypeBind object. The routine GetFuncInfo returns a pointer to an IFuncInfo object for the global function. In step 1003, the routine invokes routine ValidateParameters passing it the parameters and the pointer to the IFuncInfo object. The ValidateParameters routine determines whether the designated parameters are consistent with the formal parameters specified in the IFuncInfo object. In step 1004, the routine invokes routine GetAddress passing it the pointer to the IFuncInfo object. The routine GetAddress returns the address corresponding to the IFuncInfo object. The GetAddressOfGlobalFunction routine then returns.

[0347] Code Table 6 lists pseudocode for the routine BindToGlobalFunction. The routine BindToGlobalFunction inputs a pointer an ITypeLib object and the name of a global function. The routine retrieves an ITypeBind object for the designated function and returns a pointer to that object. The routine retrieves the ITypeBind object by searching through each ITypeInfo object within the type library that has a type kind of MODULE. The routine checks each function within the ITypeInfo object to determine whether it matches the designated name. If it matches the designated name, then the routine retrieves an ITypeBind object for that function and returns. In an alternate embodiment, the method ITypeLib::GetTypeBind() can be used to retrieve an ITypeBind instance through which the ITypeBind object for the global function of the designated name can be retrieved. Also, in an alternate embodiment, the routine BindToGlobalFunction would check to determine whether multiple global functions with the designated name were defined, rather than return when the first global function was found.

[0348] Code Table 7 lists pseudocode for the routine GetFuncInfo. The routine GetFuncInfo is passed a pointer to an ITypeBind object and the name of a function to bind. The routine returns a pointer to an IFuncInfo object for the designated function.

[0349] Code Table 8 lists pseudocode for the routine ValidateParameters. This routine receives a list of parameters and a pointer to an IFuncInfo object. The routine determines if the designated parameters are consistent with the formal parameters of the IFuncInfo instance. The routine returns as its value an indication of whether the parameters match.

[0350] Code Table 9 lists pseudocode for the routine GetAddress. The routine receives a pointer to an IFuncInfo object and returns the address of the function defined by that object. The routine retrieves a handle for that member and then uses an ITypeFixups object to retrieve the address.

[0351] FIG. 11 is a flow diagram of the routine ExecuteFunctionMember. This routine is passed a pointer to an ITypeLib object, a pointer to an object, the type of the object, the name of a function member, and the parameters to pass to the function member. The routine determines the offset of the function member within the virtual function table of the designated object, invokes that function passing it the parameters, and returns the value of the designated function. In step 1101, the routine invokes routine GetOffsetOfFunctionMember passing it the pointer to the ITypeLib object, the name of the designated function, the object type of which the designated function is a member, and the parameters for the designated function. The GetOffsetOfFunctionMember returns the offset of the designated function member within the virtual function table of the designated object type. In step 1103, the routine pushes the parameters. In step 1104, the routine invokes the designated function of the designated object. In step 1105, the routine stores the return value of the designated function. The routine ExecuteFunctionMember then returns.

[0352] FIG. 12 is a flow diagram of the routine GetOffsetOfFunctionMember. The routine inputs a pointer to an ITypeLib object, the name of a function member, the container object type of the function member, and parameters to be passed to the function member. The routine validates the parameters and returns the offset of the designated function member in the virtual function table of the container object type. In step 1201, the routine invokes routine BindToFunctionMember passing it pointer to the designated ITypeLib object and the designated container object type. The routine returns with a pointer to an ITypeBind object for the designated container object type. In step 1202, the routine invokes routine GetFuncInfo passing it a pointer to the designated ITypeInfo object and the name of the designated function member. The routine returns a pointer to an IFuncInfo object for the designated function. In step 1203, the routine invokes the routine ValidateParameters passing it the designated parameters and the pointer to the IFuncInfo object for the designated function member. In step 1205, the routine invokes routine GetOffset passing it the pointer to the IFuncInfo object for the designated function member. The routine GetOffset returns the offset of the designated function member within the virtual function table of the container object type. The routine GetOffset then returns.

[0353] Code Table 10 lists pseudocode for the routine BindToFunctionMember. The routine BindToFunctionMember is passed a pointer to an ITypeLib object and the name of the container object type. The routine returns a pointer to an ITypeBind object for the designated container object type.

[0354] Code Table 11 lists pseudocode for the routine GetOffset. The routine GetOffset is passed an IFuncInfo object and returns the offset of the function member defined by the designated IFuncInfo object.

[0355] One skilled in the art would appreciate that the type library interfaces as specified in this embodiment support classes defined with at most one base class. Instances of classes that inherit only one base class are preferably laid out with a single virtual function table. The instance contains a pointer to the virtual function table that is a known offset within the object.

[0356] In an alternate embodiment, multiple inheritance is supported. To support multiple inheritance, additional methods are included in several interfaces. In particular, the ITypeMembers interface includes methods to add, remove, and get information describing a base class. The IVarInfo interface includes a method to retrieve the offset (within an instance of an object defined by the container type) of the introducing base class (possibly virtually inherited) of the base class defined by the IVarInfo object. The IFuncInfo interface includes a method to retrieve the offset (within an instance of an object defined by the container type) of the pointer to the virtual function table containing the address of the function defined by the IFuncInfo object. The ITypeBind interface includes a method to provide information on how to cast an instance of an object defined by the container type to an instance of a base class.

[0357] Although the present invention has been described in terms of a preferred embodiment, it is not intended that the invention be limited to these embodiments. Modifications within the spirit of the invention will be apparent to those skilled in the art. The scope of the present invention is defined by the claims that follow.