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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id$ */
package org.apache.fop.layoutmgr;
import java.util.List;
import java.util.ListIterator;
import org.apache.fop.traits.MinOptMax;
import org.apache.fop.util.ListUtil;
/**
* Utilities for Knuth element lists.
*/
public final class ElementListUtils {
private ElementListUtils() {
// Utility class.
}
/**
* Removes legal breaks in an element list. A constraint can be specified to limit the
* range in which the breaks are removed. Legal breaks occuring before at least
* constraint.opt space is filled will be removed.
* @param elements the element list
* @param constraint min/opt/max value to restrict the range in which the breaks are removed.
* @return true if the opt constraint is bigger than the list contents
*/
public static boolean removeLegalBreaks(List elements, MinOptMax constraint) {
return removeLegalBreaks(elements, constraint.opt);
}
/**
* Removes legal breaks in an element list. A constraint can be specified to limit the
* range in which the breaks are removed. Legal breaks occuring before at least
* constraint space is filled will be removed.
* @param elements the element list
* @param constraint value to restrict the range in which the breaks are removed.
* @return true if the constraint is bigger than the list contents
*/
public static boolean removeLegalBreaks(List elements, int constraint) {
int len = 0;
ListIterator iter = elements.listIterator();
while (iter.hasNext()) {
ListElement el = (ListElement)iter.next();
if (el.isPenalty()) {
KnuthPenalty penalty = (KnuthPenalty)el;
//Convert all penalties to break inhibitors
if (penalty.getP() < KnuthPenalty.INFINITE) {
iter.set(new KnuthPenalty(penalty.getW(), KnuthPenalty.INFINITE,
penalty.isFlagged(), penalty.getPosition(), penalty.isAuxiliary()));
}
} else if (el.isGlue()) {
KnuthGlue glue = (KnuthGlue)el;
len += glue.getW();
iter.previous();
el = (ListElement)iter.previous();
iter.next();
if (el.isBox()) {
iter.add(new KnuthPenalty(0, KnuthPenalty.INFINITE, false,
null, false));
}
iter.next();
} else if (el instanceof BreakElement) {
BreakElement breakEl = (BreakElement)el;
if (breakEl.getPenaltyValue() < KnuthPenalty.INFINITE) {
breakEl.setPenaltyValue(KnuthPenalty.INFINITE);
}
} else {
KnuthElement kel = (KnuthElement)el;
len += kel.getW();
}
if (len >= constraint) {
return false;
}
}
return true;
}
/**
* Removes legal breaks in an element list. A constraint can be specified to limit the
* range in which the breaks are removed. Legal breaks within the space specified through the
* constraint (starting from the end of the element list) will be removed.
* @param elements the element list
* @param constraint value to restrict the range in which the breaks are removed.
* @return true if the constraint is bigger than the list contents
*/
public static boolean removeLegalBreaksFromEnd(List elements, int constraint) {
int len = 0;
ListIterator i = elements.listIterator(elements.size());
while (i.hasPrevious()) {
ListElement el = (ListElement)i.previous();
if (el.isPenalty()) {
KnuthPenalty penalty = (KnuthPenalty)el;
//Convert all penalties to break inhibitors
if (penalty.getP() < KnuthPenalty.INFINITE) {
i.set(new KnuthPenalty(penalty.getW(), KnuthPenalty.INFINITE,
penalty.isFlagged(), penalty.getPosition(), penalty.isAuxiliary()));
}
} else if (el.isGlue()) {
KnuthGlue glue = (KnuthGlue)el;
len += glue.getW();
el = (ListElement)i.previous();
i.next();
if (el.isBox()) {
i.add(new KnuthPenalty(0, KnuthPenalty.INFINITE, false,
null, false));
}
} else if (el.isUnresolvedElement()) {
if (el instanceof BreakElement) {
BreakElement breakEl = (BreakElement)el;
if (breakEl.getPenaltyValue() < KnuthPenalty.INFINITE) {
breakEl.setPenaltyValue(KnuthPenalty.INFINITE);
}
} else if (el instanceof UnresolvedListElementWithLength) {
UnresolvedListElementWithLength uel = (UnresolvedListElementWithLength)el;
len += uel.getLength().opt;
}
} else {
KnuthElement kel = (KnuthElement)el;
len += kel.getW();
}
if (len >= constraint) {
return false;
}
}
return true;
}
/**
* Calculates the content length of the given element list. Warning: It doesn't take any
* stretch and shrink possibilities into account.
* @param elems the element list
* @param start element at which to start
* @param end element at which to stop
* @return the content length
*/
public static int calcContentLength(List elems, int start, int end) {
ListIterator iter = elems.listIterator(start);
int count = end - start + 1;
int len = 0;
while (iter.hasNext()) {
ListElement el = (ListElement)iter.next();
if (el.isBox()) {
len += ((KnuthElement)el).getW();
} else if (el.isGlue()) {
len += ((KnuthElement)el).getW();
} else {
//log.debug("Ignoring penalty: " + el);
//ignore penalties
}
count--;
if (count == 0) {
break;
}
}
return len;
}
/**
* Calculates the content length of the given element list. Warning: It doesn't take any
* stretch and shrink possibilities into account.
* @param elems the element list
* @return the content length
*/
public static int calcContentLength(List elems) {
return calcContentLength(elems, 0, elems.size() - 1);
}
/**
* Indicates whether the given element list ends with a forced break.
* @param elems the element list
* @return true if the list ends with a forced break
*/
public static boolean endsWithForcedBreak(List elems) {
ListElement last = (ListElement) ListUtil.getLast(elems);
return last.isForcedBreak();
}
/**
* Indicates whether the given element list ends with a penalty with a non-infinite penalty
* value.
* @param elems the element list
* @return true if the list ends with a non-infinite penalty
*/
public static boolean endsWithNonInfinitePenalty(List elems) {
ListElement last = (ListElement) ListUtil.getLast(elems);
if (last.isPenalty() && ((KnuthPenalty)last).getP() < KnuthElement.INFINITE) {
return true;
} else if (last instanceof BreakElement
&& ((BreakElement)last).getPenaltyValue() < KnuthElement.INFINITE) {
return true;
}
return false;
}
/**
* Determines the position of the previous break before the start index on an
* element list.
* @param elems the element list
* @param startIndex the start index
* @return the position of the previous break, or -1 if there was no previous break
*/
public static int determinePreviousBreak(List elems, int startIndex) {
int prevBreak = startIndex - 1;
while (prevBreak >= 0) {
KnuthElement el = (KnuthElement)elems.get(prevBreak);
if (el.isPenalty() && el.getP() < KnuthElement.INFINITE) {
break;
}
prevBreak--;
}
return prevBreak;
}
}
|
