/*
This file is part of RouteConverter.
RouteConverter is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
RouteConverter is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with RouteConverter; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Copyright (C) 2007 Christian Pesch. All Rights Reserved.
*/
package slash.navigation.itn;
import slash.common.io.Transfer;
import slash.common.type.CompactCalendar;
import slash.navigation.base.ParserContext;
import slash.navigation.base.RouteCharacteristics;
import slash.navigation.base.TextNavigationFormat;
import slash.navigation.common.NavigationPosition;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;
import java.util.prefs.Preferences;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static slash.common.io.Transfer.*;
import static slash.common.type.CompactCalendar.createDateFormat;
import static slash.navigation.base.RouteCharacteristics.Route;
import static slash.navigation.base.RouteCharacteristics.Track;
import static slash.navigation.base.RouteComments.TRIPMASTER_DATE;
import static slash.navigation.base.RouteComments.TRIPMASTER_TIME;
/**
* Reads and writes Tom Tom Route (.itn) files.
*
* @author Christian Pesch
*/
public abstract class TomTomRouteFormat extends TextNavigationFormat<TomTomRoute> {
protected static final Preferences preferences = Preferences.userNodeForPackage(TomTomRouteFormat.class);
private static final char SEPARATOR = '|';
private static final String REGEX_SEPARATOR = "\\" + SEPARATOR;
private static final Pattern POSITION_PATTERN = Pattern.
compile("\\s*([+-]?\\d+)" + REGEX_SEPARATOR + "([+-]?\\d+)" + REGEX_SEPARATOR +
"(.*)" + REGEX_SEPARATOR + "\\d" + REGEX_SEPARATOR + "?\\s*");
private static final Pattern NAME_PATTERN = Pattern.
compile("^\"([^\"]*)\"$");
public static final int START_TYPE = 4;
// public static final int END_TYPE_VISITED = 3;
public static final int END_TYPE = 2;
// public static final int WAYPOINT_VISITED = 1;
public static final int WAYPOINT = 0;
public String getExtension() {
return ".itn";
}
public int getMaximumFileNameLength() {
return preferences.getInt("maximumFileNameLength", 18);
}
public int getMaximumPositionCount() {
return preferences.getInt("maximumPositionCount", 48);
}
public boolean isSupportsMultipleRoutes() {
return false;
}
public boolean isWritingRouteCharacteristics() {
return false;
}
@SuppressWarnings({"unchecked"})
public <P extends NavigationPosition> TomTomRoute createRoute(RouteCharacteristics characteristics, String name, List<P> positions) {
return new TomTomRoute(characteristics, name, (List<TomTomPosition>) positions);
}
protected abstract boolean isIso885915ButReadWithUtf8(String string);
public void read(BufferedReader reader, String encoding, ParserContext<TomTomRoute> context) throws IOException {
List<TomTomPosition> positions = new ArrayList<>();
String routeName = null;
CompactCalendar startDate = context.getStartDate();
while (true) {
String line = reader.readLine();
if (line == null)
break;
if (line.length() == 0 || line.startsWith("~"))
continue;
// some files contain EF BB BF which is displayed as FF FE in UltraEdit
// in UTF-8 mode we filter like this for a valid line:
if (line.startsWith("\ufeff"))
line = line.substring(1);
// in ISO-8859-1 mode we filter like this:
if (line.startsWith("\357\273\277"))
line = line.substring(3);
line = line.replaceAll("\u0080", "\u20ac");
if (isPosition(line)) {
TomTomPosition position = parsePosition(line);
if (isValidStartDate(position.getTime()))
startDate = position.getTime();
else
position.setStartDate(startDate);
if (isIso885915ButReadWithUtf8(position.getDescription()))
return;
positions.add(position);
} else if (isName(line)) {
routeName = parseName(line);
} else {
return;
}
}
if (positions.size() > 0)
context.appendRoute(new TomTomRoute(this, isTrack(positions) ? Track : Route, routeName, positions));
}
boolean isPosition(String line) {
Matcher matcher = POSITION_PATTERN.matcher(line);
return matcher.matches();
}
boolean isName(String line) {
Matcher matcher = NAME_PATTERN.matcher(line);
return matcher.matches();
}
private boolean isTrack(List<TomTomPosition> positions) {
for (TomTomPosition position : positions) {
if (position.getReason() == null && !position.hasTime())
return false;
}
return true;
}
TomTomPosition parsePosition(String line) {
Matcher lineMatcher = POSITION_PATTERN.matcher(line);
if (!lineMatcher.matches())
throw new IllegalArgumentException("'" + line + "' does not match");
String longitude = lineMatcher.group(1);
String latitude = lineMatcher.group(2);
String description = lineMatcher.group(3);
return new TomTomPosition(parseInteger(longitude), parseInteger(latitude), trim(description));
}
String parseName(String line) {
Matcher lineMatcher = NAME_PATTERN.matcher(line);
if (!lineMatcher.matches())
throw new IllegalArgumentException("'" + line + "' does not match");
String description = lineMatcher.group(1);
return trim(description);
}
String formatFirstOrLastName(TomTomPosition position, String firstOrLast, Double distance) {
StringBuilder buffer = new StringBuilder();
if (position.hasTime()) {
buffer.append(firstOrLast).append(" : ");
}
buffer.append(position.getDescription());
if (position.hasTime()) {
buffer.append(" : ").append(createDateFormat(TRIPMASTER_DATE).format(position.getTime().getTime()));
buffer.append(" - ").append(position.getElevation() != null ? position.getElevation() : 0).append(" m");
buffer.append(" - ").append(position.getSpeed() != null ? position.getSpeed() : 0).append(" Km/h");
buffer.append(" - ").append(position.getHeading() != null ? position.getHeading() : 0).append(" deg");
}
if(distance != null) {
buffer.append(" - ").append(distance.intValue()).append(" Km");
}
return buffer.toString();
}
String formatIntermediateName(TomTomPosition position, Double distance) {
StringBuilder buffer = new StringBuilder();
buffer.append(position.getDescription());
if (position.hasTime()) {
buffer.append(" : ").append(createDateFormat(TRIPMASTER_TIME).format(position.getTime().getTime()));
buffer.append(" - ").append(position.getElevation() != null ? position.getElevation() : 0).append(" m");
buffer.append(" - ").append(position.getSpeed() != null ? position.getSpeed() : 0).append(" Km/h");
buffer.append(" - ").append(position.getHeading() != null ? position.getHeading() : 0).append(" deg");
}
if(distance != null) {
buffer.append(" - ").append(distance.intValue()).append(" Km");
}
return buffer.toString();
}
private String escape(String string) {
string = Transfer.escape(string, SEPARATOR, ';');
if (string != null)
string = string.replaceAll("\u20ac", "\u0080");
return string;
}
public void write(TomTomRoute route, PrintWriter writer, int startIndex, int endIndex) {
List<TomTomPosition> positions = route.getPositions();
for (int i = startIndex; i < endIndex; i++) {
TomTomPosition position = positions.get(i);
String longitude = formatIntAsString(position.getLongitudeAsInt());
String latitude = formatIntAsString(position.getLatitudeAsInt());
boolean first = i == startIndex;
boolean last = i == endIndex - 1;
int type = WAYPOINT;
if (first)
type = START_TYPE;
else if (last)
type = END_TYPE;
String description = position.getDescription();
if (route.getCharacteristics().equals(Track)) {
Double distance = route.getDistance(startIndex, i);
if (first)
description = formatFirstOrLastName(position, "Start", distance);
else if (last)
description = formatFirstOrLastName(position, "Finish", distance);
else
description = formatIntermediateName(position, distance);
}
description = escape(description);
writer.println(longitude + SEPARATOR + latitude + SEPARATOR + description + SEPARATOR + type + SEPARATOR);
}
}
}