File Exchange

image thumbnail

Intelligent code completion for matlab

version 1.14 (6.04 KB) by

Code completion for the Matlab editor.

3 Downloads

Updated

View License

The Matlab editor provides an integrated code completion through the tab key. However the scope of this completion is the entire Matlab path, so the number of matches is usually large when matching a few characters. On the other hand the native Matlab code completion is sometimes too restrictive since it only matches sequential characters. I have found the more flexible matching of TextMate very convenient to use, where e.g. the string 'fcn' can be completed to 'function'. The purpose of this macro is to provide such a more flexible matching algorithm, but with scope restricted to the current document.
To use this macro you must install EditorMacro by Yair Altman, put this file (Matlab_Code_Completion_Macro.m) on your Matlab path and add the following lines to your startup.m file:
macros = EditorMacro('ctrl-space',@Matlab_Code_Completion_Macro, 'run');
 macros = EditorMacro('ctrl-alt-space',@Matlab_Code_Completion_Macro, 'run');
 macros = EditorMacro('shift-ctrl-space',@Matlab_Code_Completion_Macro, 'run');
To use the macro, type in the Matlab editor a string to be completed, e.g.,
fo
To find possible completions, press ctrl-space.
Then you get the suggested code completion
fo<<--{for}
Pressing ctrl-space once again you get the next best completion
fo<<--{function}
and pressing ctrl-space again
fo<<--{parfor}
Pressing ctrl-shift-space we step back to the previous suggestion
fo<<--{function}
and this completion is chosen by pressing ctrl-alt-space, so we get
function
Now with the caret positioned at the end of the function keyword, we press ctrl-alt-space again and get
function [
Now we can type a variable list
function [y,z
and type ctrl-alt-space again to get
function [y,z] =
Type the function name
function [z,w] = f
and press ctrl-alt-space again
function [z,w] = f(
Type a variable list
function [z,w] = f(x,y
and press ctrl-alt-space again
function [z,w] = f(x,y)
Next, you can type the function body, for example
function [z,w] = f(x,y)
       z=x+y; w=z-y;
(to get correct indentation you may need to apply the smart indent, e.g., by the shortcut ctrl-i). Finally, you can use ctrl-alt-space again to get the end statement
function [z,w] = f(x,y)
       z=x+y; w=z-y;
end
Similar completions work for if, elseif, for and while.

In conclusion, I have found this macro a valuable complement to the native Matlab code completion, and it has saved me a lot of typing and searching for variable and function names.
I hope you find it useful. Enjoy!

Comments and Ratings (4)

Yair Altman

Yair Altman (view profile)

For those interested in the Command Window issue, David Gittins posted a workaround in a comment on the EditorMacro page:
http://www.mathworks.com/matlabcentral/fileexchange/24615-editormacro

David Gittins

Les,
I had the same tab-completion issue when I tried EditorMacro. I have mentioned it on the EditorMacro page. I am running 2010a on CentOS.
D

Leif Persson

Les,
thanks for pointing out the documentation error.
I have tested with R2007b-R2009b on Win XP x64 but I couldn't
reproduce the error - tab completion in the command window
seems to work fine on my computer for all these releases.

Matlab_Code_Completion_Macro doesn't work properly in 2007a though, it seems that something in the regexp semantics changed from R2007a to R2007b.

Les Beckham

Leif:

I tried your utility and was quite impressed at first. However, it seems that it breaks tab completion for workspace variables in the command window. So, I won't be using it.

You might want to check into this and see if you can fix it.

If you find a fix I might try this again.

Note also that the suggested startup.m commands in the comment header don't work. I had to remove the single quote at the end of the function handle. Here is what I used:

macros = EditorMacro('ctrl-space',@Matlab_Code_Completion_Macro, 'run'); %#ok<NASGU>
macros = EditorMacro('ctrl-alt-space',@Matlab_Code_Completion_Macro, 'run'); %#ok<NASGU>
macros = EditorMacro('shift-ctrl-space',@Matlab_Code_Completion_Macro, 'run');

Regards
Les

Updates

1.14

Description update

1.12

Updated documentation

1.10

Bugfix for struct fields

1.9

Turned off debug print (again!)

1.8

Bug fix

1.7

Tokens in strings now excluded
Bug fixes

1.5

Cleaned up debug prints

1.4

Cleaned up debug prints

1.3

Improved sorting of code completion matches
Bugfix for comment exclusion
Added end statement as last altenative for ctrl-alt

1.2

Bug fix

1.1

Improved code completion: function and variable names within comments are now ignored

MATLAB Release
MATLAB 7.8 (R2009a)

Download apps, toolboxes, and other File Exchange content using Add-On Explorer in MATLAB.

» Watch video