Method and system for using editor objects to connect components

[0002] This application is a continuation of U.S. patent application Ser. No. 08/756,540, filed Nov. 25, 1996, now U.S. Pat. No. 5,805,896; which is a continuation of U.S. patent application Ser. No. 08/478,500, filed Jun. 7, 1995, now abandoned; which is a divisional of U.S. patent application Ser. No. 08/153,362, filed Nov. 16, 1993; issued as U.S. Pat. No. 5,742,848.

[0003] The present invention relates generally to a computer system for visual programming, and more specifically, to a method and system for interconnecting visual components and passing messages between connected components.

[0004] Visual programming is a computer programming technique that allows for rapid development of visually oriented programs (visual programs). FIG. 1 is a diagram illustrating a sample operation of a visual program. The visual program is a temperature converter, which converts Fahrenheit to Centigrade, and vice versa. The Fahrenheit scroll bar 101 is used to set the Fahrenheit value to between 0 and 100 degrees as indicated by the position of the Fahrenheit slider 103. The Fahrenheit display 102 displays the numeric Fahrenheit value represented by the position of the Fahrenheit slider. The Centigrade scroll bar 111 is used to set the Centigrade value between 0 and 100 degrees as indicated by the Centigrade slider 113. The Centigrade display 112 displays the numeric Centigrade value represented by the position of the Centigrade slider. In operation, when the Fahrenheit slider is moved by a user, the Centigrade slider is automatically moved to the corresponding Centigrade position and the Fahrenheit and Centigrade displays are updated. Conversely, when the Centigrade slider is moved by a user, the Fahrenheit slider is automatically moved to the corresponding Fahrenheit position and the Centigrade and Fahrenheit displays are updated.

[0005] Visual programming allows various components (e.g., a scroll bar) to be interconnected visually to effect the program behavior. A visual programming environment typically includes a list of predefined components that can be interconnected to create a visual program. Each component may include input and output ports and a visual interface. When creating a visual program, a programmer specifies the visual components and their location on the display. The programmer also specifies the interconnection between various ports. The components pass values through these connections. FIG. 2 is a block diagram illustrating a scroll bar component. The scroll bar component 201 receives messages from the operating system (e.g., mouse down) and controls the display of a scroll bar. The scroll bar also provides an input port 203 and an output port 202. The input port is used to receive a value indicating a new position of the slider and the output port is used to send a value indicating a new slider position. The scroll bar can be connected to other components through its ports.

[0006] FIG. 3 is a diagram illustrating a scroll bar connected to a display component. A display component 301 has one input port 303 for receiving a value. The display component controls the displaying of the value that it receives. The output port 202 of the scroll bar component 201 is connected to the input port 303 of the display component. In operation, whenever the scroll bar slider is moved, a value indicating the new position of the slider is sent from the scroll bar component to the display component. The display component receives this value and updates its display accordingly.

[0007] Although prior references have described general visual programming environments, visual programming is not widespread because of the inefficiencies of visual programs. For example, visual programs often execute in an interpretive mode that results in unacceptably slow performance.

[0008] It is an object of the present invention to provide a method and system that allows for creation of efficient visual programs.

[0009] It is another object of the present invention to provide a method and system that shields component developer from the details of the connecting of components and the passing of values between components.

[0010] 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 sending messages between components. In a preferred embodiment, the present invention instantiates an event object. The event object includes message information describing the message and a dispatching member function for invoking a member function of a target object passing the message information. A message is passed by invoking the dispatching member function of the event object passing an identifier to a target object and an identifier of a member function of the target object. The dispatching member function invokes the identified member function of the identified target object passing the event information as an actual parameter. The event object is preferably of a derived class that inherits a base class. The base class provides common event behavior, while the derived class provides behavior specific to a type of message.

[0011] FIG. 1 is a diagram illustrating a sample operation of a visual program.

[0012] FIG. 2 is a block diagram illustrating a scroll bar component.

[0013] FIG. 3 is a diagram illustrating a scroll bar connected to a display component.

[0014] FIG. 4 is a diagram illustrating visual programming of the present invention.

[0015] FIG. 5 is a diagram illustrating the instantiated objects for the temperature converter.

[0016] FIG. 6 is a table containing a listing of the connections for the for the temperature converter program.

[0017] FIG. 7 is a flow diagram illustrating the flow of control of sending a message from a source object to a target object.

[0018] FIG. 8 is a block diagram of data structures of a creditor object.

[0019] FIG. 9 is a block diagram of a computer system.

[0020] The present invention provides a method and system for connecting components and passing of messages (events) between components. In a preferred embodiment, each component may provide multiple input ports and output ports. Each output port sends a message corresponding to a particular type of event; each input port receives a message corresponding to a particular type of event. A component that sends a message is referred to as a source, and a component that receives the message is referred to as the target. In a preferred embodiment, each component has an associated run-time class and editor class. The editor class provides component-specitic behavior to assist in creating a visual program. The run-time class provides the component behavior when the visual program executes. A visual programming system controls the development of visual programs by instantiating objects of the editor classes and controls the run-time execution by instantiating objects of the run-time class. As described below, the present invention provides a mechanism in which messages are efficiently passed between components. In the following, a preferred embodiment of the present invention is described using well-known object-oriented terminology and terminology of the C++ programming language.

[0021] FIG. 4 is a diagram illustrating visual programming of the present invention. To generate a visual program to implement a temperature converter, a programmer would position a Fahrenheit scroll bar 410, Fahrenheit display 430, a Centigrade scroll bar 420, and a Centigrade display 440. The programmer would also position an FtoC calculator 460, which converts a Fahrenheit value to a Centigrade value, and a CtoF calculator 450, which converts a Centigrade value to a Fahrenheit value. In one embodiment, the components are selected from an extendible list of available components. The programmer then connects the components through their ports. The connections 412->461 and 412->431 indicate that when the Fahrenheit scroll bar is changed (e.g., slider moved), the new value is sent to the FtoC calculator and the Fahrenheit display. The connection 462->421 indicates that when the FtoC calculator calculates a new Centigrade value, the new value is sent to the Centigrade scroll bar. The connections 422->441 and 422->451 indicate that when the Centigrade scroll bar is changed, the new value is sent to the CtoF calculator and the Centigrade display. The connection 452->411 indicates that when the CtoF calculator calculates a new Fahrenheit value, the new value is sent to the Fahrenheit scroll bar. In one embodiment, the components are connected by entering a connect mode and selecting the source and target of each connection.

[0022] The visual programming system instantiates an object of the run-time class for each component selected by the programmer. FIG. 5 is a diagram illustrating the instantiated objects for the temperature converter. The FScrollbar object 501 corresponds to the Fahrenheit scroll bar component, the CScrollbar object 502 corresponds to the Centigrade scroll bar component, the FDisplay object 503 corresponds to the Fahrenheit display component, the CDisplay object 504 corresponds to the Centigrade display component, the FtoC object 505 corresponds to the FtoC calculator component, and the CtoF object 506 corresponds to the CtoF calculator component. Each of these objects implements the display and control of the corresponding component. The directed arcs indicate the direction of the connections, that is, from an output port to an input port.

[0023] Each component may send messages to other components corresponding to different types of events. For example, a scroll bar may send a message to indicate a changed value event has occurred and another message to indicate a scroll down has occurred. Each type of event has its own output port. Also, input ports are designated to receive only certain types of events. For example, an output port that sends messages relating to a scroll up event can only be connected to an input port that expects a message in the same format as a scroll up message.

[0024] A source object (corresponding to a source component) sends a message (communicates the occurrence of an event) by invoking a member function of a target object (corresponding to a target component). Each input and output port is preferably associated with a function member of the run-time object. For example, a scroll bar object may have a function member named ValueIn corresponding to an input port for receiving a new value and a function member named ValueOut corresponding to an output port for sending a new value. In operation, the member function ValueOut is invoked whenever a change in the value for the scroll bar occurs, e.g., when the slider is moved. The member function ValueOut invokes the target member function corresponding to each input port to which it is connected. The invoked target member function then processes the value information which is passed as a parameter.

[0025] In a preferred embodiment, message information (e.g., new value) is encapsulated in an object of an event class. The source member function corresponding to an output port creates an event object and stores the event information in the event object. The source member function effects the invocation of a notify member function of a target object passing the event object and a pointer to the target member function. The notify member function invokes a dispatching member function of the event object passing a pointer to the target object and a pointer to the target member function. The dispatching member function invokes the target member function passing the stored information as a parameter. In a preferred embodiment, different implementations of event objects are used to represent different function prototypes (parameter list) of target member functions. Each class of event object contains information that is passed to a target member function according to the function prototype. Thus, each source member function invokes target member functions with the same prototype.

[0026] In a preferred embodiment, each run-time class inherits the class CObject. The class CObject tracks the connections and controls the sending of messages. The class CObject is referred to as a connection manager. In this way, run-time classes that implement component behavior can be developed without detailed knowledge of the implementation of the class CObject. Moreover, run-time objects implemented by different. developers can cooperatively interact. FIG. 6 is a table containing a listing of the connections for the temperature converter program. The class CObject includes an array (connectionArray) that contains the connections for each output port of the run-time object. Each entry of the connection array contains an identifier of the output port of the source object, an identifier of the target object, and an identifier of the input port of the target object. For example, the connection array for the FScrollbar object contains two entries:

[0027] (Out1, FDisplay, In1) and (Out1, FtoC, In1)

[0028] “Out1” identifies the output port, “FDisplay” and “FtoC” identify the target objects, and “In1” identifies the input port of the target objects. When an event occurs for a particular output port, the source object instantiates an event object and invokes an inform targets member function of the class CObject (connection manager) identifying the output port. The output port is preferably identified by a pointer to a member function (source member function) of the source object. The inform targets member function sends an appropriate message to each target object as indicated by the connection array for the source object. The input port is preferably identified by a pointer to a member function (target member function) of the target object. The connection manager sends the message to the target object by invoking a notify member function of the target object passing a pointer to the target member function and an event object. The event object contains actual parameters for the target member function. The notify member function invokes a dispatch member function of the event object passing a pointer to the target member function and a pointer to the target object. The dispatch member function formats the actual parameters and invokes the target member function of the target object passing the actual parameters.

[0029] Code Table 1 contains pseudocode for the class CObject.

[0030] The programming system adds connections to a run-time object by invoking the member function AddTarget provided by the connection manager. The programming system invokes the AddTarget member function of the source object whenever a programmer connects two objects. The member function AddTarget is passed a pointer to the target object, a pointer to the target member function (representing the input port), and a pointer to a source member function (representing the output port). The member function AddTarget adds an entry to the connectionArray of the source object corresponding to the passed parameters. In a preferred embodiment, the connections are stored not as data members of the CObject, but rather are stored in a heap that is shared by all run-time objects. In this way, the storage overhead for. each object can be minimized.

[0031] A message is sent to a target object in the following manner. The source object instantiates an event object and stores event information in the event object. The source object invokes the member function InformTargets of its connection manager passing the event object and a pointer to the source member function. For each connection for that output port (source member function), the connection manager invokes the member function NotifyEvent of target object passing the event object, a pointer to the target member function, and a pointer to the source object. The member function NotifyEvent invokes the member function Dispatch of the event object passing a pointer to the source object, a pointer to the target object, and a pointer to the target member function. The member function Dispatch invokes the target member function of the target object passing the stored event information as actual parameters. An event object encapsulates the message information in a way that is transparent to the connection manager. Thus, the connection manager can control the invoking of target member functions passing arbitrary parameters.

[0032] FIG. 7 is a flow diagram illustrating the flow of control of sending a message from a source object to a target object. A source member function 710-714 of the source object instantiates an event object in step 711. In step 712, the source member function stores the event information in the event object. In step 713, the source member function invokes the member function InformTargets of the connection manager passing a pointer to the event and the source member function. In step 721, the member function InformTargets loops determining which entries in the connection array correspond to the source member function. When an entry is found, the member function InformTargets invokes the member function NotifyEvent of the target object passing a pointer to the event, a pointer to the source object, and a pointer to the target member function. In step 731, the member function NotifyEvent of the target object invokes the member function Dispatch of the event passing a pointer to the source object, a pointer to the target object, and pointer to the target member function. In step 741, the member function Dispatch invokes the target member function passing the event information stored in the event object. The target member function processes the event information in step 751. The target member function then returns, which causes the member functions Dispatch, NotifyEvent, and InformTargets to return to the execution of the source member function.

[0033] The use of an event object allows the connection manager to invoke input member functions with arbitrary parameters. Each prototype for a input member function has its own implementation of the event class to handle the event. The source object instantiates the appropriate class of event object. For example, the input member function ValueIn is passed an integer. Thus, an event class is implemented that contains an integer data member to store the value. The member function Dispatch of the event class invokes a passed target member function passing the stored value. An event class may be implemented for each different prototype of a target member function. For example, if the event information includes both an integer and a string, then an event class can have a data member for the integer and another for the string. The member function Dispatch of the event class invokes a passed target member function passing the integer and the string as parameters.

[0034] Code Table 2 contains pseudocode that describes the event classes. Each event class derives from the class CEvent. The event class CIntEvent is used to pass information stored as an integer to a target member function. The member function Dispatch is passed a pointer the target object and a pointer to the member function. The member function Dispatch invokes the target member function by the following statement:

[0035] (ptarget->*(LongToMember (pmftarget)))(numValue)

[0036] The event class CActionEvent is used to pass messages with no corresponding data, and the event class CStringEvent is used to pass messages with string data.

[0037] Code Table 3 contains pseudocode for a sample scroll bar object corresponding to a scroll bar component. The scroll bar object is defined by class CScrollbar, which inherits the connection manager (class CObject). The class contains data members to store the current value of the scroll bar, a large and small increment for the scroll bar, and the minimum and maximum values for the scroll bar. The class also contains the member function to set and retrieve the current value, to receive messages from the parent window of that scroll bar, and to effect various scroll bar behaviors. The scroll bar component has an input function member (value) with one parameter and an output function member (value) with no parameters.

[0038] The constructor CScrollbar registers the scroll bar with the operating system and initializes its data members. The member function HandleParentMsg receives messages from the parent window and dispatches the message. For example, if the member function HandleParentMsg is passed a message that the scroll bar event line up (SB_LINEUP) has occurred, then the member function invokes the member function LineUp. The member function LineUp instantiates a CActionEvent object, sets a pointer to the member function LineUp, and invokes the member function InformTargets of the connection manager. The member function LineUp then invokes the member function value passing a new value for the scroll bar.

[0039] The member function value receives the new value. If the new value is different than the current value, then the member function adjusts the slider, instantiates a CIntEvent object, sets the event object to the new value, sets a pointer to the member function value (to identify the source member function), and invokes the member function InformTargets of the connection manager.

[0040] The member function minimum illustrates a member function of an object that does not cause a message to be sent to target objects, that is, it does not correspond to an output port. The member function minimum, however, may correspond to an input port. In one embodiment, a member function could correspond to both an input and an output port (a bidirectional port). The member function can be invoked to receive a message and then send a message to other target objects.

[0041] In a preferred embodiment, the present invention is implemented to execute under the Windows operating system developed by Microsoft Corporation. The Windows operating system is described in “Programming Windows” written by Charles Petzold and published by Microsoft Corporation, which is hereby incorporated by reference.

[0042] In a preferred embodiment, the programming system persistently stores the run-time objects of a visual program. The programming system maintains a pointer to each run-time object corresponding to a component. To store the program, the programming environment invokes a member function Serialize (provided by the connection manager of each object). The member function Serialize writes the connection array to the persistent storage and invokes the member function SerializeObjectData to write the object specific data to the persistent storage. The member function SerializeObjectData of the connection manager would typically be overridden by the run-time object corresponding to the component. For example, the member function SerializeObjectData for the scroll bar object writes each data member to persistent storage. Similarly, each object has corresponding member functions to retrieve the persistent stored data. When storing and retrieving data, the programming system needs to map the memory address of each pointer to its persistently stored object data. When the object data is retrieved, the pointers in the connection array need to be mapped to their new memory locations.

[0043] In a preferred embodiment, each component has a corresponding editor object which controls the placement, movement, and connection to the component. A standard interface (CEditor) to the editor object is provided. The CEditor object provides a standard mechanism (1) for displaying the available ports and the current connections, (2) for selecting an available port, (3) for connecting a port to another port, and (4) for moving the component. The implementor of a component preferably implements an editor object that inherits the CEditor interface. When a programmer selects a component, the programming system instantiates both the run-time object and an editor object for the component.

[0044] FIG. 8 is a block diagram of data structures of a CEditor object. The CEditor object 802 contains a pointer to a list of available ports (mPortList), a pointer to a user interface editor object (mEditorUI), a pointer to the run-time object corresponding to the component (mSubject), a pointer to a list of child editor object (mChildEditors), and a pointer to a parent editor (mParent). Each port is described by a CEditPort object 808. A CEditPort object contains a pointer to the associated CEditor object (mOwnerEditor), a pointer to a list of input ports to which the port is connected (mConnectedPorts), status information (mStatus), and pointer to member functions identifying the input and output portions of the port (mValueIn and mvalueOut) as pointers to member functions. The CEditorUI object 812 contains member functions to control moving the component on the display and displaying available ports and connections.

[0045] A component may contains child components. For example, a window component (parent component) may contain a scroll bar component. The CEditor object for the window contains pointers to each child CEditor object.

[0046] The visual programming environment tracks the first level of parent components. Each CEditor object tracks its child CEditor objects. When an event occurs (e.g. mouse button down), the programming environment passes the event to the appropriate first level component. The first level component is responsible to passing the event on the appropriate child component.

[0047] Code Table 4 is pseudocode for the class CEditor. The CEditer class inherits the CObject class. This inheritance allows connections between CEditor objects to be controlled by the connection manager. The CEditor objects are, thus, connected in a manner similar to the way the run-time objects are connected. The CEditor object includes a constructor and member function to delete an object.

[0048] Code Table 5 contains pseudocode defining CEditorUI class. The CEditorUI class provides a standard mechanism for editing connections between components and movement of components. When a programmer selects to add a component to a visual program, the programming system instantiates the object, an CEditorUI for the object, and a CEditor object for the object. In a preferred embodiment, the programmer can move a component by clicking on the component. A tracker box is drawn and the user can then drag the component to a new position.

[0049] The programming system invokes the member function Draw to request the component to draw a tracker box. The programming system invokes the member function OnMouseStart to indicate that object is being selected, the member function OnMouseDrag to indicate the new position of the tracker, and the member function OnMouseEnd to indicate that the tracking is complete. The member function OnMouseEnd invokes the member function PositionChange to pass the new position to the CEditorUI object that is specific to the component (e.g., scroll bar).

[0050] The member function MakeStdUI initializes a standard user interface for the component. The standard user interface includes a menu for selecting to delete the component, to move or size the component, or to change properties of the component. The CEditorUI provides a standard dialog for displaying available ports and current connections. For example, a list of available ports would be

[0051] Code Table 6 contains pseudocode describing the CEditPort class. This class provides member functions to manage the actual connection between components. When two ports are selected for connection, the programming system invokes the member function Connect of the output port passing the input port. The member function Connect adds the target object to the connection array of the source object and adds the input port to the list of connections for the editor object.

[0052] Code Table 7 contains pseudocode for an implementation of the CEditor class for a scroll bar component. The implementation provides a constructor for the CEScrollBar class that inherits the CEditor class. The Constructor instantiates a CEditPort object for each port for the scroll bar component. In this example, the ports are “value” and “LineUp.” The port value is a bidirectional port, that is, the member function value can be connected to an input and output port. The constructor also creates a CEScrollBarUI object. Code Table 8 contains pseudocode for the EScrollBarUI class.

[0053] FIG. 9 is a block diagram illustrating a computer system for implementing the present invention. The computer system 901 includes central processing unit 902, memory 903, storage 904, display 905, and input device 906. In a preferred embodiment, objects are instantiated in memory and persistently stored to storage. Visual programs output data to the display and input data from the input device.

[0054] Although the present has been described in terms of a preferred embodiment, it is not intended that the invention be limited to this embodiment. 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 which follow.