Skip to content

Commit

Permalink
Merge pull request #164 from trello/android-parser
Browse files Browse the repository at this point in the history 
Improvements to the Android parser
  • Loading branch information
@DDRBoxman
DDRBoxman committed Sep 3, 2014
2 parents fc44838 + 21c31f6 commit c592c22
Show file tree
Hide file tree
Showing 4 changed files with 319 additions and 47 deletions.
274 changes: 228 additions & 46 deletions platform/android/library/src/in/uncod/android/bypass/Bypass.java
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,27 @@
package in.uncod.android.bypass;

import android.util.TypedValue;
import in.uncod.android.bypass.Element.Type;
import android.content.Context;
import android.graphics.Color;
import android.graphics.Typeface;
import android.graphics.drawable.Drawable;
import android.text.Spannable;
import android.text.SpannableStringBuilder;
import android.text.TextUtils;
import android.text.style.ImageSpan;
import android.text.style.LeadingMarginSpan;
import android.text.style.QuoteSpan;
import android.text.style.RelativeSizeSpan;
import android.text.style.StrikethroughSpan;
import android.text.style.StyleSpan;
import android.text.style.TypefaceSpan;
import android.text.style.URLSpan;
import android.util.DisplayMetrics;
import android.util.TypedValue;
import in.uncod.android.bypass.Element.Type;
import in.uncod.android.bypass.style.HorizontalLineSpan;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

public class Bypass {
static {
Expand All @@ -24,6 +32,14 @@ public class Bypass {

private final int mListItemIndent;
private final int mBlockQuoteIndent;
private final int mCodeBlockIndent;
private final int mHruleSize;

private final int mHruleTopBottomPadding;

// Keeps track of the ordered list number for each LIST element.
// We need to track multiple ordered lists at once because of nesting.
private final Map<Element, Integer> mOrderedListNumber = new ConcurrentHashMap<Element, Integer>();

/**
* @deprecated Use {@link #Bypass(android.content.Context)} instead.
Expand All @@ -34,6 +50,9 @@ public Bypass() {
mOptions = new Options();
mListItemIndent = 20;
mBlockQuoteIndent = 10;
mCodeBlockIndent = 10;
mHruleSize = 2;
mHruleTopBottomPadding = 20;
}

public Bypass(Context context) {
Expand All @@ -43,45 +62,82 @@ public Bypass(Context context) {
public Bypass(Context context, Options options) {
mOptions = options;

DisplayMetrics dm = context.getResources().getDisplayMetrics();

mListItemIndent = (int) TypedValue.applyDimension(mOptions.mListItemIndentUnit,
mOptions.mListItemIndentSize,
context.getResources().getDisplayMetrics());
mOptions.mListItemIndentSize, dm);

mBlockQuoteIndent = (int) TypedValue.applyDimension(mOptions.mBlockQuoteIndentUnit,
mOptions.mBlockQuoteIndentSize,
context.getResources().getDisplayMetrics());
mOptions.mBlockQuoteIndentSize, dm);

mCodeBlockIndent = (int) TypedValue.applyDimension(mOptions.mCodeBlockIndentUnit,
mOptions.mCodeBlockIndentSize, dm);

mHruleSize = (int) TypedValue.applyDimension(mOptions.mHruleUnit,
mOptions.mHruleSize, dm);

mHruleTopBottomPadding = (int) dm.density * 10;
}

public CharSequence markdownToSpannable(String markdown) {
return markdownToSpannable(markdown, null);
}

public CharSequence markdownToSpannable(String markdown, ImageGetter imageGetter) {
Document document = processMarkdown(markdown);

CharSequence[] spans = new CharSequence[document.getElementCount()];
for (int i = 0; i < document.getElementCount(); i++) {
spans[i] = recurseElement(document.getElement(i));
spans[i] = recurseElement(document.getElement(i), imageGetter);
}

return TextUtils.concat(spans);
}

private native Document processMarkdown(String markdown);

private CharSequence recurseElement(Element element) {
private CharSequence recurseElement(Element element, ImageGetter imageGetter) {
Type type = element.getType();

boolean isOrderedList = false;
if (type == Type.LIST) {
String flagsStr = element.getAttribute("flags");
int flags = Integer.parseInt(flagsStr);
isOrderedList = (flags & Element.F_LIST_ORDERED) != 0;
if (isOrderedList) {
mOrderedListNumber.put(element, 1);
}
}

CharSequence[] spans = new CharSequence[element.size()];
for (int i = 0; i < element.size(); i++) {
spans[i] = recurseElement(element.children[i]);
spans[i] = recurseElement(element.children[i], imageGetter);
}

// Clean up after we're done
if (isOrderedList) {
mOrderedListNumber.remove(this);
}

CharSequence concat = TextUtils.concat(spans);

SpannableStringBuilder builder = new SpannableStringBuilder();
SpannableStringBuilder builder = new ReverseSpannableStringBuilder();

String text = element.getText();
if (element.size() == 0
&& element.getParent() != null
&& element.getParent().getType() != Type.BLOCK_CODE) {
&& element.getParent() != null
&& element.getParent().getType() != Type.BLOCK_CODE) {
text = text.replace('\n', ' ');
}
switch (element.getType()) {

// Retrieve the image now so we know whether we're going to have something to display later
// If we don't, then show the alt text instead (if available).
Drawable imageDrawable = null;
if (type == Type.IMAGE && imageGetter != null && !TextUtils.isEmpty(element.getAttribute("link"))) {
imageDrawable = imageGetter.getDrawable(element.getAttribute("link"));
}

switch (type) {
case LIST:
if (element.getParent() != null
&& element.getParent().getType() == Type.LIST_ITEM) {
Expand All @@ -92,40 +148,118 @@ private CharSequence recurseElement(Element element) {
builder.append("\n");
break;
case LIST_ITEM:
builder.append(mOptions.mListItem);
builder.append(" ");
if (mOrderedListNumber.containsKey(element.getParent())) {
int number = mOrderedListNumber.get(element.getParent());
builder.append(Integer.toString(number) + ".");
mOrderedListNumber.put(element.getParent(), number + 1);
}
else {
builder.append(mOptions.mUnorderedListItem);
}
builder.append(" ");
break;
case AUTOLINK:
builder.append(element.getAttribute("link"));
break;
case HRULE:
// This ultimately gets drawn over by the line span, but
// we need something here or the span isn't even drawn.
builder.append("-");
break;
case IMAGE:
// Display alt text (or title text) if there is no image
if (imageDrawable == null) {
String show = element.getAttribute("alt");
if (TextUtils.isEmpty(show)) {
show = element.getAttribute("title");
}
if (!TextUtils.isEmpty(show)) {
show = "[" + show + "]";
builder.append(show);
}
}
else {
// Character to be replaced
builder.append("\uFFFC");
}
break;
}

builder.append(text);
builder.append(concat);

if (element.isBlockElement() && element.getType() != Type.LIST_ITEM) {
builder.append("\n");
}

if (element.getType() == Type.HEADER) {
String levelStr = element.getAttribute("level");
int level = Integer.parseInt(levelStr);
setSpan(builder, new RelativeSizeSpan(mOptions.mHeaderSizes[level - 1]));
setSpan(builder, new StyleSpan(Typeface.BOLD));
} else if (element.getType() == Type.LIST_ITEM
&& element.getParent().getParent() != null) {
setSpan(builder, new LeadingMarginSpan.Standard(mListItemIndent));
} else if (element.getType() == Type.EMPHASIS) {
setSpan(builder, new StyleSpan(Typeface.ITALIC));
} else if (element.getType() == Type.DOUBLE_EMPHASIS) {
setSpan(builder, new StyleSpan(Typeface.BOLD));
} else if (element.getType() == Type.TRIPLE_EMPHASIS) {
setSpan(builder, new StyleSpan(Typeface.BOLD_ITALIC));
} else if (element.getType() == Type.CODE_SPAN) {
setSpan(builder, new TypefaceSpan("monospace"));
} else if (element.getType() == Type.LINK) {
setSpan(builder, new URLSpan(element.getAttribute("link")));
} else if (element.getType() == Type.BLOCK_QUOTE) {
setSpan(builder, new QuoteSpan(mOptions.mBlockQuoteColor));
setSpan(builder, new LeadingMarginSpan.Standard(mBlockQuoteIndent));
setSpan(builder, new StyleSpan(Typeface.ITALIC));
} else if (element.getType() == Type.STRIKETHROUGH) {
setSpan(builder, new StrikethroughSpan());
if (type == Type.LIST_ITEM) {
if (element.size() == 0 || !element.children[element.size() - 1].isBlockElement()) {
builder.append("\n");
}
}
else if (element.isBlockElement() && type != Type.BLOCK_QUOTE) {
if (type == Type.LIST) {
// If this is a nested list, don't include newlines
if (element.getParent() == null || element.getParent().getType() != Type.LIST_ITEM) {
builder.append("\n");
}
}
else if (element.getParent() != null
&& element.getParent().getType() == Type.LIST_ITEM) {
// List items should never double-space their entries
builder.append("\n");
}
else {
builder.append("\n\n");
}
}

switch (type) {
case HEADER:
String levelStr = element.getAttribute("level");
int level = Integer.parseInt(levelStr);
setSpan(builder, new RelativeSizeSpan(mOptions.mHeaderSizes[level - 1]));
setSpan(builder, new StyleSpan(Typeface.BOLD));
break;
case LIST:
setBlockSpan(builder, new LeadingMarginSpan.Standard(mListItemIndent));
break;
case EMPHASIS:
setSpan(builder, new StyleSpan(Typeface.ITALIC));
break;
case DOUBLE_EMPHASIS:
setSpan(builder, new StyleSpan(Typeface.BOLD));
break;
case TRIPLE_EMPHASIS:
setSpan(builder, new StyleSpan(Typeface.BOLD_ITALIC));
break;
case BLOCK_CODE:
setSpan(builder, new LeadingMarginSpan.Standard(mCodeBlockIndent));
setSpan(builder, new TypefaceSpan("monospace"));
break;
case CODE_SPAN:
setSpan(builder, new TypefaceSpan("monospace"));
break;
case LINK:
case AUTOLINK:
setSpan(builder, new URLSpan(element.getAttribute("link")));
break;
case BLOCK_QUOTE:
// We add two leading margin spans so that when the order is reversed,
// the QuoteSpan will always be in the same spot.
setBlockSpan(builder, new LeadingMarginSpan.Standard(mBlockQuoteIndent));
setBlockSpan(builder, new QuoteSpan(mOptions.mBlockQuoteColor));
setBlockSpan(builder, new LeadingMarginSpan.Standard(mBlockQuoteIndent));
setBlockSpan(builder, new StyleSpan(Typeface.ITALIC));
break;
case STRIKETHROUGH:
setSpan(builder, new StrikethroughSpan());
break;
case HRULE:
setSpan(builder, new HorizontalLineSpan(mOptions.mHruleColor, mHruleSize, mHruleTopBottomPadding));
break;
case IMAGE:
if (imageDrawable != null) {
setSpan(builder, new ImageSpan(imageDrawable));
}
break;
}

return builder;
Expand All @@ -135,20 +269,32 @@ private static void setSpan(SpannableStringBuilder builder, Object what) {
builder.setSpan(what, 0, builder.length(), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
}

// These have trailing newlines that we want to avoid spanning
private static void setBlockSpan(SpannableStringBuilder builder, Object what) {
builder.setSpan(what, 0, builder.length() - 1, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
}

/**
* Configurable options for how Bypass renders certain elements.
*/
public static final class Options {
private float[] mHeaderSizes;

private String mListItem;
private String mUnorderedListItem;
private int mListItemIndentUnit;
private float mListItemIndentSize;

private int mBlockQuoteColor;
private int mBlockQuoteIndentUnit;
private float mBlockQuoteIndentSize;

private int mCodeBlockIndentUnit;
private float mCodeBlockIndentSize;

private int mHruleColor;
private int mHruleUnit;
private float mHruleSize;

public Options() {
mHeaderSizes = new float[] {
1.5f, // h1
Expand All @@ -159,13 +305,20 @@ public Options() {
1.0f, // h6
};

mListItem = "\u2022";
mUnorderedListItem = "\u2022";
mListItemIndentUnit = TypedValue.COMPLEX_UNIT_DIP;
mListItemIndentSize = 10;

mBlockQuoteColor = 0xff0000ff;
mBlockQuoteIndentUnit = TypedValue.COMPLEX_UNIT_DIP;
mBlockQuoteIndentSize = 10;

mCodeBlockIndentUnit = TypedValue.COMPLEX_UNIT_DIP;
mCodeBlockIndentSize = 10;

mHruleColor = Color.GRAY;
mHruleUnit = TypedValue.COMPLEX_UNIT_DIP;
mHruleSize = 1;
}

public Options setHeaderSizes(float[] headerSizes) {
Expand All @@ -181,8 +334,8 @@ else if (headerSizes.length != 6) {
return this;
}

public Options setListItem(String listItem) {
mListItem = listItem;
public Options setUnorderedListItem(String unorderedListItem) {
mUnorderedListItem = unorderedListItem;
return this;
}

Expand All @@ -202,5 +355,34 @@ public Options setBlockQuoteIndentSize(int unit, float size) {
mBlockQuoteIndentSize = size;
return this;
}

public Options setCodeBlockIndentSize(int unit, float size) {
mCodeBlockIndentUnit = unit;
mCodeBlockIndentSize = size;
return this;
}

public Options setHruleColor(int color) {
mHruleColor = color;
return this;
}

public Options setHruleSize(int unit, float size) {
mHruleUnit = unit;
mHruleSize = size;
return this;
}
}

/**
* Retrieves images for markdown images.
*/
public static interface ImageGetter {

/**
* This method is called when the parser encounters an image tag.
*/
public Drawable getDrawable(String source);

}
}
Loading

0 comments on commit c592c22

Please sign in to comment.