A portion of the disclosure of this patent document may contain material that is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document or the patent disclosure, as it appears in the Patent and Trademark Office patent files or records, but otherwise reserves all copyright rights whatsoever. The following notice shall apply to this document: Copyright © 2004, Microsoft Corp.
This invention relates to software development, and more particularly to navigation between the many different items available in an integrated development environment (IDE).
Modem software is typically created with a great deal of computer automated assistance. Such assistance is commercially available in a variety of software, generally referred to as integrated development environments (IDEs). For example, MICROSOFT'S VISUAL STUDIO®, BORLAND'S C++ BUILDER®, METROWERK'S CODE WARRIOR®, and IBM'S WEBSPHERE STUDIO® are all products presently available to assist in software creation. Such products provide a range of useful functions, such as coordinating communications between multiple developers working together on large projects, assisting in the actual writing of source code, assisting in specifying how a source code file will be compiled, and providing compilers and other processes that convert a source code files and the like into executable files.
The process of developing software using an IDE is depicted in
The build process 120 may comprise any number of sub-processes 121-124. One such sub-process is typically a compiler 121. A compiler 121 is software that provides a function of reading source code and generating binary files, which may be computer-executable, or near-computer-executable files. Another build process is a linker 122. A linker supplies the appropriate location references within executable files 145, 146, 147. A plurality of properties desired for executable files 145, 146, 147 may be stored in one or more files 131-134 available to the build process 120. Thus, when the time comes to convert the original files 110a-110h into executable files 145, 146, 147, the build process has access to the build property files 131-134 governing how the build is to be conducted.
A solo developer may run an IDE on a personal computer, and perform all of the above steps on a single machine. In another scenario, a team of developers may work together on an application. In this scenario, the network of collaborating developers may look similar to
As suggested by the
Thus the central server 150 is frequently called a “Source Code Control” (SCC) engine 150. The means by which most SCC engines 150 coordinate development is through sync and check-in procedures. When a developer first retrieves existing software under development from the SCC engine 150, it is called a sync 151. A sync 151 creates a copy of the application on the developer's client computer 149. This provides the developer with an official copy of the application under development, so he or she can work with the existing features of the application. A check-in 152 occurs when the developer returns his or her modifications to the SCC engine 150; and thereby updates the official version of the application under development. A set of modifications may be subject to review prior to check-in 152. If the modifications made by a developer conflict with other modifications, then the modifications may have to be scrapped.
c presents a simplified Graphic User Interface (GUI) 171 for an exemplary IDE, with many elements that are familiar to those of skill in the art as well as most modern computer users. A plurality of selectable menu elements 172-180 allow for navigation to various functions, file destinations, tool windows, application settings, and the like. A workspace 185 presents the contents of one or more open files that can typically be modified from the GUI 171. A directory tree 181 may allow navigation to the many files associated with software under development. To find a file using a directory tree, a user can first select the most general directory level containing the file, e.g., the “source” level in
The number of files in the directory tree 181 may grow to be enormous, especially in the case of many developers working together on a large software application. With a large number of files categorized in various locations in the directory tree 181, there is a risk that a developer may not remember the path to a desired file, or that the developer will waste time finding a desired file. To assist in the speedy navigation to a desired file, an IDE GUI 171 may provide a way to automatically search for a file, such as the file search element 182 in
Typically, the file search element 182 contains a character entry space 183 for typing the name of the desired file, and a button 184 for initiating a search. The search element 182 can be incorporated into the GUI 171 in a variety of ways, such as a permanently available search box included with the other menu items 172-180, or as a floating window, as illustrated in
There are many destinations in addition to the files in a directory tree 181 that developers may wish to locate. Some of the most common additional destinations are lines of source code within a file, symbols or members of a particular class in source code, bookmarks placed in source code or other locations by a developer, and tool windows. Presently, each of these various destination types, if they can be searched for at all from an IDE GUI, are searchable only from separate search elements. In other words, presently available file search elements such as 182 cannot be used to search for a tool window, a line of source code, or anything other than a file. In order to search for a desired tool window, a developer must presently either navigate through the selectable menu elements 172-180 for the desired tool window, or remember a shortcut key for a tool window search element. To save time, many developers presently memorize a large number of shortcut key combinations for opening appropriate search elements to conduct the various common searches they perform.
d-1h are a series of flowcharts that demonstrate the minimum required action to conduct a search for various common destination types. Each flowchart 1d-1h includes a first step of opening an appropriate search element 190a-194a, a second step of entering an appropriate identification 190b-194b, and a third step of executing the search 190c-194c. Because each destination type presently requires a separate search element, the steps in flowcharts 1d-1h cannot be combined. The burden of remembering how to open a search element for a particular destination type is placed on the developer. This burden entails first discovering the existence of the search element features for an IDE, second consciously remembering the various different shortcut key combinations, third determining what kind of destination type is involved prior to invoking a search.
In light of the above described deficiencies in the art, there is a need in the industry to provide systems and methods to streamline and facilitate navigation to various destination types in IDE GUIs.
In consideration of the above-identified shortcomings of the art, the present invention provides systems and methods for navigating to multiple destination types from a single search interface element in an Integrated Development Environment (IDE) Graphical User Interface (GUI). Exemplary destination types are files, lines of code, symbols, bookmarks, and tool windows. An algorithm can be used to automatically determine a likely destination type from any characters entered into a search element. The automatically determined destination type can be prioritized in the search. The burden of specifying an appropriate type of search element is thus shifted away from the developer. An auto-complete feature can provide the developer with a selection of various destinations, which may include different destination types, when a partial identification is entered into the search element. Other advantages and features of the invention are described below.
The systems and methods for navigating to multiple destination types through a single search interface element in a development environment are further described with reference to the accompanying drawings in which:
a illustrates the prior art software development process, as may be supported by Integrated Development Environment (IDE) software, in which a plurality of files 110a-110h are created with a design tool 100, then converted into executable files 145-147 by a build process 120, and where the build process draws on a second set of files 131-134 to determine various properties of the output computer executable files 145-147.
b illustrates a typical prior art collaborative software development environment, in which a plurality of software developers coordinate their efforts through a central server.
c illustrates a prior art IDE Graphical User Interface (GUI) with a directory structure 181 for locating files and a floating window search element 182 that can search for one destination type, such as files.
d illustrates a prior art sequence of steps required for navigating to a file using a file search element in a GUI. The file search element GUI cannot be used for any other destination type.
e illustrates a prior art sequence of steps required for navigating to a code line using a code line search element in a GUI. The code line search element GUI cannot be used for any other destination type.
f illustrates a prior art sequence of steps required for navigating to a symbol using a symbol search element in a GUI. The symbol search element GUI cannot be used for any other destination type.
g illustrates a prior art sequence of steps required for navigating to a bookmark using a bookmark search element in a GUI. The bookmark search element GUI cannot be used for any other destination type.
h illustrates a prior art sequence of steps required for navigating to a tool window using a tool window search element in a GUI. The tool window search element GUI cannot be used for any other destination type.
a is a block diagram broadly representing the basic features of an exemplary prior art computing device suitable for use in conjunction with various aspects of the invention;
b is a block diagram representing a more detailed exemplary prior art computing device suitable for use in conjunction with various aspects of the invention;
c illustrates an exemplary prior art networked computing environment in which may computerized processes, including those of the invention, may be implemented;
Certain specific details are set forth in the following description and figures to provide a thorough understanding of various embodiments of the invention. Certain well-known details often associated with computing and software technology are not set forth in the following disclosure, however, to avoid unnecessarily obscuring the various embodiments of the invention. Further, those of ordinary skill in the relevant art will understand that they can practice other embodiments of the invention without one or more of the details described below. Finally, while various methods are described with reference to steps and sequences in the following disclosure, the description as such is for providing a clear implementation of embodiments of the invention, and the steps and sequences of steps should not be taken as required to practice this invention.
Overview
The following detailed description will generally follow the summary of the invention, as set forth above, further explaining and expanding the definitions of the various aspects and embodiments of the invention as necessary. In general, navigation is a core component of any IDE. The invention can be used to make navigation much simpler. Improvements to navigation make developers more productive in their day to day development activities.
Embodiments of the invention can provide a one-stop shop for a developer navigating around source code and tool windows. As a developer is coding, he/she can bring up a single window to perform any type of source code or tool window navigation. The developer can type in a number or a string representing a file name, a code line number, a symbol, a bookmark name, or any other source code destination. A supporting navigation engine can then automatically detect what type of navigation the developer is trying to perform, and offer completion of the number or string that the developer is entering.
Embodiments of the invention can provide completion options by accessing various data stores that may be associated with the software under development. When a developer selects a desired destination, the navigation engine can use the appropriate navigation technique to locate and display the destination. If a non-unique destination is entered, the navigation engine can navigate to a most probably desired location. For example, if a string is entered that matches a part of a file name as well as a symbol defined in a project, the navigation engine may determine that the file is the more likely desired location, and display the file location.
a,
2
b, and 2c provide a prior art computing and networked environment which will be recognized as generally suitable for use in connection with the systems and methods set forth herein. Because the material in
First described herein is a search element for navigating to multiple destination types is set forth in connection with
Characters may be entered into character entry space 301 that identify more than one destination type. For example, a file name could be entered in the character entry area 301, and the search could be executed by selecting 302 or depressing the “enter” key. The supporting navigation engine could then navigate to the identified file. At a later time, a code line identifier could be entered into the character entry area 301, and the search again executed. The supporting navigation engine could then navigate to the identified code line. Moreover, an identifier that matches both a file name and another destination, e.g., a bookmark name, could be entered into the character entry area 301, and the search again executed. The supporting navigation engine could then navigate either to the first matching destination, or to the second matching identification. The navigation engine can contain appropriate processes for determining the destination type or prioritizing among destination types, which will be explained further below.
While preferred embodiments of the invention provide a search element 300 which can manage all common destination types, other embodiments may find reason to limit the implementation of the invention to only two, three, or other limited number of destination types. For example, some embodiments of the invention may provide an IDE with two search elements: a first for navigating to files and code lines, and a second for navigating to symbols, bookmarks, and tool windows. Each of the search elements in such an embodiment would make use of the invention, because each allows search of more than one destination type.
Search element 300 is presented in
Other embodiments of a search element 300 can be, for example, that of a permanent menu item in the toolbar space of an IDE GUI, occupied in
To clarify the illustration of
The steps of
The next step is to enter any identification 401. This refers to entering identification information in a character entry area. Identification information can be entered via a range of techniques, such as cutting and pasting, or typing characters directly. In general, identification information will comprise numbers, letters, or a combination of both. An entry that consists of numbers, such as 1234 or 4321.01 is referred to in the industry as an integer, while an entry that comprises letters or a combination of letters and numbers, such as foo.cpp, or foo123 is generally referred to as a string.
While the identification entered will ultimately be used to navigate to a unique location, the original identification may not be unique. In such cases, the search element can be equipped with an auto complete to offer a plurality of unique completion options. Alternatively, the search can be configured to prioritize some navigation destinations over others. The navigation engine that supports the search element can use a range of techniques to determine what destination types will be located for a given search. For example, if an integer is entered in the character entry area, there is a high probability that the developer is searching for a line of code in an open file. Thus, the navigation engine can be configured to prioritize code lines in searches that provide integers. This will be discussed in further detail in connection with
The final step in
The auto complete feature may provide any number of identification completions, e.g., the exemplary completions “mangler.h,” “mangler.cpp” and so on in
The plurality of destination types that may be searched using the single search element 500 are displayed as 550-554. Each of 550-554 can represent a data store comprising items of a unique destination type. For example, 550 could be a list matching file identifiers to file locations, 551 could provide such a list for code lines, 552 could be for symbols, 553 could be for bookmarks, and 554 could be for tool windows. Alternatively, some destination types, e.g., code lines and bookmarks, may be kept in the same data store, e.g., 551, thereby allowing a properly conducted single search of the data store 551 to operate as a search for multiple destination types. Modern database technologies allow for storing data in a wide variety of ways, and the invention is not limited to implementations involving discrete, separate data stores. Perhaps more likely, all of the destination types may be stored in a single database and queried using one or more queries that can identify a set of one or more destination types.
The auto complete feature 502 may present a plurality of destinations, which may be of one or more destination types. For example, a first two completions offered by auto complete may be files, while a next two are symbols, and so on. In this regard, the data stores 550-554 with various destination types may be queried as characters are entered in the character entry area, to retrieve candidates for identification completion. Another source for generating auto complete options can be a specialized data store that tracks a history of items frequently used by a particular developer. This will be discussed further with reference to
When characters are entered into a character entry area, such as 501 in
The determined priority can rank order the various locations to be searched. For example, by first searching for code lines, then file names, then bookmarks, and so forth. The priority can also eliminate several destination types altogether. For example, it may be determined that some character identifications correspond only to predictable destination types, and all locations not corresponding to such destination types can be eliminated. In other embodiments, the determined priority may comprise a first, most likely location for search, and a subsequent search of all other locations without priority.
Referring back to
Auto-complete selection priority can also be determined using an algorithm such as that illustrated in
Finally with reference to
The search engine 721 can use the identification information entered in a character entry area, and determine a destination to return. The determination of a destination, in accordance with the systems and methods provided here, may be made by either prioritizing a destination type, as described with reference to
Once a destination has been determined by the search engine, the destination may be returned in a variety of ways. The manner of returning a destination may depend on the destination type. For example, if a code line is the destination type, the search engine 721 may locate the code line in an open file, and then the navigation engine 720 can move the cursor to the identified code line. The user would see the workspace change to present the area of a file containing the specified code line. If a code line in a file that is not open is identified, the navigation engine 720 could open the appropriate file in a GUI workspace such as 185 and place the cursor at the identified code line.
If a file name is identified, the search engine 721 may find the file, and then the navigation engine 720 may navigate to the file in a GUI directory structure 181 from
If a symbol is identified, a navigation engine 720 could open the file containing the symbol, and place the cursor at the beginning of the portion of the file representing the symbol. Similarly with a bookmark, the appropriate file can be opened, presented in a workspace 185, and presented such that the portion of the file with the bookmark is in the workspace.
A tool window destination may also be presented by the navigation engine 720 in a variety of ways within a GUI after the tool window is located by the search engine 721. for example, the tool window may be presented as a floating window, by opening a GUI frame with the tool window, or by presenting a new toolbar with the appropriate tools for the tool window.
The data sources 700, 710 can be any data sources. In various preferred embodiments, the data sources 700, 710 are databases. A first data source 701 may comprise data that is dynamically stored based on the actions of a developer when developing a particular software application. This data source 701 may comprise, for example, all of the destinations navigated to by a developer. It may also rank the destinations based on a number of times that the developer has navigated to them, and based on a most recent navigation to the destinations. This information may be used to determine the most likely destinations that a developer may wish to access for any given use of the single search element. Destinations that the developer navigates to frequently are more likely to be a destination for a search than destinations that are infrequently selected.
A second data source 700 may comprise an editor data store for a particular project. This data source may comprise any and all data that a developer may desire for a particular project. The invention is not limited to any particular number or type of data sources 700, 710.
Referring first to
Consider an example of the above process illustrated in
Referring to
Consider an example of the above process illustrated in
Referring to
Consider an example of the above process illustrated in
Referring to
Consider an example of the above process illustrated in
Referring to
Consider an example of the above process illustrated in
Referring to
First, a developer may open a search element capable of navigating to a variety of destinations 1300. Next, the developer can type a first character or set of characters that indicate he or she intends to navigate to a tool window, followed by characters that identify the particular desired tool window 1301. At this point, the developer can either type enough characters to make the string a unique identifier for the desired destination, or use the arrow keys to select a desired tool window from the,options presented by auto complete, and the tab key to enter the selection in the character entry area 1302. Finally, the developer can strike the “enter” key or execute the search by other means 1303. In response to executing the search, the identified tool window may be may be located and presented in the GUI, either in a floating window, in the workspace, or by some other means.
Consider an example of the above process illustrated in
Embodiments of the invention may also allow navigation forward or backward to previous or subsequent tool windows by entering certain character combinations in the character recognition area. For example, to go back to the previous window, the developer might again open the search element 1300 and type “w:” and then execute the search, knowing that it will lead to a previous tool window.
Furthermore, embodiments of the invention could be extended to map any window mnemonic to a tool window. In other words, a developer could map his or her own keys to certain tool windows. By entering the specified characters in the character recognition area, and executing the search, the desired tool window can be opened. For example, a developer could map “cv” to “w:Class View” or map “myw” to a window that they just created using an add-in they wrote.
Exemplary Computing and Network Environment
With reference to
b illustrates a somewhat more detailed example of a suitable computing device from
The invention 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 invention include, but are not limited to, personal computers, server computers, hand-held or laptop 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 invention may be implemented in the general context of computer-executable instructions, such as program modules, being executed by a computer. Generally, program modules include routines, programs, objects, components, data structures, etc. that perform particular tasks or implement particular abstract data types. The invention may also be practiced 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 both local and remote computer storage media including memory storage devices.
With reference to
Computer 241 typically includes a variety of computer readable media. Computer readable media can be any available media that can be accessed by computer 241 and includes both volatile and nonvolatile media, removable and non-removable media. By way of example, and not limitation, computer readable media may comprise computer storage media and communication media. Computer storage media includes both volatile and nonvolatile, removable and non-removable media implemented in any method or technology for storage of information such as computer readable instructions, data structures, program modules or other data. Computer storage media includes, but is not limited to, RAM, ROM, EEPROM, flash memory or other memory technology, CD-ROM, digital versatile disks (DVD) or other optical disk storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other medium which can be used to store the desired information and which can accessed by computer 241. Communication media typically embodies computer readable instructions, data structures, program modules or other data in a modulated data signal such as a carrier wave or other transport mechanism and includes any information delivery media. The term “modulated data signal” means a signal that has one or more of its characteristics set or changed in such a manner as to encode information in the signal. By way of example, and not limitation, communication media includes wired media such as a wired network or direct-wired connection, and wireless media such as acoustic, RF, infrared and other wireless media. Combinations of the any of the above should also be included within the scope of computer readable media.
The system memory 222 includes computer storage media in the form of volatile and/or nonvolatile memory such as read only memory (ROM) 223 and random access memory (RAM) 260. A basic input/output system 224 (BIOS), containing the basic routines that help to transfer information between elements within computer 241, such as during start-up, is typically stored in ROM 223. RAM 260 typically contains data and/or program modules that are immediately accessible to and/or presently being operated on by processing unit 259. By way of example, and not limitation,
The computer 241 may also include other removable/non-removable, volatile/nonvolatile computer storage media. By way of example only,
The drives and their associated computer storage media discussed above and illustrated in
The computer 241 may operate in a networked environment using logical connections to one or more remote computers, such as a remote computer 246. The remote computer 246 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 relative to the computer 241, although only a memory storage device 247 has been illustrated in
When used in a LAN networking environment, the computer 241 is connected to the LAN 245 through a network interface or adapter 237. When used in a WAN networking environment, the computer 241 typically includes a modem 250 or other means for establishing communications over the WAN 249, such as the Internet. The modem 250, which may be internal or external, may be connected to the system bus 221 via the user input interface 236, or other appropriate mechanism. In a networked environment, program modules depicted relative to the computer 241, or portions thereof, may be stored in the remote memory storage device. By way of example, and not limitation,
It should be understood that the various techniques described herein may be implemented in connection with hardware or software or, where appropriate, with a combination of both. Thus, the methods and apparatus of the present invention, or certain aspects or portions thereof, may take the form of program code (i.e., instructions) embodied in tangible media, such as floppy diskettes, CD-ROMs, hard drives, or any other machine-readable storage medium wherein, when the program code is loaded into and executed by a machine, such as a computer, the machine becomes an apparatus for practicing the invention. In the case of program code execution on programmable computers, the computing device generally includes a processor, a storage medium readable by the processor (including volatile and non-volatile memory and/or storage elements), at least one input device, and at least one output device. One or more programs that may implement or utilize the processes described in connection with the invention, e.g., through the use of an API, reusable controls, or the like. Such programs are preferably implemented in a high level procedural or object oriented programming language to communicate with a computer system. However, the program(s) can be implemented in assembly or machine language, if desired. In any case, the language may be a compiled or interpreted language, and combined with hardware implementations.
Although exemplary embodiments refer to utilizing the present invention in the context of one or more stand-alone computer systems, the invention is not so limited, but rather may be implemented in connection with any computing environment, such as a network or distributed computing environment. Still further, the present invention may be implemented in or across a plurality of processing chips or devices, and storage may similarly be effected across a plurality of devices. Such devices might include personal computers, network servers, handheld devices, supercomputers, or computers integrated into other systems such as automobiles and airplanes.
An exemplary networked computing environment is provided in
Distributed computing provides sharing of computer resources and services by exchange between computing devices and systems. These resources and services include the exchange of information, cache storage and disk storage for files. Distributed computing takes advantage of network connectivity, allowing clients to leverage their collective power to benefit the entire enterprise. In this regard, a variety of devices may have applications, objects or resources that may implicate the processes described herein.
c provides a schematic diagram of an exemplary networked or distributed computing environment. The environment comprises computing devices 271, 272, 276, and 277 as well as objects 273, 274, and 275, and database 278. Each of these entities 271, 272, 273, 274, 275, 276, 277 and 278 may comprise or make use of programs, methods, data stores, programmable logic, etc. The entities 271, 272, 273, 274, 275, 276, 277 and 278 may span portions of the same or different devices such as PDAs, audio/video devices, MP3 players, personal computers, etc. Each entity 271, 272, 273, 274, 275, 276, 277 and 278 can communicate with another entity 271, 272, 273, 274, 275, 276, 277 and 278 by way of the communications network 270. In this regard, any entity may be responsible for the maintenance and updating of a database 278 or other storage element.
This network 270 may itself comprise other computing entities that provide services to the system of
It can also be appreciated that an object, such as 275, may be hosted on another computing device 276. Thus, although the physical environment depicted may show the connected devices as computers, such illustration is merely exemplary and the physical environment may alternatively be depicted or described comprising various digital devices such as PDAs, televisions, MP3 players, etc., software objects such as interfaces, COM objects and the like.
There are a variety of systems, components, and network configurations that support distributed computing environments. For example, computing systems may be connected together by wired or wireless systems, by local networks or widely distributed networks. Currently, many networks are coupled to the Internet, which provides an infrastructure for widely distributed computing and encompasses many different networks. Any such infrastructures, whether coupled to the Internet or not, may be used in conjunction with the systems and methods provided.
A network infrastructure may enable a host of network topologies such as client/server, peer-to-peer, or hybrid architectures. The “client” is a member of a class or group that uses the services of another class or group to which it is not related. In computing, a client is a process, i.e., roughly a set of instructions or tasks, that requests a service provided by another program. The client process utilizes the requested service without having to “know” any working details about the other program or the service itself. In a client/server architecture, particularly a networked system, a client is usually a computer that accesses shared network resources provided by another computer, e.g., a server. In the example of
A server is typically, though not necessarily, a remote computer system accessible over a remote or local network, such as the Internet. The client process may be active in a first computer system, and the server process may be active in a second computer system, communicating with one another over a communications medium, thus providing distributed functionality and allowing multiple clients to take advantage of the information-gathering capabilities of the server. Any software objects may be distributed across multiple computing devices or objects.
Client(s) and server(s) communicate with one another utilizing the functionality provided by protocol layer(s). For example, Hyper Text Transfer Protocol (HTTP) is a common protocol that is used in conjunction with the World Wide Web (WWW), or “the Web.” Typically, a computer network address such as an Internet Protocol (IP) address or other reference such as a Universal Resource Locator (URL) can be used to identify the server or client computers to each other. The network address can be referred to as a URL address. Communication can be provided over a communications medium, e.g., client(s) and server(s) may be coupled to one another via TCP/IP connection(s) for high-capacity communication.
In light of the diverse computing environments that may be built according to the general framework of provided in