blob: 79e11afe581440dcc532a88661a5857c5e0d9d1b (
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
|
/*******************************************************************************
* Copyright (c) 2006 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.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.TocContribution;
import org.eclipse.help.internal.HelpPlugin;
/*
* 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$
/* (non-Javadoc)
* @see org.eclipse.help.AbstractTocProvider#getTocContributions(java.lang.String)
*/
public TocContribution[] getTocContributions(String locale) {
List contributions = new ArrayList();
TocFile[] tocFiles = getTocFiles(locale);
TocFileParser parser = new TocFileParser();
for (int i=0;i<tocFiles.length;++i) {
try {
TocContribution toc = parser.parse(tocFiles[i]);
contributions.add(toc);
}
catch (Throwable t) {
String msg = "Error reading toc file \"" + tocFiles[i].getFile() + "\" in extension specified in plug-in: " + tocFiles[i].getPluginId(); //$NON-NLS-1$ //$NON-NLS-2$
HelpPlugin.logError(msg, t);
}
}
return (TocContribution[])contributions.toArray(new TocContribution[contributions.size()]);
}
/*
* Returns all available TocFiles for the given locale.
*/
private TocFile[] getTocFiles(String locale) {
List 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 = Boolean.toString(true).equals(elem.getAttribute(ATTRIBUTE_NAME_PRIMARY));
String extradir = elem.getAttribute(ATTRIBUTE_NAME_EXTRADIR);
String category = elem.getAttribute(ATTRIBUTE_NAME_CATEGORY);
if (file == null) {
// log and skip
String msg = ELEMENT_NAME_TOC + " element for extension point " + EXTENSION_POINT_ID_TOC + " must specify a " + ATTRIBUTE_NAME_FILE + " attribute"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
try {
msg += " (declared from plug-in " + elem.getNamespaceIdentifier() + ")"; //$NON-NLS-1$ //$NON-NLS-2$
}
catch (InvalidRegistryObjectException e) {
// skip the declaring plugin part
}
HelpPlugin.logError(msg, null);
continue;
}
TocFile tocFile = new TocFile(pluginId, file, primary, locale, extradir, category);
tocFiles.add(tocFile);
}
}
return (TocFile[])tocFiles.toArray(new TocFile[tocFiles.size()]);
}
}
|
