Merge pull request #52 from mvglasow/trac1325.rebasedR6505

Add:port_android:OSD button to show Android menu

10 files changed, 286 insertions, 14 deletions

diff --git a/navit/android/src/org/navitproject/navit/Navit.java b/navit/android/src/org/navitproject/navit/Navit.java
index 90fcbe5eb..a117ccd6d 100644
--- a/navit/android/src/org/navitproject/navit/Navit.java
+++ b/navit/android/src/org/navitproject/navit/Navit.java
@@ -246,6 +246,8 @@ public class Navit extends Activity
 		super.onCreate(savedInstanceState);

 		if (android.os.Build.VERSION.SDK_INT < android.os.Build.VERSION_CODES.HONEYCOMB)

 			this.requestWindowFeature(Window.FEATURE_NO_TITLE);

+		else

+			this.getActionBar().hide();

 

 		dialogs = new NavitDialogs(this);

 

@@ -590,6 +592,16 @@ public class Navit extends Activity
 				break;

 		}

 	}

+	

+	/**

+	 * @brief Shows the Options menu.

+	 * 

+	 * Calling this method has the same effect as pressing the hardware Menu button, where present, or touching

+	 * the overflow button in the Action bar.

+	 */

+	public void showMenu() {

+		openOptionsMenu();

+	}

 

 	void setDestination(float latitude, float longitude, String address) {

 		Toast.makeText( getApplicationContext(),getString(R.string.address_search_set_destination) + "\n" + address, Toast.LENGTH_LONG).show(); //TRANS

@@ -690,25 +702,17 @@ public class Navit extends Activity
 		NavitDestroy();

 	}

 	

-	public void fullscreen(int fullscreen) 

-	{

-		if(fullscreen != 0) 

-		{

+	public void fullscreen(int fullscreen) {

+		if(fullscreen != 0) {

 			getWindow().addFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN);

 			getWindow().clearFlags(WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN);

-			if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB)

-				this.getActionBar().hide();

 		}

-		else 

-		{

+		else {

 			getWindow().addFlags(WindowManager.LayoutParams.FLAG_FORCE_NOT_FULLSCREEN);

 			getWindow().clearFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN);

-			if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB)

-				this.getActionBar().show();

 		}

 	}

 

-

 	public void disableSuspend()

 	{

 		wl.acquire();

diff --git a/navit/android/src/org/navitproject/navit/NavitGraphics.java b/navit/android/src/org/navitproject/navit/NavitGraphics.java
index 728b49878..08f4fbe3e 100644
--- a/navit/android/src/org/navitproject/navit/NavitGraphics.java
+++ b/navit/android/src/org/navitproject/navit/NavitGraphics.java
@@ -32,6 +32,7 @@ import android.graphics.Paint;
 import android.graphics.Path;
 import android.graphics.PointF;
 import android.graphics.Rect;
+import android.os.Build;
 import android.os.Handler;
 import android.os.Message;
 import android.util.FloatMath;
@@ -41,6 +42,7 @@ import android.view.KeyEvent;
 import android.view.MenuItem;
 import android.view.MotionEvent;
 import android.view.View;
+import android.view.ViewConfiguration;
 import android.view.inputmethod.InputMethodManager;
 import android.widget.RelativeLayout;
 
@@ -792,6 +794,24 @@ public class NavitGraphics
 	private int		SizeChangedCallbackID, ButtonCallbackID, MotionCallbackID, KeypressCallbackID;
 	// private int count;
 
+	/**
+	 * @brief Returns whether the device has a hardware menu button.
+	 * 
+	 * Only Android versions starting with ICS (API version 14) support the API call to detect the presence of a
+	 * Menu button. On earlier Android versions, the following assumptions will be made: On API levels up to 10,
+	 * this method will always return {@code true}, as these Android versions relied on devices having a physical
+	 * Menu button. On API levels 11 through 13 (Honeycomb releases), this method will always return
+	 * {@code false}, as Honeycomb was a tablet-only release and did not require devices to have a Menu button.
+	 */
+	public boolean hasMenuButton() {
+		if (Build.VERSION.SDK_INT <= 10)
+			return true;
+		else if (Build.VERSION.SDK_INT <= 13)
+			return false;
+		else
+			return ViewConfiguration.get(activity.getApplication()).hasPermanentMenuKey();
+	}
+	
 	public void setSizeChangedCallback(int id)
 	{
 		SizeChangedCallbackID = id;
diff --git a/navit/attr_def.h b/navit/attr_def.h
index d5647f2f1..b3f77163b 100644
--- a/navit/attr_def.h
+++ b/navit/attr_def.h
@@ -253,6 +253,7 @@ ATTR(persistent)
 ATTR(waypoints_flag) /* toggle for "set as destination" to switch between start a new route or add */
 ATTR(no_warning_if_map_file_missing)
 ATTR(duplicate)
+ATTR(has_menu_button)
 ATTR2(0x0002ffff,type_int_end)
 ATTR2(0x00030000,type_string_begin)
 ATTR(type)
diff --git a/navit/graphics/android/graphics_android.c b/navit/graphics/android/graphics_android.c
index a543252ce..efde8358a 100644
--- a/navit/graphics/android/graphics_android.c
+++ b/navit/graphics/android/graphics_android.c
@@ -25,6 +25,8 @@
 #include "point.h"
 #include "graphics.h"
 #include "color.h"
+#include "item.h"
+#include "xmlconfig.h"
 #include "plugin.h"
 #include "event.h"
 #include "debug.h"
@@ -549,6 +551,19 @@ set_activity(jobject graphics)
 	return 1;
 }
 
+/**
+ * @brief Initializes a new Android graphics instance.
+ *
+ * This initializes a new Android graphics instance, which can either be the main view or an overlay.
+ *
+ * @param ret The new graphics instance
+ * @param parent The graphics instance that contains the new instance ({@code NULL} for the main view)
+ * @param p The position of the overlay in its parent ({@code NULL} for the main view)
+ * @param w The width of the overlay (0 for the main view)
+ * @param h The height of the overlay (0 for the main view)
+ * @param wraparound (0 for the main view)
+ * @param use_camera Whether to use the camera (0 for overlays)
+ */
 static int
 graphics_android_init(struct graphics_priv *ret, struct graphics_priv *parent, struct point *pnt, int w, int h, int wraparound, int use_camera)
 {
@@ -686,7 +701,7 @@ graphics_android_init(struct graphics_priv *ret, struct graphics_priv *parent, s
 }
 
 static jclass NavitClass;
-static jmethodID Navit_disableSuspend, Navit_exit, Navit_fullscreen, Navit_runOptionsItem;
+static jmethodID Navit_disableSuspend, Navit_exit, Navit_fullscreen, Navit_runOptionsItem, Navit_showMenu;
 
 static int
 graphics_android_fullscreen(struct window *win, int on)
@@ -702,6 +717,17 @@ graphics_android_disable_suspend(struct window *win)
 	(*jnienv)->CallVoidMethod(jnienv, android_activity, Navit_disableSuspend);
 }
 
+/**
+ * @brief Runs an item from the Android menu.
+ *
+ * This is a callback function which implements multiple API functions.
+ *
+ * @param this The {@code graohics_prov} structure
+ * @param function The API function which was called
+ * @param in Parameters to pass to the API function
+ * @param out Points to a buffer which will receive a pointer to the output of the command
+ * @param valid
+ */
 static void
 graphics_android_cmd_runMenuItem(struct graphics_priv *this, char *function, struct attr **in, struct attr ***out, int *valid)
 {
@@ -717,18 +743,57 @@ graphics_android_cmd_runMenuItem(struct graphics_priv *this, char *function, str
 	(*jnienv)->CallVoidMethod(jnienv, android_activity, Navit_runOptionsItem, ncmd);
 }
 
+/**
+ * @brief Shows the Android menu.
+ *
+ * This is the callback function associated with the {@code menu()} API function.
+ *
+ * @param this The {@code graohics_prov} structure
+ * @param function The API function which was called
+ * @param in Parameters to pass to the API function
+ * @param out Points to a buffer which will receive a pointer to the output of the command
+ * @param valid
+ */
+static void
+graphics_android_cmd_menu(struct graphics_priv *this, char *function, struct attr **in, struct attr ***out, int *valid)
+{
+	dbg(lvl_debug, "enter\n");
+	(*jnienv)->CallVoidMethod(jnienv, android_activity, Navit_showMenu);
+}
+
+/**
+ * The command table. Each entry consists of an API function name and the callback function which implements
+ * this command.
+ */
 static struct command_table commands[] = {
 	{"map_download_dialog",command_cast(graphics_android_cmd_runMenuItem)},
 	{"set_map_location",command_cast(graphics_android_cmd_runMenuItem)},
 	{"backup_restore_dialog",command_cast(graphics_android_cmd_runMenuItem)},
+	{"menu", command_cast(graphics_android_cmd_menu)},
 };
 
+/**
+ * @brief Creates a new Android graphics instance.
+ *
+ * This method is called when the graphics plugin is initialized. It creates the main view, i.e. the map view.
+ * Unless overlay mode is enabled, it also holds any OSD items.
+ *
+ * @param nav The navit instance.
+ * @param meth The methods for the new graphics instance
+ * @param attrs The attributes for the new graphics instance
+ * @param cbl The callback list for the new graphics instance
+ *
+ * @return The new graphics instance
+ */
 static struct graphics_priv *
 graphics_android_new(struct navit *nav, struct graphics_methods *meth, struct attr **attrs, struct callback_list *cbl)
 {
 	struct graphics_priv *ret;
 	struct attr *attr;
 	int use_camera=0;
+	jmethodID cid;
+
+	dbg(lvl_debug, "enter\n");
 	if (!event_request_system("android","graphics_android"))
 		return NULL;
 	ret=g_new0(struct graphics_priv, 1);
@@ -746,6 +811,22 @@ graphics_android_new(struct navit *nav, struct graphics_methods *meth, struct at
         }
 	image_cache_hash = g_hash_table_new(g_str_hash, g_str_equal);
 	if (graphics_android_init(ret, NULL, NULL, 0, 0, 0, use_camera)) {
+		cid = (*jnienv)->GetMethodID(jnienv, ret->NavitGraphicsClass, "hasMenuButton", "()Z");
+		if (cid != NULL) {
+			attr = g_new0(struct attr, 1);
+			attr->type = attr_has_menu_button;
+			attr->u.num = (*jnienv)->CallBooleanMethod(jnienv, ret->NavitGraphics, cid);
+
+			/*
+			 * Although the attribute refers to information obtained by the graphics plugin, we are storing it
+			 * with the navit object: the object is easier to access from anywhere in the program, and ultimately
+			 * it refers to a configuration value affecting all of Navit, thus users are likely to look for it in
+			 * the navit object (as the fact that graphics also handles input devices is not immedately obvious).
+			 */
+			navit_object_set_attr((struct navit_object *) nav, attr);
+			dbg(lvl_debug, "attr_has_menu_button=%d\n", attr->u.num);
+			g_free(attr);
+		}
 		dbg(lvl_debug,"returning %p\n",ret);
 		return ret;
 	} else {
@@ -754,6 +835,21 @@ graphics_android_new(struct navit *nav, struct graphics_methods *meth, struct at
 	}
 }
 
+/**
+ * @brief Creates a new overlay
+ *
+ * This method creates a graphics instance for a new overlay. If overlay mode is enabled, a separate overlay is
+ * created for each OSD item.
+ *
+ * @param gr The parent graphics instance, i.e. the one which will contain the overlay.
+ * @param meth The methods for the new graphics instance
+ * @param p The position of the overlay in its parent
+ * @param w The width of the overlay
+ * @param h The height of the overlay
+ * @param wraparound
+ *
+ * @return The graphics instance for the new overlay
+ */
 static struct graphics_priv *
 overlay_new(struct graphics_priv *gr, struct graphics_methods *meth, struct point *p, int w, int h, int wraparound)
 {
@@ -971,6 +1067,9 @@ event_android_new(struct event_methods *meth)
 	Navit_runOptionsItem = (*jnienv)->GetMethodID(jnienv, NavitClass, "runOptionsItem", "(I)V");
 	if (Navit_runOptionsItem == NULL) 
 		return NULL; 
+	Navit_showMenu = (*jnienv)->GetMethodID(jnienv, NavitClass, "showMenu", "()V");
+	if (Navit_showMenu == NULL)
+		return NULL;
 
 	dbg(lvl_debug,"ok\n");
         *meth=event_android_methods;
diff --git a/navit/osd/core/osd_core.c b/navit/osd/core/osd_core.c
index 47fd5e49c..cd19aeb55 100644
--- a/navit/osd/core/osd_core.c
+++ b/navit/osd/core/osd_core.c
@@ -1412,12 +1412,29 @@ osd_compass_new(struct navit *nav, struct osd_methods *meth,
 
 struct osd_button {
 	int use_overlay;
+	/* FIXME: do we need navit_init_cb? It is set in two places but never read.
+	 * osd_button_new sets it to osd_button_init (init callback), and
+	 * osd_button_init sets it to osd_std_click (click callback). */
 	struct callback *draw_cb,*navit_init_cb;
 	struct graphics_image *img;
 	char *src_dir,*src;
 };
 
 
+/**
+ * @brief Adjusts width and height of an OSD item to fit the image it displays.
+ *
+ * A width or height of 0%, stored in relative attributes as {@code ATTR_REL_RELSHIFT}, is used as a flag
+ * indicating that the respective dimension is unset, i.e. determined by the dimensions of its image.
+ *
+ * If this is the case for height and/or width, the respective dimension will be updated to fit the image.
+ *
+ * Note that this method is used by several OSD items, notably {@code osd_image}, {@code osd_button} and
+ * {@code osd_android_menu}.
+ *
+ * @param opc The OSD item
+ * @param img The image displayed by the item
+ */
 static void 
 osd_button_adjust_sizes(struct osd_priv_common *opc, struct graphics_image *img)
 {
@@ -1511,7 +1528,7 @@ osd_button_icon_path(struct osd_button *this_, char *src)
 {
 	if (!this_->src_dir)
 		return graphics_icon_path(src);
-	return g_strdup_printf("%s%s%s",this_->src_dir, G_DIR_SEPARATOR_S, src);
+	return g_strdup_printf("%s%s%s", this_->src_dir, G_DIR_SEPARATOR_S, src);
 }
  
 int
@@ -2001,6 +2018,7 @@ osd_nav_next_turn_new(struct navit *nav, struct osd_methods *meth,
 struct nav_toggle_announcer
 {
 	int w,h;
+	/* FIXME this is actually the click callback, which is set once but never read. Do we need this? */
 	struct callback *navit_init_cb;
 	char *icon_src;
 	int icon_h, icon_w, active, last_state;
diff --git a/navit/xpm/Makefile.am b/navit/xpm/Makefile.am
index 2ba0d3a5c..40b7cc851 100644
--- a/navit/xpm/Makefile.am
+++ b/navit/xpm/Makefile.am
@@ -56,6 +56,7 @@ image_DATA += nav_right_2_32.xpm
 svgs  = gui_about.svg
 svgs += gui_actions.svg
 svgs += gui_active.svg
+svgs += gui_android_menu.svg
 svgs += gui_bookmark.svg
 svgs += gui_formerdests.svg
 svgs += gui_display.svg
diff --git a/navit/xpm/gui_android_menu.svg b/navit/xpm/gui_android_menu.svg
new file mode 100644
index 000000000..b47eae076
--- /dev/null
+++ b/navit/xpm/gui_android_menu.svg
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="48"
+   height="48"
+   viewBox="0 0 48 48"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="gui_android_menu.svg">
+  <metadata
+     id="metadata12">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <defs
+     id="defs10" />
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1280"
+     inkscape:window-height="948"
+     id="namedview8"
+     showgrid="true"
+     inkscape:zoom="9.8333333"
+     inkscape:cx="24"
+     inkscape:cy="24"
+     inkscape:window-x="0"
+     inkscape:window-y="24"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg2"
+     fit-margin-top="16"
+     fit-margin-bottom="16"
+     fit-margin-left="22"
+     fit-margin-right="22"
+     showguides="true"
+     inkscape:guide-bbox="true">
+    <sodipodi:guide
+       position="0,12"
+       orientation="0,1"
+       id="guide4284"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="0,36"
+       orientation="0,1"
+       id="guide4286"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="0,16"
+       orientation="0,1"
+       id="guide4288"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="0,32"
+       orientation="0,1"
+       id="guide4290"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="12,0"
+       orientation="1,0"
+       id="guide4292"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="16,0"
+       orientation="1,0"
+       id="guide4294"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="32,0"
+       orientation="1,0"
+       id="guide4296"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <sodipodi:guide
+       position="36,0"
+       orientation="1,0"
+       id="guide4298"
+       inkscape:label=""
+       inkscape:color="rgb(0,0,255)" />
+    <inkscape:grid
+       type="xygrid"
+       id="grid4300" />
+  </sodipodi:namedview>
+  <circle
+     style="fill:#1a6cb6;stroke:none;stroke-width:0.79100001;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;fill-opacity:1"
+     id="path4302"
+     cx="24"
+     cy="24"
+     r="24" />
+  <path
+     d="m 24,20 c 1.1,0 2,-0.9 2,-2 0,-1.1 -0.9,-2 -2,-2 -1.1,0 -2,0.9 -2,2 0,1.1 0.9,2 2,2 z m 0,2 c -1.1,0 -2,0.9 -2,2 0,1.1 0.9,2 2,2 1.1,0 2,-0.9 2,-2 0,-1.1 -0.9,-2 -2,-2 z m 0,6 c -1.1,0 -2,0.9 -2,2 0,1.1 0.9,2 2,2 1.1,0 2,-0.9 2,-2 0,-1.1 -0.9,-2 -2,-2 z"
+     id="path6"
+     inkscape:connector-curvature="0"
+     style="fill:#ffffff" />
+</svg>
diff --git a/navit/xslt/android.xslt b/navit/xslt/android.xslt
index 28b9d8245..29802fee2 100644
--- a/navit/xslt/android.xslt
+++ b/navit/xslt/android.xslt
@@ -9,6 +9,7 @@
    <xsl:include href="default_plugins.xslt"/>
    <xsl:include href="map_sdcard_navitmap_bin.xslt"/>
    <xsl:include href="osd_minimum.xslt"/>
+   <xsl:include href="osd_android.xslt"/>
    <xsl:include href="cursor_scale.xslt"/>
    <xsl:template match="/config/plugins/plugin[1]" priority="100">
       <plugin path="$NAVIT_PREFIX/lib/lib*.so" ondemand="yes"/>
diff --git a/navit/xslt/osd_android.xslt b/navit/xslt/osd_android.xslt
new file mode 100644
index 000000000..c5f4afb4d
--- /dev/null
+++ b/navit/xslt/osd_android.xslt
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<xsl:transform version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xi="http://www.w3.org/2001/XInclude">
+   <xsl:template match="/config/navit/osd[last()]">
+      <xsl:copy><xsl:copy-of select="@*|node()"/></xsl:copy>
+      <xsl:text>&#x0A;        </xsl:text>
+      <osd type="button" src="gui_android_menu_{number($ICON_BIG)}_{number($ICON_BIG)}.png" command="graphics.menu()" x="{round(-60*number($OSD_SIZE))}" y="{round(48*number($OSD_SIZE))}" enable_expression="!has_menu_button"/>
+   </xsl:template>
+</xsl:transform>
diff --git a/navit/xslt/osd_minimum.xslt b/navit/xslt/osd_minimum.xslt
index cda88dc88..5b42769f4 100644
--- a/navit/xslt/osd_minimum.xslt
+++ b/navit/xslt/osd_minimum.xslt
@@ -18,7 +18,7 @@
       <xsl:text>&#x0A;        </xsl:text>
       <osd type="button" src="gui_zoom_out_{number($ICON_BIG)}_{number($ICON_BIG)}.png" command="zoom_out()" x="0" y="{round(number($ICON_BIG)+8*number($OSD_SIZE))}" osd_configuration="1"/>
       <xsl:text>&#x0A;        </xsl:text>
-      <osd type="button" src="cursor_{number($ICON_BIG)}_{number($ICON_BIG)}.png" command="follow=0;set_center_cursor()" x="{round(-60*number($OSD_SIZE))}" y="{round(40*number($OSD_SIZE))}" enable_expression="follow>1"/>
+      <osd type="button" src="cursor_{number($ICON_BIG)}_{number($ICON_BIG)}.png" command="follow=0;set_center_cursor()" x="{round(number($ICON_BIG)+8*number($OSD_SIZE))}" y="0" enable_expression="follow>1"/>
       <xsl:text>&#x0A;        </xsl:text>
       <xsl:copy><xsl:copy-of select="@*|node()"/></xsl:copy>
    </xsl:template>