summaryrefslogtreecommitdiffstats
path: root/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/internal/core/CodanPreferencesLoader.java
blob: 38af02736280c77122842e9d8254d378985290af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*******************************************************************************
 * Copyright (c) 2009, 2010 Alena Laskavaia 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Alena Laskavaia  - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.codan.internal.core;

import org.eclipse.cdt.codan.core.CodanCorePlugin;
import org.eclipse.cdt.codan.core.model.CodanSeverity;
import org.eclipse.cdt.codan.core.model.IProblem;
import org.eclipse.cdt.codan.core.model.IProblemProfile;
import org.eclipse.cdt.codan.core.model.IProblemWorkingCopy;
import org.eclipse.cdt.codan.core.param.IProblemPreference;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.ProjectScope;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.osgi.service.prefs.Preferences;

/**
 * Helper class to load/save problem profile settings in persistent storage
 * 
 */
public class CodanPreferencesLoader {
	private IProblemProfile baseModel;

	/**
	 * Constructor
	 * 
	 * @param profile - problem profile to work with
	 */
	public CodanPreferencesLoader(IProblemProfile profile) {
		setInput(profile);
	}

	/**
	 * Default constructor
	 */
	public CodanPreferencesLoader() {
	}

	/**
	 * Sets the profile for this class
	 * 
	 * @param profile
	 */
	public void setInput(IProblemProfile profile) {
		baseModel = profile;
	}

	/**
	 * @return problems array from the profile
	 */
	public IProblem[] getProblems() {
		IProblem[] problems = baseModel.getProblems();
		return problems;
	}

	/**
	 * @param id
	 * @param s
	 */
	public void setProperty(String id, String s) {
		IProblem prob = baseModel.findProblem(id);
		if (!(prob instanceof IProblemWorkingCopy))
			return;
		String sevs = s;
		boolean enabled = true;
		if (sevs.startsWith("-")) { //$NON-NLS-1$
			sevs = sevs.substring(1);
			enabled = false;
		}
		((IProblemWorkingCopy) prob).setEnabled(enabled);
		CodanSeverity sev;
		try {
			sev = CodanSeverity.valueOf(sevs);
		} catch (RuntimeException e) {
			sev = CodanSeverity.Warning;
		}
		((IProblemWorkingCopy) prob).setSeverity(sev);
	}

	@Override
	public String toString() {
		return getInput().toString();
	}

	/**
	 * @return problem profile set for this class
	 */
	public IProblemProfile getInput() {
		return baseModel;
	}

	/**
	 * @param id - property id, which is the same as problem id
	 * @return get text representation of a "property" value for the given id,
	 *         which is severity name, with "-" in front of it it problem is
	 *         disabled.
	 */
	public String getProperty(String id) {
		IProblem prob = baseModel.findProblem(id);
		String enabled = prob.isEnabled() ? "" : "-"; //$NON-NLS-1$ //$NON-NLS-2$
		String severity = prob.getSeverity().toString();
		String res = enabled + severity;
		return res;
	}

	/**
	 * Takes string values from storePreferences and applies them to the problem
	 * profile
	 * 
	 * @param storePreferences
	 */
	public void load(Preferences storePreferences) {
		IProblem[] probs = getProblems();
		for (int i = 0; i < probs.length; i++) {
			String id = probs[i].getId();
			String s = storePreferences.get(id, null);
			if (s != null) {
				setProperty(id, s);
				setProblemPreferenceValues(id, storePreferences);
			}
		}
	}

	/**
	 * Takes string values of the problem preferences from storePreferences
	 * and applies them to the problem profile
	 * 
	 * @param problemId
	 * @param storePreferences
	 */
	private void setProblemPreferenceValues(String problemId,
			Preferences storePreferences) {
		IProblem prob = baseModel.findProblem(problemId);
		String prefKey = getPreferencesKey(problemId);
		if (prefKey == null)
			return;
		String exported = storePreferences.get(prefKey, null);
		if (exported != null) {
			//System.err.println(prefKey + " import " + exported);
			prob.getPreference().importValue(exported);
		}
	}

	/**
	 * Return preference node (osgi preferences) for the project
	 * 
	 * @param project
	 * @return project preferences node
	 */
	public static Preferences getProjectNode(IProject project) {
		if (!project.exists())
			return null;
		Preferences prefNode = new ProjectScope(project)
				.getNode(CodanCorePlugin.PLUGIN_ID);
		if (prefNode == null)
			return null;
		return prefNode;
	}

	/**
	 * Return preference node (osgi preferences) for the workspace
	 * 
	 * @return project preferences node
	 */
	public static Preferences getWorkspaceNode() {
		Preferences prefNode = new InstanceScope()
				.getNode(CodanCorePlugin.PLUGIN_ID);
		if (prefNode == null)
			return null;
		return prefNode;
	}

	/**
	 * Name of the preference key for the root problem preference in the osgi
	 * preferences
	 * 
	 * @param id - problem id
	 * @return top level preference id
	 */
	public String getPreferencesKey(String id) {
		IProblem prob = baseModel.findProblem(id);
		IProblemPreference pref = prob.getPreference();
		if (pref == null)
			return null;
		return id + "." + pref.getKey(); //$NON-NLS-1$
	}

	/**
	 * @param id - problem id
	 * @return - export value of root problem preference (to be saved in eclipse
	 *         preferences)
	 */
	public String getPreferencesString(String id) {
		IProblem prob = baseModel.findProblem(id);
		IProblemPreference pref = prob.getPreference();
		if (pref == null)
			return null;
		String str = pref.exportValue();
		//System.err.println(id + " set " + str);
		return str;
	}
}