Software developers generally use integrated development environments (“IDEs”) to edit, build, and debug applications. An example of an IDE is MICROSOFT VISUAL STUDIO, which is a software development tool that is provided by MICROSOFT CORPORATION. IDEs provide a user interface that developers can use to develop software components and applications. IDEs generally include developer tools, such as a source code editor, a compiler and/or interpreter, a build-automation tool, and a debugger. IDEs may also include a version control system and other tools to simplify construction of a graphical user interface (“GUI”).
IDEs can have various containers for constituents of applications, such as image files, source code files, libraries, and so forth. As examples, IDEs can have solution and project containers. A solution container can contain, among other things, one or more project containers. The project containers can contain constituents of applications. The constituents of the applications can be “built” by the IDE's developer tools (e.g., compiler), such as by translating human-readable source code to machine-executable object code. Each project container can be said to be a different project type because it can provide support for a different programming language. Examples of programming languages are C#, C++, MICROSOFT VISUAL BASIC, PERL, and so forth. A project container (or simply, “a project”) is generally defined by a project file. The project file can indicate items associated with the project, such as various properties associated with the project, files that define the components the project contains, and so forth.
Developers employ IDEs to build software components, such as controls and add-ins. A control is generally a component that a developer adds to a form to enable or enhance a user's interaction with the form. As an example, a developer can add a Portable Document Format (“PDF”) reader control to a web form so that a viewer of the web form can view a PDF document. An add-in is a component that a user can add to an application (“host application”) to supplement the host application's functionality. As an example, a user can use an add-in with a MICROSOFT OFFICE host application (e.g., MICROSOFT WORD) to create a PDF document based on contents of the host application.
The IDE starts either when a user commands it to start or when an application starts it. As an example, when an add-in encounters an unexpected or specified condition, such as when an add-in encounters an error or a specified breakpoint, it can start the IDE. A breakpoint is a point in executable code at which a user has indicated to suspend execution. When the add-in encounters an error or breakpoint, the add-in can invoke the IDE and identify a region of source code within which the error or breakpoint can be found. If the IDE is not already executing when the add-in invokes it, the IDE will start. The IDE will then locate the relevant source code and display the identified region. Alternatively, an application can start the IDE, such as when the user selects a command for editing code associated with the application. Examples of code that can be associated with an application include source code, object code, scripts, macros, and so forth.
Multiple instances of an IDE can operate simultaneously. As examples, a user and multiple applications can start instances of the IDE. A user can start MICROSOFT VISUAL STUDIO, which provides an instance of the IDE, to develop software in the MICROSOFT VISUAL C# or other programming language. The user may also be using a MICROSOFT EXCEL macro that encounters an error, which causes MICROSOFT EXCEL to start a second instance of the IDE. The second instance may provide a version of the IDE that is customized for MICROSOFT EXCEL. If the user sets a breakpoint in a MICROSOFT WORD macro that the user is developing, MICROSOFT WORD may start a third instance of the IDE that is customized for MICROSOFT WORD when execution of the macro arrives at the breakpoint. When an application starts an instance of the IDE, it may need to connect to the correct instance of the IDE, such as the instance that is customized for use with the application, and not another running instance of the IDE. By connecting to the IDE, the application can take control of the IDE, such as to employ its automation functions, retrieve debugging information, control the debugger, and so forth.
A facility is provided for connecting with an application instance. An application can connect with a selected instance of another application, such as an instance of the IDE the application starts. When an application starts an instance of the IDE, it may provide a unique identifier, such as a globally unique identifier (“GUID”), to the IDE instance. When the IDE starts, it associates the GUID it received from the application with the IDE's process. As an example, the component registers the GUID as a moniker for the IDE's process in a running object table (“ROT”). The application can then identify the IDE instance, such as by locating the GUID in the ROT, and connect to the associated running process.
This Summary is provided to introduce a selection of concepts in a simplified form that are further described below in the Detailed Description. This Summary is not intended to identify key features or essential features of the claimed subject matter, nor is it intended to be used as an aid in determining the scope of the claimed subject matter.
A facility is provided for connecting with an application instance. In various embodiments, an application can connect with a selected instance of another application, such as an instance of the IDE the application starts. When an application starts an instance of the IDE, it may provide a unique identifier, such as a globally unique identifier (“GUID”), to the IDE instance. When the IDE starts, it associates the identifier it received from the application with the IDE's process. As an example, the component registers the GUID as a moniker for the IDE's process in a running object table (“ROT”). The ROT is a table that tracks objects in the running state that can be identified by a moniker. A moniker is an identifier associated with each object in the ROT. Applications can register themselves in the ROT so that other processes can determine from the ROT which processes are running. The application can then identify the IDE instance, such as by locating the GUID in the ROT, and connect to the associated running process. As an example, the application can retrieve an object pointer stored in the ROT and invoke methods provided by the IDE via the object pointer. Thus, the facility enables an application to connect with a selected instance of another application, such as an IDE.
The facility can operate with an application proxy that is capable of customizing an integrated development environment. The application proxy may execute in-process with the integrated development environment. In various embodiments, the IDE loads the application proxy when the IDE loads a project that indicates that an application proxy should be loaded to communicate with an identified application. The application proxy can start or connect with the application and handles communications between the IDE and the identified application. The application proxy can batch or logically combine inter-process communications calls. As an example, when the application creates a toolbar button in the IDE, the application can make one inter-process communications call to the application proxy to command it to create the button. The application proxy then makes the toolbar visible if it is not, creates and positions a button, sets the button's various properties, and attaches it to the toolbar. Without the application proxy, the application would have to make several inter-process communications calls to command the IDE to take these steps, thereby decreasing performance of the IDE.
In some embodiments, a software developer that develops an application proxy can do so without having to provide logic to handle multiple project types. This is so because each project provides an indication to the IDE of the application proxies that correspond to the project. Because the IDE loads application proxies that are indicated to be associated with projects the IDE loads, the IDE will not load an application proxy that has not been identified in a project. Thus, a developer of an application proxy may not need to provide logic for handling conditions associated with a project type with which the application proxy is not designed to function. As an example, a developer of an application proxy for MICROSOFT EXCEL may not need to provide logic for handling a MICROSOFT VISUAL C++ project type.
Once the application proxy is loaded, it can customize the IDE. As examples, it can indicate menu options to show or hide; toolbars to make available or disable; windows to make visible, available, or unavailable; commands to enable or disable; colors for various portions of the IDE; positions of windows, commands, and toolbars; and so forth.
In some embodiments, the application proxy can manipulate source or object code. As examples, the application proxy can add, remove, or modify source or object code. The application proxy can add source code when, for example, the user places an object (e.g., pushbutton or other user interface control) on a form. The user could then provide additional code to hook up the source code added by the application proxy to other logic associated with the object the user added.
An application proxy can retrieve properties from a “property bag” stored in the project(s) with which the application proxy is associated. A property bag is a collection of properties. The application proxy can also store properties in these property bags and modify these properties. An example of a property is a location indicator that identifies a location from which the IDE or application proxy can retrieve additional components associated with the project. As an example, the location indicator can identify a database location, uniform resource locator (“URL”), or other location from which the IDE or application proxy can retrieve additional components.
The facility is described in more detail in reference to the Figures.
The computer 100 typically includes a variety of computer-readable media that are operable with the storage unit 106. Computer-readable media can be any available media that can be accessed by the computer 100 and include both volatile and nonvolatile media and removable and nonremovable media.
The computer 100 may operate in a networked environment using logical connections to one or more remote computers. A remote computer may be a personal computer, a server, a router, a network PC, a peer device, or other common network node, and typically includes many or all of the elements described above in relation to the computer 100. A logical connection can be made via a local area network (LAN) or a wide area network (WAN), but may also be made via other networks. Such networking environments are commonplace in homes, offices, enterprisewide computer networks, intranets, and the Internet. The computer 100 can be connected to a network through the network interface 108, such as to a wired or wireless network.
The computer 100 is only one example of a suitable computing environment and is not intended to suggest any limitation as to the scope of use or functionality of the facility. Neither should the computing system environment be interpreted as having any dependency or requirement relating to any one or a combination of the illustrated components.
The facility is operational with numerous other general purpose or special purpose computing system environments or configurations. Examples of well-known computing systems, environments, and/or configurations that may be suitable for use with the facility include, but are not limited to, personal computers, server computers, handheld or laptop devices, cellular telephones, tablet devices, multiprocessor systems, microprocessor-based systems, set-top boxes, programmable consumer electronics, network PCs, minicomputers, mainframe computers, distributed computing environments that include any of the above systems or devices, and the like.
The facility may be described in the general context of computer-executable instructions, such as program modules, that are executed by a computer. Generally, program modules include routines, programs, objects, components, data structures, and so forth that perform particular tasks or implement particular abstract data types. The facility may also be employed in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network. In a distributed computing environment, program modules may be located in local and/or remote computer storage media, including memory storage devices.
While various functionalities and data are shown in
The techniques can be described in the general context of computer-executable instructions, such as program modules, executed by one or more computers or other devices. Generally, program modules include routines, programs, objects, components, data structures, etc., that perform particular tasks or implement particular abstract data types. Typically, the functionality of the program modules may be combined or distributed as desired in various embodiments.
In some embodiments, the application may communicate with the application proxy, the IDE, or both. As an example, the application may communicate some commands to the application proxy and other commands directly to the IDE. When the application proxy is not compatible with the application, such as because they have different version numbers, the application may be able to communicate more effectively with the IDE than with the application proxy. Thus, while IDE performance may deteriorate, no functionality is lost.
Components within a process space can communicate with each other, such as by invoking each other's application program interfaces (“APIs”). As an example, the application proxy and IDE can communicate with each other. Another way a component can communicate with another component within a process space is to implement specific interfaces expected by the other component. Alternatively, the components may employ any other known mechanism for intra-process communications.
The VSTA API can employ an automation interface provided by the IDE, such as DTE API 212. DTE is the top-level automation object provided by MICROSOFT VISUAL STUDIO. Components can employ the DTE to command the IDE to take various actions, such as to open and close windows, invoke IDE commands, inject code, and so forth. VSTA is described in detail at MICROSOFT CORPORATION's web site.
The VSTA API can also employ a customization API provided by the IDE, such as the Visual Studio Industry Partners (“VSIP”) API 214 provided by MICROSOFT VISUAL STUDIO. The VSIP API provides methods to customize the IDE, such as to add or remove commands, windows, user interface elements, and so forth. VSIP is described in detail at MICROSOFT CORPORATION's web site.
Thus, the application proxy is able to customize and command the IDE on behalf of the application.
At block 304, the routine loads the indicated project.
At decision block 306, the routine determines whether the project indicates an application proxy. The project can indicate an application proxy, e.g., by including a declaration for the application proxy. In various embodiments, the application proxy can be indicated using an identifier. The following Extensible Markup Language (“XML”) declaration of a portion of a project file provides an example that identifies an application proxy:
In this example, the application proxy's identifier is identified in an “InProcHost” element. In some embodiments, a value of this element may be a globally unique identifier that uniquely identifies the application proxy. The IDE, upon receiving this identifier, can determine a location at which the application proxy can be found, such as by looking up the value in a registry, database, or other location. Because the IDE is not provided with an executable file for the application proxy directly, it is less likely that the IDE will load malicious code because the IDE loads code that was previously installed, such as by an administrator. When the location is determined by a lookup (e.g., from a registry, database, or other location), an administrator can control not only the registry or database entry but also the location from which the application proxy is loaded. Thus, insertion of malicious code can be mitigated or prevented.
In some embodiments, the project file is capable of providing executable code to the IDE, but then the IDE may load malicious code inadvertently. As an example, a user may maliciously or inadvertently insert code into a project file that the IDE will then load.
When an application proxy is installed, such as by an administrator or other user with sufficient rights, the location of the application proxy is stored, such as in a registry or database. In various embodiments, the location may be stored in several locations, so that, for example, multiple types of IDEs can access the installed application proxies. As an example, different IDEs may use different portions of a registry. In such a case the locations may be stored in several different portions of the registry.
If the project indicates an application proxy, the routine continues at block 308. Otherwise, the routine continues at block 316, where it returns.
At block 308, the routine loads the indicated application proxy. The IDE can load the indicated application proxy from the local disk or any network resource, such as a database, file server, and so forth.
At block 310, the routine completes loading the project once it has completed loading the application proxy. In various embodiments, the IDE may complete loading the project even when the application proxy has not yet been completely loaded.
At block 312, the routine sends an indication to the application proxy that project loading has completed. As an example, the routine may invoke a method provided by an API associated with the application proxy.
At block 314, the routine provides a “scoped” IDE object model to the application proxy. Scoping is a term used in the art to indicate an expansion or contraction of features that are appropriate for a given context. In various embodiments, the object model is scoped such that only commands, user interface elements, and other aspects of the IDE that are associated with the application, as indicated by the project or other configuration settings, are provided to the application proxy. By scoping the object model, components employing the object model may have access only to portions of the full object model associated with the IDE. Thus, for example, the IDE may only provide features appropriate to the loaded project.
At block 316, the routine returns.
At block 404, the routine receives a scoped IDE object model. Scoping of the IDE object model was described above in relation to
At decision block 406, the routine determines whether the IDE needs customization. As an example, the routine may determine whether the IDE needs customization based on configuration settings that are specified in the project. The routine can retrieve settings from a property bag associated with the project. The property bag can contain configuration settings or any other properties. When the IDE loads the project and instantiates an application proxy, the IDE can provide an indication of the property bag to the application proxy. If the IDE needs customization, the routine continues at block 408. Otherwise, the routine continues at block 412, where it returns.
At block 408, the routine retrieves customization information from a location identified in the project, such as in the property bag. The customization information can be stored within the property bag, elsewhere in the project file, on a database, on a file server, or elsewhere.
At block 410, the routine customizes the IDE. The routine can customize the IDE by invoking various methods provided by a VSTA API or other API associated with the IDE or facility.
At block 412, the routine returns.
At block 504, the routine starts the IDE. As an example, the routine may invoke a dynamic load library (“DLL”) or executable file associated with the IDE.
At block 506, the routine invokes a load_project subroutine provided by the IDE. The load_project subroutine was described above in relation to
At block 508, the routine waits until it receives a connection request from the application proxy or proxies indicated in the project. The application proxy can be indicated in the project file that the application identified when invoking the load_project subroutine at block 506. In various embodiments, instead of waiting for the connection request, the facility may provide an entry point that the application proxy invokes when the IDE has completed loading the project.
At block 510, the routine connects to the application proxy that sends a connection request. In so doing, the processes of the application and the IDE have established an inter-process communications channel so that the application can provide further commands to the IDE, such as via the application proxy.
At block 512, the routine waits until the application proxy indicates that it is ready. As an example, the application proxy can send an event or invoke a method provided by the application to indicate that the application proxy is ready to receive commands from the application.
At block 514, the routine collects macro recording information. In various embodiments, the application may record the information and provide the information later to the routine. The recording information is collected as the user performs various tasks in the application. As an example, the information can include keystrokes, menu commands invoked by the user, and so forth.
At block 516, the routine receives a command to stop recording. As an example, the user may indicate to the application to finish recording a macro.
At block 518, the routine provides a code document object model (“DOM”) to the application proxy. A code DOM is a structured representation of code, such as macro code that the facility collected. The code DOM that the routine provides includes the macro recording information that was collected at block 514 or provided to the routine by the application. The code DOM is a collection of commands or instructions associated with the steps the user took while recording the macro.
At block 520, the routine waits for the application proxy to render code. The application proxy may render code by invoking various methods associated with the VSTA API or other components of the facility. The code is rendered based on the macro recording information indicated by the code DOM. The application proxy can be designed specifically for use with the application, so that it has sufficient information to render code associated with commands or instructions indicated by the code DOM.
At block 522, the routine commands the application proxy to compile the code it rendered at block 520. The application proxy may, in turn, command the IDE to compile the rendered code. When code is compiled, the IDE emits an assembly. An assembly is a sequence of instructions that components associated with the operating system can invoke. As an example, the .NET framework provides a component that can load and invoke steps indicated by an assembly. In some embodiments, other components associated with the facility are also assemblies including, e.g., application proxies. In various embodiments, the facility may operate with components generated using other execution environments, such as with executable or interpretable commands. In these environments, the components may be stored as executable or other files.
At block 524, the routine loads the macro assembly created by the IDE when commanded by the logic of block 522. The user can then invoke the assembly, such as by commanding the IDE or the application. When the user invokes the macro, the macro may invoke an object model associated with the application, such as by using the application's automation object API.
At block 526, the routine returns.
At block 604, the routine requests the application proxy to start the debugger. The application proxy can command the IDE to start the debugger, such as by invoking a method associated with the VSTA API or another API associated with the facility.
At block 606, the routine provides an identifier for the application to the debugger. As an example, the routine can provide the application's process identifier (“process ID”). The debugger can use this identifier to properly associate the debugged code with the application.
At block 608, the routine suspends the code that is to be debugged. As an example, the routine suspends the add-in. In various embodiments, the routine can terminate the debugged code so that it can be restarted in the debugger.
At block 610, the routine starts the code in the debugger. The debugger can then associate the code with the application based on the identifier that was provided above by the logic associated with block 606.
At block 612, the routine returns.
The ROT can be a table or other component that applications can use to register. Registering applications can indicate an application identifier (“application ID”), process ID, moniker, and other attributes. Other applications can determine which processes have registered with the ROT, such as by searching for application IDs, monikers, or other attributes.
The application process is a process that is associated with the application that starts another application, such as an IDE. As an example, the application process can be MICROSOFT WORD, MICROSOFT EXCEL, or other application. The application process is associated with an application 704 and DTE provider 706. The application 704 comprises components associated with the application, such as dynamic link libraries (commonly referred to as “DLLs”) executable files, and so forth. A DTE provider is a component that an application can employ to communicate with an IDE. As an example, an application that desires to employ an automation mechanism, extensibility mechanism, or other features of an IDE may employ a DTE provider to do so.
The IDE process is a process that is associated with the process that application 704 starts, such as an instance of the IDE. The IDE process hosts an IDE component 712 and an application proxy component 714. The IDE component comprises one or more executable files and libraries, and implements the integrated development environment. The application proxy component is discussed above, such as in relation to
A possible flow of execution will now be described with reference to
The DTE provider may then start 716 the IDE. As an example, the DTE provider may start a VSTA component. When starting the VSTA component, the DTE provider may provide various parameters. As an example, the DTE provider may identify the application (e.g., by providing a process ID or application ID corresponding to the application that instantiated the DTE provider, name, and so forth) and a globally unique identifier (“GUID”). The DTE provider can generate the GUID, retrieve it from a table or other source, etc. The DTE provider can employ any identifier that can uniquely identify a started IDE instance, and not necessarily one that is globally unique. As an example, if the application process, IDE process, and ROT all operate on the same computer, the identifier may not be unique across all computing devices.
The IDE process may then create an object for handling communication with the DTE provider. This object can be called a DTE object (not illustrated). In various embodiments, the IDE component may itself communicate with the DTE provider. In other embodiments, the application proxy may communicate with the DTE provider. In some embodiments, the application may use a component other than the DTE provider to communicate with the IDE. The IDE process may then register 718 the IDE with the ROT and indicate the received GUID as a moniker that is associated with the IDE. In some embodiments, the IDE may register a component associated with it, such as a DTE object it creates.
The facility employs the unique identifier to uniquely identify an IDE instance that the application is to connect to so that, for example, the application does not connect to another instance of the IDE that was started by a different instance of the same or another application. As an example, two instances of MICROSOFT EXCEL may each start an instance of the IDE. In such a case, the second instance of MICROSOFT EXCEL could connect to the instance of the IDE that the first instance of MICROSOFT EXCEL started if it did not locate the IDE process corresponding to the unique identifier.
The IDE may then identify a portion of the registry that is associated with the particular IDE instance. As an example, the IDE may employ a portion of the registry associated with the application, version, or other attributes the DTE provider indicated as parameters. By employing different portions of the registry, the IDE can customize itself based on the received parameters. Thus, the registry can have multiple portions allocated for different varieties of IDEs, such as for MICROSOFT VISUAL STUDIO, MICROSOFT WORD, MICROSOFT EXCEL, or any application that employs a customized IDE.
The application may then locate 720 the GUID in the ROT. As an example, the application may search for the GUID in the ROT or employ an API provided by the ROT to locate the identified GUID. Upon doing so, the application can determine the IDE's process ID or other identifier for the instance of the IDE the application started. The application can then connect 722 to the IDE instance. As an example, the application can invoke various methods provided by an API associated with the IDE, such as to customize its features.
Although the illustrated and discussed embodiment describes an application as starting an IDE, the application can start other applications in various embodiments.
At block 804, the routine receives various parameters. As examples, the routine can receive an identification of the application that instantiated the DTE provider (e.g., a process ID, name, and so forth), version number of the IDE instance that is desired, features or functions to provide or hide, and so forth.
At block 806, the routine creates a unique identifier. As an example, the routine creates a GUID. In various embodiments, the routine can look up a unique identifier to use.
At block 808, the routine starts an IDE instance. As an example, the routine may invoke an executable file that loads various libraries (e.g., DLLs) associated with the IDE. The routine may provide an indication of the application's identifier, GUID, and so forth. In some embodiments, the routine may provide these parameters when starting the IDE. In other embodiments, such as in the illustrated embodiment at block 810, the routine may provide the parameters after starting the IDE.
At block 812, the routine may wait for the IDE to start. The routine may wait for a specified period of time or may receive a notification that the IDE has started.
At block 814, the routine locates the GUID in the ROT. As an example, the routine may cycle through all monikers in the ROT or may invoke a search routine provided by an API, such as an API associated with the ROT. Upon locating the GUID, the routine may retrieve an object pointer or process ID that the application can employ to control the IDE.
At block 816, the routine returns the object pointer or process ID the routine retrieved from the ROT.
At block 904, the routine receives parameters, such as indications of a GUID and application identifier.
At block 906, the routine registers that started instance, such as in a ROT. As an example, the routine registers the started instance's process ID, GUID, and so forth. The GUID can be registered in the ROT as the process's moniker so that other components can locate the process by its moniker.
At block 908, the routine redirects the registry. As an example, the routine causes the IDE to use a portion of the registry that is appropriate for the version or features that apply to the started instance of the IDE.
At block 910, the routine returns.
Those skilled in the art will appreciate that the logic illustrated in the flow diagrams and described above may be altered in a variety of ways. For example, the order may be rearranged, substeps may be performed in parallel, shown logic may be omitted, or other logic may be included, etc. In various embodiments, the functionality provided by the facility can be adapted in such a way that alternate components provide portions of the described logic.
Although the subject matter has been described in language specific to structural features and/or methodological acts, it is to be understood that the subject matter defined in the appended claims is not necessarily limited to the specific features or acts described above. Rather, the specific features and acts described above are disclosed as example forms of implementing the claims. Accordingly, the invention is not limited except as by the appended claims.
This patent application is related to U.S. patent application Ser. No. ______ (Attorney Docket No. 418268359US), entitled “APPLICATION PROXY,” U.S. patent application Ser. No. ______ (Attorney Docket No. 418268360US), entitled “MANAGING APPLICATION CUSTOMIZATION,” and U.S. patent application Ser. No. ______ (Attorney Docket No. 418268357US), entitled “CONTROLLING APPLICATION FEATURES,” which applications are being filed concurrently and which are hereby incorporated by reference in their entireties.