Plug-in module host framework

• US 6,006,279 A
• Filed: 01/21/1997
• Issued: 12/21/1999
• Est. Priority Date: 01/21/1997
• Status: Expired due to Term

• Current Assignee: Canon Kabushiki Kaisha (Canon Inc.)
• Original Assignee: Canon Information Systems Incorporated (Canon Inc.)
• Inventors: Hayes, Persnaz Neli
• Primary Examiner(s): Oberley, Alvin E.
• Assistant Examiner(s): COURTENAY III, ST JOHN
• Application Number:
  US08/784,542
• Time in Patent Office: 1,064 Days
• Field of Search: 395/680, 395/682, 709/300, 709/302
• US Class Current: 719/328
• CPC Class Codes: G06F 9/451 Execution arrangements for user interfaces

Abstract

Computer-executable process steps stored on a computer-readable medium to provide an application programming interface (API) to a client application for communicating between the client application and a plug-in module. The API includes a menu-create routine which searches for plug-in modules, which enters information regarding a found plug-in module into a structure, the structure being used to create and to display a plug-in menu of found plug-in modules, an "about" menu-create routine which enters "about" plug-in information into an "about" structure, the "about" structure being used to create and to display a plug-in "about" menu, a menu-enable routine, a menu-disable routine and an invoking routine which permits the client application to utilize a selected plug-in module.

Claims

1. Computer-executable process steps stored on a computer-readable medium, the steps executable so as to provide an application programming interface (API) to a client application for communicating between the client application and a plug-in module, the plug-in module extending a base functionality of the client application, said API having routines comprising:

a menu-create routine, callable by the client application, which searches a designated plug-in module storage means for plug-in modules, a module consisting of a plug-in module interface resource and at least one corresponding plug-in module code resource, and which, after a plug-in module is found, enters information regarding the found plug-in module into a structure, the structure being used to create and to display a plug-in menu, the plug-in menu allowing a user to select a particular plug-in module;

an "about" menu-create routine, callable by the client application, which enters "about" plug-in information into an "about" structure, the "about" structure being used to create and to display a plug-in "about" menu, the plug-in "about" menu allowing a user to select a particular plug-in module;

a menu-enable routine, callable by the client application, which enables the plug-in menu so that a user may select a particular plug-in module from the plug-in menu;

a menu-disable routine, callable by the client application, which disables the plug-in menu so that a user may not select a particular plug-in module from the plug-in menu; and

an invoking routine, callable by the client application, which, in a case where a particular plug-in module is selected from the plug-in menu, obtains an entry point routine address for the particular plug-in module and calls an entry point routine corresponding to the entry point routine address so as to permit the client application to utilize the particular plug-in module.

2. Computer-executable process steps according to claim 1, wherein the plug-in menu is arranged hierarchically.

3. Computer-executable process steps according to claim 1, wherein said invoking routine, in a case where a particular plug-in module is selected in the plug-in "about" menu, obtains an entry point routine address for the particular plug-in module and calls an entry point routine corresponding to the entry point routine address so as to permit the client application to display information regarding the selected plug-in module.

9. Computer-executable process steps according to claim 1, wherein the API routines are stored in a dynamically linkable library (DLL).

10. Computer-executable process steps according to claim 1, wherein the invoking routine calls the entry point routine with operation selector values corresponding to a task to be performed by the plug-in module.

11. Computer-executable process steps according to claim 10, wherein the operation selector values are determined by the invoking routine so as to isolate the client application from changes in the plug-in module.

12. Computer-executable process steps according to claim 10, wherein the operation selector values are determined by the invoking routine so as to maintain backward compatibility with different versions of the plug-in module.

4. A method for accessing functionality of a plug-in module from a client application, the plug-in module extending a base functionality of the client application, said method comprising the steps of:

calling a menu-create routine which searches a designated plug-in module storage means for plug-in modules, the module consisting of a plug-in module interface resource and at least one corresponding plug-in module code resource, and which, after a plug-in module is found, enters information regarding the found plug-in module into a structure, the structure being used to create and to display a plug-in menu, the plug-in menu allowing a user to select a particular plug-in module;

calling a menu-enable routine which enables the plug-in menu on a display; and

calling an invoking routine which, in a case where a particular plug-in module is selected in the plug-in menu, obtains an entry point routine address for the particular plug-in module and calls an entry point routine corresponding to the entry point routine address so as to permit the client application to utilize the particular plug-in module.

5. A method according to claim 4, wherein the plug-in menu is arranged hierarchically.

6. A method according to claim 4, further comprising:

calling an "about" menu-create routine which enters "about" plug-in information into an "about" structure, the "about" structure being used to create and to display a plug-in "about" menu, the plug-in "about" menu allowing a user to select a particular plug-in module; and

calling an invoking routine which, in a case where a particular plug-in module is selected in the plug-in "about", obtains an entry point routine address for the particular plug-in module and calls an entry point routine corresponding to the entry point routine address so as to permit the client application to display information regarding the selected plug-in module.

13. A method according to claim 4, wherein the menu-create routine and the invoking routine are stored in a dynamically linkable library (DLL).

14. A method according to claim 4, wherein the invoking routine calls the entry point routine with operation selector values corresponding to a task to be performed by the plug-in module.

15. A method according to claim 14, wherein the operation selector values are determined by the invoking routine so as to isolate the client application from changes in the plug-in module.

16. A method according to claim 14, wherein the operation selector values are determined by the invoking routine so as to maintain backward compatibility with different versions of the plug-in module.

7. A host framework for providing functionality of a plug-in module to a client application, the plug-in module extending a base functionality of the client application, said framework comprising:

an abstract plug-in manager base class for locating a plug-in module storage means, for locating specified plug-in modules, and for creating a category list of the specified plug-in modules;

a type manager class, derived from said plug-in manager class, for creating a type information record which contains information for invoking specified plug-in modules, for adding the type information record to the category list, and for associating a plug-in module from the category list with a menu identification value;

a plug-in category class, used by said abstract plug-in manager base class and by said type manager base class, for managing storage of type information records of a specified category and for retrieving a type information record from the category list; and

a plug-in class, used by said abstract plug-in manager base class, by said type manager base class, and by said plug-in category class, for associating a plug-in module with a menu item, and for obtaining an entry point address to invoke the plug-in module associated with the menu item.

8. An apparatus according to claim 7, wherein said plug-in class contains data and behavior for associating the plug-in module with an "about" menu item and for obtaining an entry point address to invoke the plug-in module associated with the "about" menu item.

17. A host framework according to claim 7, wherein when said plug-in class associates the plug-in module with the menu item, said plug-in class is compatible with different version of the plug-in module.