Mercurial > repos > public > matlab_path_manager

annotate +mpm/MatlabPathManager.m @ 27:05a8b30ee4a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make loaded paths persistent across matlab restarts
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 18 Sep 2018 13:03:53 +0200
parents e2c18217aee0
children 0842a1b2ac7e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 classdef MatlabPathManager
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 properties
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 projectFileName = '.subpaths';
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
4 stateFileName = 'state';
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 methods
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 function obj = MatlabPathManager()
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
11 function p = installLocation(obj)
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
12 nameCurrentFile = mfilename('fullpath');
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
13 pathParts = split(nameCurrentFile, filesep);
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
14
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
15 p = join(pathParts(1:end-2), filesep);
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
16 p = p{1};
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
17 end
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
18
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 function p = stateFilePath(obj)
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
20 p = fullfile(obj.installLocation(), obj.stateFileName);
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
23 % Load a given subpath into the state file and the matlab path and do savepath(), atomically
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
24 function loadSubpath(obj, p)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
25 state = mpm.PersistentState(obj.stateFilePath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
26
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
27 addpath(p);
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
28 state.subpaths(p) = true;
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
29 state.saveState();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
30
27
05a8b30ee4a7 Make loaded paths persistent across matlab restarts
Jonatan Werpers <jonatan@werpers.com>
parents: 25
diff changeset
31 savepath() % after save state to make sure saved paths are always present in the state
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
34 % Unload a given subpath from the state file and the matlab path and do savepath(), atomically
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
35 function unloadSubpath(obj, p)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
36 state = mpm.PersistentState(obj.stateFilePath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
37
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
38 rmpath(p);
27
05a8b30ee4a7 Make loaded paths persistent across matlab restarts
Jonatan Werpers <jonatan@werpers.com>
parents: 25
diff changeset
39 savepath() % before save state to make sure saved paths are always present in the state
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
40 state.subpaths.remove(p);
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
41 state.saveState();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
42 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
43
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
44 % Read project file in a folder and return cell array of all subpaths
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
45 function sp = projectSubpaths(obj, projectFolder)
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
46 try
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
47 fstr = fileread(fullfile(projectFolder, obj.projectFileName));
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
48 catch
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
49 error('Subpath definition file ''%s'' not found.', obj.projectFileName);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
50 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
51 sp = splitlines(strtrim(fstr));
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
52 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
53
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
54 function s = loadedSubpaths(obj)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
55 state = mpm.PersistentState(obj.stateFilePath);
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
56 s = state.subpaths.keys();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
57 % TODO: Make it respect order from the matlab path
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
58 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
59
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
60 function ps = matlabPath(obj)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
61 ps = split(path(), pathsep);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
62 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
63
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
64 % Return all subpaths loaded into the matlab path, mimicing the order they appear there.
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
65 function s = pathStatus(obj)
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
68 % Return all subpaths in the project and if they are active on the matlab path or not.
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
69 function s = projectStatus(obj, projectFolder)
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
70 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
71
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
72 % Load all subpaths for a project
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
73 function checkin(obj, projectFolder)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
74 sp = obj.projectSubpaths(projectFolder);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
75
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
76 for i = 1:length(sp)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
77 fullSubpath = fullfile(projectFolder, sp{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
78 obj.loadSubpath(fullSubpath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
79 end
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
80 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
81
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
82 % Unload all subpaths for a project
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
83 function checkout(obj, projectFolder)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
84 sp = obj.projectSubpaths(projectFolder);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
85
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
86 for i = 1:length(sp)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
87 fullSubpath = fullfile(projectFolder, sp{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
88 obj.unloadSubpath(fullSubpath);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
89 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
90 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
91
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
92 % Check if the projects settings are correct
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
93 % Is the project file correct?
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
94 % The right version is in the matlab path
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
95 % The right version is at the top of the path
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
96 function b = verify(obj, projectFolder)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
97 mpath = obj.matlabPath();
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
98 sp = obj.projectSubpaths(projectFolder);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
99
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
100 for i = 1:length(sp)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
101 if ~isAtTop(sp{i}, fullfile(projectFolder, sp{i}), mpath)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
102 b = false;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
103 return;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
104 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
105 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
106 b = true;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
107
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
108 function b = isAtTop(subpath, fullsubpath, paths)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
109 for i = 1:length(paths)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
110 if ~endsWith(paths{i}, subpath)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
111 continue
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
112 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
113
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
114 b = strcmp(fullsubpath, paths{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
115 return
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
116 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
117
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
118 b = false;
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
119 end
19
2e29cca20d8a Add todo to MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 18
diff changeset
120
2e29cca20d8a Add todo to MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 18
diff changeset
121 % TODO: Refactor this into several methods?
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
122 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
123
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
124 % Unload all loaded subpaths. The matlab path should be returned to it's original state
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
125 function clear(obj)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
126 sp = obj.loadedSubpaths();
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
127
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
128 for i = 1:length(sp)
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
129 obj.unloadSubpath(sp{i});
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
130 end
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
131 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
132 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
133 end
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
134
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
135 % TODO: Organize order of methods
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
136 % TODO: Add flag for being persistent or not? (savepath or not)
27
05a8b30ee4a7 Make loaded paths persistent across matlab restarts
Jonatan Werpers <jonatan@werpers.com>
parents: 25
diff changeset
137 % TODO: Make is at top a method?