blob: fe992d1bad9e848174bb0f902db2a8c4a8a4492e (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2006, 2016 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.toc;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.InvalidRegistryObjectException;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.AbstractTocProvider;
import org.eclipse.help.ITocContribution;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.util.ResourceLocator;
import org.xml.sax.SAXParseException;
/*
* Provides toc data from toc XML files to the help system.
*/
public class TocFileProvider extends AbstractTocProvider {
public static final String EXTENSION_POINT_ID_TOC = HelpPlugin.PLUGIN_ID + ".toc"; //$NON-NLS-1$
public static final String ELEMENT_NAME_TOC = "toc"; //$NON-NLS-1$
public static final String ATTRIBUTE_NAME_FILE = "file"; //$NON-NLS-1$
public static final String ATTRIBUTE_NAME_PRIMARY = "primary"; //$NON-NLS-1$
public static final String ATTRIBUTE_NAME_EXTRADIR = "extradir"; //$NON-NLS-1$
public static final String ATTRIBUTE_NAME_CATEGORY = "category"; //$NON-NLS-1$
@Override
public ITocContribution[] getTocContributions(String locale) {
List<ITocContribution> contributions = new ArrayList<>();
TocFile[] tocFiles = getTocFiles(locale);
TocFileParser parser = new TocFileParser();
for (int i=0;i<tocFiles.length;++i) {
try {
ITocContribution toc = parser.parse(tocFiles[i]);
contributions.add(toc);
}
catch (Throwable t) {
String locationInfo = ""; //$NON-NLS-1$
if (t instanceof SAXParseException) {
SAXParseException spe = (SAXParseException) t;
locationInfo = " at line " + spe.getLineNumber() //$NON-NLS-1$
+ ", column " + spe.getColumnNumber(); //$NON-NLS-1$
}
String pluginId = tocFiles[i].getPluginId();
String file = tocFiles[i].getFile();
String msg = "Error reading help table of contents file /\"" //$NON-NLS-1$
+ ResourceLocator.getErrorPath(pluginId, file, locale)
+ locationInfo
+ "\" (skipping file)"; //$NON-NLS-1$
HelpPlugin.logError(msg, t);
}
}
return contributions.toArray(new ITocContribution[contributions.size()]);
}
/*
* Returns all available TocFiles for the given locale.
*/
protected TocFile[] getTocFiles(String locale) {
List<TocFile> tocFiles = new ArrayList<>();
IExtensionRegistry registry = Platform.getExtensionRegistry();
IConfigurationElement[] elements = registry.getConfigurationElementsFor(EXTENSION_POINT_ID_TOC);
for (int i=0;i<elements.length;++i) {
IConfigurationElement elem = elements[i];
String pluginId;
try {
pluginId = elem.getNamespaceIdentifier();
}
catch (InvalidRegistryObjectException e) {
// no longer valid; skip it
continue;
}
if (elem.getName().equals(ELEMENT_NAME_TOC)) {
String file = elem.getAttribute(ATTRIBUTE_NAME_FILE);
boolean primary = "true".equalsIgnoreCase(elem.getAttribute(ATTRIBUTE_NAME_PRIMARY)); //$NON-NLS-1$
String extradir = elem.getAttribute(ATTRIBUTE_NAME_EXTRADIR);
String category = elem.getAttribute(ATTRIBUTE_NAME_CATEGORY);
TocFile tocFile = new TocFile(pluginId, file, primary, locale, extradir, category);
tocFiles.add(tocFile);
}
}
return tocFiles.toArray(new TocFile[tocFiles.size()]);
}
@Override
public int getPriority() {
return TOC_FILE_PRIORITY;
}
}
|
