mirror of
https://github.com/vdemydiuk/mtapi.git
synced 2026-07-29 19:47:51 +00:00
Add a advanced example
It uses its own API which I packed between MTApi5 and MatLab. Possible that this is useless, but errors from the .NET assembly are more tradable.
This commit is contained in:
Christian_x7
@@ -0,0 +1 @@
|
||||
*.asv
|
||||
@@ -0,0 +1,5 @@
|
||||
function clearLogger(name)
|
||||
[~, destructor] = logging.getLogger(name);
|
||||
destructor();
|
||||
end
|
||||
|
||||
@@ -0,0 +1,590 @@
|
||||
function count = cprintf(style,format,varargin)
|
||||
% CPRINTF displays styled formatted text in the Command Window
|
||||
%
|
||||
% 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 '-' or '_' will be underlined. For example:
|
||||
% '-Blue' is underlined blue, like 'Hyperlinks';
|
||||
% '_Comments' is underlined green etc.
|
||||
%
|
||||
% 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 underlined
|
||||
% and bolded: -[0,1,1] means underlined cyan, '*[1,0,0]' is bold red.
|
||||
%
|
||||
% STYLE is case-insensitive and accepts unique partial strings just
|
||||
% like handle property names.
|
||||
%
|
||||
% CPRINTF by itself, without any input parameters, displays a demo
|
||||
%
|
||||
% Example:
|
||||
% 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([1,0.5,0],'and multi-\nline orange\n');
|
||||
% cprintf('*blue', 'and *bold* (R2011b+ only)\n');
|
||||
% cprintf('string'); % same as fprintf('string') and cprintf('text','string')
|
||||
%
|
||||
% 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:
|
||||
% <a href="http://undocumentedmatlab.com/blog/cprintf/">http://UndocumentedMatlab.com/blog/cprintf/</a>
|
||||
%
|
||||
% Limitations:
|
||||
% 1. In R2011a and earlier, a single space char is inserted at the
|
||||
% beginning of each CPRINTF text segment (this is ok in R2011b+).
|
||||
%
|
||||
% 2. In R2011a and earlier, consecutive differently-colored multi-line
|
||||
% CPRINTFs sometimes display incorrectly on the bottom line.
|
||||
% As far as I could tell this is due to a Matlab bug. Examples:
|
||||
% >> cprintf('-str','under\nline'); cprintf('err','red\n'); % hidden 'red', unhidden '_'
|
||||
% >> cprintf('str','regu\nlar'); cprintf('err','red\n'); % underline red (not purple) 'lar'
|
||||
%
|
||||
% 3. Sometimes, non newline ('\n')-terminated segments display unstyled
|
||||
% (black) when the command prompt chevron ('>>') regains focus on the
|
||||
% continuation of that line (I can't pinpoint when this happens).
|
||||
% To fix this, simply newline-terminate all command-prompt messages.
|
||||
%
|
||||
% 4. In R2011b and later, the above errors appear to be fixed. However,
|
||||
% the last character of an underlined segment is not underlined for
|
||||
% some unknown reason (add an extra space character to make it look better)
|
||||
%
|
||||
% 5. In old Matlab versions (e.g., Matlab 7.1 R14), multi-line styles
|
||||
% only affect the first line. Single-line styles work as expected.
|
||||
% R14 also appends a single space after underlined segments.
|
||||
%
|
||||
% 6. Bold style is only supported on R2011b+, and cannot also be underlined.
|
||||
%
|
||||
% Change log:
|
||||
% 2015-06-24: Fixed a few discoloration issues (some other issues still remain)
|
||||
% 2015-03-20: Fix: if command window isn't defined yet (startup) use standard fprintf as suggested by John Marozas
|
||||
% 2012-08-09: Graceful degradation support for deployed (compiled) and non-desktop applications; minor bug fixes
|
||||
% 2012-08-06: Fixes for R2012b; added bold style; accept RGB string (non-numeric) style
|
||||
% 2011-11-27: Fixes for R2011b
|
||||
% 2011-08-29: Fix by Danilo (FEX comment) for non-default text colors
|
||||
% 2011-03-04: Performance improvement
|
||||
% 2010-06-27: Fix for R2010a/b; fixed edge case reported by Sharron; CPRINTF with no args runs the demo
|
||||
% 2009-09-28: Fixed edge-case problem reported by Swagat K
|
||||
% 2009-05-28: corrected nargout behavior suggested by Andreas Gb
|
||||
% 2009-05-13: First version posted on <a href="http://www.mathworks.com/matlabcentral/fileexchange/authors/27420">MathWorks File Exchange</a>
|
||||
%
|
||||
% See also:
|
||||
% sprintf, fprintf
|
||||
|
||||
% License to use and modify this code is granted freely to all interested, as long as the original author is
|
||||
% referenced and attributed as such. The original author maintains the right to be solely associated with this work.
|
||||
|
||||
% Programmed and Copyright by Yair M. Altman: altmany(at)gmail.com
|
||||
% $Revision: 1.10 $ $Date: 2015/06/24 01:29:18 $
|
||||
|
||||
persistent majorVersion minorVersion
|
||||
if isempty(majorVersion)
|
||||
%v = version; if str2double(v(1:3)) <= 7.1
|
||||
%majorVersion = str2double(regexprep(version,'^(\d+).*','$1'));
|
||||
%minorVersion = str2double(regexprep(version,'^\d+\.(\d+).*','$1'));
|
||||
%[a,b,c,d,versionIdStrs]=regexp(version,'^(\d+)\.(\d+).*'); %#ok unused
|
||||
v = sscanf(version, '%d.', 2);
|
||||
majorVersion = v(1); %str2double(versionIdStrs{1}{1});
|
||||
minorVersion = v(2); %str2double(versionIdStrs{1}{2});
|
||||
end
|
||||
|
||||
% The following is for debug use only:
|
||||
%global docElement txt el
|
||||
if ~exist('el','var') || isempty(el), el=handle([]); end %#ok mlint short-circuit error ("used before defined")
|
||||
if nargin<1, showDemo(majorVersion,minorVersion); return; end
|
||||
if isempty(style), return; end
|
||||
if all(ishandle(style)) && length(style)~=3
|
||||
dumpElement(style);
|
||||
return;
|
||||
end
|
||||
|
||||
% Process the text string
|
||||
if nargin<2, format = style; style='text'; end
|
||||
%error(nargchk(2, inf, nargin, 'struct'));
|
||||
%str = sprintf(format,varargin{:});
|
||||
|
||||
% In compiled mode
|
||||
try useDesktop = usejava('desktop'); catch, useDesktop = false; end
|
||||
if isdeployed | ~useDesktop %#ok<OR2> - for Matlab 6 compatibility
|
||||
% do not display any formatting - use simple fprintf()
|
||||
% See: http://undocumentedmatlab.com/blog/bold-color-text-in-the-command-window/#comment-103035
|
||||
% Also see: https://mail.google.com/mail/u/0/?ui=2&shva=1#all/1390a26e7ef4aa4d
|
||||
% Also see: https://mail.google.com/mail/u/0/?ui=2&shva=1#all/13a6ed3223333b21
|
||||
count1 = fprintf(format,varargin{:});
|
||||
else
|
||||
% Else (Matlab desktop mode)
|
||||
% Get the normalized style name and underlining flag
|
||||
[underlineFlag, boldFlag, style, debugFlag] = processStyleInfo(style);
|
||||
|
||||
% Set hyperlinking, if so requested
|
||||
if underlineFlag
|
||||
format = ['<a href="">' format '</a>'];
|
||||
|
||||
% Matlab 7.1 R14 (possibly a few newer versions as well?)
|
||||
% have a bug in rendering consecutive hyperlinks
|
||||
% This is fixed by appending a single non-linked space
|
||||
if majorVersion < 7 || (majorVersion==7 && minorVersion <= 1)
|
||||
format(end+1) = ' ';
|
||||
end
|
||||
end
|
||||
|
||||
% Set bold, if requested and supported (R2011b+)
|
||||
if boldFlag
|
||||
if (majorVersion > 7 || minorVersion >= 13)
|
||||
format = ['<strong>' format '</strong>'];
|
||||
else
|
||||
boldFlag = 0;
|
||||
end
|
||||
end
|
||||
|
||||
% Get the current CW position
|
||||
cmdWinDoc = com.mathworks.mde.cmdwin.CmdWinDocument.getInstance;
|
||||
lastPos = cmdWinDoc.getLength;
|
||||
|
||||
% If not beginning of line
|
||||
bolFlag = 0; %#ok
|
||||
%if docElement.getEndOffset - docElement.getStartOffset > 1
|
||||
% Display a hyperlink element in order to force element separation
|
||||
% (otherwise adjacent elements on the same line will be merged)
|
||||
if majorVersion<7 || (majorVersion==7 && minorVersion<13)
|
||||
if ~underlineFlag
|
||||
fprintf('<a href=""> </a>'); %fprintf('<a href=""> </a>\b');
|
||||
elseif format(end)~=10 % if no newline at end
|
||||
fprintf(' '); %fprintf(' \b');
|
||||
end
|
||||
end
|
||||
%drawnow;
|
||||
bolFlag = 1;
|
||||
%end
|
||||
|
||||
% Get a handle to the Command Window component
|
||||
mde = com.mathworks.mde.desk.MLDesktop.getInstance;
|
||||
cw = mde.getClient('Command Window');
|
||||
|
||||
% Fix: if command window isn't defined yet (startup), use standard fprintf()
|
||||
if (isempty(cw))
|
||||
count1 = fprintf(format,varargin{:});
|
||||
if nargout
|
||||
count = count1;
|
||||
end
|
||||
return;
|
||||
end
|
||||
|
||||
xCmdWndView = cw.getComponent(0).getViewport.getComponent(0);
|
||||
|
||||
% Store the CW background color as a special color pref
|
||||
% This way, if the CW bg color changes (via File/Preferences),
|
||||
% it will also affect existing rendered strs
|
||||
com.mathworks.services.Prefs.setColorPref('CW_BG_Color',xCmdWndView.getBackground);
|
||||
|
||||
% Display the text in the Command Window
|
||||
% Note: fprintf(2,...) is required in order to add formatting tokens, which
|
||||
% ^^^^ can then be updated below (no such tokens when outputting to stdout)
|
||||
count1 = fprintf(2,format,varargin{:});
|
||||
|
||||
% Repaint the command window
|
||||
%awtinvoke(cmdWinDoc,'remove',lastPos,1); % TODO: find out how to remove the extra '_'
|
||||
drawnow; % this is necessary for the following to work properly (refer to Evgeny Pr in FEX comment 16/1/2011)
|
||||
xCmdWndView.repaint;
|
||||
%hListeners = cmdWinDoc.getDocumentListeners; for idx=1:numel(hListeners), try hListeners(idx).repaint; catch, end, end
|
||||
|
||||
docElement = cmdWinDoc.getParagraphElement(lastPos+1);
|
||||
if majorVersion<7 || (majorVersion==7 && minorVersion<13)
|
||||
if bolFlag && ~underlineFlag
|
||||
% Set the leading hyperlink space character ('_') to the bg color, effectively hiding it
|
||||
% Note: old Matlab versions have a bug in hyperlinks that need to be accounted for...
|
||||
%disp(' '); dumpElement(docElement)
|
||||
setElementStyle(docElement,'CW_BG_Color',1+underlineFlag,majorVersion,minorVersion); %+getUrlsFix(docElement));
|
||||
%disp(' '); dumpElement(docElement)
|
||||
el(end+1) = handle(docElement); % #ok used in debug only
|
||||
end
|
||||
|
||||
% Fix a problem with some hidden hyperlinks becoming unhidden...
|
||||
fixHyperlink(docElement);
|
||||
%dumpElement(docElement);
|
||||
end
|
||||
|
||||
% Get the Document Element(s) corresponding to the latest fprintf operation
|
||||
while docElement.getStartOffset < cmdWinDoc.getLength
|
||||
% Set the element style according to the current style
|
||||
if debugFlag, dumpElement(docElement); end
|
||||
specialFlag = underlineFlag | boldFlag;
|
||||
setElementStyle(docElement,style,specialFlag,majorVersion,minorVersion);
|
||||
if debugFlag, dumpElement(docElement); end
|
||||
docElement2 = cmdWinDoc.getParagraphElement(docElement.getEndOffset+1);
|
||||
if isequal(docElement,docElement2), break; end
|
||||
docElement = docElement2;
|
||||
end
|
||||
if debugFlag, dumpElement(docElement); end
|
||||
|
||||
% Force a Command-Window repaint
|
||||
% Note: this is important in case the rendered str was not '\n'-terminated
|
||||
xCmdWndView.repaint;
|
||||
|
||||
% The following is for debug use only:
|
||||
el(end+1) = handle(docElement); %#ok used in debug only
|
||||
%elementStart = docElement.getStartOffset;
|
||||
%elementLength = docElement.getEndOffset - elementStart;
|
||||
%txt = cmdWinDoc.getText(elementStart,elementLength);
|
||||
end
|
||||
|
||||
if nargout
|
||||
count = count1;
|
||||
end
|
||||
return; % debug breakpoint
|
||||
|
||||
% Process the requested style information
|
||||
function [underlineFlag,boldFlag,style,debugFlag] = processStyleInfo(style)
|
||||
underlineFlag = 0;
|
||||
boldFlag = 0;
|
||||
debugFlag = 0;
|
||||
|
||||
% First, strip out the underline/bold markers
|
||||
if ischar(style)
|
||||
% Styles containing '-' or '_' should be underlined (using a no-target hyperlink hack)
|
||||
%if style(1)=='-'
|
||||
underlineIdx = (style=='-') | (style=='_');
|
||||
if any(underlineIdx)
|
||||
underlineFlag = 1;
|
||||
%style = style(2:end);
|
||||
style = style(~underlineIdx);
|
||||
end
|
||||
|
||||
% Check for bold style (only if not underlined)
|
||||
boldIdx = (style=='*');
|
||||
if any(boldIdx)
|
||||
boldFlag = 1;
|
||||
style = style(~boldIdx);
|
||||
end
|
||||
if underlineFlag && boldFlag
|
||||
warning('YMA:cprintf:BoldUnderline','Matlab does not support both bold & underline')
|
||||
end
|
||||
|
||||
% Check for debug mode (style contains '!')
|
||||
debugIdx = (style=='!');
|
||||
if any(debugIdx)
|
||||
debugFlag = 1;
|
||||
style = style(~debugIdx);
|
||||
end
|
||||
|
||||
% Check if the remaining style sting is a numeric vector
|
||||
%styleNum = str2num(style); %#ok<ST2NM> % not good because style='text' is evaled!
|
||||
%if ~isempty(styleNum)
|
||||
if any(style==' ' | style==',' | style==';')
|
||||
style = str2num(style); %#ok<ST2NM>
|
||||
end
|
||||
end
|
||||
|
||||
% Style = valid matlab RGB vector
|
||||
if isnumeric(style) && length(style)==3 && all(style<=1) && all(abs(style)>=0)
|
||||
if any(style<0)
|
||||
underlineFlag = 1;
|
||||
style = abs(style);
|
||||
end
|
||||
style = getColorStyle(style);
|
||||
|
||||
elseif ~ischar(style)
|
||||
error('YMA:cprintf:InvalidStyle','Invalid style - see help section for a list of valid style values')
|
||||
|
||||
% Style name
|
||||
else
|
||||
% Try case-insensitive partial/full match with the accepted style names
|
||||
matlabStyles = {'Text','Keywords','Comments','Strings','UnterminatedStrings','SystemCommands','Errors'};
|
||||
validStyles = [matlabStyles, ...
|
||||
'Black','Cyan','Magenta','Blue','Green','Red','Yellow','White', ...
|
||||
'Hyperlinks'];
|
||||
matches = find(strncmpi(style,validStyles,length(style)));
|
||||
|
||||
% No match - error
|
||||
if isempty(matches)
|
||||
error('YMA:cprintf:InvalidStyle','Invalid style - see help section for a list of valid style values')
|
||||
|
||||
% Too many matches (ambiguous) - error
|
||||
elseif length(matches) > 1
|
||||
error('YMA:cprintf:AmbigStyle','Ambiguous style name - supply extra characters for uniqueness')
|
||||
|
||||
% Regular text
|
||||
elseif matches == 1
|
||||
style = 'ColorsText'; % fixed by Danilo, 29/8/2011
|
||||
|
||||
% Highlight preference style name
|
||||
elseif matches <= length(matlabStyles)
|
||||
style = ['Colors_M_' validStyles{matches}];
|
||||
|
||||
% Color name
|
||||
elseif matches < length(validStyles)
|
||||
colors = [0,0,0; 0,1,1; 1,0,1; 0,0,1; 0,1,0; 1,0,0; 1,1,0; 1,1,1];
|
||||
requestedColor = colors(matches-length(matlabStyles),:);
|
||||
style = getColorStyle(requestedColor);
|
||||
|
||||
% Hyperlink
|
||||
else
|
||||
style = 'Colors_HTML_HTMLLinks'; % CWLink
|
||||
underlineFlag = 1;
|
||||
end
|
||||
end
|
||||
|
||||
% Convert a Matlab RGB vector into a known style name (e.g., '[255,37,0]')
|
||||
function styleName = getColorStyle(rgb)
|
||||
intColor = int32(rgb*255);
|
||||
javaColor = java.awt.Color(intColor(1), intColor(2), intColor(3));
|
||||
styleName = sprintf('[%d,%d,%d]',intColor);
|
||||
com.mathworks.services.Prefs.setColorPref(styleName,javaColor);
|
||||
|
||||
% Fix a bug in some Matlab versions, where the number of URL segments
|
||||
% is larger than the number of style segments in a doc element
|
||||
function delta = getUrlsFix(docElement) %#ok currently unused
|
||||
tokens = docElement.getAttribute('SyntaxTokens');
|
||||
links = docElement.getAttribute('LinkStartTokens');
|
||||
if length(links) > length(tokens(1))
|
||||
delta = length(links) > length(tokens(1));
|
||||
else
|
||||
delta = 0;
|
||||
end
|
||||
|
||||
% fprintf(2,str) causes all previous '_'s in the line to become red - fix this
|
||||
function fixHyperlink(docElement)
|
||||
try
|
||||
tokens = docElement.getAttribute('SyntaxTokens');
|
||||
urls = docElement.getAttribute('HtmlLink');
|
||||
urls = urls(2);
|
||||
links = docElement.getAttribute('LinkStartTokens');
|
||||
offsets = tokens(1);
|
||||
styles = tokens(2);
|
||||
doc = docElement.getDocument;
|
||||
|
||||
% Loop over all segments in this docElement
|
||||
for idx = 1 : length(offsets)-1
|
||||
% If this is a hyperlink with no URL target and starts with ' ' and is collored as an error (red)...
|
||||
if strcmp(styles(idx).char,'Colors_M_Errors')
|
||||
character = char(doc.getText(offsets(idx)+docElement.getStartOffset,1));
|
||||
if strcmp(character,' ')
|
||||
if isempty(urls(idx)) && links(idx)==0
|
||||
% Revert the style color to the CW background color (i.e., hide it!)
|
||||
styles(idx) = java.lang.String('CW_BG_Color');
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
catch
|
||||
% never mind...
|
||||
end
|
||||
|
||||
% Set an element to a particular style (color)
|
||||
function setElementStyle(docElement,style,specialFlag, majorVersion,minorVersion)
|
||||
%global tokens links urls urlTargets % for debug only
|
||||
global oldStyles
|
||||
if nargin<3, specialFlag=0; end
|
||||
% Set the last Element token to the requested style:
|
||||
% Colors:
|
||||
tokens = docElement.getAttribute('SyntaxTokens');
|
||||
try
|
||||
styles = tokens(2);
|
||||
oldStyles{end+1} = cell(styles);
|
||||
|
||||
% Correct edge case problem
|
||||
extraInd = double(majorVersion>7 || (majorVersion==7 && minorVersion>=13)); % =0 for R2011a-, =1 for R2011b+
|
||||
%{
|
||||
if ~strcmp('CWLink',char(styles(end-hyperlinkFlag))) && ...
|
||||
strcmp('CWLink',char(styles(end-hyperlinkFlag-1)))
|
||||
extraInd = 0;%1;
|
||||
end
|
||||
hyperlinkFlag = ~isempty(strmatch('CWLink',tokens(2)));
|
||||
hyperlinkFlag = 0 + any(cellfun(@(c)(~isempty(c)&&strcmp(c,'CWLink')),cell(tokens(2))));
|
||||
%}
|
||||
|
||||
jStyle = java.lang.String(style);
|
||||
if numel(styles)==4 && isempty(char(styles(2)))
|
||||
% Attempt to fix discoloration issues - NOT SURE THAT THIS IS OK! - 24/6/2015
|
||||
styles(1) = jStyle;
|
||||
end
|
||||
styles(end-extraInd) = java.lang.String('');
|
||||
styles(end-extraInd-specialFlag) = jStyle; % #ok apparently unused but in reality used by Java
|
||||
if extraInd
|
||||
styles(end-specialFlag) = jStyle;
|
||||
end
|
||||
|
||||
oldStyles{end} = [oldStyles{end} cell(styles)];
|
||||
catch
|
||||
% never mind for now
|
||||
end
|
||||
|
||||
% Underlines (hyperlinks):
|
||||
%{
|
||||
links = docElement.getAttribute('LinkStartTokens');
|
||||
if isempty(links)
|
||||
%docElement.addAttribute('LinkStartTokens',repmat(int32(-1),length(tokens(2)),1));
|
||||
else
|
||||
%TODO: remove hyperlink by setting the value to -1
|
||||
end
|
||||
%}
|
||||
|
||||
% Correct empty URLs to be un-hyperlinkable (only underlined)
|
||||
urls = docElement.getAttribute('HtmlLink');
|
||||
if ~isempty(urls)
|
||||
urlTargets = urls(2);
|
||||
for urlIdx = 1 : length(urlTargets)
|
||||
try
|
||||
if urlTargets(urlIdx).length < 1
|
||||
urlTargets(urlIdx) = []; % '' => []
|
||||
end
|
||||
catch
|
||||
% never mind...
|
||||
a=1; %#ok used for debug breakpoint...
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
% Bold: (currently unused because we cannot modify this immutable int32 numeric array)
|
||||
%{
|
||||
try
|
||||
%hasBold = docElement.isDefined('BoldStartTokens');
|
||||
bolds = docElement.getAttribute('BoldStartTokens');
|
||||
if ~isempty(bolds)
|
||||
%docElement.addAttribute('BoldStartTokens',repmat(int32(1),length(bolds),1));
|
||||
end
|
||||
catch
|
||||
% never mind - ignore...
|
||||
a=1; %#ok used for debug breakpoint...
|
||||
end
|
||||
%}
|
||||
|
||||
return; % debug breakpoint
|
||||
|
||||
% Display information about element(s)
|
||||
function dumpElement(docElements)
|
||||
%return;
|
||||
disp(' ');
|
||||
numElements = length(docElements);
|
||||
cmdWinDoc = docElements(1).getDocument;
|
||||
for elementIdx = 1 : numElements
|
||||
if numElements > 1, fprintf('Element #%d:\n',elementIdx); end
|
||||
docElement = docElements(elementIdx);
|
||||
if ~isjava(docElement), docElement = docElement.java; end
|
||||
%docElement.dump(java.lang.System.out,1)
|
||||
disp(docElement)
|
||||
tokens = docElement.getAttribute('SyntaxTokens');
|
||||
if isempty(tokens), continue; end
|
||||
links = docElement.getAttribute('LinkStartTokens');
|
||||
urls = docElement.getAttribute('HtmlLink');
|
||||
try bolds = docElement.getAttribute('BoldStartTokens'); catch, bolds = []; end
|
||||
txt = {};
|
||||
tokenLengths = tokens(1);
|
||||
for tokenIdx = 1 : length(tokenLengths)-1
|
||||
tokenLength = diff(tokenLengths(tokenIdx+[0,1]));
|
||||
if (tokenLength < 0)
|
||||
tokenLength = docElement.getEndOffset - docElement.getStartOffset - tokenLengths(tokenIdx);
|
||||
end
|
||||
txt{tokenIdx} = cmdWinDoc.getText(docElement.getStartOffset+tokenLengths(tokenIdx),tokenLength).char; %#ok
|
||||
end
|
||||
lastTokenStartOffset = docElement.getStartOffset + tokenLengths(end);
|
||||
try
|
||||
txt{end+1} = cmdWinDoc.getText(lastTokenStartOffset, docElement.getEndOffset-lastTokenStartOffset).char; %#ok
|
||||
catch
|
||||
txt{end+1} = ''; %#ok<AGROW>
|
||||
end
|
||||
%cmdWinDoc.uiinspect
|
||||
%docElement.uiinspect
|
||||
txt = strrep(txt',sprintf('\n'),'\n');
|
||||
try
|
||||
data = [cell(tokens(2)) m2c(tokens(1)) m2c(links) m2c(urls(1)) cell(urls(2)) m2c(bolds) txt];
|
||||
if elementIdx==1
|
||||
disp(' SyntaxTokens(2,1) - LinkStartTokens - HtmlLink(1,2) - BoldStartTokens - txt');
|
||||
disp(' ==============================================================================');
|
||||
end
|
||||
catch
|
||||
try
|
||||
data = [cell(tokens(2)) m2c(tokens(1)) m2c(links) txt];
|
||||
catch
|
||||
disp([cell(tokens(2)) m2c(tokens(1)) txt]);
|
||||
try
|
||||
data = [m2c(links) m2c(urls(1)) cell(urls(2))];
|
||||
catch
|
||||
% Mtlab 7.1 only has urls(1)...
|
||||
data = [m2c(links) cell(urls)];
|
||||
end
|
||||
end
|
||||
end
|
||||
disp(data)
|
||||
end
|
||||
|
||||
% Utility function to convert matrix => cell
|
||||
function cells = m2c(data)
|
||||
%datasize = size(data); cells = mat2cell(data,ones(1,datasize(1)),ones(1,datasize(2)));
|
||||
cells = num2cell(data);
|
||||
|
||||
% Display the help and demo
|
||||
function showDemo(majorVersion,minorVersion)
|
||||
fprintf('cprintf displays formatted text in the Command Window.\n\n');
|
||||
fprintf('Syntax: count = cprintf(style,format,...); click <a href="matlab:help cprintf">here</a> for details.\n\n');
|
||||
url = 'http://UndocumentedMatlab.com/blog/cprintf/';
|
||||
fprintf(['Technical description: <a href="' url '">' url '</a>\n\n']);
|
||||
fprintf('Demo:\n\n');
|
||||
boldFlag = majorVersion>7 || (majorVersion==7 && minorVersion>=13);
|
||||
s = ['cprintf(''text'', ''regular black text'');' 10 ...
|
||||
'cprintf(''hyper'', ''followed %s'',''by'');' 10 ...
|
||||
'cprintf(''key'', ''%d colored'',' num2str(4+boldFlag) ');' 10 ...
|
||||
'cprintf(''-comment'',''& underlined'');' 10 ...
|
||||
'cprintf(''err'', ''elements:\n'');' 10 ...
|
||||
'cprintf(''cyan'', ''cyan'');' 10 ...
|
||||
'cprintf(''_green'', ''underlined green'');' 10 ...
|
||||
'cprintf(-[1,0,1], ''underlined magenta'');' 10 ...
|
||||
'cprintf([1,0.5,0], ''and multi-\nline orange\n'');' 10];
|
||||
if boldFlag
|
||||
% In R2011b+ the internal bug that causes the need for an extra space
|
||||
% is apparently fixed, so we must insert the sparator spaces manually...
|
||||
% On the other hand, 2011b enables *bold* format
|
||||
s = [s 'cprintf(''*blue'', ''and *bold* (R2011b+ only)\n'');' 10];
|
||||
s = strrep(s, ''')',' '')');
|
||||
s = strrep(s, ''',5)',' '',5)');
|
||||
s = strrep(s, '\n ','\n');
|
||||
end
|
||||
disp(s);
|
||||
eval(s);
|
||||
|
||||
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%% TODO %%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% - Fix: Remove leading space char (hidden underline '_')
|
||||
% - Fix: Find workaround for multi-line quirks/limitations
|
||||
% - Fix: Non-\n-terminated segments are displayed as black
|
||||
% - Fix: Check whether the hyperlink fix for 7.1 is also needed on 7.2 etc.
|
||||
% - Enh: Add font support
|
||||
@@ -0,0 +1,28 @@
|
||||
function [obj, deleteLogger] = getLogger(name, varargin)
|
||||
persistent loggers;
|
||||
logger_found = false;
|
||||
if ~isempty(loggers)
|
||||
for logger = loggers
|
||||
if strcmp(logger.name, name)
|
||||
obj = logger;
|
||||
logger_found = true;
|
||||
break;
|
||||
end
|
||||
end
|
||||
end
|
||||
if ~logger_found
|
||||
obj = logging.logging(name, varargin{:});
|
||||
loggers = [loggers, obj];
|
||||
end
|
||||
|
||||
deleteLogger = @() deleteLogInstance();
|
||||
|
||||
function deleteLogInstance()
|
||||
if ~logger_found
|
||||
error(['logger for file [ ' name ' ] not found'])
|
||||
end
|
||||
loggers = loggers(loggers ~= obj);
|
||||
delete(obj);
|
||||
clear('obj');
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,320 @@
|
||||
classdef logging < handle
|
||||
%LOGGING Simple logging framework.
|
||||
%
|
||||
% Author:
|
||||
% Dominique Orban <dominique.orban@gmail.com>
|
||||
% Heavily modified version of 'log4m': http://goo.gl/qDUcvZ
|
||||
%
|
||||
|
||||
properties (Constant)
|
||||
ALL = int8(0);
|
||||
TRACE = int8(1);
|
||||
DEBUG = int8(2);
|
||||
INFO = int8(3);
|
||||
WARNING = int8(4);
|
||||
ERROR = int8(5);
|
||||
CRITICAL = int8(6);
|
||||
OFF = int8(7);
|
||||
|
||||
colors_terminal = containers.Map(...
|
||||
{'normal', 'red', 'green', 'yellow', 'blue', 'brightred'}, ...
|
||||
{'%s', '\033[31m%s\033[0m', '\033[32m%s\033[0m', '\033[33m%s\033[0m', ...
|
||||
'\033[34m%s\033[0m', '\033[1;31m%s\033[0m'});
|
||||
|
||||
level_colors = containers.Map(...
|
||||
{logging.logging.INFO, logging.logging.ERROR, logging.logging.TRACE, ...
|
||||
logging.logging.WARNING, logging.logging.DEBUG, logging.logging.CRITICAL}, ...
|
||||
{'normal', 'red', 'green', 'yellow', 'blue', 'brightred'});
|
||||
|
||||
levels = containers.Map(...
|
||||
{logging.logging.ALL, logging.logging.TRACE, logging.logging.DEBUG, ...
|
||||
logging.logging.INFO, logging.logging.WARNING, logging.logging.ERROR, ...
|
||||
logging.logging.CRITICAL, logging.logging.OFF}, ...
|
||||
{'ALL', 'TRACE', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL', 'OFF'});
|
||||
end
|
||||
|
||||
properties (SetAccess=immutable)
|
||||
level_numbers;
|
||||
level_range;
|
||||
end
|
||||
|
||||
properties (SetAccess=protected)
|
||||
name;
|
||||
fullpath = 'logging.log'; % Default log file
|
||||
logfmt = '%-23s %-40s %-8s %s\n'; % Default LogFormat
|
||||
logfid = -1;
|
||||
logcolors = logging.logging.colors_terminal;
|
||||
using_terminal;
|
||||
webhook;
|
||||
instance;
|
||||
end
|
||||
|
||||
properties (Hidden,SetAccess=protected)
|
||||
datefmt_ = 'yyyy-mm-dd HH:MM:SS,FFF';
|
||||
logLevel_ = logging.logging.INFO;
|
||||
commandWindowLevel_ = logging.logging.INFO;
|
||||
end
|
||||
|
||||
properties (Dependent)
|
||||
datefmt;
|
||||
logLevel;
|
||||
commandWindowLevel;
|
||||
end
|
||||
|
||||
methods(Static)
|
||||
function [name, line] = getCallerInfo(self)
|
||||
|
||||
if nargin > 0 && self.ignoreLogging()
|
||||
name = [];
|
||||
line = [];
|
||||
return
|
||||
end
|
||||
[ST, ~] = dbstack();
|
||||
offset = min(size(ST, 1), 3);
|
||||
name = ST(offset).name;
|
||||
line = ST(offset).line;
|
||||
end
|
||||
end
|
||||
|
||||
methods
|
||||
|
||||
function setFilename(self, logPath)
|
||||
[self.logfid, message] = fopen(logPath, 'a');
|
||||
|
||||
if self.logfid < 0
|
||||
warning(['Problem with supplied logfile path: ' message]);
|
||||
self.logLevel_ = logging.logging.OFF;
|
||||
end
|
||||
|
||||
self.fullpath = logPath;
|
||||
end
|
||||
|
||||
function setCommandWindowLevel(self, level)
|
||||
self.commandWindowLevel = level;
|
||||
end
|
||||
|
||||
function setLogLevel(self, level)
|
||||
self.logLevel = level;
|
||||
end
|
||||
|
||||
function setSlackWebHook(self, WebHook)
|
||||
self.webhook = WebHook;
|
||||
end
|
||||
function setSlackInstance(self, Instance)
|
||||
self.instance = Instance;
|
||||
end
|
||||
function tf = ignoreLogging(self)
|
||||
tf = self.commandWindowLevel_ == self.OFF && self.logLevel_ == self.OFF;
|
||||
end
|
||||
|
||||
function trace(self, message,varargin)
|
||||
|
||||
sendtoslack = 0;
|
||||
if (nargin == 3 )
|
||||
if varargin{1,1} == 1
|
||||
sendtoslack = 1;
|
||||
end
|
||||
end
|
||||
|
||||
[caller_name, ~] = self.getCallerInfo(self);
|
||||
self.writeLog(self.TRACE, caller_name, message,sendtoslack);
|
||||
end
|
||||
|
||||
function debug(self, message,varargin)
|
||||
sendtoslack = 0;
|
||||
if (nargin == 3 )
|
||||
if varargin{1,1} == 1
|
||||
sendtoslack = 1;
|
||||
end
|
||||
end
|
||||
[caller_name, ~] = self.getCallerInfo(self);
|
||||
self.writeLog(self.DEBUG, caller_name, message,sendtoslack);
|
||||
end
|
||||
|
||||
function info(self, message,varargin)
|
||||
sendtoslack = 0;
|
||||
if (nargin == 3 )
|
||||
if varargin{1,1} == 1
|
||||
sendtoslack = 1;
|
||||
end
|
||||
end
|
||||
|
||||
[caller_name, ~] = self.getCallerInfo(self);
|
||||
self.writeLog(self.INFO, caller_name, message,sendtoslack);
|
||||
end
|
||||
|
||||
function warn(self, message,varargin)
|
||||
sendtoslack = 0;
|
||||
if (nargin == 3 )
|
||||
if varargin{1,1} == 1
|
||||
sendtoslack = 1;
|
||||
end
|
||||
end
|
||||
[caller_name, ~] = self.getCallerInfo(self);
|
||||
self.writeLog(self.WARNING, caller_name, message,sendtoslack);
|
||||
end
|
||||
|
||||
function error(self, message,varargin)
|
||||
sendtoslack = 0;
|
||||
if (nargin == 3 )
|
||||
if varargin{1,1} == 1
|
||||
sendtoslack = 1;
|
||||
end
|
||||
end
|
||||
[caller_name, ~] = self.getCallerInfo(self);
|
||||
self.writeLog(self.ERROR, caller_name, message,sendtoslack);
|
||||
end
|
||||
|
||||
function critical(self, message,varargin)
|
||||
sendtoslack = 0;
|
||||
if (nargin == 3 )
|
||||
if varargin{1,1} == 1
|
||||
sendtoslack = 1;
|
||||
end
|
||||
end
|
||||
[caller_name, ~] = self.getCallerInfo(self);
|
||||
self.writeLog(self.CRITICAL, caller_name, message,sendtoslack);
|
||||
end
|
||||
|
||||
function self = logging(name, varargin)
|
||||
levelkeys = self.levels.keys;
|
||||
self.level_numbers = containers.Map(self.levels.values, levelkeys);
|
||||
levelkeys = cell2mat(self.levels.keys);
|
||||
self.level_range = [min(levelkeys), max(levelkeys)];
|
||||
|
||||
p = inputParser();
|
||||
p.addRequired('name', @ischar);
|
||||
p.addParameter('path', '', @ischar);
|
||||
p.addParameter('logLevel', self.logLevel);
|
||||
p.addParameter('commandWindowLevel', self.commandWindowLevel);
|
||||
p.addParameter('datefmt', self.datefmt_);
|
||||
p.parse(name, varargin{:});
|
||||
r = p.Results;
|
||||
|
||||
self.name = r.name;
|
||||
self.commandWindowLevel = r.commandWindowLevel;
|
||||
self.datefmt = r.datefmt;
|
||||
if ~isempty(r.path)
|
||||
self.setFilename(r.path); % Opens the log file.
|
||||
self.logLevel = r.logLevel;
|
||||
else
|
||||
self.logLevel_ = logging.logging.OFF;
|
||||
end
|
||||
% Use terminal logging if swing is disabled in matlab environment.
|
||||
swingError = javachk('swing');
|
||||
self.using_terminal = (~ isempty(swingError) && strcmp(swingError.identifier, 'MATLAB:javachk:thisFeatureNotAvailable')) || ~desktop('-inuse');
|
||||
end
|
||||
|
||||
function delete(self)
|
||||
if self.logfid > -1
|
||||
fclose(self.logfid);
|
||||
end
|
||||
end
|
||||
|
||||
function writeLog(self, level, caller, message, sendtoslack)
|
||||
level = self.getLevelNumber(level);
|
||||
if self.commandWindowLevel_ <= level || self.logLevel_ <= level
|
||||
timestamp = datestr(now, self.datefmt_);
|
||||
levelStr = logging.logging.levels(level);
|
||||
|
||||
|
||||
|
||||
logline = sprintf(self.logfmt, timestamp, caller, levelStr, self.getMessage(message));
|
||||
end
|
||||
|
||||
if sendtoslack
|
||||
|
||||
level = self.getLevelNumber(level);
|
||||
|
||||
timestamp = datestr(now, self.datefmt_);
|
||||
levelStr = logging.logging.levels(level);
|
||||
|
||||
|
||||
slacklogline = sprintf(self.logfmt, timestamp, caller, levelStr, self.getMessage(message));
|
||||
|
||||
SendSlackNotification(self.webhook,strcat(self.instance,' : ', slacklogline));
|
||||
|
||||
|
||||
end
|
||||
|
||||
if self.commandWindowLevel_ <= level
|
||||
if self.using_terminal
|
||||
level_color = self.level_colors(level);
|
||||
else
|
||||
level_color = self.level_colors(logging.logging.INFO);
|
||||
end
|
||||
fprintf(self.logcolors(level_color), logline);
|
||||
end
|
||||
|
||||
if self.logLevel_ <= level && self.logfid > -1
|
||||
fprintf(self.logfid, logline);
|
||||
end
|
||||
end
|
||||
|
||||
function set.datefmt(self, fmt)
|
||||
try
|
||||
datestr(now(), fmt);
|
||||
catch
|
||||
error('Invalid date format');
|
||||
end
|
||||
self.datefmt_ = fmt;
|
||||
end
|
||||
|
||||
function fmt = get.datefmt(self)
|
||||
fmt = self.datefmt_;
|
||||
end
|
||||
|
||||
function set.logLevel(self, level)
|
||||
level = self.getLevelNumber(level);
|
||||
if level > logging.logging.OFF || level < logging.logging.ALL
|
||||
error('invalid logging level');
|
||||
end
|
||||
self.logLevel_ = level;
|
||||
end
|
||||
|
||||
function level = get.logLevel(self)
|
||||
level = self.logLevel_;
|
||||
end
|
||||
|
||||
function set.commandWindowLevel(self, level)
|
||||
self.commandWindowLevel_ = self.getLevelNumber(level);
|
||||
end
|
||||
|
||||
function level = get.commandWindowLevel(self)
|
||||
level = self.commandWindowLevel_;
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
||||
methods (Hidden)
|
||||
function level = getLevelNumber(self, level)
|
||||
% LEVEL = GETLEVELNUMBER(LEVEL)
|
||||
%
|
||||
% Converts charecter-based level names to level numbers
|
||||
% used internally by logging.
|
||||
%
|
||||
% If given a number, it makes sure the number is valid
|
||||
% then returns it unchanged.
|
||||
%
|
||||
% This allows users to specify levels by name or number.
|
||||
if isinteger(level) && self.level_range(1) <= level && level <= self.level_range(2)
|
||||
return
|
||||
else
|
||||
level = self.level_numbers(level);
|
||||
end
|
||||
end
|
||||
|
||||
function message = getMessage(~, message)
|
||||
|
||||
if isa(message, 'function_handle')
|
||||
message = message();
|
||||
end
|
||||
[rows, ~] = size(message);
|
||||
if rows > 1
|
||||
message = sprintf('\n %s', evalc('disp(message)'));
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,41 @@
|
||||
function testspeed(logPath)
|
||||
|
||||
opts.path = logPath;
|
||||
L = logging.getLogger('testlogger', opts);
|
||||
|
||||
L.setCommandWindowLevel(L.TRACE);
|
||||
L.setLogLevel(L.OFF);
|
||||
tic;
|
||||
for i=1:1e3
|
||||
L.trace('test');
|
||||
end
|
||||
disp('1e3 logs when logging only to command window');
|
||||
toc;
|
||||
|
||||
L.setCommandWindowLevel(L.OFF);
|
||||
L.setLogLevel(L.OFF);
|
||||
tic;
|
||||
for i=1:1e3
|
||||
L.trace('test');
|
||||
end
|
||||
disp('1e3 logs when logging is off');
|
||||
toc;
|
||||
|
||||
L.setCommandWindowLevel(L.OFF);
|
||||
L.setLogLevel(L.TRACE);
|
||||
tic;
|
||||
for i=1:1e3
|
||||
L.trace('test');
|
||||
end
|
||||
disp('1e3 logs when logging to file');
|
||||
toc;
|
||||
L.setCommandWindowLevel(L.OFF);
|
||||
L.setLogLevel(L.TRACE);
|
||||
|
||||
tic;
|
||||
for i=1:1e3
|
||||
L.trace(@() 'test');
|
||||
end
|
||||
disp('1e3 logs when logging to file using function handle');
|
||||
toc;
|
||||
end
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2016 optimizers
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,154 @@
|
||||
# Logging for Matlab
|
||||
|
||||
This simple logging module is a modification of [`log4m`](http://goo.gl/qDUcvZ)
|
||||
with the following improvements:
|
||||
|
||||
* multiple loggers can be created and retrieved by name (à la Python)
|
||||
* different logging levels appear in different colors if using Matlab in the terminal
|
||||
|
||||
Each logger's output can be directed to the standard output and/or to a file.
|
||||
|
||||
Each logger is assigned a logging level that will control the amount of output.
|
||||
The possible levels are, from high to low:
|
||||
|
||||
* ALL (highest)
|
||||
* TRACE
|
||||
* DEBUG
|
||||
* INFO (default)
|
||||
* WARNING
|
||||
* ERROR
|
||||
* CRITICAL
|
||||
* OFF (lowest)
|
||||
|
||||
The default level in INFO.
|
||||
If a logger outputs at a level lower than or equal to its assigned level, the output will be logged.
|
||||
To silence a logger, set its level to OFF.
|
||||
|
||||
All loggers output a string according to the Matlab format `'%-s %-23s %-8s %s\n'`.
|
||||
Note that a newline is always appended, so there is no need to terminate log lines
|
||||
with a newline.
|
||||
The format is as follows:
|
||||
* `%-s` is used to display the caller name, i.e., the function or method in which
|
||||
logging occured
|
||||
* `%-23s` is used for a time stamp of the form `2016-09-14 14:23:44,271`
|
||||
* `%-8s` is used for the logging level
|
||||
* `%s` is used for the message to be logged.
|
||||
|
||||
## API
|
||||
|
||||
An instance of the `logging` class is created using the `logging.getLogger` function.
|
||||
The first argument for this function must be the name of the logger. Four additional
|
||||
optional arguments are also available. These can either be provided as name/value
|
||||
pairs (such as `logger.getlogger(name, 'path', path)`) or as a struct where the
|
||||
field names are the names of the argument (such as `logger.getlogger(name, struct('path', path)`).
|
||||
The available arguments are:
|
||||
|
||||
* `path`: The path to the log file. If this is not specified or is an empty string,
|
||||
then logging to a file is disabled.
|
||||
This must be a string.
|
||||
* `logLevel`: set the file log level.
|
||||
Only log entries with a level greater than or equal to this level will be saved.
|
||||
This can either be a string or an integer.
|
||||
Note that this argument will be ignored if `path` is empty or not specified.
|
||||
* `commandWindowLevel`: set the command window log level.
|
||||
Only log entries with a level greater than or equal to this level will be displayed.
|
||||
This can either be a string or an integer.
|
||||
* `datefmt`: the date/time format string.
|
||||
This contains the date/time format string used by the logs.
|
||||
The format must be compatible with the built-in `datestr` function.
|
||||
This must be a string.
|
||||
|
||||
If `logger` is an instance of the `logging` class, the following methods can be used
|
||||
to log output at different levels:
|
||||
|
||||
* `logger.trace(string)`: output `string` at level TRACE.
|
||||
This level is mostly used to trace a code path.
|
||||
* `logger.debug(string)`: output `string` at level DEBUG.
|
||||
This level is mostly used to log debugging output that may help identify an issue
|
||||
or verify correctness by inspection.
|
||||
* `logger.info(string)`: output `string` at level INFO.
|
||||
This level is intended for general user messages about the progress of the program.
|
||||
* `logger.warn(string)`: output `string` at level WARNING (unrelated to Matlab's `warning()` function).
|
||||
This level is used to alert the user of a possible problem.
|
||||
* `logger.error(string)`: output `string` at level ERROR (unrelated to Matlab's `error()` function).
|
||||
This level is used for non-critical errors that can endanger correctness.
|
||||
* `logger.critical(string)`: output `string` at level CRITICAL
|
||||
This level is used for critical errors that definitely endanger correctness.
|
||||
|
||||
The following utility methods are also available:
|
||||
|
||||
* `logger.setFileName(string)`: set the log file to `string`.
|
||||
This can be used to specify or change the file logs are saved to.
|
||||
* `logger.setCommandWindowLevel(level)`: set the command window log level to `level`.
|
||||
Only log entries with a level greater than or equal to `level` will be displayed.
|
||||
`level` can either be a string or an integer.
|
||||
* `logger.setLogLevel(level)`: set the file log level to `level`.
|
||||
Only log entries with a level greater than or equal to `level` will be saved.
|
||||
`level` can either be a string or an integer.
|
||||
Note that even if the level is changed, nothing will be written if a valid
|
||||
filename has not been set for the log.
|
||||
|
||||
The following properties can be read or written:
|
||||
|
||||
* `logger.datefmt`: the date/time format string.
|
||||
This contains the date/time format string used by the logs.
|
||||
The format must be compatible with the built-in `datestr` function.
|
||||
* `logger.commandWindowLevel`: the command window log level.
|
||||
Only log entries with a level greater than or equal to `level` will be displayed.
|
||||
It can be set with either a string or an integer, but will always return an integer.
|
||||
* `logger.logLevel`: the file log level.
|
||||
Only log entries with a level greater than or equal to `level` will be saved.
|
||||
It can be set with either a string or an integer, but will always return an integer.
|
||||
|
||||
The following properties are read-only (note that these are called in a different way):
|
||||
|
||||
* `logging.logging.ALL`: The integer value for the `ALL` level (0).
|
||||
* `logging.logging.TRACE`: The integer value for the `TRACE` level (1).
|
||||
* `logging.logging.DEBUG`: The integer value for the `DEBUG` level (2).
|
||||
* `logging.logging.INFO`: The integer value for the `INFO` level (3).
|
||||
* `logging.logging.WARNING`: The integer value for the `WARNING` level (4).
|
||||
* `logging.logging.ERROR`: The integer value for the `ERROR` level (5).
|
||||
* `logging.logging.CRITICAL`: The integer value for the `CRITICAL` level (6).
|
||||
* `logging.logging.OFF`: The integer value for the `OFF` level (6).
|
||||
Note that there is no corresponding write method for this level,
|
||||
so if this level is set no logging will take place.
|
||||
|
||||
## Examples
|
||||
|
||||
A logger at default level INFO logs messages at levels INFO, WARNING, ERROR and CRITICAL, but not at levels TRACE or DEBUG:
|
||||
|
||||
```matlab
|
||||
>> addpath('/path/to/logging4matlab')
|
||||
>> logger = logging.getLogger('mylogger') % new logger with default level INFO
|
||||
>> logger.info('life is just peachy')
|
||||
logging.info 2016-09-14 15:10:06,049 INFO life is just peachy
|
||||
>> logger.debug('Easy as pi! (Euclid)') % produces no output
|
||||
>> logger.critical('run away!')
|
||||
logging.critical 2016-09-14 15:12:37,652 CRITICAL run away!
|
||||
```
|
||||
|
||||
A logger's assigned level for the command window (or terminal) can be changed:
|
||||
|
||||
```matlab
|
||||
>> logger.setCommandWindowLevel(logging.logging.WARNING)
|
||||
```
|
||||
|
||||
A logger can also output to file:
|
||||
|
||||
```matlab
|
||||
>> logger2 = logging.getLogger('myotherlogger', 'path', '/tmp/logger2.log')
|
||||
>> logger.setLogLevel(logging.logging.WARNING)
|
||||
```
|
||||
|
||||
Output to either the command window or a file can be suppressed with `logging.logging.OFF`.
|
||||
|
||||
# FAQ
|
||||
|
||||
1. *Why is there no colored logging in the Matlab command window?*
|
||||
I haven't gotten around to evaluating the performance of [`cprintf`](https://goo.gl/Nw5OOy),
|
||||
which seems to be the only viable option for colored output in the command window.
|
||||
Pull request welcome!
|
||||
2. *Can I change the colors?*
|
||||
Currently, no, but feel free to submit a pull request!
|
||||
3. *Can I change the format string used by loggers?*
|
||||
Currently, no, but feel free to submit a pull request!
|
||||
Reference in New Issue
Block a user