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
|
/*******************************************************************************
* Copyright (c) 2007, 2017 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
* EclipseSource - ongoing development
* Todor Boev
*******************************************************************************/
package org.eclipse.equinox.internal.p2.metadata;
import static org.eclipse.equinox.internal.p2.metadata.InstallableUnit.MEMBER_PROVIDED_CAPABILITIES;
import static org.eclipse.equinox.internal.p2.metadata.ProvidedCapability.MEMBER_NAME;
import static org.eclipse.equinox.internal.p2.metadata.ProvidedCapability.MEMBER_NAMESPACE;
import static org.eclipse.equinox.internal.p2.metadata.ProvidedCapability.MEMBER_VERSION;
import static org.eclipse.equinox.p2.metadata.Version.MAX_VERSION;
import static org.eclipse.equinox.p2.metadata.VersionRange.emptyRange;
import java.util.Arrays;
import java.util.List;
import org.eclipse.core.runtime.Assert;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.metadata.Version;
import org.eclipse.equinox.p2.metadata.VersionRange;
import org.eclipse.equinox.p2.metadata.expression.ExpressionUtil;
import org.eclipse.equinox.p2.metadata.expression.IExpression;
import org.eclipse.equinox.p2.metadata.expression.IExpressionFactory;
import org.eclipse.equinox.p2.metadata.expression.IMatchExpression;
/**
* A required capability represents some external constraint on an {@link IInstallableUnit}.
* Each capability represents something an {@link IInstallableUnit} needs that
* it expects to be provided by another {@link IInstallableUnit}. Capabilities are
* entirely generic, and are intended to be capable of representing anything that
* an {@link IInstallableUnit} may need either at install time, or at runtime.
* <p>
* Capabilities are segmented into namespaces. Anyone can introduce new
* capability namespaces. Some well-known namespaces are introduced directly
* by the provisioning framework.
*
* @see IInstallableUnit#NAMESPACE_IU_ID
*/
public class RequiredCapability extends Requirement implements IRequiredCapability {
private static final IExpression ALL = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE));
private static final IExpression STRICT = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s == $2)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION));
private static final IExpression OPEN_I = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s >= $2)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION));
private static final IExpression OPEN_N = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s > $2)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION));
private static final IExpression CLOSED_II = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s >= $2 && x.%s <= $3)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION, MEMBER_VERSION));
private static final IExpression CLOSED_IN = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s >= $2 && x.%s < $3)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION, MEMBER_VERSION));
private static final IExpression CLOSED_NI = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s > $2 && x.%s <= $3)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION, MEMBER_VERSION));
private static final IExpression CLOSED_NN = ExpressionUtil.parse(
String.format("%s.exists(x | x.%s == $0 && x.%s == $1 && x.%s > $2 && x.%s < $3)", //$NON-NLS-1$
MEMBER_PROVIDED_CAPABILITIES, MEMBER_NAME, MEMBER_NAMESPACE, MEMBER_VERSION, MEMBER_VERSION));
private static final List<IExpression> PREDEFINED = Arrays.asList(
ALL, STRICT, OPEN_I, OPEN_N, CLOSED_II, CLOSED_IN, CLOSED_NI, CLOSED_NN);
/**
* TODO Remove. This is a private impl class. Users must call the analogous MetadataFactory.createRequirement()
* @deprecated To be removed once CBI is fixed.
* @noreference This constructor is not intended to be referenced by clients.
*/
@Deprecated
public RequiredCapability(String namespace, String name, VersionRange range, String filter, boolean optional, boolean multiple) {
this(namespace, name, range, filter, optional, multiple, true);
}
/**
* TODO Remove. This is a private impl class. Users must call the analogous MetadataFactory.createRequirement()
* @deprecated To be removed once CBI is fixed.
* @noreference This constructor is not intended to be referenced by clients.
*/
@Deprecated
public RequiredCapability(String namespace, String name, VersionRange range, String filter, boolean optional, boolean multiple, boolean greedy) {
this(namespace, name, range, InstallableUnit.parseFilter(filter), optional ? 0 : 1, multiple ? Integer.MAX_VALUE : 1, greedy, null);
}
public RequiredCapability(String namespace, String name, VersionRange range, IMatchExpression<IInstallableUnit> filter, int min, int max, boolean greedy, String description) {
super(createMatchExpressionFromRange(namespace, name, range), filter, min, max, greedy, description);
}
@Override
public String getNamespace() {
return extractNamespace(matchExpression);
}
@Override
public String getName() {
return extractName(matchExpression);
}
@Override
public VersionRange getRange() {
return extractRange(matchExpression);
}
@Override
public String toString() {
StringBuilder result = new StringBuilder();
result.append(getNamespace());
result.append("; "); //$NON-NLS-1$
result.append(getName());
result.append(" "); //$NON-NLS-1$
result.append(getRange());
return result.toString();
}
public static IMatchExpression<IInstallableUnit> createMatchExpressionFromRange(String namespace, String name, VersionRange range) {
Assert.isNotNull(namespace);
Assert.isNotNull(name);
IExpressionFactory factory = ExpressionUtil.getFactory();
// All versions
if (range == null || range.equals(emptyRange)) {
return factory.matchExpression(ALL, name, namespace);
}
// Exact version
if (range.getMinimum().equals(range.getMaximum())) {
return factory.matchExpression(STRICT, name, namespace, range.getMinimum());
}
// Open range
if (range.getMaximum().equals(MAX_VERSION)) {
// Open inclusive or non-inclusive
IExpression expr = range.getIncludeMinimum() ? OPEN_I : OPEN_N;
return factory.matchExpression(expr, name, namespace, range.getMinimum());
}
// Closed range
IExpression expr = range.getIncludeMinimum()
// Left inclusive. Right inclusive or non-inclusive
? (range.getIncludeMaximum() ? CLOSED_II : CLOSED_IN)
// Left non-inclusive. Right inclusive or non-inclusive
: (range.getIncludeMaximum() ? CLOSED_NI : CLOSED_NN);
return factory.matchExpression(expr, name, namespace, range.getMinimum(), range.getMaximum());
}
public static String extractName(IMatchExpression<IInstallableUnit> matchExpression) {
assertVersionRangeRequirement(matchExpression);
return (String) matchExpression.getParameters()[0];
}
public static String extractNamespace(IMatchExpression<IInstallableUnit> matchExpression) {
assertVersionRangeRequirement(matchExpression);
return (String) matchExpression.getParameters()[1];
}
public static VersionRange extractRange(IMatchExpression<IInstallableUnit> matchExpression) {
assertVersionRangeRequirement(matchExpression);
IExpression expr = ExpressionUtil.getOperand(matchExpression);
Object[] params = matchExpression.getParameters();
switch (params.length) {
// No version parameter
case 2 :
return emptyRange;
// One version parameter: strict or one of the open ranges
case 3 :
Version v = (Version) params[2];
if (expr.equals(STRICT)) {
return new VersionRange(v, true, v, true);
}
return new VersionRange(v, expr.equals(OPEN_I), MAX_VERSION, true);
// Two version parameters: one of the closed ranges
default :
Version left = (Version) params[2];
boolean leftInclusive = expr.equals(CLOSED_II) || expr.equals(CLOSED_IN);
Version right = (Version) params[3];
boolean rightInclusive = expr.equals(CLOSED_II) || expr.equals(CLOSED_NI);
return new VersionRange(left, leftInclusive, right, rightInclusive);
}
}
public static boolean isStrictVersionRequirement(IMatchExpression<IInstallableUnit> matchExpression) {
return STRICT == ExpressionUtil.getOperand(matchExpression);
}
public static boolean isVersionRangeRequirement(IMatchExpression<IInstallableUnit> matchExpression) {
return PREDEFINED.contains(ExpressionUtil.getOperand(matchExpression));
}
private static void assertVersionRangeRequirement(IMatchExpression<IInstallableUnit> matchExpression) {
if (!isVersionRangeRequirement(matchExpression)) {
throw new IllegalArgumentException();
}
}
}
|
