How can I add a backup an option, addSaveCallback, to save a timestamped version of my file, to the MATLAB editor?

% I'd like to add the option to save backup files - earlier versions every time I save a file in the Matlab editor

editorObj = matlab.desktop.editor.getActive; 
editorObj.addSaveCallback(@mySaveCallback); 

function mySaveCallback(~, ~) 
disp('File has been saved!'); 
% Add your custom code here 
saveBackup(originalFilePath);
end

function saveBackup(originalFilePath)
% Check if the file exists
if ~isfile(originalFilePath)
    error('The specified file does not exist.');
end
% Extract file parts
[filePath, fileName, fileExt] = fileparts(originalFilePath);
% Create a timestamp
timestamp = datestr(now, 'yyyymmdd_HHMMSS');
% Define the backup file name
backupFileName = sprintf('%s_backup_%s%s', fileName, timestamp, fileExt);
backupFilePath = fullfile(filePath, backupFileName);
% Copy the file to create a backup
copyfile(originalFilePath, backupFilePath);
fprintf('Backup saved as: %s\n', backupFilePath);
end

[Matt J]

It appears that you have already written code to do that. It's not clear what the question is.

[dpb]

The problem is there is no such property of the returned document object...

>> editorObj = matlab.desktop.editor.getActive;
>> editorObj.addSaveCallback(@saveCallbackFunction)
Unrecognized method, property, or field 'addSaveCallback' for class 'matlab.desktop.editor.Document'. 
>> 

[Mark]

Ah yes the code looks plausible. Certainly the function saveBackup() should work, but

editorObj.addSaveCallback(@mySaveCallback); is not a real function.

An AI invented answer to my query I think.

Thanks for taking a look at the problem.

Answer 1

[dpb]

I "know nuthink!" about using the programmatic interface but it appears it doesn't have exposed properties for callback functions as do graphics objects like axes but instead you would use addlistener similarly.

The returned handle is to the document and there are no code examples for addlisteener other than one for a figure so I'm not sure just what you would use for the events...in fact, trying this locally I find

>> editorObj = matlab.desktop.editor.getActive
editorObj = 
  Document with properties:

                Filename: '...\MATLAB\Work\writeopeningbalance.m'
                  Opened: 1
                Language: 'MATLAB'
                    Text: 'function writeopeningbalance(tD,tM,fnOB)↵...
               Selection: [9.00 3.00 9.00 3.00]
            SelectedText: ''
                Modified: 0
       ExtendedSelection: [9.00 3.00 9.00 3.00]
    ExtendedSelectedText: {''}
                Editable: 1
>> events(editorObj)
Events for class matlab.desktop.editor.Document:
    ObjectBeingDestroyed
>> 

that makes it appear there is no publicly visible event for save or saveAs

I tried Yair Altman's tool to poke at object handles for hidden/undocumented properties, but it doesn't recognize the document handle so no dice there.

[dpb]

However, does seem like a reasonable enhancement.

Submit this to Mathworks as an official support or enhancement request at <Product Support Page>

The alternative would be to use a code repository to handle this topic instead.

[Mark]

Thanks for having a go at this

I was hoping I had missed something but I agree with you that there are no obvious onClose or onSave callbacks exposed for the user. I'll submit an enhancement request as you suggest.

The PC I want to run this on is so heavily locked down, I can't run a local version control such as git.

Answer 2

[Matt J]

Instead of trying to get the standard Save button to do what you want, you can make a Quick Access Toolbar button which runs your own customized save routine, as implemented in your saveBackup() code.

[dpb]

That appears to require a mouse action to use? I couldn't see a way to bind to a keystroke in the doc although I've not ever messed around with it. Doesn't seem nearly as clean a solution as would be desirable.

[Matt J]

There are 3rd party keyboard listeners you could use as well, e.g.,

https://github.com/GavriYashar/Matlab-Editor-Plugin/wiki/Setup#creating-custom-key-press-callbacks-in-editor-optional

[dpb]

No limit to what folks have done, is there?

Unfortunately, apparently for OP is under IT's thumb and if can't get them to let use git, they're probably not going to let him download/install another add-on, either. <sad>

BTW, was just curious if had missed something, not criticizing; it would be the closest that looks like can be done at present.

I do think it strange there are no other exposed events in the document editor interface, though, if going to allow programmatic control.

[Matt J]

Apparently, there are built-in keyboard shortcuts for Quick Access Toolbar buttons,

https://www.mathworks.com/matlabcentral/answers/429049-how-to-access-top-bar-favorite-commands-via-keyboard-shortcut#answer_372244

[Mark]

I like the custom save button or keyboard shortcuts options. I'll try those and report back.

[dpb]

Would be perfect if the keybindings would allow to overrule the present Ctrl-S