no.nlb.pipeline.braille.impl.NLBTranslator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mod-nlb Show documentation
Show all versions of mod-nlb Show documentation
Module for the Norwegian Library of Talking Books and Braille to produce Norwegian braille.
The newest version!
package no.nlb.pipeline.braille.impl;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import static java.util.Arrays.copyOfRange;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.google.common.base.Objects;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import static com.google.common.collect.Iterables.size;
import cz.vutbr.web.css.CSSProperty;
import cz.vutbr.web.css.Term;
import cz.vutbr.web.css.TermIdent;
import cz.vutbr.web.css.TermList;
import org.daisy.braille.css.BrailleCSSProperty.TextTransform;
import org.daisy.braille.css.SimpleInlineStyle;
import org.daisy.dotify.api.translator.UnsupportedMetricException;
import org.daisy.pipeline.braille.common.AbstractBrailleTranslator;
import org.daisy.pipeline.braille.common.AbstractTransformProvider;
import org.daisy.pipeline.braille.common.AbstractTransformProvider.util.Function;
import org.daisy.pipeline.braille.common.AbstractTransformProvider.util.Iterables;
import static org.daisy.pipeline.braille.common.AbstractTransformProvider.util.Iterables.concat;
import static org.daisy.pipeline.braille.common.AbstractTransformProvider.util.Iterables.transform;
import static org.daisy.pipeline.braille.common.AbstractTransformProvider.util.logCreate;
import static org.daisy.pipeline.braille.common.AbstractTransformProvider.util.logSelect;
import org.daisy.pipeline.braille.common.BrailleTranslator;
import org.daisy.pipeline.braille.common.BrailleTranslatorProvider;
import org.daisy.pipeline.braille.common.CSSStyledText;
import org.daisy.pipeline.braille.common.Hyphenator;
import org.daisy.pipeline.braille.common.HyphenatorProvider;
import org.daisy.pipeline.braille.common.Query;
import org.daisy.pipeline.braille.common.Query.Feature;
import org.daisy.pipeline.braille.common.Query.MutableQuery;
import static org.daisy.pipeline.braille.common.Query.util.mutableQuery;
import org.daisy.pipeline.braille.common.TransformProvider;
import static org.daisy.pipeline.braille.common.TransformProvider.util.dispatch;
import static org.daisy.pipeline.braille.common.TransformProvider.util.memoize;
import static org.daisy.pipeline.braille.common.util.Locales.parseLocale;
import static org.daisy.pipeline.braille.common.util.Strings.splitInclDelimiter;
import static org.daisy.pipeline.braille.common.util.URIs.asURI;
import org.daisy.pipeline.braille.liblouis.LiblouisTranslator;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicy;
import org.osgi.service.component.ComponentContext;
public interface NLBTranslator {
@Component(
name = "no.nlb.pipeline.braille.impl.NLBTranslator.Provider",
service = {
BrailleTranslatorProvider.class,
TransformProvider.class
}
)
public class Provider extends AbstractTransformProvider implements BrailleTranslatorProvider {
private URI href;
@Activate
private void activate(ComponentContext context, final Map properties) {
href = asURI(context.getBundleContext().getBundle().getEntry("xml/block-translate.xpl"));
}
private final static Query grade0Table = mutableQuery().add("liblouis-table", "http://www.nlb.no/liblouis/no-no-g0.utb");
private final static Query grade1Table = mutableQuery().add("liblouis-table", "http://www.nlb.no/liblouis/no-no-g1.ctb");
private final static Query grade2Table = mutableQuery().add("liblouis-table", "http://www.nlb.no/liblouis/no-no-g2.ctb");
private final static Query grade3Table = mutableQuery().add("liblouis-table", "http://www.nlb.no/liblouis/no-no-g3.ctb");
private final static Query grade0Table8dot = mutableQuery().add("liblouis-table", "http://www.nlb.no/liblouis/no-no-g0.utb");
private final static Query hyphenationTable = mutableQuery().add("libhyphen-table", "http://www.nlb.no/hyphen/hyph_nb_NO.dic");
private final static Query fallbackHyphenationTable1 = mutableQuery().add("libhyphen-table",
"http://www.libreoffice.org/dictionaries/hyphen/hyph_nb_NO.dic");
private final static Query fallbackHyphenationTable2 = mutableQuery().add("hyphenator", "tex").add("locale", "nb");
private final static Iterable empty = Iterables.empty();
private final static List supportedInput = ImmutableList.of("css","text-css","dtbook","html");
private final static List supportedOutput = ImmutableList.of("css","braille");
/**
* Recognized features:
*
* - translator: Will only match if the value is `nlb'.
* - locale: Will only match if the language subtag is 'no'.
* - grade: `0', `1', `2' or `3'.
* - dots: `6', `8'. (default 6)
*
*/
protected final Iterable _get(Query query) {
final MutableQuery q = mutableQuery(query);
for (Feature f : q.removeAll("input"))
if (!supportedInput.contains(f.getValue().get()))
return empty;
for (Feature f : q.removeAll("output"))
if (!supportedOutput.contains(f.getValue().get()))
return empty;
if (q.containsKey("locale")) {
String locale = parseLocale(q.removeOnly("locale").getValue().get()).getLanguage();
// If we want to use other tables for other languages in the future; it can be done here.
// For now, we allow all languages as input.
// The default CSS disables contraction for other languages.
}
if (q.containsKey("translator"))
if ("nlb".equals(q.removeOnly("translator").getValue().get()))
if (q.containsKey("grade")) {
String v = q.removeOnly("grade").getValue().get();
final int grade;
if (v.equals("0"))
grade = 0;
else if (v.equals("1"))
grade = 1;
else if (v.equals("2"))
grade = 2;
else if (v.equals("3"))
grade = 3;
else
return empty;
final int dots;
if (q.containsKey("dots") && q.removeOnly("dots").getValue().get().equals("8"))
dots = 8;
else
dots = 6;
if (q.isEmpty()) {
Iterable hyphenators = concat(
logSelect(hyphenationTable, hyphenatorProvider),
concat(
logSelect(fallbackHyphenationTable1, hyphenatorProvider),
logSelect(fallbackHyphenationTable2, hyphenatorProvider)));
final Query liblouisTable;
if (dots == 8)
liblouisTable = grade0Table8dot;
else
liblouisTable = grade == 3 ? grade3Table : grade == 2 ? grade2Table : grade == 1 ? grade1Table : grade0Table;
return concat(
Iterables.transform(
concat(
concat(
Iterables.transform(
hyphenators,
new Function() {
public String _apply(Hyphenator h) {
return h.getIdentifier(); }}),
"liblouis"),
"none"),
new Function>() {
public Iterable _apply(final String hyphenator) {
return concat(
transform(
logSelect(mutableQuery(liblouisTable)
.add("hyphenator", hyphenator)
.add("handle-non-standard-hyphenation", "defer"),
liblouisTranslatorProvider),
new Function>() {
public Iterable _apply(final LiblouisTranslator translator) {
return Iterables.transform(
logSelect(mutableQuery(grade0Table)
.add("hyphenator", hyphenator)
.add("handle-non-standard-hyphenation", "defer"),
liblouisTranslatorProvider),
new Function() {
public BrailleTranslator _apply(LiblouisTranslator grade0Translator) {
return __apply(
logCreate(
new TransformImpl(grade, dots, translator, grade0Translator))); }} ); }} )); }} )); }}
return empty;
}
// mimicking liblouis behavior
private final static Pattern COMPUTER = Pattern.compile(
"(?<=^|[\\x20\t\\n\\r\\u2800\\xA0])[^\\x20\t\\n\\r\\u2800\\xA0]*"
+ "(?://|www\\.|\\.com|\\.edu|\\.gov|\\.mil|\\.net|\\.org|\\.no|\\.nu|\\.se|\\.dk|\\.fi|\\.ini|\\.doc|\\.docx"
+ "|\\.xml|\\.xsl|\\.htm|\\.html|\\.tex|\\.txt|\\.gif|\\.jpg|\\.png|\\.wav|\\.mp3|\\.m3u|\\.tar|\\.gz|\\.bz2|\\.zip)"
+ "[^\\x20\t\\n\\r\\u2800\\xA0]*"
+ "(?=[\\x20\t\\n\\r\\u2800\\xA0]|$)"
);
private final static String OPEN_COMPUTER = "\u2823"; // dots 126 (<)
private final static String CLOSE_COMPUTER = "\u281C"; // dots 345 (>)
private class TransformImpl extends AbstractBrailleTranslator {
private final XProc xproc;
private final LiblouisTranslator translator;
private final LiblouisTranslator grade0Translator;
private final int grade;
private final int dots;
private TransformImpl(int grade, int dots, LiblouisTranslator translator, LiblouisTranslator grade0Translator) {
Map options = ImmutableMap.of(
"text-transform", mutableQuery().add("id", this.getIdentifier()).toString());
xproc = new XProc(href, null, options);
this.translator = translator;
this.grade0Translator = grade0Translator;
this.grade = grade;
this.dots = dots;
}
@Override
public XProc asXProc() {
return xproc;
}
@Override
public FromStyledTextToBraille fromStyledTextToBraille() {
return fromStyledTextToBraille;
}
private final FromStyledTextToBraille fromStyledTextToBraille = new FromStyledTextToBraille() {
// FIXME: simplify! see implementation of lineBreakingFromStyledText()
public java.lang.Iterable transform(java.lang.Iterable styledText) {
int size = size(styledText);
String[] text = new String[size];
SimpleInlineStyle[] style = new SimpleInlineStyle[size];
int i = 0;
for (CSSStyledText t : styledText) {
text[i] = t.getText();
style[i] = t.getStyle();
i++; }
return Arrays.asList(transform(text, style));
}
private String[] transform(String[] text, SimpleInlineStyle[] cssStyle) {
String[] segments;
// which segments are an url or e-mail address
boolean[] computer;
// mapping from index in segments to index in text
int[] mapping; {
List l1 = new ArrayList();
List l2 = new ArrayList();
List l3 = new ArrayList();
for (int i = 0; i < text.length; i++) {
String t = text[i];
if (t.isEmpty()) {
l1.add(t);
l2.add(false);
l3.add(i); }
else {
Matcher m = COMPUTER.matcher(t);
int j = 0;
String s;
while (m.find()) {
s = t.substring(j, m.start());
if (!s.isEmpty()) {
l1.add(s);
l2.add(false);
l3.add(i); }
s = m.group();
if (!s.isEmpty()) {
l1.add(s);
l2.add(true);
l3.add(i); }
j = m.end(); }
s = t.substring(j);
if (!s.isEmpty()) {
l1.add(s);
l2.add(false);
l3.add(i); }}}
int len = l1.size();
segments = new String[len];
computer = new boolean[len];
mapping = new int[len];
for (int i = 0; i < len; i++) {
segments[i] = l1.get(i);
computer[i] = l2.get(i);
mapping[i] = l3.get(i); }}
String[] brailleSegments;
SimpleInlineStyle[] segmentsStyle = new SimpleInlineStyle[segments.length];
for (int i = 0; i < segments.length; i++)
segmentsStyle[i] = cssStyle[mapping[i]];
brailleSegments = transform(segments, segmentsStyle, computer);
String braille[] = new String[text.length];
for (int i = 0; i < braille.length; i++)
braille[i] = "";
for (int i = 0; i < brailleSegments.length; i++)
if (computer[i])
braille[mapping[i]] += OPEN_COMPUTER + brailleSegments[i] + CLOSE_COMPUTER;
else
braille[mapping[i]] += brailleSegments[i];
return braille;
}
private String[] transform(String[] text, SimpleInlineStyle[] cssStyle, boolean[] uncontracted) {
if (text.length == 0)
return new String[]{};
FromStyledTextToBraille translator = TransformImpl.this.translator.fromStyledTextToBraille();
FromStyledTextToBraille grade0Translator = TransformImpl.this.grade0Translator.fromStyledTextToBraille();
String[] result = new String[text.length];
boolean uncont = false;
int j = 0;
List uncontStyle = null;
for (int i = 0; i < text.length; i++) {
SimpleInlineStyle style = cssStyle[i];
boolean thisUncont; {
thisUncont = uncontracted[i];
if (style != null) {
CSSProperty val = style.getProperty("text-transform");
if (val != null) {
if (val == TextTransform.list_values) {
TermList values = style.getValue(TermList.class, "text-transform");
Iterator> it = values.iterator();
while (it.hasNext()) {
String tt = ((TermIdent)it.next()).getValue();
if (tt.equals("uncontracted")) {
thisUncont = true;
it.remove();
break; }}
if (values.isEmpty())
style.removeProperty("text-transform"); }}}}
if (thisUncont) {
if (i > 0 && !uncont)
for (String s : transformArray(translator,
copyOfRange(text, j, i),
copyOfRange(cssStyle, j, i)))
result[j++] = s;
if (uncontStyle == null)
uncontStyle = new ArrayList();
uncontStyle.add(style);
uncont = true; }
else {
if (i > 0 && uncont) {
for (String s : transformArray(grade0Translator,
copyOfRange(text, j, i),
uncontStyle.toArray(new SimpleInlineStyle[i - j])))
result[j++] = s;
uncontStyle = null; }
uncont = false; }}
if (uncont)
for (String s : transformArray(grade0Translator,
copyOfRange(text, j, text.length),
uncontStyle.toArray(new SimpleInlineStyle[text.length - j])))
result[j++] = s;
else
for (String s : transformArray(translator,
copyOfRange(text, j, text.length),
copyOfRange(cssStyle, j, text.length)))
result[j++] = s;
return result;
}
};
@Override
public LineBreakingFromStyledText lineBreakingFromStyledText() {
return lineBreakingFromStyledText;
}
private final LineBreakingFromStyledText lineBreakingFromStyledText = new LineBreakingFromStyledText() {
public LineIterator transform(java.lang.Iterable styledText) {
List lineIterators = new ArrayList();
List buffer = new ArrayList();
boolean curComputer = false;
for (CSSStyledText st : styledText) {
String text = st.getText();
boolean needStyleCopy = false;
if (!text.isEmpty()) {
boolean computer = false;
for (String s : splitInclDelimiter(text, COMPUTER)) {
if (!s.isEmpty()) {
if (computer != curComputer && !buffer.isEmpty()) {
if (curComputer)
lineIterators.add(new NonBreakingBrailleString(OPEN_COMPUTER));
lineIterators.add(transform(buffer, curComputer));
if (curComputer)
lineIterators.add(new NonBreakingBrailleString(CLOSE_COMPUTER));
buffer = new ArrayList();
curComputer = computer; }
SimpleInlineStyle style = st.getStyle();
if (needStyleCopy)
style = (SimpleInlineStyle)style.clone();
buffer.add(new CSSStyledText(s, style));
needStyleCopy = true; }
computer = !computer; }}}
if (!buffer.isEmpty()) {
if (curComputer)
lineIterators.add(new NonBreakingBrailleString(OPEN_COMPUTER));
lineIterators.add(transform(buffer, curComputer));
if (curComputer)
lineIterators.add(new NonBreakingBrailleString(CLOSE_COMPUTER)); }
return concatLineIterators(lineIterators);
}
private LineIterator transform(java.lang.Iterable styledText, boolean computer) {
LineBreakingFromStyledText translator = TransformImpl.this.translator.lineBreakingFromStyledText();
LineBreakingFromStyledText grade0Translator = TransformImpl.this.grade0Translator.lineBreakingFromStyledText();
List lineIterators = new ArrayList();
List buffer = new ArrayList();
boolean curUncontracted = false;
for (CSSStyledText st : styledText) {
SimpleInlineStyle style = st.getStyle();
boolean uncontracted; {
uncontracted = computer;
if (style != null) {
CSSProperty val = style.getProperty("text-transform");
if (val != null) {
if (val == TextTransform.list_values) {
TermList values = style.getValue(TermList.class, "text-transform");
Iterator> it = values.iterator();
while (it.hasNext()) {
String tt = ((TermIdent)it.next()).getValue();
if (tt.equals("uncontracted")) {
uncontracted = true;
it.remove();
break; }}
if (values.isEmpty())
style.removeProperty("text-transform"); }}}}
if (uncontracted != curUncontracted && !buffer.isEmpty()) {
lineIterators.add((curUncontracted ? grade0Translator : translator).transform(buffer));
buffer = new ArrayList();
curUncontracted = uncontracted; }
buffer.add(st); }
if (!buffer.isEmpty())
lineIterators.add((curUncontracted ? grade0Translator : translator).transform(buffer));
return concatLineIterators(lineIterators);
}
};
@Override
public String toString() {
return Objects.toStringHelper(NLBTranslator.class.getSimpleName())
.add("grade", grade)
.add("dots", dots)
.toString();
}
}
private static String[] transformArray(BrailleTranslator.FromStyledTextToBraille translator,
String[] text, SimpleInlineStyle[] style) {
List styledText = new ArrayList();
for (int i = 0; i < text.length; i++)
styledText.add(new CSSStyledText(text[i], style[i]));
String[] result = new String[text.length];
int i = 0;
for (String s : translator.transform(styledText))
result[i++] = s;
return result;
}
private static class NonBreakingBrailleString implements BrailleTranslator.LineIterator {
private String remainder;
private NonBreakingBrailleString(String string) {
remainder = string;
}
public String nextTranslatedRow(int limit, boolean force) {
if (remainder.length() <= limit) {
String next = remainder;
remainder = null;
return next; }
else if (force) {
String next = remainder.substring(0, limit);
remainder = remainder.substring(limit);
return next; }
else
return "";
}
public String getTranslatedRemainder() {
return remainder;
}
public int countRemaining() {
return remainder.length();
}
public boolean hasNext() {
return (remainder != null);
}
public boolean supportsMetric(String metric) {
return false;
}
public double getMetric(String metric) {
throw new UnsupportedMetricException("Metric not supported: " + metric);
}
}
private static BrailleTranslator.LineIterator concatLineIterators(final List iterators) {
if (iterators.size() == 0)
return new NonBreakingBrailleString(null);
else if (iterators.size() == 1)
return iterators.get(0);
else
return new BrailleTranslator.LineIterator() {
private BrailleTranslator.LineIterator current = iterators.get(0);
private int currentIndex = 0;
public String nextTranslatedRow(int limit, boolean force) {
String row = "";
while (limit > row.length()) {
row += current.nextTranslatedRow(limit - row.length(), force);
if (!current.hasNext() && currentIndex + 1 < iterators.size())
current = iterators.get(++currentIndex);
else
break; }
return row;
}
public String getTranslatedRemainder() {
String remainder = "";
for (int i = currentIndex; i < iterators.size(); i++)
remainder += iterators.get(i).getTranslatedRemainder();
return remainder;
}
public int countRemaining() {
int remaining = 0;
for (int i = currentIndex; i < iterators.size(); i++)
remaining += iterators.get(i).countRemaining();
return remaining;
}
public boolean hasNext() {
if (current.hasNext())
return true;
else {
while (currentIndex + 1 < iterators.size()) {
current = iterators.get(++currentIndex);
if (current.hasNext())
return true; }}
return false;
}
public boolean supportsMetric(String metric) {
return false;
}
public double getMetric(String metric) {
throw new UnsupportedMetricException("Metric not supported: " + metric);
}
};
}
@Reference(
name = "LiblouisTranslatorProvider",
unbind = "unbindLiblouisTranslatorProvider",
service = LiblouisTranslator.Provider.class,
cardinality = ReferenceCardinality.MULTIPLE,
policy = ReferencePolicy.DYNAMIC
)
protected void bindLiblouisTranslatorProvider(LiblouisTranslator.Provider provider) {
liblouisTranslatorProviders.add(provider);
}
protected void unbindLiblouisTranslatorProvider(LiblouisTranslator.Provider provider) {
liblouisTranslatorProviders.remove(provider);
liblouisTranslatorProvider.invalidateCache();
}
private List> liblouisTranslatorProviders
= new ArrayList>();
private TransformProvider.util.MemoizingProvider liblouisTranslatorProvider
= memoize(dispatch(liblouisTranslatorProviders));
@Reference(
name = "HyphenatorProvider",
unbind = "unbindHyphenatorProvider",
service = HyphenatorProvider.class,
cardinality = ReferenceCardinality.MULTIPLE,
policy = ReferencePolicy.DYNAMIC
)
@SuppressWarnings(
"unchecked" // safe cast to TransformProvider
)
protected void bindHyphenatorProvider(HyphenatorProvider provider) {
hyphenatorProviders.add((TransformProvider)provider);
}
protected void unbindHyphenatorProvider(HyphenatorProvider provider) {
hyphenatorProviders.remove(provider);
hyphenatorProvider.invalidateCache();
}
private List> hyphenatorProviders
= new ArrayList>();
private TransformProvider.util.MemoizingProvider hyphenatorProvider
= memoize(dispatch(hyphenatorProviders));
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy