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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*******************************************************************************
* Copyright (c) 2000, 2010 IBM Corporation and others.
* 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.context;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.AbstractContextProvider;
import org.eclipse.help.IContext;
import org.eclipse.help.internal.HelpPlugin;
/*
* Manages all context-sensitive help data for the help system.
*/
public class ContextManager {
private static final String EXTENSION_POINT_ID_CONTEXT = HelpPlugin.PLUGIN_ID + ".contexts"; //$NON-NLS-1$
private static final String ELEMENT_NAME_CONTEXT_PROVIDER = "contextProvider"; //$NON-NLS-1$
private static final String ATTRIBUTE_NAME_CLASS = "class"; //$NON-NLS-1$
private Map providersByPluginId;
private Map contextIDsByPluginId;
private List globalProviders;
public ContextManager()
{
if (HelpPlugin.DEBUG_CONTEXT)
checkContextProviders();
}
/*
* Returns the Context for the given id and locale.
*/
public IContext getContext(String contextId, String locale) {
if (HelpPlugin.DEBUG_CONTEXT && contextId != null) {
System.out.println("ContextManager.getContext(\"" + contextId + "\")"); //$NON-NLS-1$ //$NON-NLS-2$
}
// ask the providers
int index = contextId.lastIndexOf('.');
if (index != -1) {
String pluginId = contextId.substring(0, index);
Iterator iter = getContextProviders(pluginId).iterator();
while (iter.hasNext()) {
AbstractContextProvider provider = (AbstractContextProvider)iter.next();
try {
IContext context = provider.getContext(contextId, locale);
if (context != null) {
if (HelpPlugin.DEBUG_CONTEXT) {
System.out.println("ContextManager.getContext found context, description = \"" + context.getText() + '"'); //$NON-NLS-1$
}
return new Context(context, contextId);
}
}
catch (Throwable t) {
// log and skip
String msg = "Error querying context provider (" + provider.getClass().getName() + ") with context Id: " + contextId; //$NON-NLS-1$ //$NON-NLS-2$
HelpPlugin.logError(msg, t);
}
}
}
if (HelpPlugin.DEBUG_CONTEXT) {
System.out.println("ContextManager.getContext - no context found"); //$NON-NLS-1$
String id = contextId;
ArrayList potentialMatches = new ArrayList();
if ((index = contextId.lastIndexOf('.'))>-1)
id = contextId.substring(index+1);
String warning = "Registered Context Provider IDs:\n"; //$NON-NLS-1$
Iterator iter = contextIDsByPluginId.keySet().iterator();
warning+="--------------------------------\n"; //$NON-NLS-1$
while (iter.hasNext())
{
String pluginID = (String)iter.next();
List contextIDList = (List)contextIDsByPluginId.get(pluginID);
for (int c=0;c<contextIDList.size();c++)
{
if (((String)contextIDList.get(c)).equalsIgnoreCase(id))
{
potentialMatches.add(pluginID+'.'+(String)contextIDList.get(c));
break;
}
}
warning+=pluginID+' '+contextIDList.toString()+'\n';
}
warning+="--------------------------------"; //$NON-NLS-1$
System.out.println(warning);
if (!potentialMatches.isEmpty())
System.out.println("The ID searched is "+contextId+". Did you mean to call setHelp with:\n"+potentialMatches); //$NON-NLS-1$ //$NON-NLS-2$
}
return null;
}
/*
* Returns all registered context providers (potentially cached) for the
* given plug-in id.
*/
private List getContextProviders(String pluginId) {
if (providersByPluginId == null) {
loadContextProviders();
}
List list = new ArrayList();
List forPlugin = (List)providersByPluginId.get(pluginId);
if (forPlugin != null) {
list.addAll(forPlugin);
}
list.addAll(globalProviders);
return list;
}
/*
* Finds and instantiates all registered context-sensitive help providers.
*/
private void loadContextProviders() {
providersByPluginId = new HashMap();
globalProviders = new ArrayList();
IExtensionRegistry registry = Platform.getExtensionRegistry();
IConfigurationElement[] elements = registry.getConfigurationElementsFor(EXTENSION_POINT_ID_CONTEXT);
for (int i=0;i<elements.length;++i) {
IConfigurationElement elem = elements[i];
if (elem.getName().equals(ELEMENT_NAME_CONTEXT_PROVIDER)) {
try {
AbstractContextProvider provider = (AbstractContextProvider)elem.createExecutableExtension(ATTRIBUTE_NAME_CLASS);
String[] plugins = provider.getPlugins();
if (plugins != null) {
for (int j=0;j<plugins.length;++j) {
List list = (List)providersByPluginId.get(plugins[j]);
if (list == null) {
list = new ArrayList();
providersByPluginId.put(plugins[j], list);
}
list.add(provider);
}
}
else {
globalProviders.add(provider);
}
}
catch (CoreException e) {
// log and skip
String msg = "Error instantiating context-sensitive help provider class \"" + elem.getAttribute(ATTRIBUTE_NAME_CLASS) + '"'; //$NON-NLS-1$
HelpPlugin.logError(msg, e);
}
}
}
}
/*
* Method only called when debugging context
* sensitive help.
*
* Checks to see if there are any duplicate ids
*
*/
private void checkContextProviders()
{
contextIDsByPluginId = new Hashtable();
Hashtable contextByContextID = new Hashtable();
if (providersByPluginId == null) {
loadContextProviders();
}
Iterator i = providersByPluginId.keySet().iterator();
while (i.hasNext())
{
String pluginID = (String)i.next();
ArrayList providers = (ArrayList)providersByPluginId.get(pluginID);
for (int p=0;p<providers.size();p++)
{
ContextFileProvider provider = (ContextFileProvider)providers.get(p);
Map[] maps = provider.getPluginContexts(pluginID,Platform.getNL());
for (int m=0;m<maps.length;m++)
{
Iterator i2 = maps[m].keySet().iterator();
while (i2.hasNext())
{
String contextID = (String)i2.next();
String fullID = pluginID+'.'+contextID;
Context currentContext = (Context)maps[m].get(contextID);
if (!contextByContextID.containsKey(fullID))
contextByContextID.put(fullID,currentContext);
else if (HelpPlugin.DEBUG_CONTEXT)
{
Context initialContext = (Context)contextByContextID.get(fullID);
String error = "Context Help ID '"+contextID+"' is found in multiple context files in plugin '"+pluginID+"'\n"+ //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
" Description 1: "+initialContext.getText()+'\n'+ //$NON-NLS-1$
" Description 2: "+currentContext.getText(); //$NON-NLS-1$
System.out.println(error);
}
ArrayList list = (ArrayList)contextIDsByPluginId.get(pluginID);
if (list==null){
list = new ArrayList();
contextIDsByPluginId.put(pluginID,list);
}
list.add(contextID);
}
}
}
}
}
}
|
