Mercurial > repos > public > matlab_path_manager

annotate +mpm/MatlabPathManager.m @ 25:e2c18217aee0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix some reference errors
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 18 Sep 2018 12:56:22 +0200
parents fdad9fe450c5
children 05a8b30ee4a7
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;
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
29
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
30 state.saveState();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
31
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
32 % TODO: Add savepath()
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
35 % 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
36 function unloadSubpath(obj, p)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
37 state = mpm.PersistentState(obj.stateFilePath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
38
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
39 rmpath(p);
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
40 state.subpaths.remove(p);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
41
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
42 state.saveState();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
43
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
44 % TODO: Add savepath()
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
45 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
46
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
47 % 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
48 function sp = projectSubpaths(obj, projectFolder)
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
49 try
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
50 fstr = fileread(fullfile(projectFolder, obj.projectFileName));
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
51 catch
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
52 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
53 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
54 sp = splitlines(strtrim(fstr));
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
55 end
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
56
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
57 function s = loadedSubpaths(obj)
23
0b4be0d4e207 Use new class for state management
Jonatan Werpers <jonatan@werpers.com>
parents: 19
diff changeset
58 state = mpm.PersistentState(obj.stateFilePath);
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
59 s = state.subpaths.keys();
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
60 % TODO: Make it respect order from the matlab path
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
61 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
62
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
63 function ps = matlabPath(obj)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
64 ps = split(path(), pathsep);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
65 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
66
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67 % 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
68 function s = pathStatus(obj)
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
69 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
70
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
71 % 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
72 function s = projectStatus(obj, projectFolder)
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
73 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
74
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
75 % Load all subpaths for a project
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
76 function checkin(obj, projectFolder)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
77 sp = obj.projectSubpaths(projectFolder);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
78
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
79 for i = 1:length(sp)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
80 fullSubpath = fullfile(projectFolder, sp{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
81 obj.loadSubpath(fullSubpath);
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
82 end
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
83 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
84
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
85 % Unload all subpaths for a project
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
86 function checkout(obj, projectFolder)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
87 sp = obj.projectSubpaths(projectFolder);
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
88
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
89 for i = 1:length(sp)
18
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
90 fullSubpath = fullfile(projectFolder, sp{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
91 obj.unloadSubpath(fullSubpath);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
92 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
93 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
94
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
95 % Check if the projects settings are correct
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
96 % Is the project file correct?
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
97 % The right version is in the matlab path
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
98 % 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
99 function b = verify(obj, projectFolder)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
100 mpath = obj.matlabPath();
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
101 sp = obj.projectSubpaths(projectFolder);
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
102
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
103 for i = 1:length(sp)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
104 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
105 b = false;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
106 return;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
107 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
108 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
109 b = true;
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
110
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
111 function b = isAtTop(subpath, fullsubpath, paths)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
112 for i = 1:length(paths)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
113 if ~endsWith(paths{i}, subpath)
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
114 continue
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
115 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
116
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
117 b = strcmp(fullsubpath, paths{i});
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
118 return
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
119 end
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
120
1e568093b569 Add verify method. Fix some bugs
Jonatan Werpers <jonatan@werpers.com>
parents: 17
diff changeset
121 b = false;
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
122 end
19
2e29cca20d8a Add todo to MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 18
diff changeset
123
2e29cca20d8a Add todo to MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 18
diff changeset
124 % TODO: Refactor this into several methods?
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
125 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
126
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
127 % 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
128 function clear(obj)
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
129 sp = obj.loadedSubpaths();
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
130
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
131 for i = 1:length(sp)
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
132 obj.unloadSubpath(sp{i});
17
c37f67ccabac Copy implementations into the MPM class
Jonatan Werpers <jonatan@werpers.com>
parents: 16
diff changeset
133 end
16
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
134 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
135 end
4c5d876068c2 Add stub for MatlabPathManager class
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
136 end
24
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
137
fdad9fe450c5 Move install location function into the MpM class
Jonatan Werpers <jonatan@werpers.com>
parents: 23
diff changeset
138 % TODO: Organize order of methods
25
e2c18217aee0 Fix some reference errors
Jonatan Werpers <jonatan@werpers.com>
parents: 24
diff changeset
139 % TODO: Add flag for being persistent or not? (savepath or not)