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
|
/*******************************************************************************
* 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;
import java.io.File;
import java.io.InputStream;
import java.net.URL;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Plugin;
import org.eclipse.core.runtime.Status;
import org.eclipse.help.internal.context.ContextManager;
import org.eclipse.help.internal.criteria.CriteriaManager;
import org.eclipse.help.internal.extension.ContentExtensionManager;
import org.eclipse.help.internal.index.IndexManager;
import org.eclipse.help.internal.toc.TocManager;
import org.eclipse.osgi.service.datalocation.Location;
import org.osgi.framework.BundleContext;
/**
* Help System Core plug-in
*/
public class HelpPlugin extends Plugin {
public final static String PLUGIN_ID = "org.eclipse.help"; //$NON-NLS-1$
// debug options
public static boolean DEBUG = false;
public static boolean DEBUG_CONTEXT = false;
public static boolean DEBUG_SEARCH = false;
public static boolean DEBUG_TOC = false;
public static boolean DEBUG_INDEX = false;
public static boolean DEBUG_CRITERIA = false;
public final static String HELP_DATA_KEY = "HELP_DATA"; //$NON-NLS-1$
public final static String BASE_TOCS_KEY = "baseTOCS"; //$NON-NLS-1$
public final static String IGNORED_TOCS_KEY = "ignoredTOCS"; //$NON-NLS-1$
public final static String IGNORED_INDEXES_KEY = "ignoredIndexes"; //$NON-NLS-1$
public final static String FILTER_INFOCENTER_KEY = "filterInfocenter"; //$NON-NLS-1$
private static HelpPlugin plugin;
private static Object tocManagerCreateLock = new Object();
private TocManager tocManager;
private ContextManager contextManager;
private ContentExtensionManager contentExtensionManager;
private IndexManager indexManager;
private CriteriaManager criteriaManager;
private IHelpProvider helpProvider;
private File configurationDirectory;
public static void logWarning(String message) {
Status errorStatus = new Status(IStatus.WARNING, PLUGIN_ID, IStatus.OK, message, null);
logStatus(errorStatus);
}
public static void logError(String message) {
Status errorStatus = new Status(IStatus.ERROR, PLUGIN_ID, IStatus.OK, message, null);
logStatus(errorStatus);
}
public static void logError(String message, Throwable ex) {
if (message == null) {
message = ""; //$NON-NLS-1$
}
Status errorStatus = new Status(IStatus.ERROR, PLUGIN_ID, IStatus.OK, message, ex);
logStatus(errorStatus);
}
private static synchronized void logStatus(IStatus errorStatus) {
HelpPlugin.getDefault().getLog().log(errorStatus);
}
/**
* @return the singleton instance of the plugin
*/
public static HelpPlugin getDefault() {
return plugin;
}
/**
* Used to obtain Toc Naviagiont Manager
*
* @return instance of TocManager
*/
public static TocManager getTocManager() {
if (getDefault().tocManager == null) {
synchronized (tocManagerCreateLock) {
if (getDefault().tocManager == null) {
getDefault().tocManager = new TocManager();
}
}
}
return getDefault().tocManager;
}
/**
* Used to obtain Context Manager returns an instance of ContextManager
*/
public static ContextManager getContextManager() {
if (getDefault().contextManager == null)
getDefault().contextManager = new ContextManager();
return getDefault().contextManager;
}
/**
* Used to obtain the ContentExtensionManager
*/
public static ContentExtensionManager getContentExtensionManager() {
if (getDefault().contentExtensionManager == null)
getDefault().contentExtensionManager = new ContentExtensionManager();
return getDefault().contentExtensionManager;
}
public static IndexManager getIndexManager() {
if (getDefault().indexManager == null)
getDefault().indexManager = new IndexManager();
return getDefault().indexManager;
}
public static CriteriaManager getCriteriaManager() {
if (getDefault().criteriaManager == null)
getDefault().criteriaManager = new CriteriaManager();
return getDefault().criteriaManager;
}
/*
* Returns the provider responsible for serving help documents.
*/
public IHelpProvider getHelpProvider() {
return helpProvider;
}
/*
* Sets the provider responsible for serving help documents. Called
* on startup.
*/
public void setHelpProvider(IHelpProvider helpProvider) {
this.helpProvider = helpProvider;
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.Plugin#start(org.osgi.framework.BundleContext)
*/
@Override
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
// determine configuration location for this plug-in
Location location = Platform.getConfigurationLocation();
if (location != null) {
URL configURL = location.getURL();
if (configURL != null && configURL.getProtocol().startsWith("file")) { //$NON-NLS-1$
configurationDirectory = new File(configURL.getFile(), PLUGIN_ID);
}
}
if (configurationDirectory == null) {
configurationDirectory = getStateLocation().toFile();
}
// Setup debugging options
DEBUG = isDebugging();
if (DEBUG) {
DEBUG_CONTEXT = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/context")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_SEARCH = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/search")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_TOC = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/toc")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_INDEX = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/index")); //$NON-NLS-1$ //$NON-NLS-2$
DEBUG_CRITERIA = "true".equalsIgnoreCase(Platform.getDebugOption(PLUGIN_ID + "/debug/criteria")); //$NON-NLS-1$ //$NON-NLS-2$
}
}
public static File getConfigurationDirectory() {
return getDefault().configurationDirectory;
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.Plugin#stop(org.osgi.framework.BundleContext)
*/
@Override
public void stop(BundleContext context) throws Exception {
plugin = null;
super.stop(context);
}
/*
* An interface by which higher plug-ins can serve help content.
*/
public static interface IHelpProvider {
public InputStream getHelpContent(String href, String locale);
}
}
|
