cprintf - display formatted colored text in the Command Window

Displays sprintf-formatted strings in the Command Window using the specified color/underline style

Description

Syntax:
     count = cprintf(style,format,...)
 
Description:
CPRINTF processes the specified text using the exact same FORMAT arguments accepted by the built-in SPRINTF and FPRINTF functions.
 
CPRINTF then displays the text in the Command Window using the specified STYLE argument. The accepted styles are those used for Matlab's syntax highlighting (see: File / Preferences / Colors / M-file Syntax Highlighting Colors), and also user-defined colors.
 
The possible pre-defined STYLE names are:
 
   'Text' - default: black
   'Keywords' - default: blue
   'Comments' - default: green
   'Strings' - default: purple
   'UnterminatedStrings' - default: dark red
   'SystemCommands' - default: orange
   'Errors' - default: light red
   'Hyperlinks' - default: underlined blue
 
   'Black','Cyan','Magenta','Blue','Green','Red','Yellow','White'
 
STYLE beginning with '-' o '_' will be underlined. For example:
   '-Blue' => underlined blue, like 'Hyperlinks'
   '_Comments' => underlined green
 
STYLE beginning with '*' will be bold (R2011b+ only). For example:
   '*Blue' is bold blue;
   '*Comments' is bold green etc.
Note: Matlab does not currently support both bold and underline, only one of them can be used in a single cprintf command. But of course bold and underline can be mixed by using separate commands.
 
STYLE also accepts a regular Matlab RGB vector, that can be negated for underlining. For example: -[0,1,1] means underlined cyan.
 
STYLE is case-insensitive and accepts unique partial strings just like handle property names.
 
Examples (see results in the attached screenshot):
   cprintf; % displays the demo

   cprintf('text', 'regular black text');
   cprintf('hyper', 'followed %s','by');
   cprintf('key', '%d colored', 4);
   cprintf('-comment','& underlined');
   cprintf('err', 'elements\n');
   cprintf('cyan', 'cyan');
   cprintf('_green', 'underlined green');
   cprintf(-[1,0,1], 'underlined magenta');
   cprintf('*blue', 'and *bold* (R2011b+ only)\n');
   cprintf([1,0.5,0],'and multi-\nline orange\n');
 
Bugs and suggestions:
Please send to Yair Altman (altmany at gmail dot com)
 
Warning:
This code heavily relies on undocumented and unsupported Matlab functionality. It works on Matlab 7+, but use at your own risk!
 
A technical description of the implementation can be found at: http://UndocumentedMatlab.com/blog/cprintf/

See details & current limitations in the main help section

Acknowledgements

This file inspired Ecopathlite: A Matlab Based Implementation Of Ecopath, Google, Set Prompt Set The Command Window Prompt, and Tcprintf : Ansi Colored Output In Terminal.

• Required Products: MATLAB
• MATLAB release: MATLAB 7.5 (R2007b)
• Other requirements: tested on Matlab 7.1, 7.5-7.12 (with a few version-specific quirks detailed in the help section). Should work on all Matlab 7 versions, but I haven't tested this.

[Barak Almog]

Awesome submission. Works perfectly on my 2012b. Thanks alot, Yair!

[Yair Altman]

Sébastien - you are using cprintf incorrectly. Firstly, the extra parameter 4 has no meaning since you are not using any printf fields (e.g. %d) in your string.

Secondly, you don't need (and actually should not use) \r - \r clears the current line to the beginning on some systems, which could explain what you are seeing.

[Sébastien MAILFERT]

Thanks for your code.
It works well with Matlab 2007 but colors are not displayed on my computer with Matlab 2012b.
The text is displayed but in white in fact.
If I write cprintf('k','test\r\n', 4), the line is written in white with a blue "-" before the string
If I write cprintf('-k','test\r\n', 4), text is displayed in blue and underscored with a blue "-" before the string.

Could you help me please?

[Karel Lebeda]

Thanks a lot!
Anyway, I have one suggestion: it doesn't turn the colouring back off unless at the end of line, e.g.:
cprintf('r', 'aaa'); fprintf('bbb')
prints everything in red...

[Christopher Redwood]

This is a fantastic submission. The bugs I have encountered pertain to R2011a. They are, as documented, a space is inserted at the front of each line, and that one must use \n at the end of each string in format. Minor inconveniences for such a good program. Great job Yair!

[Athena]

nice job! thanks.
i had problems using the function (R2012a) in a loop, colors did not work out nicely from iteration to iteration. i added fprintf('\n'); before the cprintf line and that seemed to solve, at least my problems. i also added ; to the end of all of my fprintf and cprintf lines.... that also helped.

[Grzegorz Kwiatek]

Greate submission

[Grzegorz Kwiatek]

Great submission.

[Yair Altman]

@Adam - the version that I uploaded yesterday includes support for *bold* formatting

[Patrice Tscherrig]

great!
Unfortunately on win7, R2011b 64bit

>> cprintf([255 175 0]./255, 'warning text')

does not produce the same colored text as on R2009a, WinXP, 32bit. Any idea why?

[Pio Nonus]

 

[Brian]

This is what makes Matlab fun! Thanks Yair

[Adam Wyatt]

Great.

Suggestion - can you add support for bold text to. I presume its doable since the command window already utilizes bold text.

[bedadipta]

it is just aswm.... thank u ,thank u :)

[Martin Lechner]

 

[Yair Altman]

For all the people who have noted about cprintf's issues with R2011b, the new version that was just uploaded fixes those problems, as well as the issue of the space (on R2011b only)

[Rory Adams]

You might find that changing the fprintf command on line 164 to use the standard output instead of standard error may solve your problem with the text colour

i.e. use
fprintf(1,format,varargin{:})
inplace of
fprintf(2,format,varargin{:})

[Jerry Zhou]

 

[Szilárd Németh]

A very useful function. Stopped working under R2011b (as Mark Morehead pointed it out).

Yair, do you plan to update it so that we can have this great stuff in future releases?

[Mark Morehead]

I have been using the cprintf function and find it very useful.

I just installed Matlab V 2011b (64bit) and cprintf is no longer working properly.

When I run it, I get:
>> cprintf('text', 'regular black text');
_ t>>
>>

If I highlight it, I get:
>> cprintf('text', 'regular black text');
regular black text>>
>>

So the text is printing in white. There must be a color inversion problem caused by something in the update in Matlab.

[Jon]

 

[mohammad]

 

[Danilo Zanatta]

@Yair - I've found one bug:

Since I use black background and gray text for the command window, cprintf('text', 'Hello World!\n') was showing the string in black, i.e. invisible with my configurations.

By watching around a little bit, I figured out that the text color is "saved" in the 'ColorsText' preference, so I changed the code around line 242 to:

% Regular text
elseif matches == 1
style = 'ColorsText';

Noew, when I use 'text' as style, I get *exactly* the color I have set in the preferences.

[Chandrakanth]

 

[Henry]

This function is great. I've got only one problem. If I run it on a remote machine by ssh but without X (say via Cygwin), then it reports error:

<a href=""> </a>??? Attempt to reference field of non-structure array.

Error in ==> cprintf at 156
xCmdWndView = cw.getComponent(0).getViewport.getComponent(0);

Obviously, I don't expect to see color when no display is specified. But I do want to my code platform independent. That is, if there is display, then show the colors. Otherwise, please just behave in the same way as fprintf(1, ...) (ie, please don't return error/failure).

[Andrey Kan]

 

[Matthias]

 

[Paul Macey]

 

[Reza Farrahi Moghaddam]

 

[Ben]

This helps me a lot.

However, it cannot cooperate with fprintf.
When using

cprintf('Text', '3D distance error (max):');
cprintf('Keywords', '%f\n', max(EVert));

it produces

3D distance error (max): 0.226647

Since I do not want the leading space, when trying

fprintf('3D distance error (max):');
cprintf('Keywords', '%f\n', max(EVert));

it produced

3D distance error (max):_

There is underline with the right color, but the number is in WHITE.

Could you help me out, Yair?

Best regards,
Ben

[Cedric Wannaz]

This function is great! It is in my todo list to use it, so I know almost nothing about it at this point. However, couldn't you replace the white space on line 145 with a \r for (at least partly) solving your white space issue?

fprintf('<a href="">\r</a>');

Just had a sneaky look, so I have no idea how it impacts the rest.

Best regards,

Cedric

[Yair Altman]

@James - unfortunately, blinking text is difficult to implement.

If this is sufficiently important to you, I'll be willing to develop it for you for a fee - contact me by email if this is the case.

[James Tursa]

Great work. Of course, that means I want more! Is it possible to have blinking text? I know this is generally obnoxious to use, but that is exactly what I want when I put up a warning message and a pause in a piece of code that is about to potentially crash MATLAB (a bug demonstration code).

[Evgeny Pr]

Hi!

CPRINTF in ~45 times more slowly than FPRINTF.
There is an opportunity to get rid of calling DRAWNOW in CPRINTF? This greatly reduces the performance.

[Bijit Banik]

Thanks a lot.

[Yair Altman]

Bijit - you cannot do that with cprintf, but you can do it via the text properties of the dialog box:

hDlg=helpdlg(Help_str,'Title and Authors');
hText = findall(hDlg,'type','text');
set(hText,'interpreter','tex','string','\color{red}Red text')

[Bijit Banik]

Is it possible to change the text color of a GUI dialog box text with this cprintf function? For example:

title='ANALYTICAL SOLUTIONS';
author='bijit,yair';
Help_str=char(title,author);
helpdlg(Help_str,'Title and Authors');

Now I want to see 'bijit, yair' in different color.

with thanks.

[Evgeny Pr]

 

[Yair Altman]

read the description: cprintf prints to the command prompt - NOT TO A FILE !

[Zachary Danziger]

 

[Yair Altman]

Sharron - I uploaded a new version that fixed the edge-case that you have reported

[Sharron]

This is a great tool!.
However I think the command doesn't work well in printing the back slash, for example

cprintf('Errors', '\\abc\n')

does not generate output \abc

Thanks.

[André]

 

[Rob Campbell]

Nice! Although I run almost exclusively on Unix using the -nodesktop flag. Without the Mathworks command window this function doesn't work. In fact, it generates an error. Perhaps it ought to fail gracefully?

[Rahul Prem Nazeer]

 

[bocovp]

 

[A Millo]

 

[LeFlaux]

This is a great little tool! Thank You!

[Mike]

 

[Mike]

There seems to be another bug, this one involving the '%' character. For example,

cprintf( 'keyword', '%% keyword\n' )

merely turns the command prompt (double chevron) blue, rather than printing '% keyword' and a newline character.

fprintf( '%% keyword\n' ), on the other hand, prints just what you would expect.

[Yair Altman]

@Karl - this is a corollary of the known issue with non-newline-terminated strings. In this case, the initial fprintf() was non-newline-terminated, getting cprintf confused...

A workaround for this case is to simply use cprintf for the initial black text, instead of fprintf:

cprintf('text', 'Here: ');
cprintf('blue', 'Blue\n');

[Karl]

This is great! I wish Matlab documented its Java innards better. Anyway, there seems to be another small bug.

fprintf('Here: ')
cprintf('blue', 'Blue\n');

results in a blue underscore followed by the word 'Blue' in white (invisible on white background of my command window - but shows up when highlighted).

However, the same code as above, only using '-blue' instead of 'blue', works fine (gives the expected underlined blue text).

I'm using Matlab 2007b on a Linux box.

[Alan B]

 

[Yair Altman]

yes Petter - this is a known limitation of CPRINTF that is mentioned in its help section as well as the TODO list (at the bottom of the file). Unfortunately, it seems that if there is no space separator, then Matlab attempts to combine the adjacent style segments, thereby overrunning the first segment's style with the second's. Adding a separator solves this. If anyone finds a workaround I'll be happy to hear. Until then it's a small price to pay...

[Petter]

OK, I now think that may be required.

[Petter]

The function prints an extra white space after each string. Example:

str = 'Welcome!';
n = length(str);
for k = 1:n
col = [k/n 0 0];
cprintf(col,str(k));
end
fprintf('\n');

results in:
W e l c o m e !

[Petter]

I did not know this was possible

[Aurelien Queffurust]

Tested successfully with the current release R2009a under Windows and with R2008b under Linux 64-bits. Just a great submission!

[MATLABician]

A while ago, a colleague asked me if it was possible to display in a color other than the default, in the Command Window, the values violating some thresholds in an optimization problem. My response was, "That must be doable, because MATLAB does that for, say, error messages. I will look into it." Well, you looked into it alright, Yair!

[Albert]

Great, thanks!