Home » Support » Tutorials/Power Tips » UltraEdit » Parse Source Code with the Function List
IDM Power Tips

Parse Source Code with the Function List

When coding, the Function List is one feature you can't do without... The function list displays all the functions in the active file/project. Want to jump to a specific function? Double-clicking on a function name in the list repositions the file to that function. Clearly, the Function List is indespensible for your day-to-day programming tasks...

The following Power Tip will guide you through some of the common tasks/actions for the Function List.


Open the Function List

If the Function List is not visible, you can open it from View : Views/Lists : Function List.

Function List


Navigating through code with the function list

As we'll discuss further below, the function list is populated - on a per language basis - based on regular expressions in the wordfile. The regular expressions match strings of text from your file and use that text to populate the function list.

The functions in the function list "map" to the function in the file, so you can double-click on the functions to navigate to the corresponding function in your file.

Function List


Defining the function list scope

Not only is the function list highly-flexible in what it displays, but it also provides a few configuration items that relate to how it is used.

Right-click in the function list area to view these options, you will see the following menu:

Function List

Sort

The sort option will sort the function list entries alphabetically. If you uncheck the sort, the function list items will be displayed in the order in which they appear in the file.

List for all project files

If the list for all project files option is enabled, the function list will display all functions for the project - as opposed to only the functions for the active file.

Click here to learn more about projects.

Refresh

For performance reasons, the function list data is not populated as you type. If you want to update the function list, before you save your current changes, you can select the Refresh button. Additionally, you can hit the hotkey F8 to refresh the data in the function list.

Flat list

As of UltraEdit v16.00, the function list data is displayed in a tree-view. If you wish to view the function list data as a list format, you can enable the Flat list option.


Configuring Function definitions

The Function List is highly flexible/customizable because it is populated based on regular expressions - the function strings (regular expressions) are stored in the respective wordfile.

A discussion on Regular Expressions is outside the scope of this tutorial; however, you can learn more about Regular Expressions Syntax in the Help (See "Regular Expressions") or our "Regular Expressions" Power Tip.

UltraEdit provides a dialog for configuring your Function List regualar expressions, you can access the Function List configuration dialog in Advanced : Configuration : Function List:

Function List

In the above dialog, you can view the defined groups - functions, variables, parameters, etc. If you wish to add/modify the defined groups, select the appropriate language in the language drop down box, then click on the "Modify Groups" button - this will display the Modify Groups dialog.

Add a Group

The Function List supports "grouped" items in a tree structure; therefore, you can add top-level groups and subgroups.

For our first example, we will add a top-level "imports" group to the Java language.

  1. In the Modify Groups dialog, select the top-level Groups item, then type "Imports" in the Group text field:

    Function List

  2. Now, click the Add button.
  3. Your new "Imports" group should be active (selected) in the Existing Groups box. Now you can add your Regular Expression string. To do this, double-click in the "Regular Expression to match group" field - it will become a text-entry field.

    Function List

  4. Now, paste your Regular Expression string. You should have something that looks like the following:

    Function List

    Note: In this example, we will not enter anything in the Open/Close tag fields. The Open/Close tag strings are used to define a scope - ie the scope at which the search for those strings will be executed. For example, to match parameters for a function, you might define the following Open/Close tag as "(" and ")" respectively. This would cause the regular expression to ONLY return results (matches) that occur between the "(" and ")".
  5. Click Ok
  6. You're done, the Function List will now display "Imports" - in addition to the other supported groups.

    Function List

Add a Subgroup

The process for adding a group is almost identical to the process of adding a top-level group - the only difference being that you select the group under which you wish to add the subgroup instead of the top-level "Groups" item.

As an example, consider you wish to add a subgroup under Methods for "To do's" - defined as: "//TODO: ....". The process is as follows:

  1. Select the Methods item, then type TODO in the Group text field:

    Function List

  2. Now, double-click in the "Regular expression to match group" field and type your regular expression string.
  3. As we described above, the Open/Close tag fields define the scope of the search. So, since we want to restrict "To do's" to the specific method, we will define the Open/Close tag's as "{" and "}" respectively.

    When you are done, your entry will look like the following:

    Function List

  4. Click Ok, to accept your changes.
  5. Refresh your function list, you should now see your "To Do's" in the function list under the respective Method/Function:

    Function List


Searching

As you can see, at the top of the dialog, the Function List also features a search box. If you are editing a file with many functions, you can simply type your desired function/etc and hit ENTER.

UltraEdit will locate the Function name - even expanding collapsed nodes.

Function List

Back to power tips index

Cnet/Download.com
"We won't mince words:
UltraEdit is outstanding..."

Corporate Licensing

It's easy to purchase corporate licensing from us!

  • Bulk/quantity discounts
  • Enterprise/plant/site licensing
  • Purchase with PO or invoice

The new UltraSuite

The only fully integrated solution of its kind!

Four powerful applications: UltraEdit, UltraCompare, UltraFinder, and UltraSentry!

Save over 33% when you bundle with the UltraSuite!

Power of Portable

Now supporting PortableApps!

UE/UC Mobile

Unleash the power of the total file management solution on your flash drive!